diff --git a/docs/api/rest_api/rest_api_reference/openapi.json b/docs/api/rest_api/rest_api_reference/openapi.json index 8cbd5d4ce6..ad9e818e4e 100644 --- a/docs/api/rest_api/rest_api_reference/openapi.json +++ b/docs/api/rest_api/rest_api_reference/openapi.json @@ -2,11 +2,11 @@ "openapi": "3.1.0", "info": { "x-logo": { - "url": "https://doc.ibexa.co/en/latest/images/ibexa-dxp-logo.png" + "url": "https://doc.ibexa.co/en/saas/images/cohesivo-logo.png" }, - "title": "Ibexa DXP REST API", + "title": "Cohesivo SaaS REST API", "description": "", - "version": "6.0.0" + "version": "" }, "servers": [ { @@ -94,19 +94,7 @@ }, "summary": "List of activity log groups", "description": "Lists last activity log groups and their entries.", - "parameters": [], - "deprecated": false, - "x-badges": [ - { - "name": "Experience", - "color": "#D3822B" - }, - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] + "parameters": [] }, "post": { "operationId": "ibexa.activity_log.rest.activity_log_group.list.post", @@ -193,13 +181,11 @@ "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { @@ -247,19 +233,7 @@ } }, "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Experience", - "color": "#D3822B" - }, - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] + } } }, "/bookmark": { @@ -545,8 +519,7 @@ }, "summary": "List of bookmarks", "description": "Lists bookmarked Locations for the current user.", - "parameters": [], - "deprecated": false + "parameters": [] } }, "/bookmark/{locationId}": { @@ -564,6 +537,9 @@ }, "404": { "description": "Error - the given Location is not bookmarked or does not exist." + }, + "204": { + "description": "BookmarkIsBookmarkedController resource" } }, "summary": "Check if Location is bookmarked", @@ -572,19 +548,16 @@ { "name": "locationId", "in": "path", - "description": "", + "description": "BookmarkIsBookmarkedController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] }, "post": { "operationId": "ibexa.rest.create_bookmark", @@ -614,35 +587,30 @@ "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "locationId", "in": "path", - "description": "", + "description": "BookmarkCreateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { "description": "No payload required", "content": [], "required": false - }, - "deprecated": false + } }, "delete": { "operationId": "ibexa.rest.delete_bookmark", @@ -669,30 +637,25 @@ "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "locationId", "in": "path", - "description": "", + "description": "BookmarkDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] }, "head": { "operationId": "ibexa.rest.is_bookmarked.head", @@ -716,19 +679,16 @@ { "name": "locationId", "in": "path", - "description": "", + "description": "BookmarkIsBookmarkedController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] } }, "/calendar/event": { @@ -775,13 +735,11 @@ "description": "timestamp (seconds since the Unix Epoch).", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/UnixTimestamp" }, "style": "form", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "end", @@ -789,13 +747,11 @@ "description": "timestamp.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/UnixTimestamp" }, "style": "form", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "count", @@ -803,13 +759,11 @@ "description": "Maximum number of events returned (10 by default).", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "form", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "types", @@ -817,7 +771,6 @@ "description": "Comma-separated list of type identifiers.", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "array", "items": { @@ -826,7 +779,6 @@ }, "style": "form", "explode": false, - "allowReserved": false, "example": [ "future_publication", "future_hide", @@ -840,7 +792,6 @@ "description": "comma-separated list of language codes.", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "array", "items": { @@ -849,7 +800,6 @@ }, "style": "form", "explode": false, - "allowReserved": false, "example": [ "eng-GB", "fre-FR" @@ -861,17 +811,14 @@ "description": "Pagination cursor. It's the representation of the event to start the page afterward, as the concatenation of the timestamp, the event type, and the event identifier with a colon separator (\"::\"), encoded in base64. For example \"1778264040:future_hide:future_hide:2\" (\"future_hide:2\" is the ID) encoded as \"MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy\"", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, - "allowReserved": false, "example": "MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy" } - ], - "deprecated": false + ] } }, "/calendar/event/grouped-by-day": { @@ -1126,13 +1073,11 @@ "description": "timestamp (seconds since the Unix Epoch).", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/UnixTimestamp" }, "style": "form", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "end", @@ -1140,13 +1085,11 @@ "description": "timestamp.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "$ref": "#/components/schemas/UnixTimestamp" }, "style": "form", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "count", @@ -1154,13 +1097,11 @@ "description": "Maximum number of events returned (10 by default).", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "integer" }, "style": "form", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "types", @@ -1168,7 +1109,6 @@ "description": "Comma-separated list of type identifiers.", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "array", "items": { @@ -1177,7 +1117,6 @@ }, "style": "form", "explode": false, - "allowReserved": false, "example": [ "future_publication", "future_hide", @@ -1191,7 +1130,6 @@ "description": "comma-separated list of language codes.", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "array", "items": { @@ -1200,7 +1138,6 @@ }, "style": "form", "explode": false, - "allowReserved": false, "example": [ "eng-GB", "fre-FR" @@ -1212,17 +1149,14 @@ "description": "Pagination cursor. It's the representation of the event to start the page afterward, as the concatenation of the timestamp, the event type, and the event identifier with a colon separator (\"::\"), encoded in base64. For example \"1778264040:future_hide:future_hide:2\" (\"future_hide:2\" is the ID) encoded as \"MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy\"", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "form", "explode": false, - "allowReserved": false, "example": "MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy" } - ], - "deprecated": false + ] } }, "/calendar/event/{eventType}": { @@ -1245,7 +1179,6 @@ "description": "The type of event to execute an action on.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string", "enum": [ @@ -1254,8 +1187,7 @@ ] }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { @@ -1298,4745 +1230,3227 @@ } }, "required": true - }, - "deprecated": false + } } }, - "/cart": { + "/collaboration/sessions": { "post": { - "operationId": "ibexa.rest.cart.create", + "operationId": "api_collaborationsessions_post", "tags": [ - "Cart" + "Collaboration Sessions" ], "responses": { - "200": { - "description": "If set, the created Cart is returned in XML or JSON format.", + "201": { + "description": "Session created", "content": { - "application/vnd.ibexa.api.Cart+json": { + "application/vnd.ibexa.api.ExampleSession+json": { "schema": { - "$ref": "#/components/schemas/CartWrapper" + "$ref": "#/components/schemas/ExampleSessionWrapper" }, "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": { + "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" }, - "Currency": { - "_media-type": "application/vnd.ibexa.api.Currency+json", - "id": 2, - "code": "EUR", - "subunits": 2, - "enabled": true - }, - "entries": [] + "subject": "Project Collaboration Session", + "isActive": true, + "hasPublicLink": false } } }, - "application/vnd.ibexa.api.Cart+xml": { + "application/vnd.ibexa.api.ExampleSession+xml": { "schema": { - "$ref": "#/components/schemas/Cart" - } + "$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." - } - }, - "summary": "Create Cart", - "description": "Creates Cart from payload.", - "parameters": [ - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The CartCreate schema encoded in XML or JSON format.", - "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" - } - } + "description": "Error - the input does not match the input schema definition." }, - "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] - } - }, - "/cart/view": { - "post": { - "operationId": "ibexa.rest.cart.cart.view", - "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" - } - } - } + "401": { + "description": "Error - the user is not authorized to create sessions." } }, - "summary": "Filter carts", - "description": "Executes a query and returns a View including the results.", - "parameters": [ - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], + "summary": "Create collaboration session", + "description": "Creates a new collaboration session with participants and returns the session details.", + "parameters": [], "requestBody": { - "description": "The CartViewInput schema is posted in XML or JSON format.", + "description": "Session creation payload", "content": { - "application/vnd.ibexa.api.CartViewInput+json": { + "application/vnd.ibexa.api.ExampleSessionCreate+json": { "schema": { - "$ref": "#/components/schemas/CartViewInputWrapper" + "$ref": "#/components/schemas/ExampleSessionCreate" }, "example": { - "CartViewInput": { - "identifier": "loadUserCarts", - "CartQuery": { - "offset": 0, - "limit": 10, - "ownerId": 123 - } + "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.CartViewInput+xml": { + "application/vnd.ibexa.api.ExampleSessionCreate+xml": { "schema": { - "$ref": "#/components/schemas/CartViewInput" - } + "$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, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] + } } }, - "/cart/{identifier}": { + "/collaboration/sessions/{sessionToken}": { "get": { - "operationId": "ibexa.rest.cart.get", + "operationId": "api_collaborationsessions_sessionToken_get", "tags": [ - "Cart" + "Collaboration Sessions" ], "responses": { "200": { - "description": "OK - return the cart", + "description": "Session", "content": { - "application/vnd.ibexa.api.Cart+json": { + "application/vnd.ibexa.api.ExampleSession+json": { "schema": { - "$ref": "#/components/schemas/CartWrapper" + "$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.Cart+xml": { + "application/vnd.ibexa.api.ExampleSession+xml": { "schema": { - "$ref": "#/components/schemas/Cart" - } + "$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" } } }, - "401": { - "description": "Error - the user is not authorized to get this cart." - }, "404": { - "description": "Error - The identifier do not match any Cart." + "description": "Error - the session does not exist." + }, + "401": { + "description": "Error - the user is not authorized to access this session." } }, - "summary": "Get Cart", - "description": "Gets Cart by its identifier.", + "summary": "Get collaboration session", + "description": "Retrieves a collaboration session by its token.", "parameters": [ { - "name": "identifier", + "name": "sessionToken", "in": "path", - "description": "", + "description": "The session token to retrieve.", "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" + "explode": false } ] }, "delete": { - "operationId": "ibexa.rest.cart.delete", + "operationId": "api_collaborationsessions_sessionToken_delete", "tags": [ - "Cart" + "Collaboration Sessions" ], "responses": { "204": { - "description": "CartDeleteController resource deleted" + "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 Cart", - "description": "Deletes Cart by its identifier.", + "summary": "Delete collaboration session", + "description": "Deletes a collaboration session and removes all associated data.", "parameters": [ { - "name": "identifier", + "name": "sessionToken", "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", + "description": "The session token to delete.", "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" + "explode": false } ] }, "patch": { - "operationId": "ibexa.rest.cart.update", + "operationId": "api_collaborationsessions_sessionToken_patch", "tags": [ - "Cart" + "Collaboration Sessions" ], "responses": { "200": { - "description": "OK - return the updated cart", + "description": "Updated session", "content": { - "application/vnd.ibexa.api.Cart+json": { + "application/vnd.ibexa.api.ExampleSession+json": { "schema": { - "$ref": "#/components/schemas/CartWrapper" + "$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.Cart+xml": { + "application/vnd.ibexa.api.ExampleSession+xml": { "schema": { - "$ref": "#/components/schemas/Cart" - } + "$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 update this cart." + "description": "Error - the input does not match the input schema definition." }, "404": { - "description": "Error - The identifier do not match any cart." + "description": "Error - the session does not exist." + }, + "401": { + "description": "Error - the user is not authorized to update this session." } }, - "summary": "Update Cart's metadata", - "description": "Updates identified Cart's metadata from payload.", + "summary": "Update collaboration session", + "description": "Updates collaboration session properties.", "parameters": [ { - "name": "identifier", + "name": "sessionToken", "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", + "description": "The session token to update.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "The CartMetadataUpdate schema encoded in XML or JSON format.", + "description": "Session update payload", "content": { - "application/vnd.ibexa.api.CartMetadataUpdate+json": { + "application/vnd.ibexa.api.ExampleSessionUpdate+json": { "schema": { - "$ref": "#/components/schemas/CartMetadataUpdateWrapper" + "$ref": "#/components/schemas/ExampleSessionUpdate" + }, + "example": { + "ExampleSessionUpdate": { + "hasPublicLink": true + } } }, - "application/vnd.ibexa.api.CartMetadataUpdate+xml": { + "application/vnd.ibexa.api.ExampleSessionUpdate+xml": { "schema": { - "$ref": "#/components/schemas/CartMetadataUpdate" - } + "$ref": "#/components/schemas/ExampleSessionUpdate" + }, + "example": "\n\n true\n\n\n" } }, "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] - } - }, - "/cart/{identifier}/empty": { - "post": { - "operationId": "ibexa.rest.cart.empty", - "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 - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", - "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}/entry": { + "/collaboration/sessions/{sessionToken}/invitations": { "post": { - "operationId": "ibexa.cart.rest.cart.entry.add", + "operationId": "api_collaborationsessions_sessionTokeninvitations_post", "tags": [ - "Cart" + "Collaboration Sessions" ], "responses": { - "200": { - "description": "OK - return the updated cart", + "201": { + "description": "Invitation created", "content": { - "application/vnd.ibexa.api.Cart+json": { + "application/vnd.ibexa.api.Invitation+json": { "schema": { - "$ref": "#/components/schemas/CartWrapper" + "$ref": "#/components/schemas/InvitationWrapper" } }, - "application/vnd.ibexa.api.Cart+xml": { + "application/vnd.ibexa.api.Invitation+xml": { "schema": { - "$ref": "#/components/schemas/Cart" + "$ref": "#/components/schemas/InvitationWrapper" } } } }, "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." + "description": "Error - the input does not match the input schema definition." }, "404": { - "description": "Error - The identifier do not match any cart." + "description": "Error - the session does not exist." + }, + "401": { + "description": "Error - the user is not authorized to create invitations for this session." } }, - "summary": "Add Entry to Cart", - "description": "Adds an entry to the cart referenced by its identifier", + "summary": "Create invitation in collaboration session", + "description": "Creates an invitation for a participant to join a collaboration session.", "parameters": [ { - "name": "identifier", + "name": "sessionToken", "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", + "description": "The session token.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "The CartEntryAdd schema encoded in XML or JSON format.", + "description": "Invitation creation payload", "content": { - "application/vnd.ibexa.api.CartEntryAdd+json": { + "application/vnd.ibexa.api.InvitationCreate+json": { "schema": { - "$ref": "#/components/schemas/CartEntryAddWrapper" + "$ref": "#/components/schemas/InvitationCreate" }, "example": { - "CartEntryAdd": { - "quantity": 1, - "Product": { - "code": "test" + "InvitationCreate": { + "email": "external.user@example.com", + "Sender": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" }, "context": { - "foo": "bar" - } - } - } - }, - "application/vnd.ibexa.api.CartEntryAdd+xml": { - "schema": { - "$ref": "#/components/schemas/CartEntryAdd" - } + "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, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] + } } }, - "/cart/{identifier}/entry/{entryId}": { - "delete": { - "operationId": "ibexa.rest.cart.entry.remove", + "/collaboration/sessions/{sessionToken}/participants": { + "get": { + "operationId": "api_collaborationsessions_sessionTokenparticipants_get", "tags": [ - "Cart" + "Collaboration Sessions" ], "responses": { "200": { - "description": "OK - return the updated cart", + "description": "Participants list", "content": { - "application/vnd.ibexa.api.Cart+json": { + "application/vnd.ibexa.api.ParticipantList+json": { "schema": { - "$ref": "#/components/schemas/CartWrapper" + "$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.Cart+xml": { + "application/vnd.ibexa.api.ParticipantList+xml": { "schema": { - "$ref": "#/components/schemas/Cart" - } + "$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" } } }, - "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." + "description": "Error - the session does not exist." }, - "204": { - "description": "CartEntryRemoveController resource deleted" + "401": { + "description": "Error - the user is not authorized to access this session." } }, - "summary": "Remove Entry from Cart", - "description": "Removes the given entry from the given Cart.", + "summary": "List collaboration session participants", + "description": "Retrieves a list of all participants in a collaboration session.", "parameters": [ { - "name": "identifier", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "entryId", + "name": "sessionToken", "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", + "description": "The session token.", "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" + "explode": false } ] }, - "patch": { - "operationId": "ibexa.rest.cart.cart.entry.update", + "post": { + "operationId": "api_collaborationsessions_sessionTokenparticipants_post", "tags": [ - "Cart" + "Collaboration Sessions" ], "responses": { "200": { - "description": "OK - return the updated cart", + "description": "Participants list", "content": { - "application/vnd.ibexa.api.Cart+json": { + "application/vnd.ibexa.api.ParticipantList+json": { "schema": { - "$ref": "#/components/schemas/CartWrapper" + "$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.Cart+xml": { + "application/vnd.ibexa.api.ParticipantList+xml": { "schema": { - "$ref": "#/components/schemas/Cart" - } + "$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." - }, - "401": { - "description": "Error - the user is not authorized to update an entry of this cart." + "description": "Error - the input does not match the input schema definition." }, "404": { - "description": "Error - the identifiers don't match any cart or entry." + "description": "Error - the session does not exist." + }, + "401": { + "description": "Error - the user is not authorized to modify this session." } }, - "summary": "Update Entry from Cart", - "description": "Updates the given entry from the given Cart.", + "summary": "Add participants to collaboration session", + "description": "Adds new participants to an existing collaboration session.", "parameters": [ { - "name": "identifier", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "entryId", + "name": "sessionToken", "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", + "description": "The session token.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "The CartEntryUpdate schema encoded in XML or JSON format.", + "description": "Participant list creation payload", "content": { - "application/vnd.ibexa.api.CartEntryUpdate+json": { + "application/vnd.ibexa.api.ParticipantListCreate+json": { "schema": { - "$ref": "#/components/schemas/CartEntryUpdateWrapper" + "$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.CartEntryUpdate+xml": { + "application/vnd.ibexa.api.ParticipantListCreate+xml": { "schema": { - "$ref": "#/components/schemas/CartEntryUpdate" - } + "$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, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] + } } }, - "/cart/{identifier}/move-entries-to-shopping-list": { - "post": { - "operationId": "ibexa.rest.cart.move_cart_entries_to_shopping_list", + "/collaboration/sessions/{sessionToken}/participants/{participantId}": { + "delete": { + "operationId": "api_collaborationsessions_sessionTokenparticipants_participantId_delete", "tags": [ - "Cart" + "Collaboration Sessions" ], "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" - } - } - } + "204": { + "description": "Participant removed" }, - "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 move cart entries to shopping list." - }, - "404": { - "description": "Error - the cart identifier doesn't match any existing resource." + "description": "Error - the user is not authorized to modify this session." } }, - "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.", + "summary": "Remove participant from collaboration session", + "description": "Removes a participant from a collaboration session.", "parameters": [ { - "name": "identifier", + "name": "sessionToken", "in": "path", - "description": "The Cart identifier", + "description": "The session token.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "X-CSRF-Token", - "in": "header", - "description": "CSRF Token is needed to execute this unsafe request.", + "name": "participantId", + "in": "path", + "description": "The participant ID to remove.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { - "type": "string" + "type": "integer" }, "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The CartEntryIdentifiers schema encoded in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.CartEntryIdentifiers+json": { - "schema": { - "$ref": "#/components/schemas/CartEntryIdentifiersWrapper" - }, - "example": { - "CartEntryIdentifiers": { - "entries": [ - { - "identifier": "entry-002" - }, - { - "identifier": "entry-004" - } - ] - } - } - }, - "application/vnd.ibexa.api.CartEntryIdentifiers+xml": { - "schema": { - "$ref": "#/components/schemas/CartEntryIdentifiers" - }, - "example": "\n\n \n entry-002\n \n \n entry-004\n \n\n" - } - }, - "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "explode": false } ] - } - }, - "/cart/{identifier}/move-entries-to-shopping-list/{shoppingListIdentifier}": { - "post": { - "operationId": "ibexa.rest.cart.move_cart_entries_to_shopping_list.shopping_list_identifier", + }, + "patch": { + "operationId": "api_collaborationsessions_sessionTokenparticipants_participantId_patch", "tags": [ - "Cart" + "Collaboration Sessions" ], "responses": { "200": { - "description": "OK - returns the shopping list with added cart entries", + "description": "Updated participant", "content": { - "application/vnd.ibexa.api.ShoppingList+json": { + "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/ShoppingListWrapper" + "$ref": "#/components/schemas/InternalParticipantWrapper" } }, - "application/vnd.ibexa.api.ShoppingList+xml": { + "application/vnd.ibexa.api.InternalParticipant+xml": { "schema": { - "$ref": "#/components/schemas/ShoppingList" + "$ref": "#/components/schemas/InternalParticipantWrapper" } } } }, "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." + "description": "Error - the input does not match the input schema definition." }, "404": { - "description": "Error - the cart or shopping list don't match any existing resource." + "description": "Error - the session or participant does not exist." + }, + "401": { + "description": "Error - the user is not authorized to modify this session." } }, - "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.", + "summary": "Update participant in collaboration session", + "description": "Updates properties of a participant in a collaboration session.", "parameters": [ { - "name": "identifier", + "name": "sessionToken", "in": "path", - "description": "The Cart identifier", + "description": "The session token.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "shoppingListIdentifier", + "name": "participantId", "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.", + "description": "The participant ID to update.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { - "type": "string" + "type": "integer" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "The CartEntryIdentifiers schema encoded in XML or JSON format.", + "description": "Participant update payload", "content": { - "application/vnd.ibexa.api.CartEntryIdentifiers+json": { + "application/vnd.ibexa.api.ExternalParticipantUpdate+json": { "schema": { - "$ref": "#/components/schemas/CartEntryIdentifiersWrapper" + "$ref": "#/components/schemas/ExternalParticipantUpdate" + }, + "example": { + "ExternalParticipantUpdate": { + "scope": "view" + } } }, - "application/vnd.ibexa.api.CartEntryIdentifiers+xml": { + "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/CartEntryIdentifiers" + "$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, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] + } } }, - "/cart/{identifier}/move-to-shopping-list": { - "post": { - "operationId": "ibexa.rest.cart.move_cart_to_shopping_list", + "/ai/action-types": { + "get": { + "operationId": "ibexa.rest.ai.action_type.list", "tags": [ - "Cart" + "Connector AI" ], "responses": { "200": { - "description": "OK - returns the shopping list with added cart entries", + "description": "Action type list", "content": { - "application/vnd.ibexa.api.ShoppingList+json": { + "application/vnd.ibexa.api.ai.ActionTypeList+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListWrapper" + "$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.ShoppingList+xml": { + "application/vnd.ibexa.api.ai.ActionTypeList+xml": { "schema": { - "$ref": "#/components/schemas/ShoppingList" - } + "$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" } } - }, - "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" - } - ] + "summary": "Get action types list.", + "description": "Returns action types list.", + "parameters": [] } }, - "/cart/{identifier}/move-to-shopping-list/{shoppingListIdentifier}": { - "post": { - "operationId": "ibexa.rest.cart.move_cart_to_shopping_list.shopping_list_identifier", + "/ai/action-types/{identifier}": { + "get": { + "operationId": "ibexa.rest.ai.action_type", "tags": [ - "Cart" + "Connector AI" ], "responses": { "200": { - "description": "OK - returns the shopping list with added cart entries", + "description": "Action type", "content": { - "application/vnd.ibexa.api.ShoppingList+json": { + "application/vnd.ibexa.api.ai.ActionType+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListWrapper" + "$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.ShoppingList+xml": { + "application/vnd.ibexa.api.ai.ActionType+xml": { "schema": { - "$ref": "#/components/schemas/ShoppingList" - } + "$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" } } }, - "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." + "406": { + "description": "Error - an action type of the given unique identifier is not found." } }, - "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.", + "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": "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.", + "description": "ActionTypeLoadByIdentifierController identifier", "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" + "example": "generate_alt_text" } ] } }, - "/cart/{identifier}/summary": { + "/ai/actions": { "get": { - "operationId": "ibexa.rest.cart.summary", + "operationId": "ibexa.rest.ai.action.list.get", "tags": [ - "Cart" + "Connector AI" ], "responses": { "200": { - "description": "If set, the Cart Summary is returned in XML or JSON format.", + "description": "Action configuration list is returned in JSON or XML", "content": { - "application/vnd.ibexa.api.CartSummary+json": { + "application/vnd.ibexa.api.ai.ActionConfigurationList+json": { "schema": { - "$ref": "#/components/schemas/CartSummaryWrapper" + "$ref": "#/components/schemas/ActionConfigurationList" }, "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 - } + "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": [] }, - "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 - } + "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" }, - "formatted": "\u20ac246.00" - } - }, - "vatCategorySummary": [ + "createdAt": "2025-08-07T13:16:47+02:00", + "updatedAt": "2025-08-07T13:16:47+02:00" + }, { - "_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" - } + "_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" } - ], - "Currency": { - "_media-type": "application/vnd.ibexa.api.Currency+json", - "id": 2, - "code": "EUR", - "subunits": 2, - "enabled": true - } + ] } } }, - "application/vnd.ibexa.api.CartSummary+xml": { + "application/vnd.ibexa.api.ai.ActionConfigurationList+xml": { "schema": { - "$ref": "#/components/schemas/CartSummary" - } + "$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" } } - }, - "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": "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": { + "summary": "Get action configuration list.", + "description": "Returns action configuration list.", + "parameters": [] + }, "post": { - "operationId": "api_collaborationsessions_post", + "operationId": "ibexa.rest.ai.action.list.post", "tags": [ - "Collaboration Sessions" + "Connector AI" ], "responses": { - "201": { - "description": "Session created", + "200": { + "description": "Action configuration list is returned in JSON or XML", "content": { - "application/vnd.ibexa.api.ExampleSession+json": { + "application/vnd.ibexa.api.ai.ActionConfigurationList+json": { "schema": { - "$ref": "#/components/schemas/ExampleSessionWrapper" + "$ref": "#/components/schemas/ActionConfigurationList" }, "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" + "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": [] }, - { - "_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 + "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.ExampleSession+xml": { + "application/vnd.ibexa.api.ai.ActionConfigurationList+xml": { "schema": { - "$ref": "#/components/schemas/ExampleSessionWrapper" + "$ref": "#/components/schemas/ActionConfigurationList" }, - "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" + "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" } } - }, - "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": [], + "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, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], "requestBody": { - "description": "Session creation payload", + "description": "Query action configuration search criteria", "content": { - "application/vnd.ibexa.api.ExampleSessionCreate+json": { + "application/vnd.ibexa.api.ai.ActionConfigurationListInput+json": { "schema": { - "$ref": "#/components/schemas/ExampleSessionCreate" + "$ref": "#/components/schemas/ActionConfigurationListInput" }, "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" + "ActionConfigurationListInput": { + "query": "Rewrite", + "action_type_identifier": "refine_text", + "enabled": true, + "limit": 25, + "page": 1 } } }, - "application/vnd.ibexa.api.ExampleSessionCreate+xml": { + "application/vnd.ibexa.api.ai.ActionConfigurationListInput+xml": { "schema": { - "$ref": "#/components/schemas/ExampleSessionCreate" + "$ref": "#/components/schemas/ActionConfigurationListInput" }, - "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" + "example": "\n\n Rewrite\n refine_text\n 1\n 25\n 1\n\n" } }, "required": false - }, - "deprecated": false + } } }, - "/collaboration/sessions/{sessionToken}": { - "get": { - "operationId": "api_collaborationsessions_sessionToken_get", + "/ai/actions/{actionConfigurationIdentifier}/execute": { + "post": { + "operationId": "ibexa.rest.ai.actions.execute", "tags": [ - "Collaboration Sessions" + "Connector AI" ], "responses": { "200": { - "description": "Session", + "description": "Reworked text or generated alternative text", "content": { - "application/vnd.ibexa.api.ExampleSession+json": { + "application/vnd.ibexa.api.ai.AltText+json": { "schema": { - "$ref": "#/components/schemas/ExampleSessionWrapper" + "$ref": "#/components/schemas/AltText" }, "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" - } + "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." ] - }, - "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": { + "application/vnd.ibexa.api.ai.AltText+xml": { "schema": { - "$ref": "#/components/schemas/ExampleSessionWrapper" + "$ref": "#/components/schemas/AltText" }, - "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" + "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" } } }, - "404": { - "description": "Error - the session does not exist." - }, - "401": { - "description": "Error - the user is not authorized to access this session." + "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": "Get collaboration session", - "description": "Retrieves a collaboration session by its token.", + "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": "sessionToken", + "name": "actionConfigurationIdentifier", "in": "path", - "description": "The session token to retrieve.", + "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 - } - ], - "deprecated": false - }, - "delete": { - "operationId": "api_collaborationsessions_sessionToken_delete", - "tags": [ - "Collaboration Sessions" - ], - "responses": { - "204": { - "description": "Session deleted" - }, - "404": { - "description": "Error - the session does not exist." + "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" + } + } }, - "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.", + "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 + "explode": false } ], - "deprecated": false - }, - "patch": { - "operationId": "api_collaborationsessions_sessionToken_patch", + "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 + } + } + }, + "/ai/actions/{identifier}": { + "get": { + "operationId": "ibexa.rest.ai.action", "tags": [ - "Collaboration Sessions" + "Connector AI" ], "responses": { "200": { - "description": "Updated session", + "description": "Action configuration in JSON or XML", "content": { - "application/vnd.ibexa.api.ExampleSession+json": { + "application/vnd.ibexa.api.ai.ActionConfiguration+json": { "schema": { - "$ref": "#/components/schemas/ExampleSessionWrapper" + "$ref": "#/components/schemas/ActionConfiguration" }, "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" - } - ] + "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": [] }, - "Owner": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" + "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" }, - "subject": "Project Collaboration Session", - "isActive": true, - "hasPublicLink": false + "createdAt": "2025-08-07T13:16:47+02:00", + "updatedAt": "2025-08-07T13:18:00+02:00" } } }, - "application/vnd.ibexa.api.ExampleSession+xml": { + "application/vnd.ibexa.api.ai.ActionConfiguration+xml": { "schema": { - "$ref": "#/components/schemas/ExampleSessionWrapper" + "$ref": "#/components/schemas/ActionConfiguration" }, - "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" + "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" } } }, - "400": { - "description": "Error - the input does not match the input schema definition." - }, "404": { - "description": "Error - the session does not exist." + "description": "Error - an action configuration of the given unique identifier is not found." }, "401": { - "description": "Error - the user is not authorized to update this session." + "description": "Error \u2013 the user doesn't have access to the given action configuration" } }, - "summary": "Update collaboration session", - "description": "Updates collaboration session properties.", + "summary": "Get an action configuration by its unique identifier.", + "description": "Returns an action configuration by its unique string identifier.", "parameters": [ { - "name": "sessionToken", + "name": "identifier", "in": "path", - "description": "The session token to update.", + "description": "ActionConfigurationLoadByIdentifierController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", "explode": false, - "allowReserved": false + "example": "rewrite_with_friendly_tone" } - ], - "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", + "/languages": { + "get": { + "operationId": "ibexa.rest.languages.list", "tags": [ - "Collaboration Sessions" + "Language" ], "responses": { - "201": { - "description": "Invitation created", + "200": { + "description": "If set, the list is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Invitation+json": { + "application/vnd.ibexa.api.LanguageList+json": { "schema": { - "$ref": "#/components/schemas/InvitationWrapper" + "$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.Invitation+xml": { + "application/vnd.ibexa.api.LanguageList+xml": { "schema": { - "$ref": "#/components/schemas/InvitationWrapper" - } + "$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" } } - }, - "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 + "summary": "Language list", + "description": "Lists languages", + "parameters": [] } }, - "/collaboration/sessions/{sessionToken}/participants": { + "/languages/{code}": { "get": { - "operationId": "api_collaborationsessions_sessionTokenparticipants_get", + "operationId": "ibexa.rest.languages.view", "tags": [ - "Collaboration Sessions" + "Language" ], "responses": { "200": { - "description": "Participants list", + "description": "If set, the language is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ParticipantList+json": { + "application/vnd.ibexa.api.Language+json": { "schema": { - "$ref": "#/components/schemas/ParticipantListWrapper" + "$ref": "#/components/schemas/LanguageWrapper" }, "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" + "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.ParticipantList+xml": { + "application/vnd.ibexa.api.Language+xml": { "schema": { - "$ref": "#/components/schemas/ParticipantListWrapper" + "$ref": "#/components/schemas/Language" }, - "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" + "example": "\n\n 2\n eng-GB\n English (United Kingdom)\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.", + "summary": "Get language", + "description": "Retrieves a LanguageLoadByIdController resource.", "parameters": [ { - "name": "sessionToken", + "name": "code", "in": "path", - "description": "The session token.", + "description": "LanguageLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false - }, - "post": { - "operationId": "api_collaborationsessions_sessionTokenparticipants_post", + ] + } + }, + "/content/locations": { + "get": { + "operationId": "ibexa.rest.redirect_location", "tags": [ - "Collaboration Sessions" + "Location" ], "responses": { "200": { - "description": "Participants list", + "description": "OK - returns the LocationList in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ParticipantList+json": { + "application/vnd.ibexa.api.LocationList+json": { "schema": { - "$ref": "#/components/schemas/ParticipantListWrapper" + "$ref": "#/components/schemas/LocationWrapper" }, "example": { - "ParticipantList": { - "Participants": [ - { - "User": { - "_href": "/api/ibexa/v2/user/users/14", - "_media-type": "application/vnd.ibexa.api.User+json" + "Location": { + "_media-type": "application/vnd.ibexa.api.Location+json", + "_href": "/api/ibexa/v2/content/locations/1/2/58", + "id": 58, + "priority": 0, + "hidden": false, + "invisible": false, + "explicitlyHidden": false, + "ParentLocation": { + "_media-type": "application/vnd.ibexa.api.Location+json", + "_href": "/api/ibexa/v2/content/locations/1/2" + }, + "pathString": "/1/2/58/", + "depth": 2, + "childCount": 3, + "remoteId": "0cfe62f27753448d79aaa8acd8d01699", + "Children": { + "_media-type": "application/vnd.ibexa.api.LocationList+json", + "_href": "/api/ibexa/v2/content/locations/1/2/58/children" + }, + "Content": { + "_media-type": "application/vnd.ibexa.api.Content+json", + "_href": "/api/ibexa/v2/content/objects/57" + }, + "sortField": "PATH", + "sortOrder": "ASC", + "UrlAliases": { + "_media-type": "application/vnd.ibexa.api.UrlAliasRefList+json", + "_href": "/api/ibexa/v2/content/locations/1/2/58/urlaliases" + }, + "ContentInfo": { + "_media-type": "application/vnd.ibexa.api.ContentInfo+json", + "_href": "/api/ibexa/v2/content/objects/57", + "Content": { + "_media-type": "application/vnd.ibexa.api.ContentInfo+json", + "_href": "/api/ibexa/v2/content/objects/57", + "_remoteId": "782f5afa9d6587804daa911e88ff5bb9", + "_id": 57, + "ContentType": { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/1" }, - "_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" + "Name": "All Tips", + "TranslatedName": "All Tips", + "Versions": { + "_media-type": "application/vnd.ibexa.api.VersionList+json", + "_href": "/api/ibexa/v2/content/objects/57/versions" + }, + "CurrentVersion": { + "_media-type": "application/vnd.ibexa.api.Version+json", + "_href": "/api/ibexa/v2/content/objects/57/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/57/locations" + }, + "Owner": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "lastModificationDate": "2021-06-28T11:22:52+00:00", + "publishedDate": "2021-06-28T11:22:52+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/57/objectstates" + } } - ], - "_media-type": "application/vnd.ibexa.api.ParticipantList+json" + } } } }, - "application/vnd.ibexa.api.ParticipantList+xml": { + "application/vnd.ibexa.api.LocationList+xml": { "schema": { - "$ref": "#/components/schemas/ParticipantListWrapper" + "$ref": "#/components/schemas/Location" }, - "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" + "example": "\n\n 58\n 0\n false\n false\n false\n \n /1/2/58/\n 2\n 3\n 0cfe62f27753448d79aaa8acd8d01699\n \n \n PATH\n ASC\n \n \n \n \n All Tips\n All Tips\n \n \n
\n \n \n 2021-06-28T11:22:52+00:00\n 2021-06-28T11:22:52+00:00\n eng-GB\n 1\n true\n false\n PUBLISHED\n \n \n \n\n" } } }, - "400": { - "description": "Error - the input does not match the input schema definition." + "307": { + "description": "Temporary redirect to the main resource URL." }, "404": { - "description": "Error - the session does not exist." - }, - "401": { - "description": "Error - the user is not authorized to modify this session." + "description": "Error - the Location with the given ID (remote ID or URL Alias) does not exist." } }, - "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 - } + "summary": "Load Locations by id/remoteId/urlAlias", + "description": "Loads the Location for a given ID (x), remote ID or URL alias.", + "parameters": [] + } + }, + "/content/locations/{path}": { + "get": { + "operationId": "ibexa.rest.load_location", + "tags": [ + "Location" ], - "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" + "responses": { + "200": { + "description": "If set, the new Location is returned in XML or JSON format.", + "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/58", + "id": 58, + "priority": 0, + "hidden": false, + "invisible": false, + "explicitlyHidden": false, + "ParentLocation": { + "_media-type": "application/vnd.ibexa.api.Location+json", + "_href": "/api/ibexa/v2/content/locations/1/2" }, - { - "_media-type": "application/vnd.ibexa.api.ExternalParticipantCreate+json", - "email": "user@link.invalid", - "scope": "view" + "pathString": "/1/2/58/", + "depth": 2, + "childCount": 3, + "remoteId": "0cfe62f27753448d79aaa8acd8d01699", + "Children": { + "_media-type": "application/vnd.ibexa.api.LocationList+json", + "_href": "/api/ibexa/v2/content/locations/1/2/58/children" + }, + "Content": { + "_media-type": "application/vnd.ibexa.api.Content+json", + "_href": "/api/ibexa/v2/content/objects/57" + }, + "sortField": "PATH", + "sortOrder": "ASC", + "UrlAliases": { + "_media-type": "application/vnd.ibexa.api.UrlAliasRefList+json", + "_href": "/api/ibexa/v2/content/locations/1/2/58/urlaliases" + }, + "ContentInfo": { + "_media-type": "application/vnd.ibexa.api.ContentInfo+json", + "_href": "/api/ibexa/v2/content/objects/57", + "Content": { + "_media-type": "application/vnd.ibexa.api.ContentInfo+json", + "_href": "/api/ibexa/v2/content/objects/57", + "_remoteId": "782f5afa9d6587804daa911e88ff5bb9", + "_id": 57, + "ContentType": { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/1" + }, + "Name": "All Tips", + "TranslatedName": "All Tips", + "Versions": { + "_media-type": "application/vnd.ibexa.api.VersionList+json", + "_href": "/api/ibexa/v2/content/objects/57/versions" + }, + "CurrentVersion": { + "_media-type": "application/vnd.ibexa.api.Version+json", + "_href": "/api/ibexa/v2/content/objects/57/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/57/locations" + }, + "Owner": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "lastModificationDate": "2021-06-28T11:22:52+00:00", + "publishedDate": "2021-06-28T11:22:52+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/57/objectstates" + } + } } - ] + } } - } - }, - "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" + "application/vnd.ibexa.api.Location+xml": { + "schema": { + "$ref": "#/components/schemas/Location" + }, + "example": "\n\n 61\n 0\n false\n false\n \n /1/2/61/\n 2\n 0\n 2cfa66027e3806b113d994c9c26d3a66\n \n \n NAME\n ASC\n \n \n \n \n 666\n \n \n
\n \n \n 2018-11-09T14:49:52+01:00\n 2018-11-09T14:49:52+01:00\n eng-GB\n 1\n false\n \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" + "401": { + "description": "Error - the user is not authorized to read this Location." }, "404": { - "description": "Error - the session or participant does not exist." - }, - "401": { - "description": "Error - the user is not authorized to modify this session." + "description": "Error - the Location with the given path does not exist." } }, - "summary": "Remove participant from collaboration session", - "description": "Removes a participant from a collaboration session.", + "summary": "Load Location", + "description": "Loads the Location for the given path e.g. '/content/locations/1/2/61'.", "parameters": [ { - "name": "sessionToken", - "in": "path", - "description": "The session token.", - "required": true, + "name": "If-None-Match", + "in": "header", + "description": "ETag", + "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "participantId", + "name": "path", "in": "path", - "description": "The participant ID to remove.", + "description": "LocationLoadByPathController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { - "type": "integer" + "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] }, - "patch": { - "operationId": "api_collaborationsessions_sessionTokenparticipants_participantId_patch", + "delete": { + "operationId": "ibexa.rest.delete_subtree", "tags": [ - "Collaboration Sessions" + "Location" ], "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" - } - } - } + "204": { + "description": "No Content - deleted." }, - "400": { - "description": "Error - the input does not match the input schema definition." + "401": { + "description": "Error - the user is not authorized to delete this subtree." }, "404": { - "description": "Error - the session or participant does not exist." - }, - "401": { - "description": "Error - the user is not authorized to modify this session." + "description": "Error - the Location with the given ID does not exist." } }, - "summary": "Update participant in collaboration session", - "description": "Updates properties of a participant in a collaboration session.", + "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": "sessionToken", - "in": "path", - "description": "The session token.", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "participantId", + "name": "path", "in": "path", - "description": "The participant ID to update.", + "description": "LocationSubtreeDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { - "type": "integer" + "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } + ] + }, + "patch": { + "operationId": "ibexa.rest.update_location", + "tags": [ + "Location" ], - "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" + "responses": { + "200": { + "description": "If set, the Location is returned in XML or JSON format.", + "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", + "id": 59, + "priority": 3, + "hidden": true, + "invisible": true, + "explicitlyHidden": true, + "ParentLocation": { + "_media-type": "application/vnd.ibexa.api.Location+json", + "_href": "/api/ibexa/v2/content/locations/1/2" + }, + "pathString": "/1/2/59/", + "depth": 2, + "childCount": 5, + "remoteId": "remoteId-qwert999", + "Children": { + "_media-type": "application/vnd.ibexa.api.LocationList+json", + "_href": "/api/ibexa/v2/content/locations/1/2/59/children" + }, + "Content": { + "_media-type": "application/vnd.ibexa.api.Content+json", + "_href": "/api/ibexa/v2/content/objects/58" + }, + "sortField": "NAME", + "sortOrder": "DESC", + "UrlAliases": { + "_media-type": "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" + } + } + } + } + } }, - "example": "\n\n view\n\n\n" + "application/vnd.ibexa.api.Location+xml": { + "schema": { + "$ref": "#/components/schemas/Location" + }, + "example": "\n\n 58\n 0\n false\n false\n false\n \n /1/2/58/\n 2\n 3\n 0cfe62f27753448d79aaa8acd8d01699\n \n \n PATH\n ASC\n \n \n \n \n All Tips\n All Tips\n \n \n
\n \n \n 2021-06-28T11:22:52+00:00\n 2021-06-28T11:22:52+00:00\n eng-GB\n 1\n true\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": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" }, - "application/vnd.ibexa.api.InternalParticipantUpdate+json": { + "style": "simple", + "explode": false + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "path", + "in": "path", + "description": "LocationUpdateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "The LocationUpdate schema encoded in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.LocationUpdate+json": { "schema": { - "$ref": "#/components/schemas/InternalParticipantUpdate" + "$ref": "#/components/schemas/LocationUpdateStructWrapper" }, "example": { - "InternalParticipantUpdate": { - "scope": "view" + "LocationUpdate": { + "priority": "3", + "hidden": true, + "remoteId": "remoteId-qwert999", + "sortField": "NAME", + "sortOrder": "DESC" } } }, - "application/vnd.ibexa.api.InternalParticipantUpdate+xml": { + "application/vnd.ibexa.api.LocationUpdate+xml": { "schema": { - "$ref": "#/components/schemas/InternalParticipantUpdate" + "$ref": "#/components/schemas/LocationUpdateStruct" }, - "example": "\n\n view\n\n\n" + "example": "\n\n 3\n true\n remoteId-qwert999\n CLASS\n DESC\n\n" } }, "required": false - }, - "deprecated": false + } } }, - "/ai/action-types": { + "/content/locations/{path}/children": { "get": { - "operationId": "ibexa.rest.ai.action_type.list", + "operationId": "ibexa.rest.load_location_children", "tags": [ - "Connector AI" + "Location" ], "responses": { "200": { - "description": "Action type list", + "description": "If set, the new Location list is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ai.ActionTypeList+json": { + "application/vnd.ibexa.api.LocationList+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": [] - } - ] - } + "$ref": "#/components/schemas/LocationListWrapper" } }, - "application/vnd.ibexa.api.ai.ActionTypeList+xml": { + "application/vnd.ibexa.api.LocationList+xml": { "schema": { - "$ref": "#/components/schemas/ActionTypeList" + "$ref": "#/components/schemas/LocationList" }, - "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" + "example": "\n\n \n \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 action types list.", - "description": "Returns action types list.", - "parameters": [], - "deprecated": false + "summary": "Get child Locations.", + "description": "Loads all child Locations for the given parent Location.", + "parameters": [ + { + "name": "path", + "in": "path", + "description": "LocationChildrenListController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] } }, - "/ai/action-types/{identifier}": { + "/content/locations/{path}/urlaliases": { "get": { - "operationId": "ibexa.rest.ai.action_type", + "operationId": "ibexa.rest.list_location_url_aliases", "tags": [ - "Connector AI" + "Location" ], "responses": { "200": { - "description": "Action type", + "description": "OK - returns the list of URL aliases.", "content": { - "application/vnd.ibexa.api.ai.ActionType+json": { + "application/vnd.ibexa.api.UrlAliasRefList+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 - } - } + "$ref": "#/components/schemas/UrlAliasRefListWrapper" } }, - "application/vnd.ibexa.api.ai.ActionType+xml": { + "application/vnd.ibexa.api.UrlAliasRefList+xml": { "schema": { - "$ref": "#/components/schemas/ActionType" + "$ref": "#/components/schemas/UrlAliasRefList" }, - "example": "\n\n generate_alt_text\n Generate alternative text\n image\n text\n \n 512\n 512\n 85\n \n\n" + "example": "\n\n \n \n\n" } } }, - "406": { - "description": "Error - an action type of the given unique identifier is not found." + "400": { + "description": "Error - The user has no permission to read URL aliases." + }, + "401": { + "description": "Error - The Location was not found." } }, - "summary": "Get an action type by its unique identifier.", - "description": "Returns an action type by its unique string identifier.", + "summary": "List URL aliases for Location", + "description": "Returns the list of URL aliases for a Location.", "parameters": [ { - "name": "identifier", + "name": "path", "in": "path", - "description": "", + "description": "URLAliasListLocationController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false, - "example": "generate_alt_text" + "explode": false } - ], - "deprecated": false + ] } }, - "/ai/actions": { + "/content/objectstategroups": { "get": { - "operationId": "ibexa.rest.ai.action.list.get", + "operationId": "ibexa.rest.load_object_state_groups", "tags": [ - "Connector AI" + "Object State Groups" ], "responses": { "200": { - "description": "Action configuration list is returned in JSON or XML", + "description": "OK - returns a list of Object state groups.", "content": { - "application/vnd.ibexa.api.ai.ActionConfigurationList+json": { + "application/vnd.ibexa.api.ObjectStateGroupList+json": { "schema": { - "$ref": "#/components/schemas/ActionConfigurationList" + "$ref": "#/components/schemas/ObjectStateGroupListWrapper" }, "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" - }, + "ObjectStateGroupList": { + "_media-type": "application/vnd.ibexa.api.ObjectStateGroupList+json", + "_href": "/api/ibexa/v2/content/objectstategroups", + "ObjectStateGroup": [ { - "_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": [] + "_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" }, - "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" + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Lock" + } + ] }, - "createdAt": "2025-08-07T13:16:47+02:00", - "updatedAt": "2025-08-07T13:16:47+02:00" + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "" + } + ] + } }, { - "_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": [] + "_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" }, - "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" + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Accessibility" + } + ] }, - "createdAt": "2025-08-07T13:16:47+02:00", - "updatedAt": "2025-08-07T13:16:47+02:00" + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "" + } + ] + } }, { - "_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": [] + "_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" }, - "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" + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Custom State" + } + ] }, - "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" + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Custom Object state" + } + ] + } } ] } } }, - "application/vnd.ibexa.api.ai.ActionConfigurationList+xml": { + "application/vnd.ibexa.api.ObjectStateGroupList+xml": { "schema": { - "$ref": "#/components/schemas/ActionConfigurationList" + "$ref": "#/components/schemas/ObjectStateGroupList" }, - "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" + "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": "Get action configuration list.", - "description": "Returns action configuration list.", - "parameters": [], - "deprecated": false + "summary": "List Object state groups", + "description": "Returns a list of all Object state groups.", + "parameters": [ + { + "name": "If-None-Match", + "in": "header", + "description": "ETag", + "required": false, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] }, "post": { - "operationId": "ibexa.rest.ai.action.list.post", + "operationId": "ibexa.rest.create_object_state_group", "tags": [ - "Connector AI" + "Object State Groups" ], "responses": { - "200": { - "description": "Action configuration list is returned in JSON or XML", + "201": { + "description": "Object state group created.", "content": { - "application/vnd.ibexa.api.ai.ActionConfigurationList+json": { + "application/vnd.ibexa.api.ObjectStateGroup+json": { "schema": { - "$ref": "#/components/schemas/ActionConfigurationList" + "$ref": "#/components/schemas/ObjectStateGroupWrapper" }, "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" - } - ] + "ObjectStateGroup": { + "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", + "_href": "/api/ibexa/v2/content/objectstategroups/7", + "id": 7, + "identifier": "custom-states", + "defaultLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "ObjectStates": { + "_media-type": "application/vnd.ibexa.api.ObjectStateList+json", + "_href": "/api/ibexa/v2/content/objectstategroups/7/objectstates" + }, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Custom State" + } + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Custom Object state" + } + ] + } } } }, - "application/vnd.ibexa.api.ai.ActionConfigurationList+xml": { + "application/vnd.ibexa.api.ObjectStateGroup+xml": { "schema": { - "$ref": "#/components/schemas/ActionConfigurationList" + "$ref": "#/components/schemas/ObjectStateGroup" }, - "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" + "example": "\n\n 5\n custom-states\n eng-GB\n eng-GB\n \n \n Custom State\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": "Query action configuration list.", - "description": "Returns action configuration list based on the given query.", + "summary": "Create Object state group", + "description": "Creates a new Object state group.", "parameters": [ { "name": "X-CSRF-Token", "in": "header", - "description": "CSRF token obtained during the authentication.", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "Query action configuration search criteria", + "description": "The Object state group input schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ai.ActionConfigurationListInput+json": { + "application/vnd.ibexa.api.ObjectStateGroupCreate+json": { "schema": { - "$ref": "#/components/schemas/ActionConfigurationListInput" + "$ref": "#/components/schemas/ObjectStateGroupCreateWrapper" }, "example": { - "ActionConfigurationListInput": { - "query": "Rewrite", - "action_type_identifier": "refine_text", - "enabled": true, - "limit": 25, - "page": 1 + "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.ai.ActionConfigurationListInput+xml": { + "application/vnd.ibexa.api.ObjectStateGroupCreate+xml": { "schema": { - "$ref": "#/components/schemas/ActionConfigurationListInput" + "$ref": "#/components/schemas/ObjectStateGroupCreate" }, - "example": "\n\n Rewrite\n refine_text\n 1\n 25\n 1\n\n" + "example": "\n\n custom\n eng-GB\n \n Custom State\n \n \n Custom Object state\n \n" } }, "required": false - }, - "deprecated": false + } } }, - "/ai/actions/{actionConfigurationIdentifier}/execute": { - "post": { - "operationId": "ibexa.rest.ai.actions.execute", + "/content/objectstategroups/{objectStateGroupId}": { + "get": { + "operationId": "ibexa.rest.load_object_state_group", "tags": [ - "Connector AI" + "Object State Groups" ], "responses": { "200": { - "description": "Reworked text or generated alternative text", + "description": "OK - returns the Object state group.", "content": { - "application/vnd.ibexa.api.ai.AltText+json": { + "application/vnd.ibexa.api.ObjectStateGroup+json": { "schema": { - "$ref": "#/components/schemas/AltText" + "$ref": "#/components/schemas/ObjectStateGroupWrapper" }, "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." + "ObjectStateGroup": { + "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", + "_href": "/api/ibexa/v2/content/objectstategroups/7", + "id": 7, + "identifier": "custom-states", + "defaultLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "ObjectStates": { + "_media-type": "application/vnd.ibexa.api.ObjectStateList+json", + "_href": "/api/ibexa/v2/content/objectstategroups/7/objectstates" + }, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Custom State" + } + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Custom Object state" + } ] } } } }, - "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": { + "application/vnd.ibexa.api.ObjectStateGroup+xml": { "schema": { - "$ref": "#/components/schemas/Text" + "$ref": "#/components/schemas/ObjectStateGroup" }, - "example": "\n\n Hello, I hope you are well. How have you been spending your day?\n\n" + "example": "\n\n 7\n custom-states\n eng-GB\n eng-GB\n \n \n Custom State\n \n \n Custom Object state\n \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" - } - } - } + "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": "Execute the given AI action", - "description": "Executes the given AI Action using configured ActionConfiguration or ActionHandler, if passed. Might consume AI agent resources.", + "summary": "Get Object state group", + "description": "Returns the Object state group with the provided ID.", "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, + "name": "If-None-Match", + "in": "header", + "description": "ETag", + "required": false, "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" - } - } + "explode": false }, { - "name": "X-CSRF-Token", - "in": "header", - "description": "CSRF token obtained during the authentication.", + "name": "objectStateGroupId", + "in": "path", + "description": "ObjectStateGroupLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": 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": "ibexa.rest.ai.action", + ] + }, + "delete": { + "operationId": "ibexa.rest.delete_object_state_group", "tags": [ - "Connector AI" + "Object State Groups" ], "responses": { - "200": { - "description": "Action configuration in JSON or XML", - "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." + "204": { + "description": "No Content - Object state group deleted." }, "401": { - "description": "Error \u2013 the user doesn't have access to the given action configuration" + "description": "Error - The user is not authorized to delete an Object state group." + }, + "404": { + "description": "Error - The Object state group does not exist." } }, - "summary": "Get an action configuration by its unique identifier.", - "description": "Returns an action configuration by its unique string identifier.", + "summary": "Delete Object state group", + "description": "Deletes the given Object state group including Object states.", "parameters": [ { - "name": "identifier", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "objectStateGroupId", "in": "path", - "description": "", + "description": "ObjectStateGroupDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false, - "example": "rewrite_with_friendly_tone" + "explode": false } - ], - "deprecated": false - } - }, - "/corporate": { - "get": { - "operationId": "ibexa.rest.corporate_account.root", + ] + }, + "patch": { + "operationId": "ibexa.rest.update_object_state_group", "tags": [ - "Corporate Account" + "Object State Groups" ], "responses": { "200": { - "description": "List of Link objects to specific Corporate Account REST resources", + "description": "OK - Object stated group updated.", "content": { - "application/vnd.ibexa.api.CorporateAccountRoot+json": { + "application/vnd.ibexa.api.ObjectStateGroup+json": { "schema": { - "$ref": "#/components/schemas/CorporateAccountRootWrapper" + "$ref": "#/components/schemas/ObjectStateGroupWrapper" }, "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" - } - ] + "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.CorporateAccountRoot+xml": { + "application/vnd.ibexa.api.ObjectStateGroup+xml": { "schema": { - "$ref": "#/components/schemas/CorporateAccountRoot" + "$ref": "#/components/schemas/ObjectStateGroup" }, - "example": "\n\n \n \n \n \n \n \n \n \n\n" + "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": "Root Resource", - "description": "Provides basic information about Corporate Account endpoints and configuration.", - "parameters": [], - "deprecated": false, - "x-badges": [ + "summary": "Update Object state group", + "description": "Updates an Object state group. PATCH or POST with header X-HTTP-Method-Override PATCH.", + "parameters": [ + { + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, { - "name": "Experience", - "color": "#D3822B" + "name": "If-Match", + "in": "header", + "description": "ETag", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "name": "objectStateGroupId", + "in": "path", + "description": "ObjectStateGroupUpdateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } - ] + ], + "requestBody": { + "description": "The Object state group input schema encoded in XML or JSON format.", + "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 + } } }, - "/corporate/companies": { + "/content/objectstategroups/{objectStateGroupId}/objectstates": { "get": { - "operationId": "ibexa.rest.corporate_account.companies.list", + "operationId": "ibexa.rest.load_object_states", "tags": [ - "Corporate Account" + "Object State Groups" ], "responses": { "200": { - "description": "Company list containing Company objects.", + "description": "OK - returns a list of Object states.", "content": { - "application/vnd.ibexa.api.CompanyList+json": { + "application/vnd.ibexa.api.ObjectStateList+json": { "schema": { - "$ref": "#/components/schemas/CompanyListWrapper" + "$ref": "#/components/schemas/ObjectStateListWrapper" }, "example": { - "CompanyList": { - "_media-type": "application/vnd.ibexa.api.CompanyList+json", - "companies": [ + "ObjectStateList": { + "_media-type": "application/vnd.ibexa.api.ObjectStateList+json", + "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates", + "ObjectState": [ { - "_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" + "_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" }, - "Location": { - "_media-type": "application/vnd.ibexa.api.Location+json", - "_href": "/api/ibexa/v2/content/locations/1/65/67" + "defaultLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Not locked" + } + ] }, - "locationPath": "/1/65/67/", - "isActive": true + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "" + } + ] + } }, { - "_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" + "_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" }, - "Location": { - "_media-type": "application/vnd.ibexa.api.Location+json", - "_href": "/api/ibexa/v2/content/locations/1/65/76" + "defaultLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Locked" + } + ] }, - "locationPath": "/1/65/76/", - "isActive": true + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "" + } + ] + } } ] } } }, - "application/vnd.ibexa.api.CompanyList+xml": { + "application/vnd.ibexa.api.ObjectStateList+xml": { "schema": { - "$ref": "#/components/schemas/CompanyList" + "$ref": "#/components/schemas/ObjectStateList" }, - "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" + "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" } } }, - "400": { - "description": "Returned when invalid Criterion or Sort clause is used", - "content": { - "application/vnd.ibexa.api.ErrorMessage": { - "schema": { - "$ref": "#/components/schemas/ErrorMessage" - } - } - } + "401": { + "description": "Error - The user has no permission to read Object states." } }, - "summary": "Read list of companies", - "description": "Returns paginated list of available companies.", - "parameters": [], - "deprecated": false, - "x-badges": [ + "summary": "List Object states", + "description": "Returns a list of all Object states of the given group.", + "parameters": [ { - "name": "Experience", - "color": "#D3822B" + "name": "If-None-Match", + "in": "header", + "description": "ETag", + "required": false, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "name": "objectStateGroupId", + "in": "path", + "description": "ObjectStateListController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] }, "post": { - "operationId": "ibexa.rest.corporate_account.companies.create", + "operationId": "ibexa.rest.create_object_state", "tags": [ - "Corporate Account" + "Object State Groups" ], "responses": { "201": { - "description": "If set, the new company is returned in XML or JSON format.", + "description": "Object state created.", "content": { - "application/vnd.ibexa.api.Company+json": { + "application/vnd.ibexa.api.ObjectState+json": { "schema": { - "$ref": "#/components/schemas/CompanyWrapper" + "$ref": "#/components/schemas/ObjectStateWrapper" }, "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" + "ObjectState": { + "_media-type": "application/vnd.ibexa.api.ObjectState+json", + "_href": "/api/ibexa/v2/content/objectstategroups/7/objectstates/7", + "id": 7, + "identifier": "new-state", + "priority": 0, + "ObjectStateGroup": { + "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", + "_href": "/api/ibexa/v2/content/objectstategroups/7" }, - "Location": { - "_media-type": "application/vnd.ibexa.api.Location+json", - "_href": "/api/ibexa/v2/content/locations/1/65/67" + "defaultLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "New State" + } + ] }, - "locationPath": "/1/65/67/", - "isActive": true + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "New Object State" + } + ] + } } } }, - "application/vnd.ibexa.api.Company+xml": { + "application/vnd.ibexa.api.ObjectState+xml": { "schema": { - "$ref": "#/components/schemas/Company" + "$ref": "#/components/schemas/ObjectState" }, - "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" + "example": "\n\n 5\n new-state\n 0\n \n eng-GB\n eng-GB\n \n New State\n \n \n New Object State\n \n\n" } } }, "400": { - "description": "Error - the input does not match the input schema definition." + "description": "Error - The input does not match the input schema definition." }, "401": { - "description": "Error - the user is not authorized to create this Company." + "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 a company", - "description": "Creates a CompanyCreateController resource.", + "summary": "Create Object state", + "description": "Creates a new Object state.", "parameters": [ { "name": "X-CSRF-Token", "in": "header", - "description": "Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + }, + { + "name": "objectStateGroupId", + "in": "path", + "description": "ObjectStateCreateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ], "requestBody": { - "description": "The CompanyCreate schema encoded in XML or JSON format.", + "description": "The Object state input schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.CompanyCreate+json": { + "application/vnd.ibexa.api.ObjectStateCreate+json": { "schema": { - "$ref": "#/components/schemas/CompanyCreateWrapper" + "$ref": "#/components/schemas/ObjectStateCreateWrapper" }, "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 - } - }, + "ObjectStateCreate": { + "identifier": "new-state", + "priority": "1", + "defaultLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "names": { + "value": [ { - "fieldDefinitionIdentifier": "sales_rep", - "fieldValue": { - "destinationContentId": 14 - } - }, + "_languageCode": "eng-GB", + "#text": "New State" + } + ] + }, + "descriptions": { + "value": [ { - "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" - } - } + "_languageCode": "eng-GB", + "#text": "New Object State" } ] } } } }, - "application/vnd.ibexa.api.CompanyCreate+xml": { + "application/vnd.ibexa.api.ObjectStateCreate+xml": { "schema": { - "$ref": "#/components/schemas/CompanyCreate" + "$ref": "#/components/schemas/ObjectStateCreate" }, - "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" + "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, - "x-badges": [ - { - "name": "Experience", - "color": "#D3822B" - }, - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] + } } }, - "/corporate/companies/{companyId}": { + "/content/objectstategroups/{objectStateGroupId}/objectstates/{objectStateId}": { "get": { - "operationId": "ibexa.rest.corporate_account.companies.get", + "operationId": "ibexa.rest.load_object_state", "tags": [ - "Corporate Account" + "Object State Groups" ], "responses": { "200": { - "description": "If set, the company is returned in XML or JSON format.", + "description": "OK - returns the Object state.", "content": { - "application/vnd.ibexa.api.Company+json": { + "application/vnd.ibexa.api.ObjectState+json": { "schema": { - "$ref": "#/components/schemas/CompanyWrapper" + "$ref": "#/components/schemas/ObjectStateWrapper" }, "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" + "ObjectState": { + "_media-type": "application/vnd.ibexa.api.ObjectState+json", + "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates/2", + "id": 2, + "identifier": "locked", + "priority": 1, + "ObjectStateGroup": { + "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", + "_href": "/api/ibexa/v2/content/objectstategroups/2" }, - "Location": { - "_media-type": "application/vnd.ibexa.api.Location+json", - "_href": "/api/ibexa/v2/content/locations/1/65/67" + "defaultLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Locked" + } + ] }, - "locationPath": "/1/65/67/", - "isActive": true + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "" + } + ] + } } } }, - "application/vnd.ibexa.api.Company+xml": { + "application/vnd.ibexa.api.ObjectState+xml": { "schema": { - "$ref": "#/components/schemas/Company" + "$ref": "#/components/schemas/ObjectState" }, - "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" + "example": "\n\n2\nlocked\n1\n\neng-GB\neng-GB\n\n Locked\n\n\n \n\n\n" } } }, "401": { - "description": "Error - The user is not authorized to read this company." + "description": "Error - The user is not authorized to read this Object state." }, "404": { - "description": "Error - The company does not exist." + "description": "Error - The Object state does not exist." } }, - "summary": "Get company", - "description": "Returns the company by given company ID.", + "summary": "Get Object state", + "description": "Returns the Object state.", "parameters": [ { - "name": "If-None-match", + "name": "If-None-Match", "in": "header", "description": "ETag", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "companyId", + "name": "objectStateGroupId", "in": "path", - "description": "", + "description": "ObjectStateLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false, - "x-badges": [ - { - "name": "Experience", - "color": "#D3822B" + "explode": false }, { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "name": "objectStateId", + "in": "path", + "description": "ObjectStateLoadByIdController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] }, "delete": { - "operationId": "ibexa.rest.corporate_account.companies.delete", + "operationId": "ibexa.rest.delete_object_state", "tags": [ - "Corporate Account" + "Object State Groups" ], "responses": { "204": { - "description": "No Content - given company is deleted." + "description": "No Content - Object state deleted." }, "401": { - "description": "Error - the user is not authorized to delete this company." + "description": "Error - The user is not authorized to delete an Object state." }, "404": { - "description": "Error - the company does not exist." + "description": "Error - The Object state does not exist." } }, - "summary": "Delete company", - "description": "The given company is deleted.", + "summary": "Delete Object state", + "description": "Deletes provided Object state.", "parameters": [ { "name": "X-CSRF-Token", "in": "header", - "description": "Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "companyId", + "name": "objectStateGroupId", "in": "path", - "description": "", + "description": "ObjectStateDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false, - "x-badges": [ - { - "name": "Experience", - "color": "#D3822B" + "explode": false }, { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "name": "objectStateId", + "in": "path", + "description": "ObjectStateDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] }, "patch": { - "operationId": "ibexa.rest.corporate_account.companies.update", + "operationId": "ibexa.rest.update_object_state", "tags": [ - "Corporate Account" + "Object State Groups" ], "responses": { "200": { - "description": "OK - company updated.", + "description": "OK - Object State updated", "content": { - "application/vnd.ibexa.api.Company+json": { + "application/vnd.ibexa.api.ObjectState+json": { "schema": { - "$ref": "#/components/schemas/CompanyWrapper" + "$ref": "#/components/schemas/ObjectStateWrapper" }, "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" + "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" }, - "Location": { - "_media-type": "application/vnd.ibexa.api.Location+json", - "_href": "/api/ibexa/v2/content/locations/1/65/67" + "defaultLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "New Object State name" + } + ] }, - "locationPath": "/1/65/67/", - "isActive": true + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "" + } + ] + } } } }, - "application/vnd.ibexa.api.Company+xml": { + "application/vnd.ibexa.api.ObjectState+xml": { "schema": { - "$ref": "#/components/schemas/Company" + "$ref": "#/components/schemas/ObjectState" }, - "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" + "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." + "description": "Error - The input does not match the input schema definition." }, "401": { - "description": "Error - the user is not authorized to create this company." + "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 a company", - "description": "Updates a company. PATCH or POST with header X-HTTP-Method-Override PATCH.", + "summary": "Update Object state", + "description": "Updates an Object state. PATCH or POST with header X-HTTP-Method-Override PATCH.", "parameters": [ { "name": "X-CSRF-Token", "in": "header", - "description": "Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "If-Match", @@ -6044,985 +4458,478 @@ "description": "ETag", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "companyId", + "name": "objectStateGroupId", "in": "path", - "description": "", + "description": "ObjectStateUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + }, + { + "name": "objectStateId", + "in": "path", + "description": "ObjectStateUpdateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ], "requestBody": { - "description": "The company input schema encoded in XML or JSON.", + "description": "The Object state input schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.CompanyUpdate+json": { + "application/vnd.ibexa.api.ObjectStateUpdate+json": { "schema": { - "$ref": "#/components/schemas/CompanyUpdateWrapper" + "$ref": "#/components/schemas/ObjectStateUpdateWrapper" }, "example": { - "CompanyUpdate": { - "fields": { - "field": [ + "ObjectStateUpdate": { + "names": { + "value": [ { - "fieldDefinitionIdentifier": "contact", - "fieldValue": { - "destinationContentId": 144 - } + "_languageCode": "eng-GB", + "#text": "New Object State name" } ] } } } }, - "application/vnd.ibexa.api.CompanyUpdate+xml": { + "application/vnd.ibexa.api.ObjectStateUpdate+xml": { "schema": { - "$ref": "#/components/schemas/CompanyUpdate" + "$ref": "#/components/schemas/ObjectStateUpdate" }, - "example": "\n\n \n \n contact\n \n 144\n \n \n \n\n" + "example": "\n\n 3\n eng-GB\n \n New Object State name\n \n\n" } }, "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Experience", - "color": "#D3822B" - }, - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] + } } }, - "/corporate/companies/{companyId}/members": { + "/content/objects": { "get": { - "operationId": "ibexa.rest.corporate_account.members.list", + "operationId": "ibexa.rest.redirect_content", "tags": [ - "Corporate Account" + "Objects" ], "responses": { - "200": { - "description": "If set, helps to determine response format.", - "content": { - "application/vnd.ibexa.api.MemberList+json": { + "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": { - "$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" - } - } - } - ] - } + "type": "string" } - }, - "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" - } - } - } + "description": "Error - the required `remoteId` query parameter is missing." }, "404": { - "description": "Error - The identifier do not match any company." + "description": "Error - the content with the given remote ID does not exist." } }, - "summary": "Read list of company members", - "description": "Returns paginated list of a given company members.", + "summary": "Load content by remote ID", + "description": "Loads content item for a given remote ID.", "parameters": [ { - "name": "companyId", - "in": "path", - "description": "", + "name": "remoteId", + "in": "query", + "description": "Remote ID of the content item.", "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" + "explode": false } ] }, "post": { - "operationId": "ibexa.rest.corporate_account.members.create", + "operationId": "ibexa.rest.create_content", "tags": [ - "Corporate Account" + "Objects" ], "responses": { "201": { - "description": "OK - company member created and returned.", + "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.", "content": { - "application/vnd.ibexa.api.Member+json": { + "application/vnd.ibexa.api.Content+json": { "schema": { - "$ref": "#/components/schemas/MemberWrapper" + "$ref": "#/components/schemas/ContentWrapper" }, "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" + "Content": { + "_media-type": "application/vnd.ibexa.api.Content+json", + "_href": "/api/ibexa/v2/content/objects/109", + "_remoteId": "8716f007ba15f6f35139acb55e39b811", + "_id": 109, + "ContentType": { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/2" + }, + "Name": "draft article", + "TranslatedName": "draft article", + "Versions": { + "_media-type": "application/vnd.ibexa.api.VersionList+json", + "_href": "/api/ibexa/v2/content/objects/109/versions" + }, + "CurrentVersion": { + "_media-type": "application/vnd.ibexa.api.Version+json", + "_href": "/api/ibexa/v2/content/objects/109/currentversion", + "Version": { + "_media-type": "application/vnd.ibexa.api.Version+json", + "_href": "/api/ibexa/v2/content/objects/109/versions/1", + "VersionInfo": { + "id": 587, + "versionNo": 1, + "status": "DRAFT", + "modificationDate": "2023-05-24T06:27:54+00:00", + "Creator": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "creationDate": "2023-05-24T06:27:54+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": "draft article" + } + ] + }, + "Content": { + "_media-type": "application/vnd.ibexa.api.ContentInfo+json", + "_href": "/api/ibexa/v2/content/objects/109" + } }, - "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": 488, + "fieldDefinitionIdentifier": "title", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_string", + "fieldValue": "draft article" + }, + { + "id": 489, + "fieldDefinitionIdentifier": "short_title", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_string", + "fieldValue": null + }, + { + "id": 490, + "fieldDefinitionIdentifier": "author", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_author", + "fieldValue": [] + }, + { + "id": 491, + "fieldDefinitionIdentifier": "intro", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_richtext", + "fieldValue": { + "xml": "\n
draft draft
\n", + "xhtml5edit": "\n

draft draft

\n" } }, - "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" - } - } - ] + { + "id": 492, + "fieldDefinitionIdentifier": "body", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_richtext", + "fieldValue": { + "xml": "\n
draft draft draft
\n", + "xhtml5edit": "\n

draft draft draft

\n" + } }, - "Relations": { - "_media-type": "application/vnd.ibexa.api.RelationList+json", - "_href": "/api/ibexa/v2/content/objects/139/versions/6/relations", - "Relation": [] + { + "id": 493, + "fieldDefinitionIdentifier": "enable_comments", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_boolean", + "fieldValue": false }, - "Thumbnail": { - "_media-type": "application/vnd.ibexa.api.Thumbnail+json", - "resource": "/placeholder", - "width": null, - "height": null, - "mimeType": "image/svg+xml" + { + "id": 494, + "fieldDefinitionIdentifier": "image", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_object_relation", + "fieldValue": { + "destinationContentId": null + } } - } - }, - "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" + "Relations": { + "_media-type": "application/vnd.ibexa.api.RelationList+json", + "_href": "/api/ibexa/v2/content/objects/109/versions/1/relations", + "Relation": [] }, - "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" + "Thumbnail": { + "_media-type": "application/vnd.ibexa.api.Thumbnail+json", + "resource": "/placeholder", + "width": null, + "height": null, + "mimeType": "image/svg+xml" } - }, - "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": { + "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/109/locations" + }, + "Owner": { "_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" + "_href": "/api/ibexa/v2/user/users/14" + }, + "mainLanguageCode": "eng-GB", + "currentVersionNo": 1, + "alwaysAvailable": true, + "isHidden": false, + "status": "DRAFT", + "ObjectStates": { + "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", + "_href": "/api/ibexa/v2/content/objects/109/objectstates" + } + } + } + }, + "application/vnd.ibexa.api.Content+xml": { + "schema": { + "$ref": "#/components/schemas/Content" + }, + "example": "\n\n \n draft article\n draft article\n \n \n \n \n 586\n 1\n DRAFT\n 2023-05-24T06:24:46+00:00\n \n 2023-05-24T06:24:46+00:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n draft article\n \n \n \n \n \n 481\n title\n eng-GB\n ibexa_string\n draft article\n \n \n 482\n short_title\n eng-GB\n ibexa_string\n \n \n \n 483\n author\n eng-GB\n ibexa_author\n \n \n \n 484\n intro\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" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>draft draft</para></section>\n\n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft</p></section>\n\n \n \n \n 485\n body\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" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>draft draft draft</para></section>\n\n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft draft</p></section>\n\n \n \n \n 486\n enable_comments\n eng-GB\n ibexa_boolean\n false\n \n \n 487\n image\n eng-GB\n ibexa_object_relation\n \n \n \n \n \n \n \n /placeholder\n \n \n image/svg+xml\n \n \n \n
\n \n \n eng-GB\n 1\n true\n false\n DRAFT\n \n\n" + }, + "application/vnd.ibexa.api.ContentInfo+json": { + "schema": { + "$ref": "#/components/schemas/ContentInfoWrapper" + }, + "example": { + "Content": { + "_media-type": "application/vnd.ibexa.api.ContentInfo+json", + "_href": "/api/ibexa/v2/content/objects/77", + "_remoteId": "89e9b86c673b1c1de6781bb94488b18c", + "_id": 77, + "ContentType": { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/2" + }, + "Name": "draft article", + "TranslatedName": "draft article", + "Versions": { + "_media-type": "application/vnd.ibexa.api.VersionList+json", + "_href": "/api/ibexa/v2/content/objects/77/versions" + }, + "CurrentVersion": { + "_media-type": "application/vnd.ibexa.api.Version+json", + "_href": "/api/ibexa/v2/content/objects/77/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/77/locations" + }, + "Owner": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "mainLanguageCode": "eng-GB", + "currentVersionNo": 1, + "alwaysAvailable": true, + "isHidden": false, + "status": "DRAFT", + "ObjectStates": { + "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", + "_href": "/api/ibexa/v2/content/objects/77/objectstates" + } + } + } + }, + "application/vnd.ibexa.api.ContentInfo+xml": { + "schema": { + "$ref": "#/components/schemas/ContentInfo" + }, + "example": "\n\n \n draft article\n draft article\n \n \n
\n \n \n eng-GB\n 1\n true\n false\n DRAFT\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": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "The ContentCreate schema encoded in XML or JSON format.", + "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" }, - "Owner": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" + { + "fieldDefinitionIdentifier": "intro", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_richtext", + "fieldValue": { + "xml": "

draft draft

" + } }, - "publishDate": "2023-04-28T16:10:03+02:00", - "lastModificationDate": "2023-04-28T16:17:07+02:00", - "mainLanguageCode": "eng-GB", - "alwaysAvailable": true, + { + "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 + } + } + }, + "/content/objects/{contentId}": { + "get": { + "operationId": "ibexa.rest.load_content", + "tags": [ + "Objects" + ], + "responses": { + "200": { + "description": "OK - returns the Content or ContentInfo in XML or JSON format.", + "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/144/versions/6", + "_href": "/api/ibexa/v2/content/objects/54/versions/1", "VersionInfo": { - "id": 683, - "versionNo": 6, + "id": 514, + "versionNo": 1, "status": "PUBLISHED", - "modificationDate": "2023-04-28T16:17:07+02:00", + "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": "2023-04-28T16:17:06+02:00", + "creationDate": "2018-09-17T06:48:13+00:00", "initialLanguageCode": "eng-GB", "languageCodes": "eng-GB", "VersionTranslationInfo": { @@ -7037,2878 +4944,2099 @@ "value": [ { "_languageCode": "eng-GB", - "#text": "Jay Kowalski" + "#text": "Forms" } ] }, "Content": { "_media-type": "application/vnd.ibexa.api.ContentInfo+json", - "_href": "/api/ibexa/v2/content/objects/144" + "_href": "/api/ibexa/v2/content/objects/54" } }, "Fields": { "field": [ { - "id": 698, - "fieldDefinitionIdentifier": "first_name", + "id": 249, + "fieldDefinitionIdentifier": "name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", - "fieldValue": "Jay" + "fieldValue": "Forms" }, { - "id": 699, - "fieldDefinitionIdentifier": "last_name", + "id": 250, + "fieldDefinitionIdentifier": "short_name", "languageCode": "eng-GB", "fieldTypeIdentifier": "ibexa_string", - "fieldValue": "Kowalski" + "fieldValue": null }, { - "id": 700, - "fieldDefinitionIdentifier": "phone_number", + "id": 251, + "fieldDefinitionIdentifier": "short_description", "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_string", - "fieldValue": "+48 123 123 456" + "fieldTypeIdentifier": "ibexa_richtext", + "fieldValue": { + "xml": "\n
\n", + "xhtml5edit": "\n
\n" + } }, { - "id": 701, - "fieldDefinitionIdentifier": "user", + "id": 252, + "fieldDefinitionIdentifier": "description", "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_user", + "fieldTypeIdentifier": "ibexa_richtext", "fieldValue": { - "hasStoredLogin": true, - "contentId": 144, - "login": "jay.kowalski", - "email": "jay.kowalski@email.invalid", - "passwordUpdatedAt": 1682691427, - "enabled": false, - "maxLogin": 5, - "plainPassword": null + "xml": "\n
\n", + "xhtml5edit": "\n
\n" } } ] }, "Relations": { "_media-type": "application/vnd.ibexa.api.RelationList+json", - "_href": "/api/ibexa/v2/content/objects/144/versions/6/relations", + "_href": "/api/ibexa/v2/content/objects/54/versions/1/relations", "Relation": [] }, "Thumbnail": { "_media-type": "application/vnd.ibexa.api.Thumbnail+json", - "resource": "/user/default_profile_image/initials.svg?initials=JK#profile_image", + "resource": "/bundles/ezplatformadminui/img/ez-icons.svg#folder", "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" - } + "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.Member+xml": { + "application/vnd.ibexa.api.Content+xml": { "schema": { - "$ref": "#/components/schemas/Member" + "$ref": "#/components/schemas/Content" }, - "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" + "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" + } + }, + "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 create a company member." + "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": "Create a company member", - "description": "Creates a company member.", + "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).\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.", "parameters": [ { - "name": "X-CSRF-Token", + "name": "If-None-Match", "in": "header", - "description": "Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.", - "required": true, + "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 + "explode": false }, { - "name": "companyId", + "name": "contentId", "in": "path", - "description": "", + "description": "ContentLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { - "type": "string" + "type": "integer" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "requestBody": { - "description": "The MemberCreate schema encoded in XML or JSON format.", - "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": "ibexa.rest.corporate_account.members.get", - "tags": [ - "Corporate Account" + ] + }, + "delete": { + "operationId": "ibexa.rest.delete_content", + "tags": [ + "Objects" ], "responses": { - "200": { - "description": "If set, the company member is returned in XML or JSON format.", - "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." + "204": { + "description": "The content item is deleted." }, "404": { - "description": "Error - The company does not exist." + "description": "Error - content item was not found." + }, + "401": { + "description": "Error - the user is not authorized to delete this content item." } }, - "summary": "Get company member", - "description": "Returns the company member by given member ID.", + "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": "companyId", - "in": "path", - "description": "", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "memberId", + "name": "contentId", "in": "path", - "description": "", + "description": "ContentDeleteController identifier", "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" + "explode": false } ] }, - "delete": { - "operationId": "ibexa.rest.corporate_account.members.delete", + "patch": { + "operationId": "ibexa.rest.update_content_metadata", "tags": [ - "Corporate Account" + "Objects" ], "responses": { - "204": { - "description": "No Content - given company member is deleted." + "200": { + "description": "If set, all information for the content item (excluding the current version) is returned in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.ContentInfo+json": { + "schema": { + "$ref": "#/components/schemas/ContentInfoWrapper" + } + }, + "application/vnd.ibexa.api.ContentInfo+xml": { + "schema": { + "$ref": "#/components/schemas/ContentInfo" + }, + "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." }, "401": { - "description": "Error - the user is not authorized to delete this company member." + "description": "Error - the user is not authorized to update this object." }, "404": { - "description": "Error - the company member does not exist." + "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": "Delete company member", - "description": "The given company member is deleted.", + "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": "X-CSRF-Token", "in": "header", - "description": "Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "companyId", - "in": "path", - "description": "", + "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 + "explode": false }, { - "name": "memberId", + "name": "contentId", "in": "path", - "description": "", + "description": "ContentMetadataUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], - "deprecated": false, - "x-badges": [ - { - "name": "Experience", - "color": "#D3822B" + "requestBody": { + "description": "The ContentUpdate schema encoded in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.ContentUpdate+json": { + "schema": { + "$ref": "#/components/schemas/ContentInfoWrapper" + } + }, + "application/vnd.ibexa.api.ContentUpdate+xml": { + "schema": { + "$ref": "#/components/schemas/ContentInfo" + }, + "example": "\n\n eng-GB\n
\n \n \n false\n 69848aeb86164c35e5c98202eebe9e05\n\n" + } }, - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] - }, - "patch": { - "operationId": "ibexa.rest.corporate_account.members.patch", + "required": false + } + } + }, + "/content/objects/{contentId}/currentversion": { + "get": { + "operationId": "ibexa.rest.redirect_current_version", "tags": [ - "Corporate Account" + "Objects" ], "responses": { "200": { - "description": "OK - company member updated.", + "description": "OK - returns the Version in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Member+json": { + "application/vnd.ibexa.api.Version+json": { "schema": { - "$ref": "#/components/schemas/MemberWrapper" + "$ref": "#/components/schemas/VersionWrapper" }, "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.", + "Version": { + "_media-type": "application/vnd.ibexa.api.Version+json", + "_href": "/api/ibexa/v2/content/objects/107/versions/2", + "VersionInfo": { + "id": 578, + "versionNo": 2, + "status": "PUBLISHED", + "modificationDate": "2023-05-24T05:59:09+00:00", + "Creator": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "creationDate": "2023-05-24T05:59:02+00:00", + "initialLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "VersionTranslationInfo": { + "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", + "Language": [ + { + "languageCode": "eng-GB" + } + ] + }, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Features" + } + ] + }, "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" + "_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" }, - "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" + { + "id": 478, + "fieldDefinitionIdentifier": "short_name", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_string", + "fieldValue": null }, - "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" - } + { + "id": 479, + "fieldDefinitionIdentifier": "short_description", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_richtext", + "fieldValue": { + "xml": "\n
\n", + "xhtml5edit": "\n
\n" } }, - "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" + { + "id": 480, + "fieldDefinitionIdentifier": "description", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_richtext", + "fieldValue": { + "xml": "\n
\n", + "xhtml5edit": "\n
\n" + } } - }, - "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": { + "Relations": { + "_media-type": "application/vnd.ibexa.api.RelationList+json", + "_href": "/api/ibexa/v2/content/objects/107/versions/2/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 578\n 2\n PUBLISHED\n 2023-05-24T05:59:09+00:00\n \n 2023-05-24T05:59:02+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": "ContentCurrentVersionRedirectController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + }, + "post": { + "operationId": "ibexa.rest.content.create_draft_from_current_version", + "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" }, - "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" + "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" }, - "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 - } - } - ] + { + "id": 478, + "fieldDefinitionIdentifier": "short_name", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_string", + "fieldValue": null }, - "Relations": { - "_media-type": "application/vnd.ibexa.api.RelationList+json", - "_href": "/api/ibexa/v2/content/objects/144/versions/6/relations", - "Relation": [] + { + "id": 479, + "fieldDefinitionIdentifier": "short_description", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_richtext", + "fieldValue": { + "xml": "\n
\n", + "xhtml5edit": "\n
\n" + } }, - "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" + { + "id": 480, + "fieldDefinitionIdentifier": "description", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_richtext", + "fieldValue": { + "xml": "\n
\n", + "xhtml5edit": "\n
\n" + } } - }, - "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" - } + "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.Member+xml": { + "application/vnd.ibexa.api.Version+xml": { "schema": { - "$ref": "#/components/schemas/Member" + "$ref": "#/components/schemas/Version" }, - "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" + "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 create this company member." + "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": "Update a company member", - "description": "Updates a company member. PATCH or POST with header X-HTTP-Method-Override PATCH.", + "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": "X-CSRF-Token", "in": "header", - "description": "Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "If-Match", - "in": "header", - "description": "ETag", + "name": "contentId", + "in": "path", + "description": "ContentDraftCreateFromCurrentVersionController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + } + ], + "requestBody": { + "description": "No payload required", + "content": [], + "required": false + } + } + }, + "/content/objects/{contentId}/hide": { + "post": { + "operationId": "ibexa.rest.hide_content", + "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": "companyId", - "in": "path", - "description": "", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "memberId", + "name": "contentId", "in": "path", - "description": "", + "description": "ContentHideController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "The company input schema encoded in XML or JSON.", - "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" - }, + "description": "No payload required", + "content": [], + "required": false + } + } + }, + "/content/objects/{contentId}/locations": { + "get": { + "operationId": "ibexa.rest.load_locations_for_content", + "tags": [ + "Objects" + ], + "responses": { + "200": { + "description": "If set, the Location list is returned in XML or JSON format.", + "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": [ { - "fieldDefinitionIdentifier": "phone_number", - "fieldValue": "+48 123 123 456" + "_media-type": "application/vnd.ibexa.api.Location+json", + "_href": "/api/ibexa/v2/content/locations/1/2/57/65" } ] } } - } - }, - "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" + "application/vnd.ibexa.api.LocationList+xml": { + "schema": { + "$ref": "#/components/schemas/LocationList" + }, + "example": "\n\n \n\n" + } } }, - "required": false + "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." + } }, - "deprecated": false, - "x-badges": [ + "summary": "Get Locations for content item", + "description": "Loads all Locations for the given content item.", + "parameters": [ { - "name": "Experience", - "color": "#D3822B" + "name": "If-None-Match", + "in": "header", + "description": "ETag", + "required": false, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "name": "contentId", + "in": "path", + "description": "LocationForContentListController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] - } - }, - "/corporate/sales-representatives": { - "get": { - "operationId": "ibexa.rest.corporate_account.sales_representatives.get", + }, + "post": { + "operationId": "ibexa.rest.create_location", "tags": [ - "Corporate Account" + "Objects" ], "responses": { - "200": { - "description": "Sales representatives list containing Company objects.", + "201": { + "description": "If set, the new Location is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.SalesRepresentativesList+json": { + "application/vnd.ibexa.api.Location+json": { "schema": { - "$ref": "#/components/schemas/SalesRepresentativesListWrapper" + "$ref": "#/components/schemas/LocationWrapper" }, "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", + "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/4" + "_href": "/api/ibexa/v2/content/types/2" }, - "name": "John Black", + "Name": "Art1", + "TranslatedName": "Art1", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", - "_href": "/api/ibexa/v2/content/objects/75/versions" + "_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/10" - }, - "MainLocation": { - "_media-type": "application/vnd.ibexa.api.Location+json", - "_href": "/api/ibexa/v2/content/locations/1/5/64/76" + "_href": "/api/ibexa/v2/content/sections/1" }, "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" + "_href": "/api/ibexa/v2/content/objects/59/locations" }, "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", + "lastModificationDate": "2021-06-28T11:33:01+00:00", + "publishedDate": "2021-06-28T11:33:01+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" + "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.SalesRepresentativesList+xml": { + "application/vnd.ibexa.api.Location+xml": { "schema": { - "$ref": "#/components/schemas/SalesRepresentativesList" + "$ref": "#/components/schemas/Location" }, - "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" + "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 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": [], - "deprecated": false, - "x-badges": [ - { - "name": "Experience", - "color": "#D3822B" + "description": "Error - the user is not authorized to create this Location." }, - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] - } - }, - "/discounts": { - "get": { - "operationId": "ibexa.discounts.rest.list", - "tags": [ - "Discounts" - ], - "responses": { - "200": { - "description": "A discount list is returned.", - "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" - } - ] - } - ] - } - } - } - } + "403": { + "description": "Error - a Location under the given parent ID already exists." } }, - "summary": "Get discounts", - "description": "Returns a list of all defined discounts", + "summary": "Create new Location for content item", + "description": "Creates a new Location for the given content item.", "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, + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { - "type": "integer" + "type": "string" }, - "style": "form", - "explode": false, - "allowReserved": false, - "example": 25 - } - ], - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] - }, - "post": { - "operationId": "ibexa.discounts.rest.create", - "tags": [ - "Discounts" - ], - "responses": { - "200": { - "description": "The created discount is returned.", - "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." + "style": "simple", + "explode": false }, - "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.", + "name": "contentId", + "in": "path", + "description": "LocationCreateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "The DiscountCreate schema", + "description": "The LocationCreate schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.DiscountCreate+json": { + "application/vnd.ibexa.api.LocationCreate+json": { "schema": { - "$ref": "#/components/schemas/DiscountCreate" + "$ref": "#/components/schemas/LocationCreateWrapper" }, "example": { - "DiscountCreate": { - "identifier": "my_discount_identifier", - "type": "cart", - "priority": 1, - "isEnabled": true, - "userId": 14, - "rule": { - "type": "fixed_amount", - "amount": "12" + "LocationCreate": { + "_media-type": "application/vnd.ibexa.api.LocationCreate", + "ParentLocation": { + "_href": "/api/ibexa/v2/content/locations/1/59" }, - "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" - ] - } + "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, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] + } } }, - "/discounts/{identifier}": { + "/content/objects/{contentId}/objectstates": { "get": { - "operationId": "ibexa.discounts.rest.identifier", + "operationId": "ibexa.rest.get_object_states_for_content", "tags": [ - "Discounts" + "Objects" ], "responses": { "200": { - "description": "The discount is returned.", + "description": "OK - returns the Object state.", "content": { - "application/vnd.ibexa.api.Discount+json": { + "application/vnd.ibexa.api.ContentObjectStates+json": { "schema": { - "$ref": "#/components/schemas/Discount" + "$ref": "#/components/schemas/ContentObjectStates" }, "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": [ + "ContentObjectStates": { + "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", + "ObjectState": [ { - "_media-type": "application/vnd.ibexa.api.DiscountCondition.IsInCurrency+json", - "identifier": "is_in_currency", - "expressionValues": { - "currency_code": "PLN" - } - } - ], - "DiscountTranslations": [ + "_media-type": "application/vnd.ibexa.api.ObjectState+json", + "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates/1" + }, { - "_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.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 \n \n\n" } } }, "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." + "description": "Error - The content item does not exist." } }, - "summary": "Get a discount item by its unique identifier.", - "description": "Returns a discount item by its unique string identifier.", + "summary": "Get Object states of content item", + "description": "Returns the Object states of a content item", "parameters": [ { - "name": "identifier", - "in": "path", - "description": "", - "required": true, + "name": "If-None-Match", + "in": "header", + "description": "ETag", + "required": false, "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": "ibexa.discounts.rest.delete", - "tags": [ - "Discounts" - ], - "responses": { - "204": { - "description": "The discount is deleted." - }, - "404": { - "description": "Error - a discount of the given unique identifier is not found." + "explode": false }, - "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", + "name": "contentId", "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.", + "description": "ObjectStatesForContentListController identifier", "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" + "explode": false } ] }, "patch": { - "operationId": "ibexa.discounts.rest.update", + "operationId": "ibexa.rest.set_object_states_for_content", "tags": [ - "Discounts" + "Objects" ], "responses": { - "200": { - "description": "The updated discount is returned.", + "204": { + "description": "OK - Object state updated.", "content": { - "application/vnd.ibexa.api.Discount+json": { + "application/vnd.ibexa.api.ContentObjectStates+json": { "schema": { - "$ref": "#/components/schemas/Discount" + "$ref": "#/components/schemas/ContentObjectStatesWrapper" }, "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": [ + "ContentObjectStates": { + "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", + "ObjectState": [ { - "_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.ObjectState+json", + "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates/2" } ] } } + }, + "application/vnd.ibexa.api.ContentObjectStates+xml": { + "schema": { + "$ref": "#/components/schemas/ContentObjectStates" + }, + "example": "\n\n \n\n" } } }, - "404": { - "description": "Error - a discount of the given unique identifier is not found." + "400": { + "description": "Error - The input does not match the input schema definition." }, "401": { - "description": "Error - the user is not authorized to update a discount item." + "description": "Error - The user is not authorized to set an Object state." }, - "406": { - "description": "Error - the input data is not valid." + "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": "Update a discount", - "description": "Updates a new discount", + "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": "identifier", - "in": "path", - "description": "", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false, - "example": "my_discount_identifier" + "explode": false }, { - "name": "X-CSRF-Token", + "name": "If-Match", "in": "header", - "description": "CSRF token obtained during the authentication.", + "description": "ETag", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + }, + { + "name": "contentId", + "in": "path", + "description": "ObjectStatesForContentUpdateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ], "requestBody": { - "description": "The DiscountUpdate schema", + "description": "The content item Object states input schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.DiscountUpdate+json": { + "application/vnd.ibexa.api.ContentObjectStates+json": { "schema": { - "$ref": "#/components/schemas/DiscountUpdate" + "$ref": "#/components/schemas/ContentObjectStatesWrapper" }, "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": [ + "ContentObjectStates": { + "ObjectState": [ { - "languageCode": "eng-GB", - "name": "My Discount", - "description": "My Discount description", - "label": "My Discount label", - "labelDescription": "My Discount description" + "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates/2" } - ], - "context": { - "arbitrary_foo_key": "arbitrary_foo_value", - "arbitrary_bar_key": [ - "arbitrary_bar_value1", - "arbitrary_bar_value2" - ] - } + ] } } + }, + "application/vnd.ibexa.api.ContentObjectStates+xml": { + "schema": { + "$ref": "#/components/schemas/ContentObjectStates" + }, + "example": "\n\n \n\n" } }, "required": false + } + } + }, + "/content/objects/{contentId}/relations": { + "get": { + "operationId": "ibexa.rest.redirect_current_version_relations", + "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." + } }, - "deprecated": false, - "x-badges": [ + "summary": "Load Relations of content item", + "description": "Redirects to the Relations of the current version.", + "parameters": [ { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "name": "contentId", + "in": "path", + "description": "ContentCurrentVersionRelationsRedirectController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] } }, - "/discounts/{identifier}/disable": { + "/content/objects/{contentId}/reveal": { "post": { - "operationId": "ibexa.discounts.rest.disable", + "operationId": "ibexa.rest.reveal_content", "tags": [ - "Discounts" + "Objects" ], "responses": { "204": { - "description": "The discount is disabled." - }, - "404": { - "description": "Error - a discount of the given unique identifier is not found." + "description": "OK - Object item is revealed." }, "401": { - "description": "Error - the user is not authorized to disable a discount item." + "description": "Error - The user has no permission to change Object item visibility." + }, + "404": { + "description": "Error - The content item was not found." } }, - "summary": "Disables a discount", - "description": "Disables a discount item by its unique identifier", + "summary": "Reveal content item", + "description": "Makes or keep the content item visible", "parameters": [ { - "name": "identifier", - "in": "path", - "description": "", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false, - "example": "my_discount_identifier" + "explode": false }, { - "name": "X-CSRF-Token", - "in": "header", - "description": "CSRF token obtained during the authentication.", + "name": "contentId", + "in": "path", + "description": "ContentRevealController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { "description": "No payload required", "content": [], "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] + } } }, - "/discounts/{identifier}/enable": { - "post": { - "operationId": "ibexa.discounts.rest.enable", + "/content/objects/{contentId}/translations/{languageCode}": { + "delete": { + "operationId": "ibexa.rest.delete_content_translation", "tags": [ - "Discounts" + "Objects" ], "responses": { "204": { - "description": "The discount is enabled." + "description": "No Content" + }, + "401": { + "description": "Error - the user is not authorized to delete content item (content/remove policy)." }, "404": { - "description": "Error - a discount of the given unique identifier is not found." + "description": "Error - the content item was not found." }, - "401": { - "description": "Error - the user is not authorized to enable a discount item." + "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": "Enables a discount", - "description": "Enables a discount item by its unique identifier", + "summary": "Delete translation (permanently)", + "description": "Permanently deletes a translation from all versions of a content item.", "parameters": [ { - "name": "identifier", - "in": "path", - "description": "", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false, - "example": "my_discount_identifier" + "explode": false }, { - "name": "X-CSRF-Token", - "in": "header", - "description": "CSRF token obtained during the authentication.", + "name": "contentId", + "in": "path", + "description": "ContentTranslationDeleteController identifier", "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": [ + "explode": false + }, { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "name": "languageCode", + "in": "path", + "description": "ContentTranslationDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] } }, - "/discounts/{id}": { + "/content/objects/{contentId}/versions": { "get": { - "operationId": "ibexa.discounts.rest.id", + "operationId": "ibexa.rest.load_content_versions", "tags": [ - "Discounts" + "Objects" ], "responses": { "200": { - "description": "The discount is returned.", + "description": "If set, the version list is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Discount+json": { + "application/vnd.ibexa.api.VersionList+json": { "schema": { - "$ref": "#/components/schemas/Discount" + "$ref": "#/components/schemas/VersionListWrapper" }, "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": [ + "VersionList": { + "_media-type": "application/vnd.ibexa.api.VersionList+json", + "_href": "/api/ibexa/v2/content/objects/61/versions", + "VersionItem": [ { - "_media-type": "application/vnd.ibexa.api.DiscountCondition.IsInCurrency+json", - "identifier": "is_in_currency", - "expressionValues": { - "currency_code": "PLN" + "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" + } } - } - ], - "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" + "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" } } }, - "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." + "description": "Error - the user has no permission to read the versions." } }, - "summary": "Get a discount item", - "description": "Returns a discount item by its ID.", + "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": "id", + "name": "contentId", "in": "path", - "description": "", + "description": "ContentVersionsListController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { - "type": "integer" + "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false, - "example": 1 - } - ], - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "explode": false } ] } }, - "/discounts_codes/{cartIdentifier}/apply": { - "post": { - "operationId": "ibexa.rest.discounts_codes.apply", + "/content/objects/{contentId}/versions/{versionNo}": { + "get": { + "operationId": "ibexa.rest.load_content_in_version", "tags": [ - "Discounts" + "Objects" ], "responses": { "200": { - "description": "OK - The discount code has been applied and is returned.", + "description": "If set, the version list is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.DiscountCode+json": { + "application/vnd.ibexa.api.Version+json": { "schema": { - "$ref": "#/components/schemas/DiscountCodeWrapper" + "$ref": "#/components/schemas/VersionWrapper" }, "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" + "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" } } }, - "404": { - "description": "Not Found - the cart does not exist, or, the requested discount code has not been found or is already applied." + "304": { + "description": "Not Modified - the ETag matches the current one." + }, + "401": { + "description": "Error - the user is not authorized to read this content item." }, - "429": { - "description": "Too Many Requests - rate limit exceeded, next requests are temporarily blocked as a security measure." + "404": { + "description": "Error - the ID or version is not found." } }, - "summary": "Apply discount code", - "description": "Apply a discount code on a cart given by its identifier.", + "summary": "Load version", + "description": "Loads a specific version of a content item. This method returns Fields and relations.", "parameters": [ { - "name": "X-CSRF-Token", + "name": "If-None-Match", "in": "header", - "description": "", + "description": "Only return the version if the given ETag is the not current one, otherwise a 304 is returned.", + "required": false, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "contentId", + "in": "path", + "description": "ContentInVersionLoadController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "cartIdentifier", + "name": "versionNo", "in": "path", - "description": "", + "description": "ContentInVersionLoadController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } + ] + }, + "post": { + "operationId": "ibexa.rest.content.create_draft_from_version", + "tags": [ + "Objects" ], - "requestBody": { - "description": "The discount code to apply", - "content": { - "application/vnd.ibexa.api.DiscountCode+json": { - "schema": { - "$ref": "#/components/schemas/DiscountCodeWrapper" - }, - "example": { - "DiscountCode": { - "code": "summer10" + "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" } } }, - "required": false + "401": { + "description": "Error - the user is not authorized to update this content item." + }, + "404": { + "description": "Error - the content item was not found." + } }, - "deprecated": false, - "x-badges": [ + "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": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "contentId", + "in": "path", + "description": "ContentDraftCreateFromVersionController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "name": "versionNo", + "in": "path", + "description": "ContentDraftCreateFromVersionController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } - ] - } - }, - "/discounts_codes/{cartIdentifier}/drop": { - "post": { - "operationId": "ibexa.rest.discounts_codes.drop", + ], + "requestBody": { + "description": "No payload required", + "content": [], + "required": false + } + }, + "delete": { + "operationId": "ibexa.rest.delete_content_version", "tags": [ - "Discounts" + "Objects" ], "responses": { "204": { - "description": "No Content - the discount code has been dropped." + "description": "No Content - the version is deleted." }, "404": { - "description": "Not Found - the cart does not exist." + "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": "Drop discount code", - "description": "Unapply a discount code from a cart given by its identifier.", + "summary": "Delete content version", + "description": "Deletes the content version.", "parameters": [ { "name": "X-CSRF-Token", "in": "header", - "description": "", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "cartIdentifier", + "name": "contentId", "in": "path", - "description": "", + "description": "ContentVersionDeleteController identifier", "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" - } - } - } + "explode": false }, - "required": false - }, - "deprecated": false, - "x-badges": [ { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "name": "versionNo", + "in": "path", + "description": "ContentVersionDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] - } - }, - "/languages": { - "get": { - "operationId": "ibexa.rest.languages.list", + }, + "patch": { + "operationId": "ibexa.rest.update_version", "tags": [ - "Language" + "Objects" ], "responses": { "200": { - "description": "If set, the list is returned in XML or JSON format.", + "description": "If set, the updated version is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.LanguageList+json": { + "application/vnd.ibexa.api.Version+json": { "schema": { - "$ref": "#/components/schemas/LanguageListWrapper" + "$ref": "#/components/schemas/VersionWrapper" }, "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)" + "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" }, - { - "_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": [], - "deprecated": false - } - }, - "/languages/{code}": { - "get": { - "operationId": "ibexa.rest.languages.view", - "tags": [ - "Language" - ], - "responses": { - "200": { - "description": "If set, the language is returned in XML or JSON format.", - "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)" + "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.Language+xml": { + "application/vnd.ibexa.api.Version+xml": { "schema": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Version" }, - "example": "\n\n 2\n eng-GB\n English (United Kingdom)\n\n" + "example": "\n\n \n 45\n 4\n DRAFT\n 2012-02-20T12:00:00\n \n 22012-02-20T12:00:00\n ger-DE\n \n Neuer Titel\n \n \n \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 authors\n ger-DE\n \n \n \n \n \n \n \n \n \n \n \n COMMON\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 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": "Get language", - "description": "Retrieves a LanguageLoadByIdController resource.", + "summary": "Update version", + "description": "A specific draft is updated. PATCH or POST with header X-HTTP-Method-Override PATCH.", "parameters": [ { - "name": "code", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "If-match", + "in": "header", + "description": "Performs the patch only if the specified ETag is the current one.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "contentId", "in": "path", - "description": "", + "description": "ContentVersionUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + }, + { + "name": "versionNo", + "in": "path", + "description": "ContentVersionUpdateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ], - "deprecated": false - } - }, - "/content/locations": { - "get": { - "operationId": "ibexa.rest.redirect_location", - "tags": [ - "Location" - ], - "responses": { - "200": { - "description": "OK - returns the LocationList in XML or JSON format.", - "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/58", - "id": 58, - "priority": 0, - "hidden": false, - "invisible": false, - "explicitlyHidden": false, - "ParentLocation": { - "_media-type": "application/vnd.ibexa.api.Location+json", - "_href": "/api/ibexa/v2/content/locations/1/2" - }, - "pathString": "/1/2/58/", - "depth": 2, - "childCount": 3, - "remoteId": "0cfe62f27753448d79aaa8acd8d01699", - "Children": { - "_media-type": "application/vnd.ibexa.api.LocationList+json", - "_href": "/api/ibexa/v2/content/locations/1/2/58/children" - }, - "Content": { - "_media-type": "application/vnd.ibexa.api.Content+json", - "_href": "/api/ibexa/v2/content/objects/57" - }, - "sortField": "PATH", - "sortOrder": "ASC", - "UrlAliases": { - "_media-type": "application/vnd.ibexa.api.UrlAliasRefList+json", - "_href": "/api/ibexa/v2/content/locations/1/2/58/urlaliases" - }, - "ContentInfo": { - "_media-type": "application/vnd.ibexa.api.ContentInfo+json", - "_href": "/api/ibexa/v2/content/objects/57", - "Content": { - "_media-type": "application/vnd.ibexa.api.ContentInfo+json", - "_href": "/api/ibexa/v2/content/objects/57", - "_remoteId": "782f5afa9d6587804daa911e88ff5bb9", - "_id": 57, - "ContentType": { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/1" - }, - "Name": "All Tips", - "TranslatedName": "All Tips", - "Versions": { - "_media-type": "application/vnd.ibexa.api.VersionList+json", - "_href": "/api/ibexa/v2/content/objects/57/versions" - }, - "CurrentVersion": { - "_media-type": "application/vnd.ibexa.api.Version+json", - "_href": "/api/ibexa/v2/content/objects/57/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/57/locations" - }, - "Owner": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "lastModificationDate": "2021-06-28T11:22:52+00:00", - "publishedDate": "2021-06-28T11:22:52+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/57/objectstates" - } - } - } - } - } - }, - "application/vnd.ibexa.api.LocationList+xml": { - "schema": { - "$ref": "#/components/schemas/Location" - }, - "example": "\n\n 58\n 0\n false\n false\n false\n \n /1/2/58/\n 2\n 3\n 0cfe62f27753448d79aaa8acd8d01699\n \n \n PATH\n ASC\n \n \n \n \n All Tips\n All Tips\n \n \n
\n \n \n 2021-06-28T11:22:52+00:00\n 2021-06-28T11:22:52+00:00\n eng-GB\n 1\n true\n false\n PUBLISHED\n \n \n \n\n" + "requestBody": { + "description": "The VersionUpdate schema encoded in XML or JSON format.", + "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" } }, - "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": [], - "deprecated": false + "required": false + } } }, - "/content/locations/{path}": { + "/content/objects/{contentId}/versions/{versionNo}/relations": { "get": { - "operationId": "ibexa.rest.load_location", + "operationId": "ibexa.rest.load_version_relations", "tags": [ - "Location" + "Objects" ], "responses": { "200": { - "description": "If set, the new Location is returned in XML or JSON format.", + "description": "If set, the Relation is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Location+json": { + "application/vnd.ibexa.api.RelationList+json": { "schema": { - "$ref": "#/components/schemas/LocationWrapper" + "$ref": "#/components/schemas/RelationListWrapper" }, "example": { - "Location": { - "_media-type": "application/vnd.ibexa.api.Location+json", - "_href": "/api/ibexa/v2/content/locations/1/2/58", - "id": 58, - "priority": 0, - "hidden": false, - "invisible": false, - "explicitlyHidden": false, - "ParentLocation": { - "_media-type": "application/vnd.ibexa.api.Location+json", - "_href": "/api/ibexa/v2/content/locations/1/2" - }, - "pathString": "/1/2/58/", - "depth": 2, - "childCount": 3, - "remoteId": "0cfe62f27753448d79aaa8acd8d01699", - "Children": { - "_media-type": "application/vnd.ibexa.api.LocationList+json", - "_href": "/api/ibexa/v2/content/locations/1/2/58/children" - }, - "Content": { - "_media-type": "application/vnd.ibexa.api.Content+json", - "_href": "/api/ibexa/v2/content/objects/57" - }, - "sortField": "PATH", - "sortOrder": "ASC", - "UrlAliases": { - "_media-type": "application/vnd.ibexa.api.UrlAliasRefList+json", - "_href": "/api/ibexa/v2/content/locations/1/2/58/urlaliases" - }, - "ContentInfo": { - "_media-type": "application/vnd.ibexa.api.ContentInfo+json", - "_href": "/api/ibexa/v2/content/objects/57", - "Content": { - "_media-type": "application/vnd.ibexa.api.ContentInfo+json", - "_href": "/api/ibexa/v2/content/objects/57", - "_remoteId": "782f5afa9d6587804daa911e88ff5bb9", - "_id": 57, - "ContentType": { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/1" - }, - "Name": "All Tips", - "TranslatedName": "All Tips", - "Versions": { - "_media-type": "application/vnd.ibexa.api.VersionList+json", - "_href": "/api/ibexa/v2/content/objects/57/versions" - }, - "CurrentVersion": { - "_media-type": "application/vnd.ibexa.api.Version+json", - "_href": "/api/ibexa/v2/content/objects/57/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/57/locations" + "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" }, - "Owner": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" + "DestinationContent": { + "_media-type": "application/vnd.ibexa.api.ContentInfo+json", + "_href": "/api/ibexa/v2/content/objects/52" }, - "lastModificationDate": "2021-06-28T11:22:52+00:00", - "publishedDate": "2021-06-28T11:22:52+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/57/objectstates" - } + "RelationType": "LINK" } - } + ] } } }, - "application/vnd.ibexa.api.Location+xml": { + "application/vnd.ibexa.api.RelationList+xml": { "schema": { - "$ref": "#/components/schemas/Location" + "$ref": "#/components/schemas/RelationList" }, - "example": "\n\n 61\n 0\n false\n false\n \n /1/2/61/\n 2\n 0\n 2cfa66027e3806b113d994c9c26d3a66\n \n \n NAME\n ASC\n \n \n \n \n 666\n \n \n
\n \n \n 2018-11-09T14:49:52+01:00\n 2018-11-09T14:49:52+01:00\n eng-GB\n 1\n false\n \n \n \n\n" + "example": "\n\n \n \n \n LINK\n \n\n" } } }, "401": { - "description": "Error - the user is not authorized to read this Location." + "description": "Error - the user is not authorized to read this content item." }, "404": { - "description": "Error - the Location with the given path does not exist." + "description": "Error - the content item was not found." } }, - "summary": "Load Location", - "description": "Loads the Location for the given path e.g. '/content/locations/1/2/61'.", + "summary": "Load Relations of content item version", + "description": "Loads the Relations of the given version.", "parameters": [ { - "name": "If-None-Match", - "in": "header", - "description": "ETag", - "required": false, + "name": "contentId", + "in": "path", + "description": "ContentVersionsRelationsListController identifier", + "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "path", + "name": "versionNo", "in": "path", - "description": "", + "description": "ContentVersionsRelationsListController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] }, - "delete": { - "operationId": "ibexa.rest.delete_subtree", + "post": { + "operationId": "ibexa.rest.create_relation", "tags": [ - "Location" + "Objects" ], "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." + "201": { + "description": "If set, the updated version is returned in XML or JSON format.", + "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": "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.", + "summary": "Create new Relation", + "description": "Creates a new Relation of type COMMON for the given draft.", "parameters": [ { "name": "X-CSRF-Token", @@ -9916,13806 +7044,1838 @@ "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "path", + "name": "contentId", "in": "path", - "description": "", + "description": "ContentRelationCreateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + }, + { + "name": "versionNo", + "in": "path", + "description": "ContentRelationCreateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ], - "deprecated": false - }, - "patch": { - "operationId": "ibexa.rest.update_location", - "tags": [ - "Location" - ], - "responses": { - "200": { - "description": "If set, the Location is returned in XML or JSON format.", - "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", - "id": 59, - "priority": 3, - "hidden": true, - "invisible": true, - "explicitlyHidden": true, - "ParentLocation": { - "_media-type": "application/vnd.ibexa.api.Location+json", - "_href": "/api/ibexa/v2/content/locations/1/2" - }, - "pathString": "/1/2/59/", - "depth": 2, - "childCount": 5, - "remoteId": "remoteId-qwert999", - "Children": { - "_media-type": "application/vnd.ibexa.api.LocationList+json", - "_href": "/api/ibexa/v2/content/locations/1/2/59/children" - }, - "Content": { - "_media-type": "application/vnd.ibexa.api.Content+json", - "_href": "/api/ibexa/v2/content/objects/58" - }, - "sortField": "NAME", - "sortOrder": "DESC", - "UrlAliases": { - "_media-type": "application/vnd.ibexa.api.UrlAliasRefList+json", - "_href": "/api/ibexa/v2/content/locations/1/2/59/urlaliases" + "requestBody": { + "description": "The RelationCreate schema encoded in XML or JSON format.", + "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 + } + } + }, + "/content/objects/{contentId}/versions/{versionNo}/relations/{relationId}": { + "get": { + "operationId": "ibexa.rest.load_version_relation", + "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" }, - "ContentInfo": { + "DestinationContent": { "_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" - } - } - } + "_href": "/api/ibexa/v2/content/objects/59" + }, + "RelationType": "COMMON" } } }, - "application/vnd.ibexa.api.Location+xml": { + "application/vnd.ibexa.api.Relation+xml": { "schema": { - "$ref": "#/components/schemas/Location" + "$ref": "#/components/schemas/Relation" }, - "example": "\n\n 58\n 0\n false\n false\n false\n \n /1/2/58/\n 2\n 3\n 0cfe62f27753448d79aaa8acd8d01699\n \n \n PATH\n ASC\n \n \n \n \n All Tips\n All Tips\n \n \n
\n \n \n 2021-06-28T11:22:52+00:00\n 2021-06-28T11:22:52+00:00\n eng-GB\n 1\n true\n false\n PUBLISHED\n \n \n \n\n" + "example": "\n\n \n \n COMMON\n\n" } } }, "401": { - "description": "Error - the user is not authorized to update this Location." + "description": "Error - the user is not authorized to read this content item." }, "404": { - "description": "Error - the Location with the given ID does not exist." + "description": "Error - the content item with the given ID or the Relation 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.", + "summary": "Load Relation", + "description": "Loads a Relation for the given content item.", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "name": "contentId", + "in": "path", + "description": "ContentVersionRelationLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "If-Match", - "in": "header", - "description": "ETag", + "name": "versionNo", + "in": "path", + "description": "ContentVersionRelationLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "path", + "name": "relationId", "in": "path", - "description": "", + "description": "ContentVersionRelationLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "requestBody": { - "description": "The LocationUpdate schema encoded in XML or JSON format.", - "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": "ibexa.rest.load_location_children", + ] + }, + "delete": { + "operationId": "ibexa.rest.remove_relation", "tags": [ - "Location" + "Objects" ], "responses": { - "200": { - "description": "If set, the new Location list is returned in XML or JSON format.", - "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 \n \n\n" - } - } + "204": { + "description": "No Content - deleted a Relation of the given draft." }, "401": { - "description": "Error - the user is not authorized to read this content item." + "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 - the content item with the given ID does not exist." + "description": "Error - content item or the Relation were not found in the given version." } }, - "summary": "Get child Locations.", - "description": "Loads all child Locations for the given parent Location.", + "summary": "Delete Relation", + "description": "Deletes a Relation of the given draft.", "parameters": [ { - "name": "path", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "contentId", "in": "path", - "description": "", + "description": "ContentVersionRelationDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + }, + { + "name": "versionNo", + "in": "path", + "description": "ContentVersionRelationDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "relationId", + "in": "path", + "description": "ContentVersionRelationDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } - ], - "deprecated": false + ] } }, - "/content/locations/{path}/urlaliases": { - "get": { - "operationId": "ibexa.rest.list_location_url_aliases", + "/content/objects/{contentId}/versions/{versionNo}/translations/{languageCode}": { + "delete": { + "operationId": "ibexa.rest.delete_translation_from_draft", "tags": [ - "Location" + "Objects" ], "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\n" - } - } - }, - "400": { - "description": "Error - The user has no permission to read URL aliases." + "204": { + "description": "No Content - removes a translation from a version draft." }, "401": { - "description": "Error - The Location was not found." + "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": "List URL aliases for Location", - "description": "Returns the list of URL aliases for a Location.", + "summary": "Delete translation from version draft", + "description": "Removes a translation from a version draft.", "parameters": [ { - "name": "path", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "contentId", "in": "path", - "description": "", + "description": "ContentDraftTranslationDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + }, + { + "name": "versionNo", + "in": "path", + "description": "ContentDraftTranslationDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "languageCode", + "in": "path", + "description": "ContentDraftTranslationDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } - ], - "deprecated": false + ] } }, - "/content/objectstategroups": { + "/page/structure": { "get": { - "operationId": "ibexa.rest.load_object_state_groups", + "operationId": "ibexa.page_builder.rest.page_structure", "tags": [ - "Object State Groups" + "Page" ], "responses": { "200": { - "description": "OK - returns a list of Object state groups.", + "description": "The Page structure is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ObjectStateGroupList+json": { + "application/vnd.ibexa.api.PageStructure+json": { "schema": { - "$ref": "#/components/schemas/ObjectStateGroupListWrapper" + "$ref": "#/components/schemas/PageStructureWrapper" }, "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": "" - } - ] - } + "PageStructure": { + "_media-type": "application/vnd.ibexa.api.PageStructure+json", + "layouts": [ + { + "_media-type": "application/vnd.ibexa.api.PageStructureLayout+json", + "identifier": "default", + "name": "default", + "description": "Default layout for Landing Page", + "zones": [ + { + "_media-type": "application/vnd.ibexa.api.PageStructureZone+json", + "identifier": "default_id", + "name": "default", + "description": "" + } + ] + } + ], + "blocks": [ + { + "_media-type": "application/vnd.ibexa.api.PageStructureBlock+json", + "identifier": "richtext", + "name": "Text", + "description": "Holds formatted rich text authored in the editor.", + "category": "default", + "views": [ + { + "_media-type": "application/vnd.ibexa.api.PageStructureView+json", + "identifier": "default", + "name": "Default view", + "description": "" + } + ], + "attributes": [ + { + "_media-type": "application/vnd.ibexa.api.PageStructureAttribute+json", + "identifier": "content", + "name": "Content", + "type": "richtext", + "category": "default", + "options": [] + } + ] }, { - "_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" + "_media-type": "application/vnd.ibexa.api.PageStructureBlock+json", + "identifier": "collection", + "name": "Collection", + "description": "Shows a hand-picked, ordered collection of content items.", + "category": "default", + "views": [ + { + "_media-type": "application/vnd.ibexa.api.PageStructureView+json", + "identifier": "default", + "name": "Default block layout", + "description": "" + } + ], + "attributes": [ + { + "_media-type": "application/vnd.ibexa.api.PageStructureAttribute+json", + "identifier": "locationlist", + "name": "Location list", + "type": "locationlist", + "category": "default", + "options": { + "match": { + "default": [] + } } - ] - } + } + ] } ] } } }, - "application/vnd.ibexa.api.ObjectStateGroupList+xml": { + "application/vnd.ibexa.api.PageStructure+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" + "$ref": "#/components/schemas/PageStructure" + } } } }, - "401": { - "description": "Error - The user has no permission to read Object state groups." + "400": { + "description": "Error - the content type given in `contentTypeIdentifier` exists, but cannot hold a Page, because it has no field of the `ibexa_landing_page` field type." + }, + "404": { + "description": "Error - the identifier given in `contentTypeIdentifier` names no existing content type." } }, - "summary": "List Object state groups", - "description": "Returns a list of all Object state groups.", + "summary": "Page structure", + "description": "Lists the layouts and blocks available for building Pages, with the zones of every layout and the views and attributes of every block.", "parameters": [ { - "name": "If-None-Match", - "in": "header", - "description": "ETag", + "name": "contentTypeIdentifier", + "in": "query", + "description": "Identifier of a content type holding a Page. When given, only the layouts and blocks allowed for that content type are returned. When omitted or empty, the whole catalogue is returned.", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, - "style": "simple", + "style": "form", "explode": false, - "allowReserved": false + "example": "landing_page" } - ], - "deprecated": false - }, - "post": { - "operationId": "ibexa.rest.create_object_state_group", + ] + } + }, + "/product/catalog/products": { + "get": { + "operationId": "ibexa.product_catalog.rest.products", "tags": [ - "Object State Groups" + "Product" ], "responses": { - "201": { - "description": "Object state group created.", + "200": { + "description": "If set, the products are returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ObjectStateGroup+json": { + "application/vnd.ibexa.api.ProductList+json": { "schema": { - "$ref": "#/components/schemas/ObjectStateGroupWrapper" + "$ref": "#/components/schemas/ProductListWrapper" }, "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": "Custom State" - } - ] - }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Custom Object state" - } - ] - } + "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": [] + } + ] } } - }, - "application/vnd.ibexa.api.ObjectStateGroup+xml": { - "schema": { - "$ref": "#/components/schemas/ObjectStateGroup" - }, - "example": "\n\n 5\n custom-states\n eng-GB\n eng-GB\n \n \n Custom State\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." + "description": "Error - the user has no permission to read product." } }, - "summary": "Create Object state group", - "description": "Creates a new Object state group.", - "parameters": [ - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], + "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": [], "requestBody": { - "description": "The Object state group input schema encoded in XML or JSON format.", + "description": "The product list schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ObjectStateGroupCreate+json": { + "application/vnd.ibexa.api.ProductListGet+json": { "schema": { - "$ref": "#/components/schemas/ObjectStateGroupCreateWrapper" + "$ref": "#/components/schemas/ProductListGetWrapper" }, "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" - } - ] - } + "ProductListGet": { + "offset": 0, + "limit": 10, + "languages": [ + "eng-GB" + ] } } - }, - "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": "ibexa.rest.load_object_state_group", - "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": "Custom State" - } - ] - }, - "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 Custom State\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": "If-None-Match", - "in": "header", - "description": "ETag", - "required": false, - "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": "ibexa.rest.delete_object_state_group", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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 - }, - "patch": { - "operationId": "ibexa.rest.update_object_state_group", + "/product/catalog/products/view": { + "post": { + "operationId": "ibexa.product_catalog.rest.products.view", "tags": [ - "Object State Groups" + "Product" ], "responses": { "200": { - "description": "OK - Object stated group updated.", + "description": "The view in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ObjectStateGroup+json": { + "application/vnd.ibexa.api.ProductView+json": { "schema": { - "$ref": "#/components/schemas/ObjectStateGroupWrapper" + "$ref": "#/components/schemas/ProductViewWrapper" }, "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" - } - ] + "ProductView": { + "_media-type": "application/vnd.ibexa.api.ProductView+json", + "identifier": "TitleView", + "ProductQuery": { + "_media-type": "application/vnd.ibexa.api.ProductQuery+json" }, - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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 Object state group input schema encoded in XML or JSON format.", - "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": "ibexa.rest.load_object_states", - "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": "If-None-Match", - "in": "header", - "description": "ETag", - "required": false, - "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": "ibexa.rest.create_object_state", - "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/7/objectstates/7", - "id": 7, - "identifier": "new-state", - "priority": 0, - "ObjectStateGroup": { - "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", - "_href": "/api/ibexa/v2/content/objectstategroups/7" - }, - "defaultLanguageCode": "eng-GB", - "languageCodes": "eng-GB", - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "New State" - } - ] - }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "New Object State" - } - ] - } - } - } - }, - "application/vnd.ibexa.api.ObjectState+xml": { - "schema": { - "$ref": "#/components/schemas/ObjectState" - }, - "example": "\n\n 5\n new-state\n 0\n \n eng-GB\n eng-GB\n \n New State\n \n \n New 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." - }, - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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 Object state input schema encoded in XML or JSON format.", - "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": "ibexa.rest.load_object_state", - "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/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.ObjectState+xml": { - "schema": { - "$ref": "#/components/schemas/ObjectState" - }, - "example": "\n\n2\nlocked\n1\n\neng-GB\neng-GB\n\n Locked\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": "If-None-Match", - "in": "header", - "description": "ETag", - "required": false, - "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": "ibexa.rest.delete_object_state", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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 - }, - "patch": { - "operationId": "ibexa.rest.update_object_state", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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 Object state input schema encoded in XML or JSON format.", - "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": "ibexa.rest.redirect_content", - "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": "ibexa.rest.create_content", - "tags": [ - "Objects" - ], - "responses": { - "201": { - "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.", - "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/109", - "_remoteId": "8716f007ba15f6f35139acb55e39b811", - "_id": 109, - "ContentType": { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/2" - }, - "Name": "draft article", - "TranslatedName": "draft article", - "Versions": { - "_media-type": "application/vnd.ibexa.api.VersionList+json", - "_href": "/api/ibexa/v2/content/objects/109/versions" - }, - "CurrentVersion": { - "_media-type": "application/vnd.ibexa.api.Version+json", - "_href": "/api/ibexa/v2/content/objects/109/currentversion", - "Version": { - "_media-type": "application/vnd.ibexa.api.Version+json", - "_href": "/api/ibexa/v2/content/objects/109/versions/1", - "VersionInfo": { - "id": 587, - "versionNo": 1, - "status": "DRAFT", - "modificationDate": "2023-05-24T06:27:54+00:00", - "Creator": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "creationDate": "2023-05-24T06:27:54+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": "draft article" - } - ] - }, - "Content": { - "_media-type": "application/vnd.ibexa.api.ContentInfo+json", - "_href": "/api/ibexa/v2/content/objects/109" - } - }, - "Fields": { - "field": [ - { - "id": 488, - "fieldDefinitionIdentifier": "title", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_string", - "fieldValue": "draft article" - }, - { - "id": 489, - "fieldDefinitionIdentifier": "short_title", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_string", - "fieldValue": null - }, - { - "id": 490, - "fieldDefinitionIdentifier": "author", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_author", - "fieldValue": [] - }, - { - "id": 491, - "fieldDefinitionIdentifier": "intro", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_richtext", - "fieldValue": { - "xml": "\n
draft draft
\n", - "xhtml5edit": "\n

draft draft

\n" - } - }, - { - "id": 492, - "fieldDefinitionIdentifier": "body", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_richtext", - "fieldValue": { - "xml": "\n
draft draft draft
\n", - "xhtml5edit": "\n

draft draft draft

\n" - } - }, - { - "id": 493, - "fieldDefinitionIdentifier": "enable_comments", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_boolean", - "fieldValue": false - }, - { - "id": 494, - "fieldDefinitionIdentifier": "image", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_object_relation", - "fieldValue": { - "destinationContentId": null - } - } - ] - }, - "Relations": { - "_media-type": "application/vnd.ibexa.api.RelationList+json", - "_href": "/api/ibexa/v2/content/objects/109/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/109/locations" - }, - "Owner": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "mainLanguageCode": "eng-GB", - "currentVersionNo": 1, - "alwaysAvailable": true, - "isHidden": false, - "status": "DRAFT", - "ObjectStates": { - "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", - "_href": "/api/ibexa/v2/content/objects/109/objectstates" - } - } - } - }, - "application/vnd.ibexa.api.Content+xml": { - "schema": { - "$ref": "#/components/schemas/Content" - }, - "example": "\n\n \n draft article\n draft article\n \n \n \n \n 586\n 1\n DRAFT\n 2023-05-24T06:24:46+00:00\n \n 2023-05-24T06:24:46+00:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n draft article\n \n \n \n \n \n 481\n title\n eng-GB\n ibexa_string\n draft article\n \n \n 482\n short_title\n eng-GB\n ibexa_string\n \n \n \n 483\n author\n eng-GB\n ibexa_author\n \n \n \n 484\n intro\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" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>draft draft</para></section>\n\n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft</p></section>\n\n \n \n \n 485\n body\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" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>draft draft draft</para></section>\n\n <?xml version="1.0" encoding="UTF-8"?>\n<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft draft</p></section>\n\n \n \n \n 486\n enable_comments\n eng-GB\n ibexa_boolean\n false\n \n \n 487\n image\n eng-GB\n ibexa_object_relation\n \n \n \n \n \n \n \n /placeholder\n \n \n image/svg+xml\n \n \n \n
\n \n \n eng-GB\n 1\n true\n false\n DRAFT\n \n\n" - }, - "application/vnd.ibexa.api.ContentInfo+json": { - "schema": { - "$ref": "#/components/schemas/ContentInfoWrapper" - }, - "example": { - "Content": { - "_media-type": "application/vnd.ibexa.api.ContentInfo+json", - "_href": "/api/ibexa/v2/content/objects/77", - "_remoteId": "89e9b86c673b1c1de6781bb94488b18c", - "_id": 77, - "ContentType": { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/2" - }, - "Name": "draft article", - "TranslatedName": "draft article", - "Versions": { - "_media-type": "application/vnd.ibexa.api.VersionList+json", - "_href": "/api/ibexa/v2/content/objects/77/versions" - }, - "CurrentVersion": { - "_media-type": "application/vnd.ibexa.api.Version+json", - "_href": "/api/ibexa/v2/content/objects/77/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/77/locations" - }, - "Owner": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "mainLanguageCode": "eng-GB", - "currentVersionNo": 1, - "alwaysAvailable": true, - "isHidden": false, - "status": "DRAFT", - "ObjectStates": { - "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", - "_href": "/api/ibexa/v2/content/objects/77/objectstates" - } - } - } - }, - "application/vnd.ibexa.api.ContentInfo+xml": { - "schema": { - "$ref": "#/components/schemas/ContentInfo" - }, - "example": "\n\n \n draft article\n draft article\n \n \n
\n \n \n eng-GB\n 1\n true\n false\n DRAFT\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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token 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 ContentCreate schema encoded in XML or JSON format.", - "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": "ibexa.rest.load_content", - "tags": [ - "Objects" - ], - "responses": { - "200": { - "description": "OK - returns the Content or ContentInfo in XML or JSON format.", - "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" - } - }, - "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).\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.", - "parameters": [ - { - "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": "ibexa.rest.delete_content", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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": "ibexa.rest.update_content_metadata", - "tags": [ - "Objects" - ], - "responses": { - "200": { - "description": "If set, all information for the content item (excluding the current version) is returned in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.ContentInfo+json": { - "schema": { - "$ref": "#/components/schemas/ContentInfoWrapper" - } - }, - "application/vnd.ibexa.api.ContentInfo+xml": { - "schema": { - "$ref": "#/components/schemas/ContentInfo" - }, - "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." - }, - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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": "contentId", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The ContentUpdate schema encoded in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.ContentUpdate+json": { - "schema": { - "$ref": "#/components/schemas/ContentInfoWrapper" - } - }, - "application/vnd.ibexa.api.ContentUpdate+xml": { - "schema": { - "$ref": "#/components/schemas/ContentInfo" - }, - "example": "\n\n eng-GB\n
\n \n \n false\n 69848aeb86164c35e5c98202eebe9e05\n\n" - } - }, - "required": false - }, - "deprecated": false - } - }, - "/content/objects/{contentId}/currentversion": { - "get": { - "operationId": "ibexa.rest.redirect_current_version", - "tags": [ - "Objects" - ], - "responses": { - "200": { - "description": "OK - returns the Version in XML or JSON format.", - "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/2", - "VersionInfo": { - "id": 578, - "versionNo": 2, - "status": "PUBLISHED", - "modificationDate": "2023-05-24T05:59:09+00:00", - "Creator": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "creationDate": "2023-05-24T05:59:02+00:00", - "initialLanguageCode": "eng-GB", - "languageCodes": "eng-GB", - "VersionTranslationInfo": { - "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", - "Language": [ - { - "languageCode": "eng-GB" - } - ] - }, - "names": { - "value": [ - { - "_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/2/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 578\n 2\n PUBLISHED\n 2023-05-24T05:59:09+00:00\n \n 2023-05-24T05:59:02+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": "ibexa.rest.content.create_draft_from_current_version", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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": "No payload required", - "content": [], - "required": false - }, - "deprecated": false - } - }, - "/content/objects/{contentId}/hide": { - "post": { - "operationId": "ibexa.rest.hide_content", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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": "No payload required", - "content": [], - "required": false - }, - "deprecated": false - } - }, - "/content/objects/{contentId}/locations": { - "get": { - "operationId": "ibexa.rest.load_locations_for_content", - "tags": [ - "Objects" - ], - "responses": { - "200": { - "description": "If set, the Location list is returned in XML or JSON format.", - "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": "If-None-Match", - "in": "header", - "description": "ETag", - "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": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "post": { - "operationId": "ibexa.rest.create_location", - "tags": [ - "Objects" - ], - "responses": { - "201": { - "description": "If set, the new Location is returned in XML or JSON format.", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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 LocationCreate schema encoded in XML or JSON format.", - "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": "ibexa.rest.get_object_states_for_content", - "tags": [ - "Objects" - ], - "responses": { - "200": { - "description": "OK - returns the Object state.", - "content": { - "application/vnd.ibexa.api.ContentObjectStates+json": { - "schema": { - "$ref": "#/components/schemas/ContentObjectStates" - }, - "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 \n \n\n" - } - } - }, - "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": "If-None-Match", - "in": "header", - "description": "ETag", - "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": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "patch": { - "operationId": "ibexa.rest.set_object_states_for_content", - "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/2" - } - ] - } - } - }, - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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 content item Object states input schema encoded in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.ContentObjectStates+json": { - "schema": { - "$ref": "#/components/schemas/ContentObjectStatesWrapper" - }, - "example": { - "ContentObjectStates": { - "ObjectState": [ - { - "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates/2" - } - ] - } - } - }, - "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": "ibexa.rest.redirect_current_version_relations", - "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": "ibexa.rest.reveal_content", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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": "No payload required", - "content": [], - "required": false - }, - "deprecated": false - } - }, - "/content/objects/{contentId}/translations/{languageCode}": { - "delete": { - "operationId": "ibexa.rest.delete_content_translation", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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": "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": "ibexa.rest.load_content_versions", - "tags": [ - "Objects" - ], - "responses": { - "200": { - "description": "If set, the version list is returned in XML or JSON format.", - "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": "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": "ibexa.rest.load_content_in_version", - "tags": [ - "Objects" - ], - "responses": { - "200": { - "description": "If set, the version list is returned in XML or JSON format.", - "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": "Not Modified - the ETag matches 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": 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": "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": "ibexa.rest.content.create_draft_from_version", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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": "No payload required", - "content": [], - "required": false - }, - "deprecated": false - }, - "delete": { - "operationId": "ibexa.rest.delete_content_version", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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 - }, - "patch": { - "operationId": "ibexa.rest.update_version", - "tags": [ - "Objects" - ], - "responses": { - "200": { - "description": "If set, the updated version is returned in XML or JSON format.", - "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 45\n 4\n DRAFT\n 2012-02-20T12:00:00\n \n 22012-02-20T12:00:00\n ger-DE\n \n Neuer Titel\n \n \n \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 authors\n ger-DE\n \n \n \n \n \n \n \n \n \n \n \n COMMON\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 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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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": "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 VersionUpdate schema encoded in XML or JSON format.", - "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": "ibexa.rest.load_version_relations", - "tags": [ - "Objects" - ], - "responses": { - "200": { - "description": "If set, the Relation is returned in XML or JSON format.", - "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": "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": "ibexa.rest.create_relation", - "tags": [ - "Objects" - ], - "responses": { - "201": { - "description": "If set, the updated version is returned in XML or JSON format.", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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 RelationCreate schema encoded in XML or JSON format.", - "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": "ibexa.rest.load_version_relation", - "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": "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": "ibexa.rest.remove_relation", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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 - } - }, - "/content/objects/{contentId}/versions/{versionNo}/translations/{languageCode}": { - "delete": { - "operationId": "ibexa.rest.delete_translation_from_draft", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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": "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": "ibexa.order_management.rest.order.cancel", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", - "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": "No payload required", - "content": [], - "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] - } - }, - "/orders/order/{identifier}": { - "get": { - "operationId": "ibexa.order_management.rest.order.identifier", - "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": "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": "ibexa.order_management.rest.order", - "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": 1, - "identifier": "02ce9f94-e36b-4acf-92f7-eb93cda6af71", - "created": { - "date": "2023-10-18 06:24:00.000000", - "timezone_type": 3, - "timezone": "UTC" - }, - "modified": { - "date": "2023-10-18 06:24:00.000000", - "timezone_type": 3, - "timezone": "UTC" - }, - "status": "pending", - "source": "local_shop", - "OrderUser": { - "_media-type": "application/vnd.ibexa.api.OrderUser+json", - "id": null, - "name": "Anonymous User", - "email": "test@test.com" - }, - "OrderCurrency": { - "_media-type": "application/vnd.ibexa.api.OrderCurrency+json", - "id": 2, - "code": "EUR" - }, - "OrderValue": { - "_media-type": "application/vnd.ibexa.api.OrderValue+json", - "vat": { - "amount": "96", - "currency": "EUR" - }, - "total_gross": { - "amount": "1512", - "currency": "EUR" - }, - "total_net": { - "amount": "1200", - "currency": "EUR" - }, - "shipping_cost": { - "amount": "216", - "currency": "EUR" - } - }, - "OrderItemsList": [ - { - "_media-type": "application/vnd.ibexa.api.OrderItem+json", - "quantity": 1, - "OrderItemValue": { - "_media-type": "application/vnd.ibexa.api.OrderItemValue+json", - "unit_price_gross": { - "amount": "1296", - "currency": "EUR" - }, - "unit_price_net": { - "amount": "1200", - "currency": "EUR" - }, - "vat_rate": "8.00", - "subtotal_price_gross": { - "amount": "1296", - "currency": "EUR" - }, - "subtotal_price_net": { - "amount": "1200", - "currency": "EUR" - } - }, - "OrderItemProduct": { - "_media-type": "application/vnd.ibexa.api.OrderItemProduct+json", - "id": 83, - "code": "test123", - "name": "test123" - } - } - ], - "context": { - "shipping_address": { - "name": null, - "country": "PL", - "fields": { - "tax_id": "16", - "region": "Polska", - "locality": "Krak\u00f3w", - "street": "Krupnicza 16", - "postal_code": "31-123", - "email": "test@test.com", - "phone_number": "123123123" - } - }, - "billing_address": { - "name": null, - "country": "PL", - "fields": { - "tax_id": "16", - "region": "Polska", - "locality": "Krak\u00f3w", - "street": "Krupnicza 16", - "postal_code": "31-123", - "email": "test@test.com", - "phone_number": "123123123" - } - }, - "entries_count": 1, - "same_for_shipping": true, - "select_shipping": { - "shipping_method": { - "identifier": "test", - "name": "test" - }, - "payment_method": { - "identifier": "test", - "name": "test", - "type": "online" - } - }, - "summary": [], - "shipping_cost_incl_vat": { - "amount": "216", - "currency": "EUR" - } - } - } - } - }, - "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": "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": "ibexa.order_management.rest.order.update", - "tags": [ - "Orders" - ], - "responses": { - "200": { - "description": "If set, the updated order is returned in XML or JSON format.", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", - "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 OrderUpdate schema encoded in XML or JSON format.", - "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": "ibexa.order_management.rest.orders", - "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": [], - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] - }, - "post": { - "operationId": "ibexa.order_management.rest.order.create", - "tags": [ - "Orders" - ], - "responses": { - "200": { - "description": "If set, the new order is returned in JSON format.", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The Order schema encoded in XML or JSON format.", - "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": "ibexa.rest.payment_method.create", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The Payment Method input schema encoded in XML or JSON.", - "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": "ibexa.rest.payment_method.view", - "tags": [ - "Payments" - ], - "responses": { - "200": { - "description": "The view in XML or JSON format.", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The view input in XML or JSON format.", - "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": "ibexa.rest.payment_method.get_by_identifier", - "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": "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": "ibexa.rest.payment_method.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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", - "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" - } - ] - }, - "patch": { - "operationId": "ibexa.rest.payment_method.update", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", - "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 Payment Method input schema encoded in XML or JSON.", - "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": "ibexa.rest.payment_method.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": "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": "ibexa.product_catalog.rest.products", - "tags": [ - "Product" - ], - "responses": { - "200": { - "description": "If set, the products are returned in XML or JSON format.", - "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": [], - "requestBody": { - "description": "The product list schema encoded in XML or JSON format.", - "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": "ibexa.product_catalog.rest.products.view", - "tags": [ - "Product" - ], - "responses": { - "200": { - "description": "The view in XML or JSON format.", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The view input in XML or JSON format.", - "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": "ibexa.product_catalog.rest.product", - "tags": [ - "Product" - ], - "responses": { - "200": { - "description": "If set, the products are returned in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.Product+json": { - "schema": { - "$ref": "#/components/schemas/ProductWrapper" - }, - "example": { - "Product": { - "_media-type": "application/vnd.ibexa.api.Product+json", - "code": "DRESUN", - "name": "Yellow sundress", - "ProductType": { - "_media-type": "application/vnd.ibexa.api.ProductType+json", - "identifier": "dress", - "name": "Dress", - "AttributeAssignmentList": [ - { - "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", - "is_required": false, - "is_discriminator": false, - "Attribute": { - "_media-type": "application/vnd.ibexa.api.Attribute+json", - "identifier": "size", - "name": "Size", - "description": "", - "type": "Integer", - "type_identifier": "integer", - "value": 5, - "group": "Hat", - "position": 0, - "options": [] - } - } - ] - }, - "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": "Yellow sundress", - "TranslatedName": "Yellow sundress", - "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": "Yellow sundress" - } - ] - }, - "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": "Yellow sundress" - }, - { - "id": 613, - "fieldDefinitionIdentifier": "product_specification", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_product_specification", - "fieldValue": { - "id": 25, - "code": "DRESUN", - "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": 1647006758, - "updated_at": 1647006758, - "AttributesList": [ - { - "_media-type": "application/vnd.ibexa.api.Attribute+json", - "identifier": "size", - "name": "Size", - "description": "", - "type": "Integer", - "type_identifier": "integer", - "value": 5, - "group": "Clothes", - "position": 0, - "options": [] - } - ] - } - } - } - } - }, - "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": "code", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "An optional product schema encoded in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.ProductGet+json": { - "schema": { - "$ref": "#/components/schemas/ProductGetWrapper" - }, - "example": { - "ProductGet": { - "languages": [ - "eng-GB" - ] - } - } - } - }, - "required": false - }, - "deprecated": false - }, - "patch": { - "operationId": "ibexa.product_catalog.rest.products.update", - "tags": [ - "Product" - ], - "responses": { - "201": { - "description": "If set, the updated product is returned in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.Product+json": { - "schema": { - "$ref": "#/components/schemas/ProductWrapper" - }, - "example": { - "Product": { - "_media-type": "application/vnd.ibexa.api.Product+json", - "code": "bbbb", - "name": "fgh", - "ProductType": { - "_media-type": "application/vnd.ibexa.api.ProductType+json", - "identifier": "test_pt321", - "name": "New Product Type", - "AttributeAssignmentList": [ - { - "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", - "is_required": false, - "is_discriminator": true, - "Attribute": { - "_media-type": "application/vnd.ibexa.api.Attribute+json", - "identifier": "testAttr", - "name": "testAttr", - "description": "", - "type": "Checkbox", - "type_identifier": "checkbox", - "value": true, - "group": "Test Attribute group", - "position": 0, - "options": [] - } - } - ] - }, - "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": "fgh", - "TranslatedName": "fgh", - "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": "fgh" - } - ] - }, - "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": "fgh" - }, - { - "id": 613, - "fieldDefinitionIdentifier": "product_specification", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_product_specification", - "fieldValue": { - "id": 25, - "code": "bbbb", - "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": 1646398748, - "updated_at": 1646398748, - "AttributesList": [ - { - "_media-type": "application/vnd.ibexa.api.Attribute+json", - "identifier": "testAttr", - "name": "testAttr", - "description": "", - "type": "Checkbox", - "type_identifier": "checkbox", - "value": true, - "group": "Test Attribute group", - "position": 0, - "options": [] - }, - { - "_media-type": "application/vnd.ibexa.api.Attribute+json", - "identifier": "nnnn", - "name": "nnnn", - "description": "", - "type": "Checkbox", - "type_identifier": "checkbox", - "value": true, - "group": "Test 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 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": "code", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "If set, the updated product is returned in XML or JSON format.", - "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": "ibexa.product_catalog.rest.prices.list", - "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": "code", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "post": { - "operationId": "ibexa.product_catalog.rest.prices.create", - "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": 5, - "amount": "15.00", - "base_amount": "25.00", - "Currency": { - "_media-type": "application/vnd.ibexa.api.Currency+json", - "id": 2, - "code": "EUR", - "subunits": 2, - "enabled": true - }, - "money": "1500", - "base_money": "2500", - "custom_money": "1500", - "custom_amount": "15.00" - } - } - }, - "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": "code", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The product price schema encoded in JSON format.", - "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": "ibexa.product_catalog.rest.prices.get.base_price", - "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": 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" - } - } - } - } - }, - "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": "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": "ibexa.product_catalog.rest.prices.get.custom_price", - "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": "11.50", - "base_amount": "10.00", - "Currency": { - "_media-type": "application/vnd.ibexa.api.Currency+json", - "id": 5, - "code": "USD", - "subunits": 2, - "enabled": true - }, - "money": "1150", - "base_money": "1000", - "custom_money": "1150", - "custom_amount": "11.50", - "custom_rule": "15.00" - } - } - } - } - }, - "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": "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": "ibexa.product_catalog.rest.prices.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": "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 - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "patch": { - "operationId": "ibexa.product_catalog.rest.prices.update", - "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": 2, - "amount": "35.00", - "base_amount": "35.00", - "Currency": { - "_media-type": "application/vnd.ibexa.api.Currency+json", - "id": 5, - "code": "USD", - "subunits": 2, - "enabled": true - }, - "money": "3500", - "base_money": "3500" - } - } - } - } - }, - "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": "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 - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "Update price or custom price for given currency.", - "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": "ibexa.product_catalog.rest.products.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 - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - } - }, - "/product/catalog/products/{productTypeIdentifier}": { - "post": { - "operationId": "ibexa.product_catalog.rest.products.create", - "tags": [ - "Product" - ], - "responses": { - "201": { - "description": "If set, the new product is returned in XML or JSON format.", - "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": "productTypeIdentifier", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The product schema encoded in XML or JSON format.", - "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": "ibexa.product_catalog.rest.attributes", - "tags": [ - "Product Attribute" - ], - "responses": { - "200": { - "description": "AttributeList - If set, the attributes list is returned in XML or JSON format.", - "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": [], - "requestBody": { - "description": "Attribute filter", - "content": { - "application/vnd.ibexa.api.AttributeListGet+json": { - "schema": { - "$ref": "#/components/schemas/AttributeListGetWrapper" - }, - "example": { - "AttributeListGet": { - "group_name_prefix": "a", - "name_prefix": "a", - "offset": 0, - "limit": 10 - } - } - }, - "application/vnd.ibexa.api.AttributeListGet+xml": { - "schema": { - "$ref": "#/components/schemas/AttributeListGet" - } - } - }, - "required": false - }, - "deprecated": false - }, - "post": { - "operationId": "ibexa.product_catalog.rest.attributes.create", - "tags": [ - "Product Attribute" - ], - "responses": { - "201": { - "description": "If set, the new attribute is returned in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.Attribute+json": { - "schema": { - "$ref": "#/components/schemas/AttributeWrapper" - }, - "example": { - "Attribute": { - "_media-type": "application/vnd.ibexa.api.Attribute+json", - "identifier": "foo", - "name": "Attribute", - "description": "description", - "type": "Checkbox", - "type_identifier": "checkbox", - "value": true, - "group": "Attribute Test", - "position": 0, - "options": [] - } - } - } - } - }, - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The attribute schema encoded in XML or JSON format.", - "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": "ibexa.product_catalog.rest.attributes.translation.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 - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - } - }, - "/product/catalog/attributes/view": { - "post": { - "operationId": "ibexa.product_catalog.rest.attributes.view", - "tags": [ - "Product Attribute" - ], - "responses": { - "200": { - "description": "The view in XML or JSON format.", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The view input in XML or JSON format.", - "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": "ibexa.product_catalog.rest.attributes.get", - "tags": [ - "Product Attribute" - ], - "responses": { - "200": { - "description": "Attribute - If set, the given attribute is returned in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.Attribute+json": { - "schema": { - "$ref": "#/components/schemas/AttributeWrapper" - }, - "example": { - "Attribute": { - "_media-type": "application/vnd.ibexa.api.Attribute+json", - "identifier": "attrib2", - "name": "Attrib2", - "description": "", - "type": "Checkbox", - "type_identifier": "checkbox", - "value": true, - "group": "Attribute Group Test", - "position": 0, - "options": [] - } - } - }, - "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": "id", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "delete": { - "operationId": "ibexa.product_catalog.rest.attributes.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 - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "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": "ibexa.product_catalog.rest.attributes.update", - "tags": [ - "Product Attribute" - ], - "responses": { - "201": { - "description": "If set, the updated attribute is returned in XML or JSON format.", - "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": "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 - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "If set, the updated attribute group is returned in XML or JSON format.", - "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": "ibexa.product_catalog.rest.attribute_groups", - "tags": [ - "Product Attribute Group" - ], - "responses": { - "200": { - "description": "AttributeGroupList - If set, the attribute group list is returned in XML or JSON format.", - "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": [], - "requestBody": { - "description": "The AttributeGroupListGet schema encoded in XML or JSON format.", - "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": "ibexa.product_catalog.rest.attribute_groups.create", - "tags": [ - "Product Attribute Group" - ], - "responses": { - "201": { - "description": "If set, the new attribute group is returned in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.AttributeGroup+json": { - "schema": { - "$ref": "#/components/schemas/AttributeGroupWrapper" - }, - "example": { - "AttributeGroup": { - "_media-type": "application/vnd.ibexa.api.AttributeGroup+json", - "name": "Attribute Group Test", - "identifier": "attr_group_test", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The AttributeGroup schema encoded in XML or JSON format.", - "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": "ibexa.product_catalog.rest.attribute_groups.translation.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 - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - } - }, - "/product/catalog/attribute_groups/view": { - "post": { - "operationId": "ibexa.product_catalog.rest.attribute_groups.view", - "tags": [ - "Product Attribute Group" - ], - "responses": { - "200": { - "description": "The view in XML or JSON format.", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The view input in XML or JSON format.", - "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": "ibexa.product_catalog.rest.attribute_groups.get", - "tags": [ - "Product Attribute Group" - ], - "responses": { - "200": { - "description": "AttributeGroupGet - If set, the attribute group List is returned in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.AttributeGroup+json": { - "schema": { - "$ref": "#/components/schemas/AttributeGroupWrapper" - }, - "example": { - "AttributeGroup": { - "_media-type": "application/vnd.ibexa.api.AttributeGroup+json", - "name": "Attribute Group Test", - "identifier": "attr_group_test", - "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": "id", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "An optional AttributeGroupGet schema encoded in XML or JSON format.", - "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": "ibexa.product_catalog.rest.attribute_groups.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 - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "patch": { - "operationId": "ibexa.product_catalog.rest.attribute_groups.update", - "tags": [ - "Product Attribute Group" - ], - "responses": { - "201": { - "description": "If set, the updated attribute group is returned in XML or JSON format.", - "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": "id", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The attribute group update schema is sent in XML or JSON format.", - "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": "ibexa.product_catalog.rest.attribute_types", - "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": [], - "deprecated": false - } - }, - "/product/catalog/attribute_types/{identifier}": { - "get": { - "operationId": "ibexa.product_catalog.rest.attribute_type", - "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": "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": "ibexa.product_catalog.rest.catalogs.create", - "tags": [ - "Product Catalog" - ], - "responses": { - "201": { - "description": "If set, the new catalog is returned in XML or JSON format.", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The catalog schema encoded in XML or JSON format.", - "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": "ibexa.product_catalog.rest.catalogs.copy", - "tags": [ - "Product Catalog" - ], - "responses": { - "201": { - "description": "If set, the copied catalog is returned in XML or JSON format.", - "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": "identifier", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "If set, the copied catalog is returned in XML or JSON format.", - "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": "ibexa.product_catalog.rest.catalog.filters", - "tags": [ - "Product Catalog" - ], - "responses": { - "200": { - "description": "If set, the filters are returned in XML or JSON format.", - "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": [], - "deprecated": false - } - }, - "/product/catalog/catalogs/sort_clauses": { - "get": { - "operationId": "ibexa.product_catalog.rest.catalog.sort_clauses", - "tags": [ - "Product Catalog" - ], - "responses": { - "200": { - "description": "If set, the clauses are returned in XML or JSON format.", - "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": [], - "deprecated": false - } - }, - "/product/catalog/catalogs/view": { - "post": { - "operationId": "ibexa.product_catalog.rest.catalogs.view", - "tags": [ - "Product Catalog" - ], - "responses": { - "200": { - "description": "The view in XML or JSON format.", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The view input in XML or JSON format.", - "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": "ibexa.product_catalog.rest.catalogs.get", - "tags": [ - "Product Catalog" - ], - "responses": { - "200": { - "description": "If set, the catalog is returned in XML or JSON format.", - "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", - "name": "Snow Equipment", - "description": "", - "User": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "created": 1666090438, - "modified": 1666090438, - "status": "draft", - "Criteria": [ - { - "_media-type": "application/vnd.ibexa.api.ProductCode+json", - "ProductCodeCriterion": { - "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json", - "codes": [ - "ski", - "snowboard" - ] - } - }, - { - "_media-type": "application/vnd.ibexa.api.ProductAvailability+json", - "ProductAvailabilityCriterion": { - "_media-type": "application/vnd.ibexa.api.ProductAvailabilityCriterion+json", - "is_available": true - } - }, - { - "_media-type": "application/vnd.ibexa.api.ColorAttribute+json", - "ColorAttributeCriterion": { - "_media-type": "application/vnd.ibexa.api.ColorAttributeCriterion+json", - "identifier": "color", - "value": [ - "#000000", - "#FFFFFF" - ] - } - }, - { - "_media-type": "application/vnd.ibexa.api.CreatedAt+json", - "CreatedAtCriterion": { - "_media-type": "application/vnd.ibexa.api.CreatedAtCriterion+json", - "created_at": { - "date": "2022-09-12 00:00:00.000000", - "timezone_type": 3, - "timezone": "Europe/Warsaw" - }, - "operator": ">=" - } - }, - { - "_media-type": "application/vnd.ibexa.api.FloatAttribute+json", - "FloatAttributeCriterion": { - "_media-type": "application/vnd.ibexa.api.FloatAttributeCriterion+json", - "identifier": "width", - "value": 16.6 - } - }, - { - "_media-type": "application/vnd.ibexa.api.IntegerAttributeRange+json", - "IntegerAttributeRangeCriterion": { - "_media-type": "application/vnd.ibexa.api.IntegerAttributeRangeCriterion+json", - "identifier": "length", - "min": 180, - "max": 230 - } - } - ] - } - } - }, - "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": "identifier", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "delete": { - "operationId": "ibexa.product_catalog.rest.catalogs.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 - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "patch": { - "operationId": "ibexa.product_catalog.rest.catalogs.update", - "tags": [ - "Product Catalog" - ], - "responses": { - "201": { - "description": "If set, the updated catalog is returned in XML or JSON format.", - "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_updated", - "name": "Snow Equipment updated", - "description": "Snow Equipment catalog for 2022", - "User": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "created": 1666090438, - "modified": 1666091260, - "status": "published", - "Criteria": [ - { - "_media-type": "application/vnd.ibexa.api.ProductCode+json", - "ProductCodeCriterion": { - "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json", - "codes": [ - "ski" - ] - } - }, - { - "_media-type": "application/vnd.ibexa.api.ProductAvailability+json", - "ProductAvailabilityCriterion": { - "_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": "identifier", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "If set, the updated catalog is returned in XML or JSON format.", - "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": "ibexa.product_catalog.rest.catalogs.products.view", - "tags": [ - "Product Catalog" - ], - "responses": { - "200": { - "description": "The view in XML or JSON format.", - "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": 1, - "ProductList": { - "_media-type": "application/vnd.ibexa.api.ProductList+json", - "Product": [ - { - "_media-type": "application/vnd.ibexa.api.Product+json", - "code": "test", - "name": "test", - "ProductType": { - "_media-type": "application/vnd.ibexa.api.ProductType+json", - "identifier": "quickdraw", - "name": "Quickdraw", - "AttributeAssignmentList": [] - }, - "Content": { - "_media-type": "application/vnd.ibexa.api.Content+json", - "_href": "/api/ibexa/v2/content/objects/187", - "_remoteId": "b0608be4ef4dc978ad603d02ac3c9ad1", - "_id": 187, - "ContentType": { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/55" - }, - "Name": "test", - "TranslatedName": "test", - "Versions": { - "_media-type": "application/vnd.ibexa.api.VersionList+json", - "_href": "/api/ibexa/v2/content/objects/187/versions" - }, - "CurrentVersion": { - "_media-type": "application/vnd.ibexa.api.Version+json", - "_href": "/api/ibexa/v2/content/objects/187/currentversion", - "Version": { - "_media-type": "application/vnd.ibexa.api.Version+json", - "_href": "/api/ibexa/v2/content/objects/187/versions/1", - "VersionInfo": { - "id": 665, - "versionNo": 1, - "status": "PUBLISHED", - "modificationDate": "2022-08-26T11:16:49+02:00", - "Creator": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "creationDate": "2022-08-26T11:16: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": "test" - } - ] - }, - "Content": { - "_media-type": "application/vnd.ibexa.api.ContentInfo+json", - "_href": "/api/ibexa/v2/content/objects/187" - } - }, - "Fields": { - "field": [ - { - "id": 915, - "fieldDefinitionIdentifier": "name", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_string", - "fieldValue": "test" - }, - { - "id": 916, - "fieldDefinitionIdentifier": "product_specification", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_product_specification", - "fieldValue": { - "id": 60, - "code": "test", - "attributes": [] - } - }, - { - "id": 917, - "fieldDefinitionIdentifier": "description", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_richtext", - "fieldValue": { - "xml": "\n
\n", - "xhtml5edit": "\n
\n" - } - }, - { - "id": 918, - "fieldDefinitionIdentifier": "image", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_image_asset", - "fieldValue": { - "destinationContentId": null, - "alternativeText": null, - "source": null - } - }, - { - "id": 919, - "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/187/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/187/locations" - }, - "Owner": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "lastModificationDate": "2022-08-26T11:16:49+02:00", - "publishedDate": "2022-08-26T11:16:49+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/187/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": 1661505409, - "updated_at": 1661505409, - "AttributesList": [] - } - ] - } - } - } - } - }, - "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": "identifier", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The view input in XML or JSON format.", - "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": "ibexa.product_catalog.rest.currencies", - "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": [], - "deprecated": false - }, - "post": { - "operationId": "ibexa.product_catalog.rest.currencies.create", - "tags": [ - "Product Currency" - ], - "responses": { - "200": { - "description": "If set, the new currency is returned in JSON format.", - "content": { - "application/vnd.ibexa.api.Currency+json": { - "schema": { - "$ref": "#/components/schemas/CurrencyWrapper" - }, - "example": { - "Currency": { - "_media-type": "application/vnd.ibexa.api.Currency+json", - "id": 181, - "code": "cur", - "subunits": 1, - "enabled": true - } - } - } - } - }, - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The Currency schema encoded in XML or JSON format.", - "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": "ibexa.product_catalog.rest.currencies.view", - "tags": [ - "Product Currency" - ], - "responses": { - "200": { - "description": "The view in XML or JSON format.", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The view input in XML or JSON format.", - "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": "ibexa.product_catalog.rest.currencies.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": 3, - "code": "ALL", - "subunits": 2, - "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": "id", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "delete": { - "operationId": "ibexa.product_catalog.rest.currencies.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 - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "patch": { - "operationId": "ibexa.product_catalog.rest.currencies.update", - "tags": [ - "Product Currency" - ], - "responses": { - "200": { - "description": "If set, the updated currency is returned in XML or JSON format.", - "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": "id", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The CurrencyUpdate schema encoded in XML or JSON format.", - "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": "ibexa.product_catalog.rest.customer_groups.list", - "tags": [ - "Product Customer Group" - ], - "responses": { - "200": { - "description": "If set, the customer groups list is returned in XML or JSON format.", - "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": [], - "deprecated": false - }, - "post": { - "operationId": "ibexa.product_catalog.rest.customer_group.create", - "tags": [ - "Product Customer Group" - ], - "responses": { - "201": { - "description": "If set, the new customer group is returned in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.CustomerGroup+json": { - "schema": { - "$ref": "#/components/schemas/CustomerGroupWrapper" - }, - "example": { - "CustomerGroup": { - "_media-type": "application/vnd.ibexa.api.CustomerGroup+json", - "id": 5, - "name": "test-en", - "identifier": "test", - "description": "test-desc-en", - "users": [], - "global_price_rate": "1.00" - } - } - } - } - }, - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The CustomerGroupCreate schema encoded in XML or JSON format.", - "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": "ibexa.product_catalog.rest.customer_groups.view", - "tags": [ - "Product Customer Group" - ], - "responses": { - "200": { - "description": "The view in XML or JSON format.", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The view input in XML or JSON format.", - "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": "ibexa.product_catalog.rest.customer_groups.identifier", - "tags": [ - "Product Customer Group" - ], - "responses": { - "200": { - "description": "If set, the customer group is returned in XML or JSON format.", - "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": "Resellers", - "identifier": "resellers", - "description": "", - "users": [], - "global_price_rate": "0.00" - } - } - } - } - }, - "401": { - "description": "Error - the user has no permission to read customer groups." - } - }, - "summary": "Load customer group", - "description": "Returns a 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 - }, - "delete": { - "operationId": "ibexa.product_catalog.rest.customer_groups.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 - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "patch": { - "operationId": "ibexa.product_catalog.rest.customer_group.update", - "tags": [ - "Product Customer Group" - ], - "responses": { - "201": { - "description": "If set, the updated customer group is returned in XML or JSON format.", - "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": "identifier", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The CustomerGroupUpdate schema encoded in XML or JSON format.", - "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": "ibexa.product_catalog.rest.customer_group", - "tags": [ - "Product Customer Group" - ], - "responses": { - "200": { - "description": "If set, the customer group is returned in XML or JSON format.", - "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": "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": "ibexa.product_catalog.rest.regions", - "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": [], - "deprecated": false - } - }, - "/product/catalog/regions/view": { - "post": { - "operationId": "ibexa.product_catalog.rest.regions.view", - "tags": [ - "Product Region" - ], - "responses": { - "200": { - "description": "The view in XML or JSON format.", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The view input in XML or JSON format.", - "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": "ibexa.product_catalog.rest.region", - "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": "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": "ibexa.product_catalog.rest.product_types", - "tags": [ - "Product Type" - ], - "responses": { - "200": { - "description": "ProductTypeList - If set, the product type list is returned in XML or JSON format.", - "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": [], - "requestBody": { - "description": "The ProductTypeList schema encoded in XML or JSON format.", - "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": "ibexa.product_catalog.rest.product_types.create", - "tags": [ - "Product Type" - ], - "responses": { - "201": { - "description": "If set, the new product type is returned in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.ProductType+json": { - "schema": { - "$ref": "#/components/schemas/ProductTypeWrapper" - }, - "example": { - "ProductType": { - "_media-type": "application/vnd.ibexa.api.ProductType+json", - "identifier": "test_pt321", - "name": "New Product Type", - "AttributeAssignmentList": [ - { - "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", - "is_required": false, - "is_discriminator": true, - "Attribute": { - "_media-type": "application/vnd.ibexa.api.Attribute+json", - "identifier": "testAttr", - "name": "testAttr", - "description": "", - "type": "Checkbox", - "type_identifier": "checkbox", - "value": true, - "group": "Test Attribute group", - "position": 0, - "options": [] - } - } - ] - } - } - } - } - }, - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The ProductType schema encoded in XML or JSON format.", - "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": "ibexa.product_catalog.rest.product_types.is_used", - "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" - }, - "example": "\n\n 1\n\n" - } - } - }, - "404": { - "description": "Error - product type not found." - } - }, - "summary": "Check product type usage", - "description": "Checks whether the product type is in use.", - "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/product_types/view": { - "post": { - "operationId": "ibexa.product_catalog.rest.product_types.view", - "tags": [ - "Product Type" - ], - "responses": { - "200": { - "description": "The view in XML or JSON format.", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The view input in XML or JSON format.", - "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": "ibexa.product_catalog.rest.product_type", - "tags": [ - "Product Type" - ], - "responses": { - "200": { - "description": "OK - load the product type", - "content": { - "application/vnd.ibexa.api.ProductType+json": { - "schema": { - "$ref": "#/components/schemas/ProductTypeWrapper" - }, - "example": { - "ProductType": { - "_media-type": "application/vnd.ibexa.api.ProductType+json", - "identifier": "d_rope", - "name": "Dynamic ropes", - "AttributeAssignmentList": [] - } - } - }, - "application/vnd.ibexa.api.ProductType+xml": { - "schema": { - "$ref": "#/components/schemas/ProductType" - } - } - } - }, - "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": "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": "ibexa.product_catalog.rest.product_types.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 - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "patch": { - "operationId": "ibexa.product_catalog.rest.product_types.update", - "tags": [ - "Product Type" - ], - "responses": { - "201": { - "description": "If set, the updated product type is returned in XML or JSON format.", - "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": "id", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "If set, the updated product type is returned in XML or JSON format.", - "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": "ibexa.product_catalog.rest.product_variant", - "tags": [ - "Product Variant" - ], - "responses": { - "200": { - "description": "OK - loads the product variant.", - "content": { - "application/vnd.ibexa.api.ProductVariant+json": { - "schema": { - "$ref": "#/components/schemas/ProductVariantWrapper" - }, - "example": { - "ProductVariant": { - "_media-type": "application/vnd.ibexa.api.ProductVariant+json", - "code": "macbook", - "name": "Macbook Air 32/232", - "Product": { - "_media-type": "application/vnd.ibexa.api.Product+json", - "code": "mac_air", - "name": "Macbook Air", - "ProductType": { - "_media-type": "application/vnd.ibexa.api.ProductType+json", - "identifier": "laptop", - "name": "Laptop", - "AttributeAssignmentList": [ - { - "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", - "is_required": false, - "is_discriminator": true, - "Attribute": { - "_media-type": "application/vnd.ibexa.api.Attribute+json", - "identifier": "number", - "name": "number", - "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" - } - }, + "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": [ { - "id": 719, - "fieldDefinitionIdentifier": "image", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_image_asset", - "fieldValue": { - "destinationContentId": null, - "alternativeText": null, - "source": 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": "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 } }, { - "id": 720, - "fieldDefinitionIdentifier": "category", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", - "fieldValue": { - "taxonomy_entries": [], - "taxonomy": 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 } } ] }, - "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 - } - } - ] - } - } - } - } - }, - "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": "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": "ibexa.product_catalog.rest.product_variants.generate", - "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": "baseProductCode", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The product variant schema encoded in XML or JSON format.", - "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": "ibexa.product_catalog.rest.product_variants.view", - "tags": [ - "Product Variant" - ], - "responses": { - "200": { - "description": "The view in XML or JSON format.", - "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/67", + "_remoteId": "c5c22c68912af81992b74851f158db4a", + "_id": 67, + "ContentType": { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/53" }, - "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 - } - }, + "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": [ { - "id": 720, - "fieldDefinitionIdentifier": "category", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", - "fieldValue": { - "taxonomy_entries": [], - "taxonomy": null - } + "languageCode": "eng-GB" } ] }, - "Relations": { - "_media-type": "application/vnd.ibexa.api.RelationList+json", - "_href": "/api/ibexa/v2/content/objects/152/versions/1/relations", - "Relation": [] + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Other Office Desk" + } + ] }, - "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" + "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/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" + "Section": { + "_media-type": "application/vnd.ibexa.api.Section+json", + "_href": "/api/ibexa/v2/content/sections/1" }, - "created_at": 1658409438, - "updated_at": 1658409438, - "AttributesList": [] + "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" + } }, - "DiscriminatorAttributesList": [ + "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": "number", - "name": "number", + "identifier": "color", + "name": "Color", "description": "", - "type": "Float", - "type_identifier": "float", - "value": 1.5, - "group": "test", + "type": "Selection", + "type_identifier": "selection", + "group": "Desk", "position": 0, "options": { - "min": 4, - "max": 5 - } + "choices": [ + { + "label": { + "eng-GB": "Black" + }, + "value": "black" + }, + { + "label": { + "eng-GB": "White" + }, + "value": "white" + } + ] + }, + "value": "white" }, { "_media-type": "application/vnd.ibexa.api.Attribute+json", - "identifier": "testattr", - "name": "testAttr", + "identifier": "width", + "name": "Width", "description": "", - "type": "Integer", - "type_identifier": "integer", - "value": 5, - "group": "test", + "type": "Measurement (single)", + "type_identifier": "measurement_single", + "group": "Desk", "position": 0, "options": { - "min": 4, - "max": 5 - } + "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.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 - } - } + "_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 } - ] - }, - "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.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/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" - } + "_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" }, - "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" - } - }, + "creationDate": "2023-04-12T14:06:14+00:00", + "initialLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "VersionTranslationInfo": { + "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", + "Language": [ { - "id": 719, - "fieldDefinitionIdentifier": "image", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_image_asset", - "fieldValue": { - "destinationContentId": null, - "alternativeText": null, - "source": null - } - }, + "languageCode": "eng-GB" + } + ] + }, + "names": { + "value": [ { - "id": 720, - "fieldDefinitionIdentifier": "category", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", - "fieldValue": { - "taxonomy_entries": [], - "taxonomy": null - } + "_languageCode": "eng-GB", + "#text": "Ergo Office Desk" } ] }, - "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" + "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/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" + "Section": { + "_media-type": "application/vnd.ibexa.api.Section+json", + "_href": "/api/ibexa/v2/content/sections/1" }, - "created_at": 1658409438, - "updated_at": 1658409438, - "AttributesList": [] + "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" + } }, - "DiscriminatorAttributesList": [ + "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": "number", - "name": "number", + "identifier": "color", + "name": "Color", "description": "", - "type": "Float", - "type_identifier": "float", - "value": 1.5, - "group": "test", + "type": "Selection", + "type_identifier": "selection", + "group": "Desk", "position": 0, "options": { - "min": 4, - "max": 5 - } + "choices": [ + { + "label": { + "eng-GB": "Black" + }, + "value": "black" + }, + { + "label": { + "eng-GB": "White" + }, + "value": "white" + } + ] + }, + "value": "black" }, { "_media-type": "application/vnd.ibexa.api.Attribute+json", - "identifier": "testattr", - "name": "testAttr", + "identifier": "width", + "name": "Width", "description": "", - "type": "Integer", - "type_identifier": "integer", - "value": 5, - "group": "test", + "type": "Measurement (single)", + "type_identifier": "measurement_single", + "group": "Desk", "position": 0, "options": { - "min": 4, - "max": 5 - } + "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.ProductVariantView+xml": { + "application/vnd.ibexa.api.ProductView+xml": { "schema": { - "$ref": "#/components/schemas/ProductVariantView" + "$ref": "#/components/schemas/ProductView" } } } }, "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", + "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": "baseProductCode", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, { "name": "X-CSRF-Token", "in": "header", "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { "description": "The view input in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ProductVariantViewInput+json": { + "application/vnd.ibexa.api.ProductViewInput+json": { "schema": { - "$ref": "#/components/schemas/ProductVariantViewInputWrapper" + "$ref": "#/components/schemas/ProductViewInputWrapper" }, "example": { "ViewInput": { "identifier": "TitleView", - "ProductVariantQuery": { + "ProductQuery": { + "limit": "10", "offset": "0", - "limit": "10" + "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.ProductVariantViewInput+xml": { + "application/vnd.ibexa.api.ProductViewInput+xml": { "schema": { - "$ref": "#/components/schemas/ProductVariantViewInput" + "$ref": "#/components/schemas/ProductViewInput" + } + } + }, + "required": false + } + } + }, + "/product/catalog/products/{code}": { + "get": { + "operationId": "ibexa.product_catalog.rest.product", + "tags": [ + "Product" + ], + "responses": { + "200": { + "description": "If set, the products are returned in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.Product+json": { + "schema": { + "$ref": "#/components/schemas/ProductWrapper" + }, + "example": { + "Product": { + "_media-type": "application/vnd.ibexa.api.Product+json", + "code": "DRESUN", + "name": "Yellow sundress", + "ProductType": { + "_media-type": "application/vnd.ibexa.api.ProductType+json", + "identifier": "dress", + "name": "Dress", + "AttributeAssignmentList": [ + { + "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", + "is_required": false, + "is_discriminator": false, + "Attribute": { + "_media-type": "application/vnd.ibexa.api.Attribute+json", + "identifier": "size", + "name": "Size", + "description": "", + "type": "Integer", + "type_identifier": "integer", + "value": 5, + "group": "Hat", + "position": 0, + "options": [] + } + } + ] + }, + "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": "Yellow sundress", + "TranslatedName": "Yellow sundress", + "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": "Yellow sundress" + } + ] + }, + "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": "Yellow sundress" + }, + { + "id": 613, + "fieldDefinitionIdentifier": "product_specification", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_product_specification", + "fieldValue": { + "id": 25, + "code": "DRESUN", + "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": 1647006758, + "updated_at": 1647006758, + "AttributesList": [ + { + "_media-type": "application/vnd.ibexa.api.Attribute+json", + "identifier": "size", + "name": "Size", + "description": "", + "type": "Integer", + "type_identifier": "integer", + "value": 5, + "group": "Clothes", + "position": 0, + "options": [] + } + ] + } + } } } }, - "required": false - }, - "deprecated": false - } - }, - "/product/catalog/product_variants/{baseProductCode}": { - "post": { - "operationId": "ibexa.product_catalog.rest.product_variants.create", - "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." + "description": "Error - the user is not authorized to view this product." }, "404": { - "description": "Error - no base product with the given code exists." + "description": "Error - no product with the given code exists." } }, - "summary": "Create product variant", - "description": "Creates a new product variant.", + "summary": "Load the given product", + "description": "Loads the given product.", "parameters": [ { - "name": "baseProductCode", + "name": "code", "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", + "description": "ProductLoadByCodeController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "The product variant schema encoded in XML or JSON format.", + "description": "An optional product schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ProductVariantCreate+json": { + "application/vnd.ibexa.api.ProductGet+json": { "schema": { - "$ref": "#/components/schemas/ProductVariantCreateWrapper" + "$ref": "#/components/schemas/ProductGetWrapper" }, "example": { - "ProductVariantCreate": { - "attributes": { - "width": 100, - "height": 50, - "color": "#000000" - }, - "code": "macbook_pro" + "ProductGet": { + "languages": [ + "eng-GB" + ] } } } }, "required": false - }, - "deprecated": false - } - }, - "/product/catalog/product_variants/{code}": { - "delete": { - "operationId": "ibexa.product_catalog.rest.product_variants.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 - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false + } }, "patch": { - "operationId": "ibexa.product_catalog.rest.product_variants.update", + "operationId": "ibexa.product_catalog.rest.products.update", "tags": [ - "Product Variant" + "Product" ], "responses": { "201": { - "description": "If set, the updated product variant is returned in XML or JSON format.", + "description": "If set, the updated product is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ProductVariant+json": { + "application/vnd.ibexa.api.Product+json": { "schema": { - "$ref": "#/components/schemas/ProductVariantWrapper" + "$ref": "#/components/schemas/ProductWrapper" }, "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 - } - } + "Product": { + "_media-type": "application/vnd.ibexa.api.Product+json", + "code": "bbbb", + "name": "fgh", + "ProductType": { + "_media-type": "application/vnd.ibexa.api.ProductType+json", + "identifier": "test_pt321", + "name": "New Product Type", + "AttributeAssignmentList": [ + { + "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", + "is_required": false, + "is_discriminator": true, + "Attribute": { + "_media-type": "application/vnd.ibexa.api.Attribute+json", + "identifier": "testAttr", + "name": "testAttr", + "description": "", + "type": "Checkbox", + "type_identifier": "checkbox", + "value": true, + "group": "Test Attribute group", + "position": 0, + "options": [] } - ] + } + ] + }, + "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" }, - "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": { + "Name": "fgh", + "TranslatedName": "fgh", + "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/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" - } + "_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" }, - "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 - } - }, + "creationDate": "2022-05-27T09:29:33+00:00", + "initialLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "VersionTranslationInfo": { + "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", + "Language": [ { - "id": 720, - "fieldDefinitionIdentifier": "category", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", - "fieldValue": { - "taxonomy_entries": [], - "taxonomy": null - } + "languageCode": "eng-GB" } ] }, - "Relations": { - "_media-type": "application/vnd.ibexa.api.RelationList+json", - "_href": "/api/ibexa/v2/content/objects/152/versions/1/relations", - "Relation": [] + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "fgh" + } + ] }, - "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" + "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": "fgh" + }, + { + "id": 613, + "fieldDefinitionIdentifier": "product_specification", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_product_specification", + "fieldValue": { + "id": 25, + "code": "bbbb", + "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/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" + "Section": { + "_media-type": "application/vnd.ibexa.api.Section+json", + "_href": "/api/ibexa/v2/content/sections/1" }, - "created_at": 1658409438, - "updated_at": 1658409438, - "AttributesList": [] + "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" + } }, - "DiscriminatorAttributesList": [] + "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": 1646398748, + "updated_at": 1646398748, + "AttributesList": [ + { + "_media-type": "application/vnd.ibexa.api.Attribute+json", + "identifier": "testAttr", + "name": "testAttr", + "description": "", + "type": "Checkbox", + "type_identifier": "checkbox", + "value": true, + "group": "Test Attribute group", + "position": 0, + "options": [] + }, + { + "_media-type": "application/vnd.ibexa.api.Attribute+json", + "identifier": "nnnn", + "name": "nnnn", + "description": "", + "type": "Checkbox", + "type_identifier": "checkbox", + "value": true, + "group": "Test Attribute group", + "position": 0, + "options": [] + } + ] } } } @@ -23725,31 +8885,29 @@ "description": "Error - the input does not match the input schema definition." }, "401": { - "description": "Error - the user is not authorized to update this product variant." + "description": "Error - the user is not authorized to update this product." }, "403": { - "description": "Error - a product variant with the same code already exists." + "description": "Error - a product with the same code already exists." }, "404": { - "description": "Error - no product variant with the given code exists." + "description": "Error - no product with the given code exists." } }, - "summary": "Update product variant", - "description": "Updates product variant.", + "summary": "Update product", + "description": "Updates product.", "parameters": [ { "name": "code", "in": "path", - "description": "", + "description": "ProductUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "X-CSRF-Token", @@ -23757,499 +8915,810 @@ "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "The product variant update schema encoded in XML or JSON format.", + "description": "If set, the updated product is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ProductVariantUpdate+json": { + "application/vnd.ibexa.api.ProductUpdate+json": { "schema": { - "$ref": "#/components/schemas/ProductVariantUpdateWrapper" + "$ref": "#/components/schemas/ProductUpdateWrapper" }, "example": { - "ProductVariantUpdate": { - "code": "test", - "attributes": { - "number": 2, - "testattr": 10 - } + "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/vat/{region}": { + "/product/catalog/products/{code}/prices": { "get": { - "operationId": "ibexa.product_catalog.rest.vat.list", + "operationId": "ibexa.product_catalog.rest.prices.list", "tags": [ - "Product Vat" + "Product" ], "responses": { "200": { - "description": "OK - loads the VAT category list.", + "description": "OK - loads the list of product prices.", "content": { - "application/vnd.ibexa.api.VatCategoryList+json": { + "application/vnd.ibexa.api.PriceList+json": { "schema": { - "$ref": "#/components/schemas/VatCategoryListWrapper" + "$ref": "#/components/schemas/PriceListWrapper" }, "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 - }, + "PriceList": { + "_media-type": "application/vnd.ibexa.api.PriceList+json", + "prices": [ { - "_media-type": "application/vnd.ibexa.api.VatCategory+json", - "identifier": "reduced", - "region": "region_1", - "vatValue": 6 + "_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.VatCategory+json", - "identifier": "none", - "region": "region_1", - "vatValue": null + "_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 is not authorized to read this object." - }, - "404": { - "description": "Error - the VAT category region does not exist." + "description": "Error - the user has no permission to read prices." } }, - "summary": "Load VAT region", - "description": "Loads a VAT category for the given region.", + "summary": "Load the list of product prices", + "description": "Loads the list of product prices.", "parameters": [ { - "name": "region", + "name": "code", "in": "path", - "description": "", + "description": "PriceLoadAllController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false - } - }, - "/product/catalog/vat/{region}/{identifier}": { - "get": { - "operationId": "ibexa.product_catalog.rest.vat", + ] + }, + "post": { + "operationId": "ibexa.product_catalog.rest.prices.create", "tags": [ - "Product Vat" + "Product" ], "responses": { "200": { - "description": "OK - loads the VAT category.", + "description": "OK - creates product price.", "content": { - "application/vnd.ibexa.api.VatCategory+json": { + "application/vnd.ibexa.api.CustomPrice+json": { "schema": { - "$ref": "#/components/schemas/VatCategoryWrapper" + "$ref": "#/components/schemas/CustomPriceWrapper" }, "example": { - "VatCategory": { - "_media-type": "application/vnd.ibexa.api.VatCategory+json", - "identifier": "standard", - "region": "region_1", - "vatValue": 18 + "CustomPrice": { + "_media-type": "application/vnd.ibexa.api.CustomPrice+json", + "id": 5, + "amount": "15.00", + "base_amount": "25.00", + "Currency": { + "_media-type": "application/vnd.ibexa.api.Currency+json", + "id": 2, + "code": "EUR", + "subunits": 2, + "enabled": true + }, + "money": "1500", + "base_money": "2500", + "custom_money": "1500", + "custom_amount": "15.00" + } + } + }, + "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 is not authorized to read this object." + "400": { + "description": "Error - the input does not match the input schema definition." }, - "404": { - "description": "Error - the VAT category for the given identifier not exists." + "401": { + "description": "Error - the user is not authorized to create this price." } }, - "summary": "Load VAT specific region", - "description": "Loads a VAT category for the given identifier.", + "summary": "Create product price or custom price", + "description": "Create product price or custom price.", "parameters": [ { - "name": "region", + "name": "code", "in": "path", - "description": "", + "description": "PriceCreateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "identifier", - "in": "path", - "description": "", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], - "deprecated": false + "requestBody": { + "description": "The product price schema encoded in JSON format.", + "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 + } } }, - "/content/sections": { + "/product/catalog/products/{code}/prices/{currencyCode}": { "get": { - "operationId": "ibexa.rest.list_sections", + "operationId": "ibexa.product_catalog.rest.prices.get.base_price", "tags": [ - "Section" + "Product" ], "responses": { "200": { - "description": "If set, the Section list is returned in XML or JSON format.", + "description": "OK - gets price in given currency.", "content": { - "application/vnd.ibexa.api.SectionList+json": { + "application/vnd.ibexa.api.Price+json": { "schema": { - "$ref": "#/components/schemas/SectionListWrapper" + "$ref": "#/components/schemas/PriceWrapper" }, "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" - } - ] + "Price": { + "_media-type": "application/vnd.ibexa.api.Price+json", + "id": 1, + "amount": "12.00", + "base_amount": "12.00", + "Currency": { + "_media-type": "application/vnd.ibexa.api.Currency+json", + "id": 2, + "code": "EUR", + "subunits": 2, + "enabled": true + }, + "money": "1200", + "base_money": "1200" } } - }, - "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." + "description": "Error - the user has no permission to read prices." + }, + "404": { + "description": "Error - the price does not exist." } }, - "summary": "Get Sections", - "description": "Returns a list of all Sections.", + "summary": "Get price in given currency", + "description": "Get price in given currency.", "parameters": [ { - "name": "If-None-Match", - "in": "header", - "description": "ETag", - "required": false, + "name": "code", + "in": "path", + "description": "PriceLoadByProductCodeController identifier", + "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + }, + { + "name": "currencyCode", + "in": "path", + "description": "PriceLoadByProductCodeController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } - ], - "deprecated": false - }, - "post": { - "operationId": "ibexa.rest.create_section", + ] + } + }, + "/product/catalog/products/{code}/prices/{currencyCode}/customer-group/{customerGroupIdentifier}": { + "get": { + "operationId": "ibexa.product_catalog.rest.prices.get.custom_price", "tags": [ - "Section" + "Product" ], "responses": { - "201": { - "description": "If set, the new Section is returned in XML or JSON format.", + "200": { + "description": "OK - gets price in given currency and customer group.", "content": { - "application/vnd.ibexa.api.Section+json": { + "application/vnd.ibexa.api.CustomPrice+json": { "schema": { - "$ref": "#/components/schemas/SectionWrapper" + "$ref": "#/components/schemas/CustomPriceWrapper" }, "example": { - "Section": { - "_media-type": "application/vnd.ibexa.api.Section+json", - "_href": "/api/ibexa/v2/content/sections/13", - "sectionId": 13, - "identifier": "restricted", - "name": "Restricted" + "CustomPrice": { + "_media-type": "application/vnd.ibexa.api.CustomPrice+json", + "id": 3, + "amount": "11.50", + "base_amount": "10.00", + "Currency": { + "_media-type": "application/vnd.ibexa.api.Currency+json", + "id": 5, + "code": "USD", + "subunits": 2, + "enabled": true + }, + "money": "1150", + "base_money": "1000", + "custom_money": "1150", + "custom_amount": "11.50", + "custom_rule": "15.00" } } - }, - "application/vnd.ibexa.api.Section+xml": { - "schema": { - "$ref": "#/components/schemas/Section" - }, - "example": "\n
\n 7\n restricted\n Restricted\n
\n" } } + }, + "401": { + "description": "Error - the user has no permission to read prices." + }, + "404": { + "description": "Error - the price does not exist." } }, - "summary": "Create new Section", - "description": "Creates a new Section.", + "summary": "Get price in given currency and customer group", + "description": "Get price in given currency and customer group.", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "name": "code", + "in": "path", + "description": "PriceLoadByProductCodeController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The Section input schema encoded in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.SectionInput+json": { - "schema": { - "$ref": "#/components/schemas/SectionInputWrapper" - }, - "example": { - "SectionInput": { - "identifier": "restricted", - "name": "Restricted" - } - } + "explode": false + }, + { + "name": "currencyCode", + "in": "path", + "description": "PriceLoadByProductCodeController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" }, - "application/vnd.ibexa.api.SectionInput+xml": { - "schema": { - "$ref": "#/components/schemas/SectionInput" - }, - "example": "\n\n restricted\n Restricted\n" - } + "style": "simple", + "explode": false }, - "required": false - }, - "deprecated": false + { + "name": "customerGroupIdentifier", + "in": "path", + "description": "PriceLoadByProductCodeController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] } }, - "/content/sections/{sectionId}": { - "get": { - "operationId": "ibexa.rest.load_section", + "/product/catalog/products/{code}/prices/{id}": { + "delete": { + "operationId": "ibexa.product_catalog.rest.prices.delete", "tags": [ - "Section" + "Product" ], "responses": { "200": { - "description": "If set, the Section is returned in XML or JSON format.", + "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": "code", + "in": "path", + "description": "PriceDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "id", + "in": "path", + "description": "PriceDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + }, + "patch": { + "operationId": "ibexa.product_catalog.rest.prices.update", + "tags": [ + "Product" + ], + "responses": { + "200": { + "description": "OK - updates product price.", "content": { - "application/vnd.ibexa.api.Section+json": { + "application/vnd.ibexa.api.CustomPrice+json": { "schema": { - "$ref": "#/components/schemas/SectionWrapper" + "$ref": "#/components/schemas/CustomPriceWrapper" }, "example": { - "Section": { - "_media-type": "application/vnd.ibexa.api.Section+json", - "_href": "/api/ibexa/v2/content/sections/10", - "sectionId": 10, - "identifier": "design", - "name": "Design" + "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.Section+xml": { + "application/vnd.ibexa.api.Price+json": { "schema": { - "$ref": "#/components/schemas/Section" + "$ref": "#/components/schemas/PriceWrapper" }, - "example": "\n
\n 10\n design\n Design\n
\n" + "example": { + "Price": { + "_media-type": "application/vnd.ibexa.api.Price+json", + "id": 2, + "amount": "35.00", + "base_amount": "35.00", + "Currency": { + "_media-type": "application/vnd.ibexa.api.Currency+json", + "id": 5, + "code": "USD", + "subunits": 2, + "enabled": true + }, + "money": "3500", + "base_money": "3500" + } + } } } }, - "401": { - "description": "Error - The user is not authorized to read this Section." + "400": { + "description": "Error - the input does not match the input schema definition." }, - "404": { - "description": "Error - The Section does not exist." + "401": { + "description": "Error - the user is not authorized to update this price." } }, - "summary": "Get Section", - "description": "Returns the Section by given Section ID.", + "summary": "Update product price", + "description": "Updates product price.", "parameters": [ { - "name": "If-None-match", - "in": "header", - "description": "ETag", - "required": false, + "name": "code", + "in": "path", + "description": "PriceUpdateController identifier", + "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "sectionId", + "name": "id", "in": "path", - "description": "", + "description": "PriceUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + }, + { + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ], - "deprecated": false - }, + "requestBody": { + "description": "Update price or custom price for given currency.", + "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 + } + } + }, + "/product/catalog/products/{identifier}": { "delete": { - "operationId": "ibexa.rest.delete_section", + "operationId": "ibexa.product_catalog.rest.products.delete", "tags": [ - "Section" + "Product" ], "responses": { "204": { - "description": "No Content - given Section is deleted." + "description": "No content - the given product is deleted." }, "401": { - "description": "Error - the user is not authorized to delete this Section." - }, - "404": { - "description": "Error - the Section does not exist." + "description": "Error - the user is not authorized to delete this product." } }, - "summary": "Delete Section", - "description": "The given Section is deleted.", + "summary": "Delete product", + "description": "Deletes the given product.", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "name": "identifier", + "in": "path", + "description": "ProductDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "sectionId", - "in": "path", - "description": "", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false - }, - "patch": { - "operationId": "ibexa.rest.update_section", + ] + } + }, + "/product/catalog/products/{productTypeIdentifier}": { + "post": { + "operationId": "ibexa.product_catalog.rest.products.create", "tags": [ - "Section" + "Product" ], "responses": { - "200": { - "description": "OK - Section updated.", + "201": { + "description": "If set, the new product is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Section+json": { + "application/vnd.ibexa.api.ProductCreate+json": { "schema": { - "$ref": "#/components/schemas/SectionWrapper" + "$ref": "#/components/schemas/ProductWrapper" }, "example": { - "Section": { - "_media-type": "application/vnd.ibexa.api.Section+json", - "_href": "/api/ibexa/v2/content/sections/7", - "sectionId": 7, - "identifier": "template", - "name": "Template" + "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": [] } } - }, - "application/vnd.ibexa.api.Section+xml": { - "schema": { - "$ref": "#/components/schemas/Section" - }, - "example": "\n
\n 7\n template\n Template\n
\n" } } }, @@ -24257,794 +9726,576 @@ "description": "Error - the input does not match the input schema definition." }, "401": { - "description": "Error - the user is not authorized to create this Section." + "description": "Error - the user is not authorized to update this product." }, "403": { - "description": "Error - a Section with the given identifier already exists." + "description": "Error - a product with the same name already exists." }, - "412": { - "description": "Error - the current ETag does not match with the one provided in the If-Match header." + "404": { + "description": "Error - no product with the given code exists." } }, - "summary": "Update a Section", - "description": "Updates a Section. PATCH or POST with header X-HTTP-Method-Override PATCH.", + "summary": "Create product", + "description": "Creates a new product.", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "name": "productTypeIdentifier", + "in": "path", + "description": "ProductCreateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "If-Match", + "name": "X-CSRF-Token", "in": "header", - "description": "ETag", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "sectionId", - "in": "path", - "description": "", + "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "The Section input schema encoded in XML or JSON.", + "description": "The product schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.SectionInput+json": { + "application/vnd.ibexa.api.ProductCreate+json": { "schema": { - "$ref": "#/components/schemas/SectionInputWrapper" + "$ref": "#/components/schemas/ProductCreateWrapper" }, "example": { - "SectionInput": { - "identifier": "template", - "name": "Template" - } - } - }, - "application/vnd.ibexa.api.SectionInput+xml": { - "schema": { - "$ref": "#/components/schemas/SectionInput" - }, - "example": "\n\n template\n Template\n\n" - } - }, - "required": false - }, - "deprecated": false - } - }, - "/segment_groups": { - "get": { - "operationId": "ibexa.segmentation.rest.segment_groups.list", - "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" + "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" } } - }, - "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": [], - "deprecated": false, - "x-badges": [ - { - "name": "Experience", - "color": "#D3822B" }, - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] + "required": false + } } }, - "/segment_groups/{identifier}": { + "/product/catalog/attributes": { "get": { - "operationId": "ibexa.segmentation.rest.segment_groups.view", + "operationId": "ibexa.product_catalog.rest.attributes", "tags": [ - "Segmentation" + "Product Attribute" ], "responses": { "200": { - "description": "OK - return the segment group.", + "description": "AttributeList - If set, the attributes list is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.SegmentGroup+json": { + "application/vnd.ibexa.api.AttributeList+json": { "schema": { - "$ref": "#/components/schemas/SegmentGroupWrapper" + "$ref": "#/components/schemas/AttributeListWrapper" }, "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" + "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.SegmentGroup+xml": { + "application/vnd.ibexa.api.AttributeList+xml": { "schema": { - "$ref": "#/components/schemas/SegmentGroup" - }, - "example": "\n\n 1\n corporate_accounts\n Corporate Accounts\n\n" + "$ref": "#/components/schemas/AttributeList" + } } } }, "401": { - "description": "Error - the user is not authorized to load this segment group." - }, - "404": { - "description": "Error - the identifier doesn't match any segment group." + "description": "Error - the user has no permission to read user groups." } }, - "summary": "Load segment group", - "description": "Loads segment group.", - "parameters": [ - { - "name": "identifier", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" + "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": [], + "requestBody": { + "description": "Attribute filter", + "content": { + "application/vnd.ibexa.api.AttributeListGet+json": { + "schema": { + "$ref": "#/components/schemas/AttributeListGetWrapper" + }, + "example": { + "AttributeListGet": { + "group_name_prefix": "a", + "name_prefix": "a", + "offset": 0, + "limit": 10 + } + } }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false, - "x-badges": [ - { - "name": "Experience", - "color": "#D3822B" + "application/vnd.ibexa.api.AttributeListGet+xml": { + "schema": { + "$ref": "#/components/schemas/AttributeListGet" + } + } }, - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] - } - }, - "/segment_groups/{identifier}/segments": { - "get": { - "operationId": "ibexa.segmentation.rest.segment_groups.list.segments", + "required": false + } + }, + "post": { + "operationId": "ibexa.product_catalog.rest.attributes.create", "tags": [ - "Segmentation" + "Product Attribute" ], "responses": { - "200": { - "description": "OK - list the group's segments.", + "201": { + "description": "If set, the new attribute is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.SegmentList+json": { + "application/vnd.ibexa.api.Attribute+json": { "schema": { - "$ref": "#/components/schemas/SegmentListWrapper" + "$ref": "#/components/schemas/AttributeWrapper" }, "example": { - "SegmentList": { - "_media-type": "application/vnd.ibexa.api.SegmentList+json", - "_href": "/api/ibexa/v2/segment_groups/corporate_accounts/segments", - "Segment": [] + "Attribute": { + "_media-type": "application/vnd.ibexa.api.Attribute+json", + "identifier": "foo", + "name": "Attribute", + "description": "description", + "type": "Checkbox", + "type_identifier": "checkbox", + "value": true, + "group": "Attribute Test", + "position": 0, + "options": [] } } - }, - "application/vnd.ibexa.api.SegmentList+xml": { - "schema": { - "$ref": "#/components/schemas/SegmentList" - }, - "example": "\n\n" } } }, + "400": { + "description": "Error - the input does not match the input schema definition." + }, "401": { - "description": "Error - the user is not authorized to load this group's segments." + "description": "Error - the user is not authorized to create this attribute." }, - "404": { - "description": "Error - the identifier doesn't match any segment group." + "403": { + "description": "Error - an attribute with the same name already exists." } }, - "summary": "List segment group's segments", - "description": "Lists segment group's segments.", + "summary": "Create attribute", + "description": "Creates a new attribute.", "parameters": [ { - "name": "identifier", - "in": "path", - "description": "", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], - "deprecated": false, - "x-badges": [ - { - "name": "Experience", - "color": "#D3822B" + "requestBody": { + "description": "The attribute schema encoded in XML or JSON format.", + "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" + } + } + } + } }, - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] + "required": false + } } }, - "/segments/{identifier}": { - "get": { - "operationId": "ibexa.segmentation.rest.segments.view", + "/product/catalog/attributes/translation/{id}/{languageCode}": { + "delete": { + "operationId": "ibexa.product_catalog.rest.attributes.translation.delete", "tags": [ - "Segmentation" + "Product Attribute" ], "responses": { "200": { - "description": "OK - Return the segment.", - "content": { - "application/vnd.ibexa.api.Segment+json": { - "schema": { - "$ref": "#/components/schemas/SegmentWrapper" - }, - "example": { - "Segment": { - "_media-type": "application/vnd.ibexa.api.Segment+json", - "_href": "/api/ibexa/v2/segments/corporate_account", - "id": 1, - "identifier": "corporate_account", - "name": "Corporate Account", - "source": "ibexa", - "lastUpdatedBy": "14", - "updatedAt": "2026-06-30T12:00:00+00:00", - "SegmentGroup": { - "_media-type": "application/vnd.ibexa.api.SegmentGroup+json", - "_href": "/api/ibexa/v2/segment_groups/corporate_accounts" - } - } - } - }, - "application/vnd.ibexa.api.Segment+xml": { - "schema": { - "$ref": "#/components/schemas/Segment" - }, - "example": "\n\n 1\n corporate_account\n Corporate Account\n ibexa\n 14\n 2026-06-30T12:00:00+00:00\n \n\n" - } - } + "description": "No Content." }, "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." + "description": "Error - the user is not authorized to delete this translation." } }, - "summary": "Load segment", - "description": "Loads the identified segment.", + "summary": "Delete attribute translation", + "description": "The given translation is removed from the attribute.", "parameters": [ { - "name": "identifier", + "name": "id", "in": "path", - "description": "", + "description": "AttributeTranslationDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false, - "x-badges": [ + "explode": false + }, { - "name": "Experience", - "color": "#D3822B" + "name": "languageCode", + "in": "path", + "description": "AttributeTranslationDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] } }, - "/orders/order/{orderIdentifier}/shipments": { + "/product/catalog/attributes/view": { "post": { - "operationId": "ibexa.shipping.rest.shipment.create", + "operationId": "ibexa.product_catalog.rest.attributes.view", "tags": [ - "Shipping" + "Product Attribute" ], "responses": { "200": { - "description": "The created shipment.", + "description": "The view in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Shipment+json": { + "application/vnd.ibexa.api.AttributeView+json": { "schema": { - "$ref": "#/components/schemas/ShipmentWrapper" + "$ref": "#/components/schemas/AttributeViewWrapper" }, "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/12345678-1234-5678-9abc-123456789abc" - }, - "Amount": { - "value": "1922", - "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" + "AttributeView": { + "_media-type": "application/vnd.ibexa.api.AttributeView+json", + "identifier": "TitleView", + "AttributeQuery": { + "_media-type": "application/vnd.ibexa.api.AttributeQuery+json" }, - "Method": { - "_media-type": "application/vnd.ibexa.api.ShippingMethod+json", - "_href": "/api/ibexa/v2/shipping/methods/parcel_locker" + "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.Shipment+xml": { + "application/vnd.ibexa.api.AttributeView+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 1922\n EUR\n \n 2023-06-26T15:40:28+02:00\n 2023-06-26T15:40:28+02:00\n \n \n\n" + "$ref": "#/components/schemas/AttributeView" + } } } }, "400": { "description": "Error - the input does not match the input schema definition." - }, - "401": { - "description": "Error - the user is not authorized to create a shipment or to update this order." - }, - "404": { - "description": "Error - the order with the given identifier does not exist." - }, - "201": { - "description": "Not supported - 200 OK is returned on success." - }, - "422": { - "description": "Not supported - 400 Bad Request is returned on unprocessable input." } }, - "summary": "Create shipment", - "description": "Creates a shipment.", + "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": "X-CSRF-Token", "in": "header", - "description": "The CSRF token.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "orderIdentifier", - "in": "path", - "description": "The order's identifier to create a shipment for.", + "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "The shipment to create.", + "description": "The view input in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShipmentCreate+json": { + "application/vnd.ibexa.api.AttributeViewInput+json": { "schema": { - "$ref": "#/components/schemas/ShipmentCreateWrapper" + "$ref": "#/components/schemas/AttributeViewInputWrapper" }, "example": { - "ShipmentCreate": { - "identifier": "abc", - "ShippingMethod": { - "_media-type": "application/vnd.ibexa.api.ShippingMethod+json", - "_href": "/api/ibexa/v2/shipping/methods/parcel_locker" - }, - "Amount": { - "value": "1922", - "currency": "EUR" - }, - "Owner": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "Context": { - "key1": "value1", - "key2": "value2" + "ViewInput": { + "identifier": "TitleView", + "AttributeQuery": { + "limit": "10", + "offset": "0", + "Query": { + "AttributeNameCriterion": "measure", + "AttributeGroupIdentifierCriterion": "test_attribute_group" + } } } } }, - "application/vnd.ibexa.api.ShipmentCreate+xml": { + "application/vnd.ibexa.api.AttributeViewInput+xml": { "schema": { - "$ref": "#/components/schemas/ShipmentCreate" - }, - "example": "\n\n abc\n \n \n 1922\n EUR\n \n \n \n value1\n value2\n \n\n" + "$ref": "#/components/schemas/AttributeViewInput" + } } }, "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] + } } }, - "/shipments": { + "/product/catalog/attributes/{id}": { "get": { - "operationId": "ibexa.shipping.rest.shipment.all.find", + "operationId": "ibexa.product_catalog.rest.attributes.get", "tags": [ - "Shipping" + "Product Attribute" ], "responses": { "200": { - "description": "OK - loads the shipments.", + "description": "Attribute - If set, the given attribute is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShipmentRefList+json": { + "application/vnd.ibexa.api.Attribute+json": { "schema": { - "$ref": "#/components/schemas/ShipmentRefListWrapper" + "$ref": "#/components/schemas/AttributeWrapper" }, "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" - } - ] + "Attribute": { + "_media-type": "application/vnd.ibexa.api.Attribute+json", + "identifier": "attrib2", + "name": "Attrib2", + "description": "", + "type": "Checkbox", + "type_identifier": "checkbox", + "value": true, + "group": "Attribute Group Test", + "position": 0, + "options": [] } } }, - "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": [], - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] - } - }, - "/shipments/{identifier}": { - "get": { - "operationId": "ibexa.shipping.rest.shipment.get", - "tags": [ - "Shipping" - ], - "responses": { - "200": { - "description": "OK - loads the shipment.", - "content": { - "application/vnd.ibexa.api.Shipment+json": { + "application/vnd.ibexa.api.Attribute+xml": { "schema": { - "$ref": "#/components/schemas/ShipmentWrapper" - }, - "example": { - "Shipment": { - "_media-type": "application/vnd.ibexa.api.Shipment+json", - "_href": "/api/ibexa/v2/shipments/ae741491-e80c-49f2-8a44-5163b4afa144", - "id": 1, - "identifier": "ae741491-e80c-49f2-8a44-5163b4afa144", - "status": "pending", - "transitions": { - "transitionList": [ - "prepare", - "cancel" - ] - }, - "Order": { - "_media-type": "application/vnd.ibexa.api.Order+json", - "_href": "/api/ibexa/v2/orders/order/33f6db52-478f-41f1-afbe-6d38f6a4704f" - }, - "Amount": { - "value": "2257", - "currency": "EUR" - }, - "createdAt": "2023-06-26T15:40:28+02:00", - "updatedAt": "2023-06-26T15:40:28+02:00", - "Owner": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "Method": { - "_media-type": "application/vnd.ibexa.api.ShippingMethod+json", - "_href": "/api/ibexa/v2/shipping/methods/parcel_locker_delivery" - } - } + "$ref": "#/components/schemas/Attribute" } - }, - "application/vnd.ibexa.api.Shipment+xml": { - "schema": { - "$ref": "#/components/schemas/Shipment" - }, - "example": "\n\n 1\n ae741491-e80c-49f2-8a44-5163b4afa144\n pending\n \n prepare\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." + "description": "Error - the user has no permission to read the attribute." } }, - "summary": "Load a single shipment based on its identifier", - "description": "Loads a single shipment based on its identifier.", + "summary": "Load attribute", + "description": "Loads given attribute.", "parameters": [ { - "name": "identifier", + "name": "id", "in": "path", - "description": "The shipment identifier.", + "description": "AttributeLoadByIdentifierController identifier", "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" + "explode": false } ] }, "delete": { - "operationId": "ibexa.shipping.rest.shipment.delete", + "operationId": "ibexa.product_catalog.rest.attributes.delete", "tags": [ - "Shipping" + "Product Attribute" ], "responses": { - "204": { - "description": "No content - shipment is deleted." + "200": { + "description": "No Content." }, "401": { - "description": "Error - the user is not authorized to delete this shipment." - }, - "404": { - "description": "Error - the shipment with the given ID does not exist." + "description": "Error - the user is not authorized to delete this attribute." } }, - "summary": "Delete shipment", - "description": "Deletes a shipment.", + "summary": "Delete attribute", + "description": "The given attribute is removed from the attribute group.", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", + "name": "id", + "in": "path", + "description": "AttributeDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "identifier", - "in": "path", - "description": "", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", "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" + "explode": false } ] - }, + } + }, + "/product/catalog/attributes/{id}/{group_id}": { "patch": { - "operationId": "ibexa.shipping.rest.shipment.update", + "operationId": "ibexa.product_catalog.rest.attributes.update", "tags": [ - "Shipping" + "Product Attribute" ], "responses": { - "200": { - "description": "If set, the updated shipment is returned in XML or JSON format.", + "201": { + "description": "If set, the updated attribute is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Shipment+json": { + "application/vnd.ibexa.api.Attribute+json": { "schema": { - "$ref": "#/components/schemas/ShipmentWrapper" + "$ref": "#/components/schemas/AttributeWrapper" }, "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" - } + "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.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" } } }, @@ -25052,4624 +10303,5124 @@ "description": "Error - the input does not match the input schema definition." }, "401": { - "description": "Error - the user is not authorized to update this shipment." + "description": "Error - the user is not authorized to create this attribute." }, - "404": { - "description": "Error - the shipment with the given ID does not exist." + "403": { + "description": "Error - an attribute with the same name already exists." }, - "406": { - "description": "Error - the shipment cannot be cancelled due to not-allowed workflow transition" + "404": { + "description": "Error - the attribute with the given ID does not exist." } }, - "summary": "Update shipment", - "description": "Updates a shipment.", + "summary": "Update attribute", + "description": "Updates an attribute.", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", + "name": "id", + "in": "path", + "description": "AttributeUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "identifier", + "name": "group_id", "in": "path", - "description": "The shipment identifier.", + "description": "AttributeUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + }, + { + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ], "requestBody": { - "description": "The ShipmentUpdate schema encoded in XML or JSON format.", + "description": "If set, the updated attribute group is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShipmentUpdate+json": { + "application/vnd.ibexa.api.AttributeUpdate+json": { "schema": { - "$ref": "#/components/schemas/ShipmentUpdateWrapper" + "$ref": "#/components/schemas/AttributeUpdateWrapper" }, "example": { - "ShipmentUpdate": { - "identifier": "new_identifier", - "transition": "prepare", - "Owner": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" + "AttributeUpdate": { + "identifier": "attr_group", + "names": { + "eng-GB": "Attribute Group" + }, + "descriptions": { + "eng-GB": "description" }, - "Context": { - "item1": "value1", - "item2": "value2" + "position": 0, + "options": { + "foo": "bar" } } } - }, - "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": { + "/product/catalog/attribute_groups": { "get": { - "operationId": "ibexa.shipping.rest.shipping_method.type.list", + "operationId": "ibexa.product_catalog.rest.attribute_groups", "tags": [ - "Shipping" + "Product Attribute Group" ], "responses": { "200": { - "description": "OK - loads the shipping method.", + "description": "AttributeGroupList - If set, the attribute group list is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShippingMethodTypesList+json": { + "application/vnd.ibexa.api.AttributeGroupList+json": { "schema": { - "$ref": "#/components/schemas/ShippingMethodTypesListWrapper" + "$ref": "#/components/schemas/AttributeGroupListWrapper" }, "example": { - "ShippingMethodTypesList": { - "_media-type": "application/vnd.ibexa.api.ShippingMethodTypesList+json", - "_href": "/api/ibexa/v2/shipping/method-types", - "ShippingMethodTypes": [ + "AttributeGroupList": { + "_media-type": "application/vnd.ibexa.api.AttributeGroupList+json", + "AttributeGroup": [ { - "_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.AttributeGroup+json", + "name": "Attribute Group Test", + "identifier": "attr_group_test", + "position": 0 }, { - "_media-type": "application/vnd.ibexa.api.ShippingMethodType+json", - "_href": "/api/ibexa/v2/shipping/method-types/free", - "identifier": "free", - "name": "Free shipping" + "_media-type": "application/vnd.ibexa.api.AttributeGroup+json", + "name": "Dimensions", + "identifier": "ag_dimensions", + "position": 0 } ] } } }, - "application/vnd.ibexa.api.ShippingMethodTypesList+xml": { + "application/vnd.ibexa.api.AttributeGroupList+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" + "$ref": "#/components/schemas/AttributeGroupList" + } } } }, "401": { - "description": "Error - the user has no permission to read shipping methods types." - }, - "404": { - "description": "Error - the shipping method type does not exist." + "description": "Error - the user has no permission to read attribute groups." } }, - "summary": "Load shipping methods types", - "description": "Loads shipping methods types.", + "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": [], - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] - } - }, - "/shipping/method-types/{identifier}": { - "get": { - "operationId": "ibexa.shipping.rest.shipping_method.type.get", + "requestBody": { + "description": "The AttributeGroupListGet schema encoded in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.AttributeGroupListGet+json": { + "schema": { + "$ref": "#/components/schemas/AttributeGroupListGetWrapper" + }, + "example": { + "AttributeGroupListGet": { + "prefix": "s", + "offset": 0, + "limit": 10 + } + } + } + }, + "required": false + } + }, + "post": { + "operationId": "ibexa.product_catalog.rest.attribute_groups.create", "tags": [ - "Shipping" + "Product Attribute Group" ], "responses": { - "200": { - "description": "OK - loads the shipping method.", + "201": { + "description": "If set, the new attribute group is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShippingMethodType+json": { + "application/vnd.ibexa.api.AttributeGroup+json": { "schema": { - "$ref": "#/components/schemas/ShippingMethodTypeWrapper" + "$ref": "#/components/schemas/AttributeGroupWrapper" }, "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" + "AttributeGroup": { + "_media-type": "application/vnd.ibexa.api.AttributeGroup+json", + "name": "Attribute Group Test", + "identifier": "attr_group_test", + "position": 0 } } - }, - "application/vnd.ibexa.api.ShippingMethodType+xml": { - "schema": { - "$ref": "#/components/schemas/ShippingMethodType" - }, - "example": "\n\n flat_rate\n Flat rate\n\n" } } }, + "400": { + "description": "Error - the input does not match the input schema definition." + }, "401": { - "description": "Error - the user has no permission to read shipping methods." + "description": "Error - the user is not authorized to create this attribute group." }, - "404": { - "description": "Error - the shipping method type does not exist." + "403": { + "description": "Error - an attribute group with the same identifier already exists." } }, - "summary": "Load shipping method type based on its identifier", - "description": "Loads shipping methods type based on their identifiers.", + "summary": "Create attribute group", + "description": "Creates a new attribute group.", "parameters": [ { - "name": "identifier", - "in": "path", - "description": "", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", "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" + "explode": false } - ] - } - }, - "/shipping/methods": { - "get": { - "operationId": "ibexa.shipping.rest.shipping_method.find", - "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" - } - ] - } - } + "requestBody": { + "description": "The AttributeGroup schema encoded in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.AttributeGroupCreate+json": { + "schema": { + "$ref": "#/components/schemas/AttributeGroupCreateWrapper" }, - "application/vnd.ibexa.api.ShippingMethodRefList+xml": { - "schema": { - "$ref": "#/components/schemas/ShippingMethodRefList" - }, - "example": "\n\n \n \n\n" + "example": { + "AttributeGroupCreate": { + "identifier": "attr_group_test", + "names": { + "eng-GB": "Attribute Group Test" + }, + "position": 0 + } } } }, - "401": { - "description": "Error - the user has no permission to read shipping methods." - } - }, - "summary": "Load shipping methods", - "description": "Loads shipping methods.", - "parameters": [], - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] + "required": false + } } }, - "/shipping/methods/{identifier}": { - "get": { - "operationId": "ibexa.shipping.rest.shipping_method.get", + "/product/catalog/attribute_groups/translation/{id}/{languageCode}": { + "delete": { + "operationId": "ibexa.product_catalog.rest.attribute_groups.translation.delete", "tags": [ - "Shipping" + "Product Attribute Group" ], "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" - } - } + "description": "No content - the given attribute group translation is deleted." }, "401": { - "description": "Error - the user has no permission to read shipping methods." - }, - "404": { - "description": "Error - the shipping method does not exist." + "description": "Error - the user is not authorized to delete this attribute group translation assignment." } }, - "summary": "Load shipping method based on its identifier", - "description": "Loads shipping method based on its identifier.", + "summary": "Delete attribute group translation", + "description": "Deletes given translation from attribute group.", "parameters": [ { - "name": "identifier", + "name": "id", "in": "path", - "description": "", + "description": "AttributeGroupTranslationDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false, - "x-badges": [ + "explode": false + }, + { + "name": "languageCode", + "in": "path", + "description": "AttributeGroupTranslationDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] } }, - "/shopping-list": { - "get": { - "operationId": "ibexa.rest.shopping_list.list", + "/product/catalog/attribute_groups/view": { + "post": { + "operationId": "ibexa.product_catalog.rest.attribute_groups.view", "tags": [ - "Shopping List" + "Product Attribute Group" ], "responses": { "200": { - "description": "Shopping list collection returned.", + "description": "The view in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShoppingListCollection+json": { + "application/vnd.ibexa.api.AttributeGroupView+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListCollectionWrapper" + "$ref": "#/components/schemas/AttributeGroupViewWrapper" }, "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": [ + "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": [ { - "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" + "_media-type": "application/vnd.ibexa.api.AttributeGroup+json", + "name": "Test Attribute group", + "identifier": "test_attribute_group", + "position": 0 } - ], - "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": { + "application/vnd.ibexa.api.AttributeGroupView+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" + "$ref": "#/components/schemas/AttributeGroupView" + } } } }, - "401": { - "description": "Error - The user is not authorized to list shopping lists." + "400": { + "description": "Error - the input does not match the input schema definition." } }, - "summary": "List shopping lists", - "description": "Returns a list of shopping lists owned by the current user.", + "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": "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, + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", + "required": true, "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 + "style": "simple", + "explode": false } ], - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "requestBody": { + "description": "The view input in XML or JSON format.", + "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" + } + } }, - { - "name": "LTS Update", - "color": "#5DA7C0", - "position": "after" - } - ] - }, - "post": { - "operationId": "ibexa.rest.shopping_list.create", + "required": false + } + } + }, + "/product/catalog/attribute_groups/{id}": { + "get": { + "operationId": "ibexa.product_catalog.rest.attribute_groups.get", "tags": [ - "Shopping List" + "Product Attribute Group" ], "responses": { - "201": { - "description": "Shopping list created.", + "200": { + "description": "AttributeGroupGet - If set, the attribute group List is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShoppingList+json": { + "application/vnd.ibexa.api.AttributeGroup+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListWrapper" + "$ref": "#/components/schemas/AttributeGroupWrapper" }, "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" + "AttributeGroup": { + "_media-type": "application/vnd.ibexa.api.AttributeGroup+json", + "name": "Attribute Group Test", + "identifier": "attr_group_test", + "position": 0 } } }, - "application/vnd.ibexa.api.ShoppingList+xml": { + "application/vnd.ibexa.api.AttributeGroup+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" + "$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 a shopping list." - }, - "403": { - "description": "Error - Invalid request (e.g., missing required name)." - }, - "406": { - "description": "Error - Shopping list limit exceeded for the current user." + "description": "Error - the user has no permission to read attribute groups." } }, - "summary": "Create shopping list", - "description": "Creates a new shopping list for the current user. The list will be owned by the authenticated user.", + "summary": "Load attribute group", + "description": "Returns the given attribute group.", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "CSRF Token is needed to execute this unsafe request.", + "name": "id", + "in": "path", + "description": "AttributeGroupLoadByIdentifierController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "Shopping list to create", + "description": "An optional AttributeGroupGet schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShoppingListCreate+json": { + "application/vnd.ibexa.api.AttributeGroupGet+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListCreateWrapper" + "$ref": "#/components/schemas/AttributeGroupGetWrapper" }, "example": { - "ShoppingListCreate": { - "name": "My Shopping List" + "AttributeGroupGet": { + "languages": [ + "eng-GB" + ] } } }, - "application/vnd.ibexa.api.ShoppingListCreate+xml": { + "application/vnd.ibexa.api.AttributeGroupGet+xml": { "schema": { - "$ref": "#/components/schemas/ShoppingListCreate" - }, - "example": "\n\n My Shopping List\n\n" + "$ref": "#/components/schemas/AttributeGroupGet" + } } }, "required": false + } + }, + "delete": { + "operationId": "ibexa.product_catalog.rest.attribute_groups.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." + } }, - "deprecated": false, - "x-badges": [ + "summary": "Delete attribute group", + "description": "Deletes an attribute group.", + "parameters": [ { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "name": "id", + "in": "path", + "description": "AttributeGroupDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "name": "LTS Update", - "color": "#5DA7C0", - "position": "after" + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] - } - }, - "/shopping-list/default/entries": { - "post": { - "operationId": "ibexa.rest.shopping_list.add_to_default_entries", + }, + "patch": { + "operationId": "ibexa.product_catalog.rest.attribute_groups.update", "tags": [ - "Shopping List" + "Product Attribute Group" ], "responses": { - "200": { - "description": "Entries added successfully. Returns the default shopping list.", + "201": { + "description": "If set, the updated attribute group is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShoppingList+json": { + "application/vnd.ibexa.api.AttributeGroup+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListWrapper" + "$ref": "#/components/schemas/AttributeGroupWrapper" }, "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" + "AttributeGroup": { + "_media-type": "application/vnd.ibexa.api.AttributeGroup+json", + "name": "Colors Group", + "identifier": "ag_colors", + "position": 0 } } }, - "application/vnd.ibexa.api.ShoppingList+xml": { + "application/vnd.ibexa.api.AttributeGroup+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" + "$ref": "#/components/schemas/AttributeGroup" + } } } }, "400": { - "description": "Error - The input does not match the input schema definition." + "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." + "description": "Error - the user is not authorized to create this attribute group." }, "403": { - "description": "Error - Invalid request (e.g., invalid product code, duplicate entry)." + "description": "Error - an attribute group with the same identifier already exists." }, - "406": { - "description": "Error - Shopping list entry limit exceeded." + "404": { + "description": "Error - the group with the given ID does not exist." } }, - "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.", + "summary": "Update attribute group", + "description": "Updates an attribute group.", "parameters": [ + { + "name": "id", + "in": "path", + "description": "AttributeGroupUpdateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, { "name": "X-CSRF-Token", "in": "header", - "description": "CSRF Token is needed to execute this unsafe request.", + "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "Entries to add to the default shopping list", + "description": "The attribute group update schema is sent in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShoppingListEntriesAdd+json": { + "application/vnd.ibexa.api.AttributeGroupUpdate+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListEntriesAddWrapper" + "$ref": "#/components/schemas/AttributeGroupUpdateWrapper" }, "example": { - "ShoppingListEntriesAdd": { - "entries": [ - { - "productCode": "PRODUCT-001" - }, - { - "productCode": "PRODUCT-002" - } - ] + "AttributeGroupUpdate": { + "identifier": "ag_colors", + "names": { + "eng-GB": "Colors Group" + }, + "position": 0 } } }, - "application/vnd.ibexa.api.ShoppingListEntriesAdd+xml": { + "application/vnd.ibexa.api.AttributeGroupUpdate+xml": { "schema": { - "$ref": "#/components/schemas/ShoppingListEntriesAdd" - }, - "example": "\n\n \n \n PRODUCT-001\n \n \n PRODUCT-002\n \n \n\n" + "$ref": "#/components/schemas/AttributeGroupUpdate" + } } }, "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - }, - { - "name": "LTS Update", - "color": "#5DA7C0", - "position": "after" + } + } + }, + "/product/catalog/attribute_types": { + "get": { + "operationId": "ibexa.product_catalog.rest.attribute_types", + "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": [] } }, - "/shopping-list/{identifier}": { + "/product/catalog/attribute_types/{identifier}": { "get": { - "operationId": "ibexa.rest.shopping_list.get", + "operationId": "ibexa.product_catalog.rest.attribute_type", "tags": [ - "Shopping List" + "Product Attribute Type" ], "responses": { "200": { - "description": "OK - returns the shopping list", + "description": "OK - returns the Attribute Type", "content": { - "application/vnd.ibexa.api.ShoppingList+json": { + "application/vnd.ibexa.api.AttributeType+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" - } + "$ref": "#/components/schemas/AttributeTypeWrapper" } }, - "application/vnd.ibexa.api.ShoppingList+xml": { + "application/vnd.ibexa.api.AttributeType+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" + "$ref": "#/components/schemas/AttributeType" + } } } }, - "401": { - "description": "Error - the user is not authorized to access this shopping list." - }, "404": { - "description": "Error - the identifier does not match any shopping list." + "description": "Error - The Attribute Type does not exist." } }, - "summary": "Get shopping list", - "description": "Gets a shopping list by its identifier.", + "summary": "Get Attribute Type", + "description": "Gets an Attribute Type by its identifier.", "parameters": [ { "name": "identifier", "in": "path", - "description": "The shopping list identifier (UUID)", + "description": "AttributeTypeLoadByIdentifierController identifier", "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" + "explode": false } ] - }, - "delete": { - "operationId": "ibexa.rest.shopping_list.delete", + } + }, + "/product/catalog/catalogs": { + "post": { + "operationId": "ibexa.product_catalog.rest.catalogs.create", "tags": [ - "Shopping List" + "Product Catalog" ], "responses": { - "204": { - "description": "No Content - shopping list deleted successfully." + "201": { + "description": "If set, the new catalog is returned in XML or JSON format.", + "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 delete this shopping list." + "description": "Error - the user is not authorized to update this catalog." }, "403": { - "description": "Error - Cannot delete the default shopping list." + "description": "Error - a catalog with the same name already exists." }, "404": { - "description": "Error - Shopping list with the given identifier does not exist." + "description": "Error - no catalog with the given code exists." } }, - "summary": "Delete shopping list", - "description": "Deletes a shopping list by its identifier. The default shopping list cannot be deleted.", + "summary": "Create catalog", + "description": "Creates a new catalog.", "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.", + "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "requestBody": { + "description": "The catalog schema encoded in XML or JSON format.", + "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" + } + } + } }, - { - "name": "LTS Update", - "color": "#5DA7C0", - "position": "after" - } - ] - }, - "patch": { - "operationId": "ibexa.rest.shopping_list.update", + "required": false + } + } + }, + "/product/catalog/catalogs/copy/{identifier}": { + "post": { + "operationId": "ibexa.product_catalog.rest.catalogs.copy", "tags": [ - "Shopping List" + "Product Catalog" ], "responses": { - "200": { - "description": "Shopping list updated.", + "201": { + "description": "If set, the copied catalog is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShoppingList+json": { + "application/vnd.ibexa.api.Catalog+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListWrapper" + "$ref": "#/components/schemas/CatalogWrapper" }, "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" + "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" }, - "entries": [ + "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 + } + }, { - "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" + "_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": ">=" + } } - ], - "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." + "description": "Error - the input does not match the input schema definition." }, "401": { - "description": "Error - The user is not authorized to update this shopping list." + "description": "Error - the user is not authorized to copy this catalog." }, "403": { - "description": "Error - Invalid request (e.g., validation failed)." + "description": "Error - a catalog with the same identifier already exists." }, "404": { - "description": "Error - The shopping list does not exist." + "description": "Error - no catalog with the given identifier exists." } }, - "summary": "Update shopping list", - "description": "Updates an existing shopping list. Only the name can be updated.", + "summary": "Copy catalog", + "description": "Copies a catalog.", "parameters": [ { "name": "identifier", "in": "path", - "description": "The shopping list identifier (UUID).", + "description": "CatalogCopyController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "X-CSRF-Token", "in": "header", - "description": "CSRF Token is needed to execute this unsafe request.", + "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "Shopping list metadata to update", + "description": "If set, the copied catalog is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShoppingListUpdate+json": { + "application/vnd.ibexa.api.CatalogCopy+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListUpdateWrapper" + "$ref": "#/components/schemas/CatalogCopyWrapper" }, "example": { - "ShoppingListUpdate": { - "name": "Updated Shopping List Name" + "CatalogCopy": { + "identifier": "test_catalog_copied", + "creator_id": 14 } } - }, - "application/vnd.ibexa.api.ShoppingListUpdate+xml": { - "schema": { - "$ref": "#/components/schemas/ShoppingListUpdate" - }, - "example": "\n\n Updated Shopping List Name\n\n" } }, "required": false + } + } + }, + "/product/catalog/catalogs/filters": { + "get": { + "operationId": "ibexa.product_catalog.rest.catalog.filters", + "tags": [ + "Product Catalog" + ], + "responses": { + "200": { + "description": "If set, the filters are returned in XML or JSON format.", + "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" + } + } + } + } }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - }, - { - "name": "LTS Update", - "color": "#5DA7C0", - "position": "after" + "summary": "Load catalog filters", + "description": "Loads product filters available for catalogs.", + "parameters": [] + } + }, + "/product/catalog/catalogs/sort_clauses": { + "get": { + "operationId": "ibexa.product_catalog.rest.catalog.sort_clauses", + "tags": [ + "Product Catalog" + ], + "responses": { + "200": { + "description": "If set, the clauses are returned in XML or JSON format.", + "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": [] } }, - "/shopping-list/{identifier}/add-entries-to-cart": { + "/product/catalog/catalogs/view": { "post": { - "operationId": "ibexa.rest.cart.shopping_list.add_entries_to_cart", + "operationId": "ibexa.product_catalog.rest.catalogs.view", "tags": [ - "Shopping List" + "Product Catalog" ], "responses": { "200": { - "description": "OK - returns the cart with added shopping list entries", + "description": "The view in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Cart+json": { + "application/vnd.ibexa.api.CatalogView+json": { "schema": { - "$ref": "#/components/schemas/CartWrapper" + "$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.Cart+xml": { + "application/vnd.ibexa.api.CatalogView+xml": { "schema": { - "$ref": "#/components/schemas/Cart" + "$ref": "#/components/schemas/CatalogView" } } } }, "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." + "description": "Error - the input does not match the input schema definition." } }, - "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).", + "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": "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.", + "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "The ShoppingListEntryIdentifiers schema encoded in XML or JSON format.", + "description": "The view input in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShoppingListEntryIdentifiers+json": { + "application/vnd.ibexa.api.CatalogViewInput+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListEntryIdentifiersWrapper" + "$ref": "#/components/schemas/CatalogViewInputWrapper" }, "example": { - "ShoppingListEntryIdentifiers": { - "entries": [ - { - "identifier": "entry-001" - }, - { - "identifier": "entry-003" + "ViewInput": { + "identifier": "TitleView", + "CatalogQuery": { + "Query": { + "CatalogIdentifierCriterion": "test", + "CatalogNameCriterion": "test" } - ] + } } } }, - "application/vnd.ibexa.api.ShoppingListEntryIdentifiers+xml": { + "application/vnd.ibexa.api.CatalogViewInput+xml": { "schema": { - "$ref": "#/components/schemas/ShoppingListEntryIdentifiers" - }, - "example": "\n\n \n entry-001\n \n \n entry-003\n \n\n" + "$ref": "#/components/schemas/CatalogViewInput" + } } }, "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": "ibexa.rest.cart.shopping_list.add_entries_to_cart.cart_identifier", + "/product/catalog/catalogs/{identifier}": { + "get": { + "operationId": "ibexa.product_catalog.rest.catalogs.get", "tags": [ - "Shopping List" + "Product Catalog" ], "responses": { "200": { - "description": "OK - returns the cart with added shopping list entries", + "description": "If set, the catalog is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Cart+json": { + "application/vnd.ibexa.api.Catalog+json": { "schema": { - "$ref": "#/components/schemas/CartWrapper" + "$ref": "#/components/schemas/CatalogWrapper" + }, + "example": { + "Catalog": { + "_media-type": "application/vnd.ibexa.api.Catalog+json", + "identifier": "test_catalog", + "name": "Snow Equipment", + "description": "", + "User": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "created": 1666090438, + "modified": 1666090438, + "status": "draft", + "Criteria": [ + { + "_media-type": "application/vnd.ibexa.api.ProductCode+json", + "ProductCodeCriterion": { + "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json", + "codes": [ + "ski", + "snowboard" + ] + } + }, + { + "_media-type": "application/vnd.ibexa.api.ProductAvailability+json", + "ProductAvailabilityCriterion": { + "_media-type": "application/vnd.ibexa.api.ProductAvailabilityCriterion+json", + "is_available": true + } + }, + { + "_media-type": "application/vnd.ibexa.api.ColorAttribute+json", + "ColorAttributeCriterion": { + "_media-type": "application/vnd.ibexa.api.ColorAttributeCriterion+json", + "identifier": "color", + "value": [ + "#000000", + "#FFFFFF" + ] + } + }, + { + "_media-type": "application/vnd.ibexa.api.CreatedAt+json", + "CreatedAtCriterion": { + "_media-type": "application/vnd.ibexa.api.CreatedAtCriterion+json", + "created_at": { + "date": "2022-09-12 00:00:00.000000", + "timezone_type": 3, + "timezone": "Europe/Warsaw" + }, + "operator": ">=" + } + }, + { + "_media-type": "application/vnd.ibexa.api.FloatAttribute+json", + "FloatAttributeCriterion": { + "_media-type": "application/vnd.ibexa.api.FloatAttributeCriterion+json", + "identifier": "width", + "value": 16.6 + } + }, + { + "_media-type": "application/vnd.ibexa.api.IntegerAttributeRange+json", + "IntegerAttributeRangeCriterion": { + "_media-type": "application/vnd.ibexa.api.IntegerAttributeRangeCriterion+json", + "identifier": "length", + "min": 180, + "max": 230 + } + } + ] + } } }, - "application/vnd.ibexa.api.Cart+xml": { + "application/vnd.ibexa.api.Catalog+xml": { "schema": { - "$ref": "#/components/schemas/Cart" + "$ref": "#/components/schemas/Catalog" } } } }, - "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." + "description": "Error - the user is not authorized to view this catalog." }, "404": { - "description": "Error - the shopping list, cart, or entry identifiers don't match any existing resource." + "description": "Error - no catalog with the given identifier exists." } }, - "summary": "Add Selected Entries from Shopping List to Specific Cart", - "description": "Adds selected entries from the given Shopping List to the specified Cart.", + "summary": "Load catalog", + "description": "Loads the given catalog.", "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.", + "description": "CatalogLoadByIdentifierController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The ShoppingListEntryIdentifiers schema encoded in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.ShoppingListEntryIdentifiers+json": { - "schema": { - "$ref": "#/components/schemas/ShoppingListEntryIdentifiersWrapper" - }, - "example": { - "ShoppingListEntryIdentifiers": { - "entries": [ - { - "identifier": "entry-001" - }, - { - "identifier": "entry-003" - } - ] - } - } - }, - "application/vnd.ibexa.api.ShoppingListEntryIdentifiers+xml": { - "schema": { - "$ref": "#/components/schemas/ShoppingListEntryIdentifiers" - }, - "example": "\n\n \n entry-001\n \n \n entry-003\n \n\n" - } - }, - "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - }, - { - "name": "LTS Update", - "color": "#5DA7C0", - "position": "after" + "explode": false } ] - } - }, - "/shopping-list/{identifier}/add-to-cart": { - "post": { - "operationId": "ibexa.rest.cart.shopping_list.add_to_cart", + }, + "delete": { + "operationId": "ibexa.product_catalog.rest.catalogs.delete", "tags": [ - "Shopping List" + "Product Catalog" ], "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" - } - } - } + "204": { + "description": "No content - the given catalog is deleted." }, "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." + "description": "Error - the user is not authorized to delete this catalog." } }, - "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).", + "summary": "Delete catalog", + "description": "Deletes the given catalog.", "parameters": [ { "name": "identifier", "in": "path", - "description": "The Shopping List identifier", + "description": "CatalogDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "X-CSRF-Token", "in": "header", - "description": "CSRF Token is needed to execute this unsafe request.", + "description": "The CSRF token is required when passing user session.", "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" + "explode": false } ] - } - }, - "/shopping-list/{identifier}/add-to-cart/{cartIdentifier}": { - "post": { - "operationId": "ibexa.rest.cart.shopping_list.add_to_cart.car_identifier", + }, + "patch": { + "operationId": "ibexa.product_catalog.rest.catalogs.update", "tags": [ - "Shopping List" + "Product Catalog" ], "responses": { - "200": { - "description": "OK - returns the cart with added shopping list entries", + "201": { + "description": "If set, the updated catalog is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Cart+json": { - "schema": { - "$ref": "#/components/schemas/CartWrapper" - } - }, - "application/vnd.ibexa.api.Cart+xml": { + "application/vnd.ibexa.api.Catalog+json": { "schema": { - "$ref": "#/components/schemas/Cart" + "$ref": "#/components/schemas/CatalogWrapper" + }, + "example": { + "Catalog": { + "_media-type": "application/vnd.ibexa.api.Catalog+json", + "identifier": "test_catalog_updated", + "name": "Snow Equipment updated", + "description": "Snow Equipment catalog for 2022", + "User": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "created": 1666090438, + "modified": 1666091260, + "status": "published", + "Criteria": [ + { + "_media-type": "application/vnd.ibexa.api.ProductCode+json", + "ProductCodeCriterion": { + "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json", + "codes": [ + "ski" + ] + } + }, + { + "_media-type": "application/vnd.ibexa.api.ProductAvailability+json", + "ProductAvailabilityCriterion": { + "_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 add shopping list to cart." + "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 - the shopping list or cart identifier doesn't match any existing resource." + "description": "Error - no catalog with the given identifier exists." } }, - "summary": "Add Shopping List to Specific Cart", - "description": "Adds all entries from the given Shopping List to the specified Cart.", + "summary": "Update catalog", + "description": "Updates a catalog.", "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", + "description": "CatalogUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "X-CSRF-Token", "in": "header", - "description": "CSRF Token is needed to execute this unsafe request.", + "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "No payload required", - "content": [], - "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "description": "If set, the updated catalog is returned in XML or JSON format.", + "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" + } + } + } }, - { - "name": "LTS Update", - "color": "#5DA7C0", - "position": "after" - } - ] + "required": false + } } }, - "/shopping-list/{identifier}/clear": { + "/product/catalog/catalogs/{identifier}/products/view": { "post": { - "operationId": "ibexa.rest.shopping_list.clear", + "operationId": "ibexa.product_catalog.rest.catalogs.products.view", "tags": [ - "Shopping List" + "Product Catalog" ], "responses": { "200": { - "description": "Shopping list cleared successfully. Returns the updated shopping list with no entries.", + "description": "The view in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShoppingList+json": { + "application/vnd.ibexa.api.ProductView+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListWrapper" + "$ref": "#/components/schemas/ProductViewWrapper" }, "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" + "ProductView": { + "_media-type": "application/vnd.ibexa.api.ProductView+json", + "identifier": "TitleView", + "ProductQuery": { + "_media-type": "application/vnd.ibexa.api.ProductQuery+json" }, - "entries": [], - "createdAt": "2024-10-29T12:00:00+00:00", - "updatedAt": "2024-10-29T12:15:00+00:00" + "Result": { + "_media-type": "application/vnd.ibexa.api.ViewResult+json", + "count": 1, + "ProductList": { + "_media-type": "application/vnd.ibexa.api.ProductList+json", + "Product": [ + { + "_media-type": "application/vnd.ibexa.api.Product+json", + "code": "test", + "name": "test", + "ProductType": { + "_media-type": "application/vnd.ibexa.api.ProductType+json", + "identifier": "quickdraw", + "name": "Quickdraw", + "AttributeAssignmentList": [] + }, + "Content": { + "_media-type": "application/vnd.ibexa.api.Content+json", + "_href": "/api/ibexa/v2/content/objects/187", + "_remoteId": "b0608be4ef4dc978ad603d02ac3c9ad1", + "_id": 187, + "ContentType": { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/55" + }, + "Name": "test", + "TranslatedName": "test", + "Versions": { + "_media-type": "application/vnd.ibexa.api.VersionList+json", + "_href": "/api/ibexa/v2/content/objects/187/versions" + }, + "CurrentVersion": { + "_media-type": "application/vnd.ibexa.api.Version+json", + "_href": "/api/ibexa/v2/content/objects/187/currentversion", + "Version": { + "_media-type": "application/vnd.ibexa.api.Version+json", + "_href": "/api/ibexa/v2/content/objects/187/versions/1", + "VersionInfo": { + "id": 665, + "versionNo": 1, + "status": "PUBLISHED", + "modificationDate": "2022-08-26T11:16:49+02:00", + "Creator": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "creationDate": "2022-08-26T11:16: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": "test" + } + ] + }, + "Content": { + "_media-type": "application/vnd.ibexa.api.ContentInfo+json", + "_href": "/api/ibexa/v2/content/objects/187" + } + }, + "Fields": { + "field": [ + { + "id": 915, + "fieldDefinitionIdentifier": "name", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_string", + "fieldValue": "test" + }, + { + "id": 916, + "fieldDefinitionIdentifier": "product_specification", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_product_specification", + "fieldValue": { + "id": 60, + "code": "test", + "attributes": [] + } + }, + { + "id": 917, + "fieldDefinitionIdentifier": "description", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_richtext", + "fieldValue": { + "xml": "\n
\n", + "xhtml5edit": "\n
\n" + } + }, + { + "id": 918, + "fieldDefinitionIdentifier": "image", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_image_asset", + "fieldValue": { + "destinationContentId": null, + "alternativeText": null, + "source": null + } + }, + { + "id": 919, + "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/187/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/187/locations" + }, + "Owner": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "lastModificationDate": "2022-08-26T11:16:49+02:00", + "publishedDate": "2022-08-26T11:16:49+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/187/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": 1661505409, + "updated_at": 1661505409, + "AttributesList": [] + } + ] + } + } } } }, - "application/vnd.ibexa.api.ShoppingList+xml": { + "application/vnd.ibexa.api.ProductView+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" + "$ref": "#/components/schemas/ProductView" + } } } }, - "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." + "400": { + "description": "Error - the input does not match the input schema definition." } }, - "summary": "Clear shopping list", - "description": "Removes all entries from a shopping list while keeping the list itself.", + "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": "identifier", "in": "path", - "description": "The unique identifier (UUID) of the shopping list.", + "description": "CatalogProductsViewController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "X-CSRF-Token", "in": "header", - "description": "CSRF Token is needed to execute this unsafe request.", + "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "No payload required", - "content": [], - "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "description": "The view input in XML or JSON format.", + "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" + } + } }, - { - "name": "LTS Update", - "color": "#5DA7C0", - "position": "after" - } - ] + "required": false + } } }, - "/shopping-list/{identifier}/entries": { - "post": { - "operationId": "ibexa.rest.shopping_list.add_entries", + "/product/catalog/currencies": { + "get": { + "operationId": "ibexa.product_catalog.rest.currencies", "tags": [ - "Shopping List" + "Product Currency" ], "responses": { "200": { - "description": "Entries added successfully. Returns the updated shopping list.", + "description": "OK - loads currencies.", "content": { - "application/vnd.ibexa.api.ShoppingList+json": { + "application/vnd.ibexa.api.CurrencyList+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListWrapper" + "$ref": "#/components/schemas/CurrencyListWrapper" }, "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": [ + "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 + }, { - "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" + "_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 } - ], - "createdAt": "2024-10-29T12:00:00+00:00", - "updatedAt": "2024-10-29T12:00:00+00:00" + ] } } - }, - "application/vnd.ibexa.api.ShoppingList+xml": { + } + } + }, + "401": { + "description": "Error - the user has no permission to read currencies." + } + }, + "summary": "Load currencies", + "description": "Loads the list of currencies.", + "parameters": [] + }, + "post": { + "operationId": "ibexa.product_catalog.rest.currencies.create", + "tags": [ + "Product Currency" + ], + "responses": { + "200": { + "description": "If set, the new currency is returned in JSON format.", + "content": { + "application/vnd.ibexa.api.Currency+json": { "schema": { - "$ref": "#/components/schemas/ShoppingList" + "$ref": "#/components/schemas/CurrencyWrapper" }, - "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" + "example": { + "Currency": { + "_media-type": "application/vnd.ibexa.api.Currency+json", + "id": 181, + "code": "cur", + "subunits": 1, + "enabled": true + } + } } } }, "400": { - "description": "Error - The input does not match the input schema definition." + "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)." + "description": "Error - the user is not authorized to create this currency." }, "406": { - "description": "Error - Shopping list entry limit exceeded." - }, - "404": { - "description": "Error - Shopping list not found." + "description": "Error - a currency with this code already exists." } }, - "summary": "Add entries to shopping list", - "description": "Adds one or more product entries to an existing shopping list.", + "summary": "Create currency", + "description": "Creates a new currency.", "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.", + "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "Entries to add to the shopping list", + "description": "The Currency schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShoppingListEntriesAdd+json": { + "application/vnd.ibexa.api.CurrencyCreate+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListEntriesAddWrapper" + "$ref": "#/components/schemas/CurrencyCreateWrapper" }, "example": { - "ShoppingListEntriesAdd": { - "entries": [ - { - "productCode": "PRODUCT-001" - }, - { - "productCode": "PRODUCT-002" - } - ] + "CurrencyCreate": { + "code": "cur", + "subunits": 1, + "enabled": true } } - }, - "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": { + "/product/catalog/currencies/view": { "post": { - "operationId": "ibexa.rest.shopping_list.remove_entries", + "operationId": "ibexa.product_catalog.rest.currencies.view", "tags": [ - "Shopping List" + "Product Currency" ], "responses": { "200": { - "description": "Entries removed successfully. Returns the updated shopping list.", + "description": "The view in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShoppingList+json": { + "application/vnd.ibexa.api.CurrencyView+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListWrapper" + "$ref": "#/components/schemas/CurrencyViewWrapper" }, "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" + "CurrencyView": { + "_media-type": "application/vnd.ibexa.api.CurrencyView+json", + "identifier": "TitleView", + "CurrencyQuery": { + "_media-type": "application/vnd.ibexa.api.CurrencyQuery+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" + "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 + } + ] } - ], - "createdAt": "2024-10-29T12:00:00+00:00", - "updatedAt": "2024-10-29T12:00:00+00:00" + } } } }, - "application/vnd.ibexa.api.ShoppingList+xml": { + "application/vnd.ibexa.api.CurrencyView+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" + "$ref": "#/components/schemas/CurrencyView" + } } } }, "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." + "description": "Error - the input does not match the input schema definition." } }, - "summary": "Remove entries from shopping list", - "description": "Removes one or more product entries from an existing shopping list by their identifiers.", + "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": "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.", + "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "Entries to remove from shopping list", + "description": "The view input in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShoppingListEntriesRemove+json": { + "application/vnd.ibexa.api.CurrencyViewInput+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListEntriesRemoveWrapper" + "$ref": "#/components/schemas/CurrencyViewInputWrapper" }, "example": { - "ShoppingListEntriesRemove": { - "identifiers": [ - "650e8400-e29b-41d4-a716-446655440001", - "650e8400-e29b-41d4-a716-446655440002" - ] + "ViewInput": { + "identifier": "TitleView", + "CurrencyQuery": { + "limit": "10", + "offset": "0" + } } } }, - "application/vnd.ibexa.api.ShoppingListEntriesRemove+xml": { + "application/vnd.ibexa.api.CurrencyViewInput+xml": { "schema": { - "$ref": "#/components/schemas/ShoppingListEntriesRemove" - }, - "example": "\n\n \n 650e8400-e29b-41d4-a716-446655440001\n 650e8400-e29b-41d4-a716-446655440002\n \n\n" + "$ref": "#/components/schemas/CurrencyViewInput" + } } }, "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - }, - { - "name": "LTS Update", - "color": "#5DA7C0", - "position": "after" - } - ] + } } }, - "/taxonomy/{taxonomyName}/entries": { - "delete": { - "operationId": "ibexa.taxonomy.rest.entries.remove", + "/product/catalog/currencies/{id}": { + "get": { + "operationId": "ibexa.product_catalog.rest.currencies.get", "tags": [ - "Taxonomy" + "Product Currency" ], "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", - "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": "TaxonomyEntryBulkRemove schema encoded in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.TaxonomyEntryBulkRemove+json": { - "schema": { - "$ref": "#/components/schemas/TaxonomyEntryBulkRemoveWrapper" - }, - "example": { - "TaxonomyEntryBulkRemove": { - "entries": [ - 2, - 3 - ] + "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": 3, + "code": "ALL", + "subunits": 2, + "enabled": false + } } } - }, - "application/vnd.ibexa.api.TaxonomyEntryBulkRemove+xml": { - "schema": { - "$ref": "#/components/schemas/TaxonomyEntryBulkRemove" - } } }, - "required": false - }, - "deprecated": false - } - }, - "/taxonomy/{taxonomyName}/entries/move": { - "post": { - "operationId": "ibexa.taxonomy.rest.entries.move", - "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." + "description": "Error - the user has no permission to read currencies." }, "404": { - "description": "Error - Some to-be-moved or sibling entries do not exist." + "description": "Error - the currency does not exist." } }, - "summary": "Move Entries", - "description": "Bulk move several taxonomy entries relative to sibling.", + "summary": "Load currency", + "description": "Loads a currency.", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "taxonomyName", + "name": "id", "in": "path", - "description": "", + "description": "CurrencyLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "requestBody": { - "description": "The TaxonomyEntryBulkMove schema encoded in XML or JSON format.", - "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": "ibexa.taxonomy.rest.entry_assignment.load_by_id", - "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" - } - } - } + ] + }, + "delete": { + "operationId": "ibexa.product_catalog.rest.currencies.delete", + "tags": [ + "Product Currency" + ], + "responses": { + "200": { + "description": "No content - the given currency is deleted." }, - "404": { - "description": "Error - the assignment does not exist." + "401": { + "description": "Error - the user is not authorized to delete this currency." } }, - "summary": "Get Assignment by ID", - "description": "Gets taxonomy entry Assignment by its ID.", + "summary": "Delete currency", + "description": "Deletes the given currency.", "parameters": [ { - "name": "taxonomyName", + "name": "id", "in": "path", - "description": "", + "description": "CurrencyDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "id", - "in": "path", - "description": "", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false - } - }, - "/taxonomy/{taxonomyName}/entry-assignments/assign-to-content": { - "post": { - "operationId": "ibexa.taxonomy.rest.entry_assignments.assign_to_content", + ] + }, + "patch": { + "operationId": "ibexa.product_catalog.rest.currencies.update", "tags": [ - "Taxonomy" + "Product Currency" ], "responses": { - "201": { - "description": "No Content." + "200": { + "description": "If set, the updated currency is returned in XML or JSON format.", + "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 assign this Entry." + "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": "Assign entry", - "description": "Assigns taxonomy entry to a content item.", + "summary": "Update currency", + "description": "Updates a currency.", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", + "name": "id", + "in": "path", + "description": "CurrencyUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "taxonomyName", - "in": "path", - "description": "", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "TaxonomyEntryAssignToContent schema encoded in JSON format.", + "description": "The CurrencyUpdate schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json": { + "application/vnd.ibexa.api.CurrencyUpdate+json": { "schema": { - "$ref": "#/components/schemas/TaxonomyEntryAssignToContentWrapper" + "$ref": "#/components/schemas/CurrencyUpdateWrapper" }, "example": { - "TaxonomyEntryAssignToContent": { - "content": 130, - "entries": [ - 2, - 3 - ] + "CurrencyUpdate": { + "subunits": 1, + "enabled": false } } } }, "required": false - }, - "deprecated": false + } } }, - "/taxonomy/{taxonomyName}/entry-assignments/content-id/{contentId}": { + "/product/catalog/customer_groups": { "get": { - "operationId": "ibexa.taxonomy.rest.entry_assignments.load", + "operationId": "ibexa.product_catalog.rest.customer_groups.list", "tags": [ - "Taxonomy" + "Product Customer Group" ], "responses": { "200": { - "description": "OK - returns the assigment collection.", + "description": "If set, the customer groups list is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.EntryAssignmentCollection+json": { + "application/vnd.ibexa.api.CustomerGroupList+json": { "schema": { - "$ref": "#/components/schemas/EntryAssignmentCollectionWrapper" + "$ref": "#/components/schemas/CustomerGroupListWrapper" }, "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": [ + "CustomerGroupList": { + "_media-type": "application/vnd.ibexa.api.CustomerGroupList+json", + "CustomerGroup": [ { - "_media-type": "application/vnd.ibexa.api.TaxonomyEntryAssignment+json", + "_media-type": "application/vnd.ibexa.api.CustomerGroup+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" - } - } + "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" } ] } } - }, - "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." + "401": { + "description": "Error - the user has no permission to read customer groups." } }, - "summary": "Get Assignments to a Content", - "description": "Gets taxonomy entries assigned to a content item by its ID.", - "parameters": [ - { - "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": { + "summary": "Load customer groups", + "description": "Returns a list of customer groups", + "parameters": [] + }, "post": { - "operationId": "ibexa.taxonomy.rest.entry_assignments.unassign_from_content", + "operationId": "ibexa.product_catalog.rest.customer_group.create", "tags": [ - "Taxonomy" + "Product Customer Group" ], "responses": { "201": { - "description": "No Content." + "description": "If set, the new customer group is returned in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.CustomerGroup+json": { + "schema": { + "$ref": "#/components/schemas/CustomerGroupWrapper" + }, + "example": { + "CustomerGroup": { + "_media-type": "application/vnd.ibexa.api.CustomerGroup+json", + "id": 5, + "name": "test-en", + "identifier": "test", + "description": "test-desc-en", + "users": [], + "global_price_rate": "1.00" + } + } + } + } }, "400": { "description": "Error - the input does not match the input schema definition." }, "401": { - "description": "Error - the user is not authorized to unassign this entry." + "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": "Unassign entry", - "description": "Unassigns taxonomy entry from a content item.", + "summary": "Create customer group", + "description": "Creates a new customer group.", "parameters": [ { "name": "X-CSRF-Token", "in": "header", - "description": "The CSRF token.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "taxonomyName", - "in": "path", - "description": "", + "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "TaxonomyEntryUnassignFromContent schema encoded in JSON format.", + "description": "The CustomerGroupCreate schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json": { + "application/vnd.ibexa.api.CustomerGroupCreate+json": { "schema": { - "$ref": "#/components/schemas/TaxonomyEntryUnassignFromContentWrapper" + "$ref": "#/components/schemas/CustomerGroupCreateWrapper" }, "example": { - "TaxonomyEntryUnassignFromContent": { - "content": 130, - "entries": [ - 2, - 3 - ] + "CustomerGroupCreate": { + "identifier": "customer_group", + "names": { + "eng-GB": "Customer Group" + }, + "descriptions": { + "eng-GB": "Customer Group description" + }, + "global_price_rate": "1" } } } }, "required": false - }, - "deprecated": false + } } }, - "/taxonomy/{taxonomyName}/entry/content-id/{contentId}": { - "get": { - "operationId": "ibexa.taxonomy.rest.entry.load_by_content_id", + "/product/catalog/customer_groups/view": { + "post": { + "operationId": "ibexa.product_catalog.rest.customer_groups.view", "tags": [ - "Taxonomy" + "Product Customer Group" ], "responses": { "200": { - "description": "OK - returns the taxonomy Entry.", + "description": "The view in XML or JSON format.", "content": { - "application/vnd.ibexa.api.TaxonomyEntry+json": { + "application/vnd.ibexa.api.CustomerGroupView+json": { "schema": { - "$ref": "#/components/schemas/TaxonomyEntryWrapper" + "$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.TaxonomyEntry+xml": { + "application/vnd.ibexa.api.CustomerGroupView+xml": { "schema": { - "$ref": "#/components/schemas/TaxonomyEntry" + "$ref": "#/components/schemas/CustomerGroupView" } } } }, - "401": { - "description": "Error - the user is not authorized to read this Entry." - }, - "404": { - "description": "Error - the Entry does not exists." + "400": { + "description": "Error - the input does not match the input schema definition." } }, - "summary": "Get Entry by Content ID", - "description": "Loads taxonomy Entry by its Content ID.", + "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": "taxonomyName", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "contentId", - "in": "path", - "description": "", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], - "deprecated": false + "requestBody": { + "description": "The view input in XML or JSON format.", + "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 + } } }, - "/taxonomy/{taxonomyName}/entry/identifier/{identifier}": { + "/product/catalog/customer_groups/{identifier}": { "get": { - "operationId": "ibexa.taxonomy.rest.entry.load_by_identifier", + "operationId": "ibexa.product_catalog.rest.customer_groups.identifier", "tags": [ - "Taxonomy" + "Product Customer Group" ], "responses": { "200": { - "description": "OK - returns the taxonomy Entry.", + "description": "If set, the customer group is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.TaxonomyEntry+json": { - "schema": { - "$ref": "#/components/schemas/TaxonomyEntryWrapper" - } - }, - "application/vnd.ibexa.api.TaxonomyEntry+xml": { + "application/vnd.ibexa.api.CustomerGroup+json": { "schema": { - "$ref": "#/components/schemas/TaxonomyEntry" + "$ref": "#/components/schemas/CustomerGroupWrapper" + }, + "example": { + "CustomerGroup": { + "_media-type": "application/vnd.ibexa.api.CustomerGroup+json", + "id": 1, + "name": "Resellers", + "identifier": "resellers", + "description": "", + "users": [], + "global_price_rate": "0.00" + } } } } }, "401": { - "description": "Error - the user is not authorized to read this Entry." + "description": "Error - the user has no permission to read customer groups." + } + }, + "summary": "Load customer group", + "description": "Returns a customer group", + "parameters": [ + { + "name": "identifier", + "in": "path", + "description": "CustomerGroupLoadByIdentifierController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + }, + "delete": { + "operationId": "ibexa.product_catalog.rest.customer_groups.delete", + "tags": [ + "Product Customer Group" + ], + "responses": { + "204": { + "description": "No content - the given customer group is deleted." }, - "404": { - "description": "Error - the Entry does not exists." + "401": { + "description": "Error - the user is not authorized to delete this customer group." } }, - "summary": "Get Entry by identifier", - "description": "Loads taxonomy Entry by its Entry identifier.", + "summary": "Delete customer group", + "description": "Deletes the given customer group.", "parameters": [ { - "name": "taxonomyName", + "name": "identifier", "in": "path", - "description": "", + "description": "CustomerGroupDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "identifier", - "in": "path", - "description": "", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false - } - }, - "/taxonomy/{taxonomyName}/entry/{id}": { - "get": { - "operationId": "ibexa.taxonomy.rest.entry.load_by_id", + ] + }, + "patch": { + "operationId": "ibexa.product_catalog.rest.customer_group.update", "tags": [ - "Taxonomy" + "Product Customer Group" ], "responses": { - "200": { - "description": "OK - returns the taxonomy Entry.", + "201": { + "description": "If set, the updated customer group is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.TaxonomyEntry+json": { - "schema": { - "$ref": "#/components/schemas/TaxonomyEntryWrapper" - } - }, - "application/vnd.ibexa.api.TaxonomyEntry+xml": { + "application/vnd.ibexa.api.CustomerGroup+json": { "schema": { - "$ref": "#/components/schemas/TaxonomyEntry" + "$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 is not authorized to read this Entry." + "400": { + "description": "Error - the input does not match the input schema definition." }, - "404": { - "description": "Error - the Entry does not exists." + "401": { + "description": "Error - the user is not authorized to update a customer group." } }, - "summary": "Get Entry by ID", - "description": "Loads taxonomy Entry by its Entry ID.", + "summary": "Update customer group", + "description": "Updates the given customer group.", "parameters": [ { - "name": "taxonomyName", + "name": "identifier", "in": "path", - "description": "", + "description": "CustomerGroupUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "id", - "in": "path", - "description": "", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], - "deprecated": false + "requestBody": { + "description": "The CustomerGroupUpdate schema encoded in XML or JSON format.", + "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 + } } }, - "/content/trash": { + "/product/catalog/customer_groups/{id}": { "get": { - "operationId": "ibexa.rest.load_trash_items", + "operationId": "ibexa.product_catalog.rest.customer_group", "tags": [ - "Trash" + "Product Customer Group" ], "responses": { "200": { - "description": "OK - returns the list of items in the Trash.", + "description": "If set, the customer group is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Trash+json": { + "application/vnd.ibexa.api.CustomerGroup+json": { "schema": { - "$ref": "#/components/schemas/TrashWrapper" + "$ref": "#/components/schemas/CustomerGroupWrapper" }, "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" - } - } - } - } - ] + "CustomerGroup": { + "_media-type": "application/vnd.ibexa.api.CustomerGroup+json", + "id": 1, + "name": "Customer Group", + "identifier": "customer_group", + "description": "", + "users": [], + "global_price_rate": "1.00" } } - }, - "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": [], - "deprecated": false - }, - "delete": { - "operationId": "ibexa.rest.empty_trash", - "tags": [ - "Trash" - ], - "responses": { - "204": { - "description": "No Content - Trash emptied." - }, - "401": { - "description": "Error - The user is not authorized to empty all items from Trash." + "description": "Error - the user has no permission to read customer groups." } }, - "summary": "Empty Trash", - "description": "Empties the Trash.", + "summary": "Load customer group", + "description": "Returns a customer group", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "name": "id", + "in": "path", + "description": "CustomerGroupLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { - "type": "string" + "type": "integer" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] } }, - "/content/trash/{trashItemid}": { + "/product/catalog/regions": { "get": { - "operationId": "ibexa.rest.load_trash_item", + "operationId": "ibexa.product_catalog.rest.regions", "tags": [ - "Trash" + "Product Region" ], "responses": { "200": { - "description": "If set, the item in Trash is returned in XML or JSON format.", + "description": "OK - loads regions.", "content": { - "application/vnd.ibexa.api.TrashItem+json": { + "application/vnd.ibexa.api.RegionList+json": { "schema": { - "$ref": "#/components/schemas/TrashItemWrapper" + "$ref": "#/components/schemas/RegionListWrapper" }, "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" - } + "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.TrashItem+xml": { + "application/vnd.ibexa.api.RegionList+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" + "$ref": "#/components/schemas/RegionList" + } } } }, "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." + "description": "Error - the user has no permission to read regions." } }, - "summary": "Get Trash item", - "description": "Returns the item in Trash with the provided ID.", - "parameters": [ - { - "name": "trashItemid", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "delete": { - "operationId": "ibexa.rest.delete_trash_item", + "summary": "Load regions", + "description": "Loads the list of regions.", + "parameters": [] + } + }, + "/product/catalog/regions/view": { + "post": { + "operationId": "ibexa.product_catalog.rest.regions.view", "tags": [ - "Trash" + "Product Region" ], "responses": { - "204": { - "description": "No Content - item deleted." - }, - "401": { - "description": "Error - The user is not authorized to delete the provided item." + "200": { + "description": "The view in XML or JSON format.", + "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" + } + } + } }, - "404": { - "description": "Error - The provided item does not exist in Trash." + "400": { + "description": "Error - the input does not match the input schema definition." } }, - "summary": "Delete Trash item", - "description": "Deletes the provided item from Trash.", - "parameters": [ - { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "trashItemid", - "in": "path", - "description": "", + "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": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], - "deprecated": false + "requestBody": { + "description": "The view input in XML or JSON format.", + "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 + } } }, - "/content/types": { + "/product/catalog/regions/{identifier}": { "get": { - "operationId": "ibexa.rest.list_content_types", + "operationId": "ibexa.product_catalog.rest.region", "tags": [ - "Type" + "Product Region" ], "responses": { "200": { - "description": "OK - returns a list of content types.", + "description": "OK - loads region.", "content": { - "application/vnd.ibexa.api.ContentTypeInfoList+json": { + "application/vnd.ibexa.api.Region+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": [] - } - ] - } - }, + "$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": "identifier", + "in": "path", + "description": "RegionLoadByIdentifierController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + } + }, + "/product/catalog/product_types": { + "get": { + "operationId": "ibexa.product_catalog.rest.product_types", + "tags": [ + "Product Type" + ], + "responses": { + "200": { + "description": "ProductTypeList - If set, the product type list is returned in XML or JSON format.", + "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.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.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": [], + "requestBody": { + "description": "The ProductTypeList schema encoded in XML or JSON format.", + "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 + } + }, + "post": { + "operationId": "ibexa.product_catalog.rest.product_types.create", + "tags": [ + "Product Type" + ], + "responses": { + "201": { + "description": "If set, the new product type is returned in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.ProductType+json": { + "schema": { + "$ref": "#/components/schemas/ProductTypeWrapper" + }, + "example": { + "ProductType": { + "_media-type": "application/vnd.ibexa.api.ProductType+json", + "identifier": "test_pt321", + "name": "New Product Type", + "AttributeAssignmentList": [ + { + "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", + "is_required": false, + "is_discriminator": true, + "Attribute": { + "_media-type": "application/vnd.ibexa.api.Attribute+json", + "identifier": "testAttr", + "name": "testAttr", + "description": "", + "type": "Checkbox", + "type_identifier": "checkbox", + "value": true, + "group": "Test Attribute group", + "position": 0, + "options": [] + } + } + ] + } + } + } + } + }, + "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": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "The ProductType schema encoded in XML or JSON format.", + "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": "<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" } - }, - { - "_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": [] + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] + }, + "fieldSettings": [], + "validatorConfiguration": { + "StringLengthValidator": { + "maxStringLength": 255, + "minStringLength": null } - ] + } } - }, - { - "_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" + ] + } + }, + "main_language_code": "eng-GB", + "assigned_attributes": [ + { + "identifier": "testAttr", + "is_required": false, + "is_discriminator": true + } + ] + } + } + } + }, + "required": false + } + } + }, + "/product/catalog/product_types/is_used/{identifier}": { + "get": { + "operationId": "ibexa.product_catalog.rest.product_types.is_used", + "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" + }, + "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ProductTypeUsage media-type=\"application/vnd.ibexa.api.ProductTypeUsage+xml\">\n <is_used>1</is_used>\n</ProductTypeUsage>\n" + } + } + }, + "404": { + "description": "Error - product type not found." + } + }, + "summary": "Check product type usage", + "description": "Checks whether the product type is in use.", + "parameters": [ + { + "name": "identifier", + "in": "path", + "description": "ProductTypeIsUsedController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + } + }, + "/product/catalog/product_types/view": { + "post": { + "operationId": "ibexa.product_catalog.rest.product_types.view", + "tags": [ + "Product Type" + ], + "responses": { + "200": { + "description": "The view in XML or JSON format.", + "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 + } } - ] - }, - "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.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": [] } } - }, - { - "_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": { + "application/vnd.ibexa.api.ProductTypeView+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" + "$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": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "The view input in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.ProductTypeViewInput+json": { + "schema": { + "$ref": "#/components/schemas/ProductTypeViewInputWrapper" }, - "application/vnd.ibexa.api.ContentTypeList+json": { + "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 + } + } + }, + "/product/catalog/product_types/{identifier}": { + "get": { + "operationId": "ibexa.product_catalog.rest.product_type", + "tags": [ + "Product Type" + ], + "responses": { + "200": { + "description": "OK - load the product type", + "content": { + "application/vnd.ibexa.api.ProductType+json": { "schema": { - "$ref": "#/components/schemas/ContentTypeListWrapper" + "$ref": "#/components/schemas/ProductTypeWrapper" + }, + "example": { + "ProductType": { + "_media-type": "application/vnd.ibexa.api.ProductType+json", + "identifier": "d_rope", + "name": "Dynamic ropes", + "AttributeAssignmentList": [] + } } }, - "application/vnd.ibexa.api.ContentTypeList+xml": { + "application/vnd.ibexa.api.ProductType+xml": { "schema": { - "$ref": "#/components/schemas/ContentTypeList" + "$ref": "#/components/schemas/ProductType" } } } }, "401": { - "description": "Error - The user has no permission to read the content types." + "description": "Error - the user has no permission to read product type." + }, + "404": { + "description": "Error - product type not found." } }, - "summary": "List content types", - "description": "Returns a list of content types.", - "parameters": [], - "deprecated": false + "summary": "Load product type", + "description": "Returns the given product type.", + "parameters": [ + { + "name": "identifier", + "in": "path", + "description": "ProductTypeLoadByIdentifierController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] } }, - "/content/types/view": { - "post": { - "operationId": "ibexa.rest.content_types.view", + "/product/catalog/product_types/{id}": { + "delete": { + "operationId": "ibexa.product_catalog.rest.product_types.delete", "tags": [ - "Type" + "Product Type" ], "responses": { - "200": { - "description": "The view in XML or JSON format.", + "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": "ProductTypeDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + }, + "patch": { + "operationId": "ibexa.product_catalog.rest.product_types.update", + "tags": [ + "Product Type" + ], + "responses": { + "201": { + "description": "If set, the updated product type is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ContentTypeList+json": { + "application/vnd.ibexa.api.ProductType+json": { "schema": { - "$ref": "#/components/schemas/ContentTypeInfoListWrapper" + "$ref": "#/components/schemas/ProductTypeWrapper" }, "example": { - "ContentTypeList": { - "_media-type": "application/vnd.ibexa.api.ContentTypeList+json", - "_href": "/api/ibexa/v2/content/typegroups/1/types", - "ContentType": [ + "ProductType": { + "_media-type": "application/vnd.ibexa.api.ProductType+json", + "identifier": "NEW", + "name": "pt_1_updated", + "AttributeAssignmentList": [ { - "_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" + "_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": "id", + "in": "path", + "description": "ProductTypeUpdateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "If set, the updated product type is returned in XML or JSON format.", + "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 + } + } + }, + "/product/catalog/product_variant/{code}": { + "get": { + "operationId": "ibexa.product_catalog.rest.product_variant", + "tags": [ + "Product Variant" + ], + "responses": { + "200": { + "description": "OK - loads the product variant.", + "content": { + "application/vnd.ibexa.api.ProductVariant+json": { + "schema": { + "$ref": "#/components/schemas/ProductVariantWrapper" + }, + "example": { + "ProductVariant": { + "_media-type": "application/vnd.ibexa.api.ProductVariant+json", + "code": "macbook", + "name": "Macbook Air 32/232", + "Product": { + "_media-type": "application/vnd.ibexa.api.Product+json", + "code": "mac_air", + "name": "Macbook Air", + "ProductType": { + "_media-type": "application/vnd.ibexa.api.ProductType+json", + "identifier": "laptop", + "name": "Laptop", + "AttributeAssignmentList": [ + { + "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", + "is_required": false, + "is_discriminator": true, + "Attribute": { + "_media-type": "application/vnd.ibexa.api.Attribute+json", + "identifier": "number", + "name": "number", + "description": "", + "type": "Float", + "type_identifier": "float", + "value": 1.5, + "group": "test", + "position": 0, + "options": { + "min": 4, + "max": 5 + } } - ] - }, - "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": [ + }, + { + "_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", - "#text": "Title" + "languageCode": "eng-GB" } ] }, - "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" + "#text": "Macbook Air" } ] }, - "descriptions": { - "value": [] - }, - "fieldSettings": [], - "validatorConfiguration": { - "StringLengthValidator": { - "maxStringLength": 255, - "minStringLength": null - } + "Content": { + "_media-type": "application/vnd.ibexa.api.ContentInfo+json", + "_href": "/api/ibexa/v2/content/objects/152" } }, - { - "_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" + "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": [] } - ] - }, - "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" + }, + { + "id": 718, + "fieldDefinitionIdentifier": "description", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_richtext", + "fieldValue": { + "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" xmlns:ezxhtml=\"http://ibexa.co/xmlns/dxp/docbook/xhtml\" xmlns:ezcustom=\"http://ibexa.co/xmlns/dxp/docbook/custom\" version=\"5.0-variant ezpublish-1.0\"><para>test</para></section>\n", + "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"><p>test</p></section>\n" } - ] - }, - "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" + }, + { + "id": 719, + "fieldDefinitionIdentifier": "image", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_image_asset", + "fieldValue": { + "destinationContentId": null, + "alternativeText": null, + "source": null } - ] - }, - "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" + }, + { + "id": 720, + "fieldDefinitionIdentifier": "category", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", + "fieldValue": { + "taxonomy_entries": [], + "taxonomy": null } - ] - }, - "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" + "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" } - ] + } }, - "descriptions": { - "value": [] + "Section": { + "_media-type": "application/vnd.ibexa.api.Section+json", + "_href": "/api/ibexa/v2/content/sections/1" }, - "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" + "Locations": { + "_media-type": "application/vnd.ibexa.api.LocationList+json", + "_href": "/api/ibexa/v2/content/objects/152/locations" }, - "Modifier": { + "Owner": { "_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, + "lastModificationDate": "2022-07-21T15:17:18+02:00", + "publishedDate": "2022-07-21T15:17:18+02:00", "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": [ + "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 + } + } + ] + } + } + } + } + }, + "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": "code", + "in": "path", + "description": "ProductVariantLoadByCodeController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + } + }, + "/product/catalog/product_variants/generate/{baseProductCode}": { + "post": { + "operationId": "ibexa.product_catalog.rest.product_variants.generate", + "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": "baseProductCode", + "in": "path", + "description": "ProductVariantGenereateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "The product variant schema encoded in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.ProductVariantGenerate+json": { + "schema": { + "$ref": "#/components/schemas/ProductVariantGenerateWrapper" + }, + "example": { + "ProductVariantGenerate": { + "attributes": { + "width": [ + 123 + ], + "colors": [ + "#000000", + "#ffffff", + "#d4d400", + "#ff0000" + ] + } + } + } + } + }, + "required": false + } + } + }, + "/product/catalog/product_variants/view/{baseProductCode}": { + "post": { + "operationId": "ibexa.product_catalog.rest.product_variants.view", + "tags": [ + "Product Variant" + ], + "responses": { + "200": { + "description": "The view in XML or JSON format.", + "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": [ { - "_languageCode": "eng-GB", - "#text": "Name" + "_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 + } + } } ] }, - "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" + "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": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" xmlns:ezxhtml=\"http://ibexa.co/xmlns/dxp/docbook/xhtml\" xmlns:ezcustom=\"http://ibexa.co/xmlns/dxp/docbook/custom\" version=\"5.0-variant ezpublish-1.0\"><para>test</para></section>\n", + "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"><p>test</p></section>\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" + } }, - "descriptions": { - "value": [] + "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" }, - "fieldSettings": [], - "validatorConfiguration": { - "StringLengthValidator": { - "maxStringLength": 100, - "minStringLength": null - } - } + "created_at": 1658409438, + "updated_at": 1658409438, + "AttributesList": [] }, - { - "_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" + "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 + } }, - "isSearchable": true, - "names": { - "value": [ + { + "_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": [ { - "_languageCode": "eng-GB", - "#text": "Short description" + "_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 + } + } } ] }, - "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" + "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": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" xmlns:ezxhtml=\"http://ibexa.co/xmlns/dxp/docbook/xhtml\" xmlns:ezcustom=\"http://ibexa.co/xmlns/dxp/docbook/custom\" version=\"5.0-variant ezpublish-1.0\"><para>test</para></section>\n", + "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"><p>test</p></section>\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" + } } - ] - }, - "descriptions": { - "value": [] + }, + "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" + } }, - "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" - } - ] + "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" }, - "descriptions": { - "value": [] + "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 + } }, - "fieldSettings": [], - "validatorConfiguration": { - "StringLengthValidator": { - "maxStringLength": null, - "minStringLength": null + { + "_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.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" + ] + } + ] + } + } + } + } + }, + "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": "baseProductCode", + "in": "path", + "description": "ProductVariantViewController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "The view input in XML or JSON format.", + "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 + } + } + }, + "/product/catalog/product_variants/{baseProductCode}": { + "post": { + "operationId": "ibexa.product_catalog.rest.product_variants.create", + "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": "baseProductCode", + "in": "path", + "description": "ProductVariantCreateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "The product variant schema encoded in XML or JSON format.", + "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 + } + } + }, + "/product/catalog/product_variants/{code}": { + "delete": { + "operationId": "ibexa.product_catalog.rest.product_variants.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": "ProductVariantDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + }, + "patch": { + "operationId": "ibexa.product_catalog.rest.product_variants.update", + "tags": [ + "Product Variant" + ], + "responses": { + "201": { + "description": "If set, the updated product variant is returned in XML or JSON format.", + "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 + } } - ] - }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "" + }, + { + "_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 + } } - ] - }, - "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" - } - ] + } + ] + }, + "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" }, - "descriptions": { - "value": [ + "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", - "#text": "Title" + "languageCode": "eng-GB" } ] }, - "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" + "#text": "Macbook Air" } ] }, - "fieldSettings": [], - "validatorConfiguration": { - "StringLengthValidator": { - "maxStringLength": null, - "minStringLength": null - } + "Content": { + "_media-type": "application/vnd.ibexa.api.ContentInfo+json", + "_href": "/api/ibexa/v2/content/objects/152" } }, - { - "_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": [] + "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": [] } - ] - }, - "isSearchable": false, - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Landing page" + }, + { + "id": 718, + "fieldDefinitionIdentifier": "description", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_richtext", + "fieldValue": { + "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" xmlns:ezxhtml=\"http://ibexa.co/xmlns/dxp/docbook/xhtml\" xmlns:ezcustom=\"http://ibexa.co/xmlns/dxp/docbook/custom\" version=\"5.0-variant ezpublish-1.0\"><para>test</para></section>\n", + "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"><p>test</p></section>\n" } - ] - }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Landing page" + }, + { + "id": 719, + "fieldDefinitionIdentifier": "image", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_image_asset", + "fieldValue": { + "destinationContentId": null, + "alternativeText": null, + "source": null } - ] - }, - "fieldSettings": { - "availableBlocks": null, - "availableLayouts": null, - "editorMode": "page_view_mode" - }, - "validatorConfiguration": [] + }, + { + "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": "code", + "in": "path", + "description": "ProductVariantUpdateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF token is required when passing user session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "The product variant update schema encoded in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.ProductVariantUpdate+json": { + "schema": { + "$ref": "#/components/schemas/ProductVariantUpdateWrapper" + }, + "example": { + "ProductVariantUpdate": { + "code": "test", + "attributes": { + "number": 2, + "testattr": 10 + } + } + } + } + }, + "required": false + } + } + }, + "/product/catalog/vat/{region}": { + "get": { + "operationId": "ibexa.product_catalog.rest.vat.list", + "tags": [ + "Product Vat" + ], + "responses": { + "200": { + "description": "OK - loads the VAT category list.", + "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": "region", + "in": "path", + "description": "VatCategoriesListController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + } + }, + "/product/catalog/vat/{region}/{identifier}": { + "get": { + "operationId": "ibexa.product_catalog.rest.vat", + "tags": [ + "Product Vat" + ], + "responses": { + "200": { + "description": "OK - loads the VAT category.", + "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": "region", + "in": "path", + "description": "VatCategoryLoadByIdentifierController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "identifier", + "in": "path", + "description": "VatCategoryLoadByIdentifierController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + } + }, + "/content/sections": { + "get": { + "operationId": "ibexa.rest.list_sections", + "tags": [ + "Section" + ], + "responses": { + "200": { + "description": "If set, the Section list is returned in XML or JSON format.", + "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.ContentTypeList+xml": { + "application/vnd.ibexa.api.SectionList+xml": { + "schema": { + "$ref": "#/components/schemas/SectionList" + }, + "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SectionList media-type=\"application/vnd.ibexa.api.SectionList+xml\" href=\"/api/ibexa/v2/content/sections\">\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/1\">\n <sectionId>1</sectionId>\n <identifier>standard</identifier>\n <name>Standard</name>\n </Section>\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/2\">\n <sectionId>2</sectionId>\n <identifier>users</identifier>\n <name>Users</name>\n </Section>\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/3\">\n <sectionId>3</sectionId>\n <identifier>media</identifier>\n <name>Media</name>\n </Section>\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/6\">\n <sectionId>6</sectionId>\n <identifier>form</identifier>\n <name>Form</name>\n </Section>\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/7\">\n <sectionId>7</sectionId>\n <identifier>template</identifier>\n <name>Template</name>\n </Section>\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/8\">\n <sectionId>8</sectionId>\n <identifier>restricted</identifier>\n <name>Restricted</name>\n </Section>\n</SectionList>\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": "If-None-Match", + "in": "header", + "description": "ETag", + "required": false, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + }, + "post": { + "operationId": "ibexa.rest.create_section", + "tags": [ + "Section" + ], + "responses": { + "201": { + "description": "If set, the new Section is returned in XML or JSON format.", + "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/13", + "sectionId": 13, + "identifier": "restricted", + "name": "Restricted" + } + } + }, + "application/vnd.ibexa.api.Section+xml": { "schema": { - "$ref": "#/components/schemas/ContentTypeInfoList" + "$ref": "#/components/schemas/Section" }, - "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" + "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/7\">\n <sectionId>7</sectionId>\n <identifier>restricted</identifier>\n <name>Restricted</name>\n</Section>\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.", + "summary": "Create new Section", + "description": "Creates a new Section.", "parameters": [ { "name": "X-CSRF-Token", @@ -29677,505 +15428,197 @@ "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "The view input in XML or JSON format.", + "description": "The Section input schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ContentTypeViewInput+json": { + "application/vnd.ibexa.api.SectionInput+json": { "schema": { - "$ref": "#/components/schemas/ContentTypeViewInputWrapper" + "$ref": "#/components/schemas/SectionInputWrapper" }, "example": { - "ViewInput": { - "identifier": "ContentTypeView", - "ContentTypeQuery": { - "limit": "10", - "offset": "1", - "Query": { - "ContentTypeIdCriterion": [ - 1, - 2 - ], - "ContentTypeIdentifierCriterion": "folder", - "IsSystemCriterion": true, - "ContentTypeGroupIdCriterion": 1, - "ContainsFieldDefinitionIdCriterion": 2 - }, - "SortClauses": { - "Identifier": "descending", - "Id": "ascending" - } - } + "SectionInput": { + "identifier": "restricted", + "name": "Restricted" } } }, - "application/vnd.ibexa.api.ContentTypeViewInput+xml": { + "application/vnd.ibexa.api.SectionInput+xml": { "schema": { - "$ref": "#/components/schemas/ContentTypeViewInput" + "$ref": "#/components/schemas/SectionInput" }, - "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" + "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SectionInput>\n <identifier>restricted</identifier>\n <name>Restricted</name>\n</SectionInput>" } }, "required": false - }, - "deprecated": false + } } }, - "/content/types/{contentTypeId}": { + "/content/sections/{sectionId}": { "get": { - "operationId": "ibexa.rest.load_content_type", + "operationId": "ibexa.rest.load_section", "tags": [ - "Type" + "Section" ], "responses": { "200": { - "description": "OK - returns the content type.", + "description": "If set, the Section is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ContentType+json": { + "application/vnd.ibexa.api.Section+json": { "schema": { - "$ref": "#/components/schemas/ContentTypeWrapper" + "$ref": "#/components/schemas/SectionWrapper" }, "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": [] - } - ] - } + "Section": { + "_media-type": "application/vnd.ibexa.api.Section+json", + "_href": "/api/ibexa/v2/content/sections/10", + "sectionId": 10, + "identifier": "design", + "name": "Design" } } }, - "application/vnd.ibexa.api.ContentType+xml": { + "application/vnd.ibexa.api.Section+xml": { "schema": { - "$ref": "#/components/schemas/ContentType" + "$ref": "#/components/schemas/Section" }, - "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\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-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 <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" + "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/5\">\n <sectionId>10</sectionId>\n <identifier>design</identifier>\n <name>Design</name>\n</Section>\n" } } }, "401": { - "description": "Error - The user is not authorized to read this content type." + "description": "Error - The user is not authorized to read this Section." }, "404": { - "description": "Error - The content type does not exist." + "description": "Error - The Section does not exist." } }, - "summary": "Get content type", - "description": "Returns the content type with the provided ID.", + "summary": "Get Section", + "description": "Returns the Section by given Section ID.", "parameters": [ { - "name": "If-None-Match", + "name": "If-None-match", "in": "header", "description": "ETag", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "contentTypeId", + "name": "sectionId", "in": "path", - "description": "", + "description": "SectionLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } + ] + }, + "delete": { + "operationId": "ibexa.rest.delete_section", + "tags": [ + "Section" ], - "deprecated": false + "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": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "sectionId", + "in": "path", + "description": "SectionDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] }, - "post": { - "operationId": "ibexa.rest.create_content_type_draft", + "patch": { + "operationId": "ibexa.rest.update_section", "tags": [ - "Type" + "Section" ], "responses": { - "201": { - "description": "Draft created.", + "200": { + "description": "OK - Section updated.", "content": { - "application/vnd.ibexa.api.ContentTypeInfo+json": { + "application/vnd.ibexa.api.Section+json": { "schema": { - "$ref": "#/components/schemas/ContentTypeInfoWrapper" + "$ref": "#/components/schemas/SectionWrapper" }, "example": { - "ContentTypeInfo": { - "_media-type": "application/vnd.ibexa.api.ContentTypeInfo+json", - "_href": "/api/ibexa/v2/content/types/1/draft", - "id": 1, - "status": "DRAFT", - "identifier": "folder", - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Folder" - } - ] - }, - "descriptions": { - "value": [] - }, - "creationDate": "2002-06-18T09:21:38+00:00", - "modificationDate": "2021-08-11T11:17:58+00:00", - "Creator": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "Modifier": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "Groups": { - "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", - "_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" + "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.ContentTypeInfo+xml": { + "application/vnd.ibexa.api.Section+xml": { "schema": { - "$ref": "#/components/schemas/ContentTypeInfo" + "$ref": "#/components/schemas/Section" }, - "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeInfo media-type=\"application/vnd.ibexa.api.ContentTypeInfo+xml\" href=\"/api/ibexa/v2/content/types/3/draft\">\n <id>3</id>\n <status>DRAFT</status>\n <identifier>user_group</identifier>\n <names>\n <value languageCode=\"eng-GB\">User group</value>\n </names>\n <descriptions/>\n <creationDate>2002-06-18T11:21:38+02:00</creationDate>\n <modificationDate>2019-02-25T14:41:53+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/3/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/3/draft\"/>\n <remoteId>25b4268cdcd01921b808a0d854b877ef</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><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" + "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/7\">\n <sectionId>7</sectionId>\n <identifier>template</identifier>\n <name>Template</name>\n</Section>\n" } } }, "400": { - "description": "Error - The input does not match the input schema definition." + "description": "Error - the input does not match the input schema definition." }, "401": { - "description": "Error - The user is not authorized to create the draft." + "description": "Error - the user is not authorized to create this Section." }, "403": { - "description": "Error - A content type with the given new identifier already exists. A draft already exists." + "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": "Create Draft", - "description": "Creates a draft and updates it with the given data.", + "summary": "Update a Section", + "description": "Updates a Section. PATCH or POST with header X-HTTP-Method-Override PATCH.", "parameters": [ { "name": "X-CSRF-Token", @@ -30183,1410 +15626,1184 @@ "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "contentTypeId", + "name": "If-Match", + "in": "header", + "description": "ETag", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "sectionId", "in": "path", - "description": "", + "description": "SectionUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "The content type Update schema encoded in XML or JSON format.", + "description": "The Section input schema encoded in XML or JSON.", "content": { - "application/vnd.ibexa.api.ContentTypeUpdate+json": { + "application/vnd.ibexa.api.SectionInput+json": { "schema": { - "$ref": "#/components/schemas/ContentTypeUpdateWrapper" + "$ref": "#/components/schemas/SectionInputWrapper" }, "example": { - "ContentTypeUpdate": { - "_media-type": "application/vnd.ibexa.api.ContentTypeUpdate", - "defaultAlwaysAvailable": "true" + "SectionInput": { + "identifier": "template", + "name": "Template" } } }, - "application/vnd.ibexa.api.ContentTypeUpdate+xml": { + "application/vnd.ibexa.api.SectionInput+xml": { "schema": { - "$ref": "#/components/schemas/ContentTypeUpdate" + "$ref": "#/components/schemas/SectionInput" }, - "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeUpdate>\n <defaultAlwaysAvailable>true</defaultAlwaysAvailable>\n</ContentTypeUpdate>\n" + "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SectionInput>\n <identifier>template</identifier>\n <name>Template</name>\n</SectionInput>\n" } }, "required": false - }, - "deprecated": false - }, - "delete": { - "operationId": "ibexa.rest.delete_content_type", + } + } + }, + "/segment_groups": { + "get": { + "operationId": "ibexa.segmentation.rest.segment_groups.list", "tags": [ - "Type" + "Segmentation" ], "responses": { - "204": { - "description": "No Content - content type deleted." + "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": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SegmentGroupList media-type=\"application/vnd.ibexa.api.SegmentGroupList+xml\" href=\"/api/ibexa/v2/segment_groups\">\n <SegmentGroup media-type=\"application/vnd.ibexa.api.SegmentGroup+xml\" href=\"/api/ibexa/v2/segment_groups/corporate_accounts\">\n <id>1</id>\n <identifier>corporate_accounts</identifier>\n <name>Corporate Accounts</name>\n </SegmentGroup>\n</SegmentGroupList>\n" + } + } }, "401": { - "description": "Error - The user is not authorized to delete this content type." + "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": [] + } + }, + "/segment_groups/{identifier}": { + "get": { + "operationId": "ibexa.segmentation.rest.segment_groups.view", + "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": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SegmentGroup media-type=\"application/vnd.ibexa.api.SegmentGroup+xml\" href=\"/api/ibexa/v2/segment_groups/corporate_accounts\">\n <id>1</id>\n <identifier>corporate_accounts</identifier>\n <name>Corporate Accounts</name>\n</SegmentGroup>\n" + } + } }, - "403": { - "description": "Error - There are object instances of this content type." + "401": { + "description": "Error - the user is not authorized to load this segment group." }, "404": { - "description": "Error - The content type does not exist." + "description": "Error - the identifier doesn't match any segment group." } }, - "summary": "Delete content type", - "description": "Deletes the provided content type.", + "summary": "Load segment group", + "description": "Loads segment group.", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "name": "identifier", + "in": "path", + "description": "SegmentGroupViewController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + } + ] + } + }, + "/segment_groups/{identifier}/segments": { + "get": { + "operationId": "ibexa.segmentation.rest.segment_groups.list.segments", + "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": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SegmentList media-type=\"application/vnd.ibexa.api.SegmentList+xml\" href=\"/api/ibexa/v2/segment_groups/corporate_accounts/segments\"/>\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": "contentTypeId", + "name": "identifier", "in": "path", - "description": "", + "description": "SegmentListController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] } }, - "/content/types/{contentTypeId}/draft": { + "/segments/{identifier}": { "get": { - "operationId": "ibexa.rest.load_content_type_draft", + "operationId": "ibexa.segmentation.rest.segments.view", "tags": [ - "Type" + "Segmentation" ], "responses": { "200": { - "description": "OK - returns the content type.", + "description": "OK - Return the segment.", "content": { - "application/vnd.ibexa.api.ContentType+json": { + "application/vnd.ibexa.api.Segment+json": { "schema": { - "$ref": "#/components/schemas/ContentTypeWrapper" + "$ref": "#/components/schemas/SegmentWrapper" }, "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": [] - } - ] + "Segment": { + "_media-type": "application/vnd.ibexa.api.Segment+json", + "_href": "/api/ibexa/v2/segments/corporate_account", + "id": 1, + "identifier": "corporate_account", + "name": "Corporate Account", + "source": "cohesivo", + "lastUpdatedBy": "14", + "updatedAt": "2026-06-30T12:00:00+00:00", + "SegmentGroup": { + "_media-type": "application/vnd.ibexa.api.SegmentGroup+json", + "_href": "/api/ibexa/v2/segment_groups/corporate_accounts" } } } }, - "application/vnd.ibexa.api.ContentType+xml": { + "application/vnd.ibexa.api.Segment+xml": { "schema": { - "$ref": "#/components/schemas/ContentType" + "$ref": "#/components/schemas/Segment" }, - "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" + "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Segment media-type=\"application/vnd.ibexa.api.Segment+xml\" href=\"/api/ibexa/v2/segments/corporate_account\">\n <id>1</id>\n <identifier>corporate_account</identifier>\n <name>Corporate Account</name>\n <source>cohesivo</source>\n <lastUpdatedBy>14</lastUpdatedBy>\n <updatedAt>2026-06-30T12:00:00+00:00</updatedAt>\n <SegmentGroup media-type=\"application/vnd.ibexa.api.SegmentGroup+xml\" href=\"/api/ibexa/v2/segment_groups/corporate_accounts\"/>\n</Segment>\n" } } }, "401": { - "description": "Error - The user is not authorized to read this content type." + "description": "Error - the user is not authorized to load this group's segments." }, "404": { - "description": "Error - The content type does not exist or does not have a draft." + "description": "Error - the identifier doesn't match any segment group." } }, - "summary": "Get content type draft", - "description": "Returns the draft of the content type with the provided ID.", + "summary": "Load segment", + "description": "Loads the identified segment.", "parameters": [ { - "name": "contentTypeId", + "name": "identifier", "in": "path", - "description": "", + "description": "SegmentViewController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false - }, + ] + } + }, + "/taxonomy/{taxonomyName}/entries": { "delete": { - "operationId": "ibexa.rest.delete_content_type_draft", + "operationId": "ibexa.taxonomy.rest.entries.remove", "tags": [ - "Type" + "Taxonomy" ], "responses": { "204": { - "description": "No Content - content type draft deleted." + "description": "No Content - The entries have been deleted." }, - "401": { - "description": "Error - The user is not authorized to delete this content type draft." + "400": { + "description": "Error - The input does not match the input schema definition." }, - "404": { - "description": "Error - The content type draft does not exist." + "401": { + "description": "Error - The user is not authorized to delete some of the entries." } }, - "summary": "Delete content type draft", - "description": "Deletes the provided content type draft.", + "summary": "Delete Entries", + "description": "Bulk removes several taxonomy entries.", "parameters": [ { "name": "X-CSRF-Token", "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "description": "The CSRF token.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "contentTypeId", + "name": "taxonomyName", "in": "path", - "description": "", + "description": "TaxonomyEntryBulkRemoveController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], - "deprecated": false - }, - "patch": { - "operationId": "ibexa.rest.update_content_type_draft", - "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" - } - } + "requestBody": { + "description": "TaxonomyEntryBulkRemove schema encoded in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.TaxonomyEntryBulkRemove+json": { + "schema": { + "$ref": "#/components/schemas/TaxonomyEntryBulkRemoveWrapper" }, - "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" + "example": { + "TaxonomyEntryBulkRemove": { + "entries": [ + 2, + 3 + ] + } + } + }, + "application/vnd.ibexa.api.TaxonomyEntryBulkRemove+xml": { + "schema": { + "$ref": "#/components/schemas/TaxonomyEntryBulkRemove" } } }, + "required": false + } + } + }, + "/taxonomy/{taxonomyName}/entries/move": { + "post": { + "operationId": "ibexa.taxonomy.rest.entries.move", + "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 update the draft." - }, - "403": { - "description": "Error - A content type with the given new identifier already exists." + "description": "Error - The user is not authorized to move some of the entries." }, "404": { - "description": "Error - There is no draft for this content type." + "description": "Error - Some to-be-moved or sibling entries do not exist." } }, - "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.", + "summary": "Move Entries", + "description": "Bulk move several taxonomy entries relative to sibling.", "parameters": [ { "name": "X-CSRF-Token", "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "description": "The CSRF token.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "contentTypeId", + "name": "taxonomyName", "in": "path", - "description": "", + "description": "TaxonomyEntryBulkMoveController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "The content type update schema encoded in XML or JSON format.", + "description": "The TaxonomyEntryBulkMove schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ContentTypeUpdate+json": { + "application/vnd.ibexa.api.TaxonomyEntryBulkMove+json": { "schema": { - "$ref": "#/components/schemas/ContentTypeUpdateWrapper" + "$ref": "#/components/schemas/TaxonomyEntryBulkMoveWrapper" }, "example": { - "ContentTypeUpdate": { - "_media-type": "application/vnd.ibexa.api.ContentTypeUpdate", - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Updated content type name" - } - ] - }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "This is an updated content type description" - } - ] - } + "TaxonomyEntryBulkMove": { + "entries": [ + { + "entry": 2, + "sibling": 1, + "position": "next" + }, + { + "entry": 3, + "sibling": 1, + "position": "prev" + } + ] } } }, - "application/vnd.ibexa.api.ContentTypeUpdate+xml": { + "application/vnd.ibexa.api.TaxonomyEntryBulkMove+xml": { "schema": { - "$ref": "#/components/schemas/ContentTypeUpdate" - }, - "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeUpdate>\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</ContentTypeUpdate>\n" + "$ref": "#/components/schemas/TaxonomyEntryBulkMove" + } } }, "required": false - }, - "deprecated": false + } } }, - "/content/types/{contentTypeId}/draft/fieldDefinitions": { + "/taxonomy/{taxonomyName}/entry-assignment/{id}": { "get": { - "operationId": "ibexa.rest.load_content_type_draft_field_definition_list", + "operationId": "ibexa.taxonomy.rest.entry_assignment.load_by_id", "tags": [ - "Type" + "Taxonomy" ], "responses": { "200": { - "description": "OK - return a list of Field definitions.", + "description": "OK - returns the taxonomy entry Assignment.", "content": { - "application/vnd.ibexa.api.FieldDefinitionList+json": { + "application/vnd.ibexa.api.TaxonomyEntryAssignment+json": { "schema": { - "$ref": "#/components/schemas/FieldDefinitionsWrapper" + "$ref": "#/components/schemas/TaxonomyEntryAssignmentWrapper" } }, - "application/vnd.ibexa.api.FieldDefinitionList+xml": { + "application/vnd.ibexa.api.TaxonomyEntryAssignment+xml": { "schema": { - "$ref": "#/components/schemas/FieldDefinitions" + "$ref": "#/components/schemas/TaxonomyEntryAssignment" } } } }, "404": { - "description": "Error - The content type draft does not exist." + "description": "Error - the assignment does not exist." } }, - "summary": "Get Draft Field definition list", - "description": "Returns all Field definitions of the provided content type Draft.", + "summary": "Get Assignment by ID", + "description": "Gets taxonomy entry Assignment by its ID.", "parameters": [ { - "name": "contentTypeId", + "name": "taxonomyName", "in": "path", - "description": "", + "description": "TaxonomyEntryAssignmentLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + }, + { + "name": "id", + "in": "path", + "description": "TaxonomyEntryAssignmentLoadByIdController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } - ], - "deprecated": false - }, + ] + } + }, + "/taxonomy/{taxonomyName}/entry-assignments/assign-to-content": { "post": { - "operationId": "ibexa.rest.add_content_type_draft_field_definition", + "operationId": "ibexa.taxonomy.rest.entry_assignments.assign_to_content", "tags": [ - "Type" + "Taxonomy" ], "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/14/draft/fieldDefinitions/221\">\n <id>221</id>\n <identifier>name2</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>0</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names/>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">32</value>\n <value key=\"minStringLength\">8</value>\n </value>\n </validatorConfiguration>\n</FieldDefinition>\n" - } - } + "description": "No Content." }, "400": { - "description": "Error - The input does not match the input schema definition or validation on the Field definition fails." + "description": "Error - the input does not match the input schema definition." }, "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." + "description": "Error - the user is not authorized to assign this Entry." } }, - "summary": "Add content type Draft Field definition", - "description": "Creates a new Field definition for the given content type.", + "summary": "Assign entry", + "description": "Assigns taxonomy entry to a content item.", "parameters": [ { "name": "X-CSRF-Token", "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "description": "The CSRF token.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "contentTypeId", + "name": "taxonomyName", "in": "path", - "description": "", + "description": "TaxonomyEntryAssignmentAssignController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "The Field Definition Create schema encoded in XML or JSON format.", + "description": "TaxonomyEntryAssignToContent schema encoded in JSON format.", "content": { - "application/vnd.ibexa.api.FieldDefinitionCreate+json": { - "schema": { - "$ref": "#/components/schemas/FieldDefinitionCreateWrapper" - } - }, - "application/vnd.ibexa.api.FieldDefinitionCreate+xml": { + "application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json": { "schema": { - "$ref": "#/components/schemas/FieldDefinitionCreate" + "$ref": "#/components/schemas/TaxonomyEntryAssignToContentWrapper" }, - "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" + "example": { + "TaxonomyEntryAssignToContent": { + "content": 130, + "entries": [ + 2, + 3 + ] + } + } } }, "required": false - }, - "deprecated": false + } } }, - "/content/types/{contentTypeId}/draft/fieldDefinitions/{fieldDefinitionId}": { + "/taxonomy/{taxonomyName}/entry-assignments/content-id/{contentId}": { "get": { - "operationId": "ibexa.rest.load_content_type_draft_field_definition", + "operationId": "ibexa.taxonomy.rest.entry_assignments.load", "tags": [ - "Type" + "Taxonomy" ], "responses": { "200": { - "description": "OK - returns the Field definition.", + "description": "OK - returns the assigment collection.", "content": { - "application/vnd.ibexa.api.FieldDefinition+json": { + "application/vnd.ibexa.api.EntryAssignmentCollection+json": { "schema": { - "$ref": "#/components/schemas/FieldDefinitionWrapper" + "$ref": "#/components/schemas/EntryAssignmentCollectionWrapper" }, "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" + "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" } - ] + } }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": null + "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" + } } - ] - }, - "fieldSettings": [], - "validatorConfiguration": [] + } + ] } } }, - "application/vnd.ibexa.api.FieldDefinition+xml": { + "application/vnd.ibexa.api.EntryAssignmentCollection+xml": { "schema": { - "$ref": "#/components/schemas/FieldDefinition" + "$ref": "#/components/schemas/EntryAssignmentCollection" }, - "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" + "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<EntryAssignmentCollection media-type=\"application/vnd.ibexa.api.EntryAssignmentCollection+xml\">\n <content media-type=\"application/vnd.ibexa.api.Content+xml\">\n <Content media-type=\"application/vnd.ibexa.api.ContentInfo+xml\" href=\"/api/ibexa/v2/content/objects/1\" remoteId=\"9459d3c29e15006e45197295722c7ade\" id=\"1\">\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/1\"/>\n <Name>Ibexa Platform</Name>\n <TranslatedName>Ibexa Platform</TranslatedName>\n <Versions media-type=\"application/vnd.ibexa.api.VersionList+xml\" href=\"/api/ibexa/v2/content/objects/1/versions\"/>\n <CurrentVersion media-type=\"application/vnd.ibexa.api.Version+xml\" href=\"/api/ibexa/v2/content/objects/1/currentversion\"/>\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/1\"/>\n <Locations media-type=\"application/vnd.ibexa.api.LocationList+xml\" href=\"/api/ibexa/v2/content/objects/1/locations\"/>\n <Owner media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <lastModificationDate>2023-01-01T00:00:00+00:00</lastModificationDate>\n <publishedDate>2015-11-30T13:10:46+00:00</publishedDate>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <currentVersionNo>10</currentVersionNo>\n <alwaysAvailable>true</alwaysAvailable>\n <isHidden>false</isHidden>\n <status>PUBLISHED</status>\n <ObjectStates media-type=\"application/vnd.ibexa.api.ContentObjectStates+xml\" href=\"/api/ibexa/v2/content/objects/1/objectstates\"/>\n </Content>\n </content>\n <TaxonomyEntryAssignment media-type=\"application/vnd.ibexa.api.TaxonomyEntryAssignment+xml\">\n <id>1</id>\n <content media-type=\"application/vnd.ibexa.api.Content+xml\">\n <Content media-type=\"application/vnd.ibexa.api.ContentInfo+xml\" href=\"/api/ibexa/v2/content/objects/1\" remoteId=\"9459d3c29e15006e45197295722c7ade\" id=\"1\">\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/1\"/>\n <Name>Ibexa Platform</Name>\n <TranslatedName>Ibexa Platform</TranslatedName>\n <Versions media-type=\"application/vnd.ibexa.api.VersionList+xml\" href=\"/api/ibexa/v2/content/objects/1/versions\"/>\n <CurrentVersion media-type=\"application/vnd.ibexa.api.Version+xml\" href=\"/api/ibexa/v2/content/objects/1/currentversion\"/>\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/1\"/>\n <Locations media-type=\"application/vnd.ibexa.api.LocationList+xml\" href=\"/api/ibexa/v2/content/objects/1/locations\"/>\n <Owner media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <lastModificationDate>2023-01-01T00:00:00+00:00</lastModificationDate>\n <publishedDate>2015-11-30T13:10:46+00:00</publishedDate>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <currentVersionNo>10</currentVersionNo>\n <alwaysAvailable>true</alwaysAvailable>\n <isHidden>false</isHidden>\n <status>PUBLISHED</status>\n <ObjectStates media-type=\"application/vnd.ibexa.api.ContentObjectStates+xml\" href=\"/api/ibexa/v2/content/objects/1/objectstates\"/>\n </Content>\n </content>\n <entry media-type=\"application/vnd.ibexa.api.TaxonomyEntry+xml\">\n <TaxonomyEntry media-type=\"application/vnd.ibexa.api.TaxonomyEntry+xml\">\n <id>3</id>\n <identifier>example</identifier>\n <name>Example</name>\n <contentId>65</contentId>\n <content media-type=\"application/vnd.ibexa.api.Content+xml\" href=\"/api/ibexa/v2/content/objects/65\"/>\n <taxonomy>tags</taxonomy>\n </TaxonomyEntry>\n </entry>\n </TaxonomyEntryAssignment>\n</EntryAssignmentCollection>" } } }, - "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": "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": "ibexa.rest.remove_content_type_draft_field_definition", - "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." + "description": "Error - the Content does not exists." } }, - "summary": "Delete content type Draft Field definition", - "description": "Deletes the provided Field definition.", + "summary": "Get Assignments to a Content", + "description": "Gets taxonomy entries assigned to a content item by its ID.", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "contentTypeId", + "name": "taxonomyName", "in": "path", - "description": "", + "description": "TaxonomyEntryAssignmentLoadController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "fieldDefinitionId", + "name": "contentId", "in": "path", - "description": "", + "description": "TaxonomyEntryAssignmentLoadController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false - }, - "patch": { - "operationId": "ibexa.rest.update_content_type_draft_field_definition", + ] + } + }, + "/taxonomy/{taxonomyName}/entry-assignments/unassign-from-content": { + "post": { + "operationId": "ibexa.taxonomy.rest.entry_assignments.unassign_from_content", "tags": [ - "Type" + "Taxonomy" ], "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/15/draft/fieldDefinitions/197\">\n <id>197</id>\n <identifier>author</identifier>\n <fieldType>ibexa_author</fieldType>\n <fieldGroup>new_field_group</fieldGroup>\n <position>10</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" - } - } + "201": { + "description": "No Content." }, "400": { - "description": "Error - The input does not match the input schema definition." + "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." + "description": "Error - the user is not authorized to unassign this entry." } }, - "summary": "Update content type Draft Field definition", - "description": "Updates the attributes of a Field definition.", + "summary": "Unassign entry", + "description": "Unassigns taxonomy entry from a content item.", "parameters": [ { "name": "X-CSRF-Token", "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "contentTypeId", - "in": "path", - "description": "", + "description": "The CSRF token.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "fieldDefinitionId", + "name": "taxonomyName", "in": "path", - "description": "", + "description": "TaxonomyEntryAssignmentUnassignController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "The Field definition update schema encoded in XML or JSON format.", + "description": "TaxonomyEntryUnassignFromContent schema encoded in JSON format.", "content": { - "application/vnd.ibexa.api.FieldDefinitionUpdate+json": { - "schema": { - "$ref": "#/components/schemas/FieldDefinitionUpdateWrapper" - } - }, - "application/vnd.ibexa.api.FieldDefinitionUpdate+xml": { + "application/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json": { "schema": { - "$ref": "#/components/schemas/FieldDefinitionUpdate" + "$ref": "#/components/schemas/TaxonomyEntryUnassignFromContentWrapper" }, - "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<FieldDefinitionUpdate>\n <fieldGroup>new_field_group</fieldGroup>\n <position>10</position>\n</FieldDefinitionUpdate>\n" + "example": { + "TaxonomyEntryUnassignFromContent": { + "content": 130, + "entries": [ + 2, + 3 + ] + } + } } }, "required": false - }, - "deprecated": false + } } }, - "/content/types/{contentTypeId}/fieldDefinitions": { + "/taxonomy/{taxonomyName}/entry/content-id/{contentId}": { "get": { - "operationId": "ibexa.rest.load_content_type_field_definition_list", + "operationId": "ibexa.taxonomy.rest.entry.load_by_content_id", "tags": [ - "Type" + "Taxonomy" ], "responses": { "200": { - "description": "OK - return a list of Field definitions.", + "description": "OK - returns the taxonomy Entry.", "content": { - "application/vnd.ibexa.api.FieldDefinitionList+json": { + "application/vnd.ibexa.api.TaxonomyEntry+json": { "schema": { - "$ref": "#/components/schemas/FieldDefinitionsWrapper" + "$ref": "#/components/schemas/TaxonomyEntryWrapper" } }, - "application/vnd.ibexa.api.FieldDefinitionList+xml": { + "application/vnd.ibexa.api.TaxonomyEntry+xml": { "schema": { - "$ref": "#/components/schemas/FieldDefinitions" + "$ref": "#/components/schemas/TaxonomyEntry" } } } }, + "401": { + "description": "Error - the user is not authorized to read this Entry." + }, "404": { - "description": "Error - The content type does not exist." + "description": "Error - the Entry does not exists." } }, - "summary": "Get Field definition list", - "description": "Returns all Field definitions of the provided content type.", + "summary": "Get Entry by Content ID", + "description": "Loads taxonomy Entry by its Content ID.", "parameters": [ { - "name": "contentTypeId", + "name": "taxonomyName", "in": "path", - "description": "", + "description": "TaxonomyEntryLoadByContentIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + }, + { + "name": "contentId", + "in": "path", + "description": "TaxonomyEntryLoadByContentIdController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } - ], - "deprecated": false + ] } }, - "/content/types/{contentTypeId}/fieldDefinitions/{fieldDefinitionId}": { + "/taxonomy/{taxonomyName}/entry/identifier/{identifier}": { "get": { - "operationId": "ibexa.rest.load_content_type_field_definition", + "operationId": "ibexa.taxonomy.rest.entry.load_by_identifier", "tags": [ - "Type" + "Taxonomy" ], "responses": { "200": { - "description": "OK - returns the Field definition.", + "description": "OK - returns the taxonomy Entry.", "content": { - "application/vnd.ibexa.api.FieldDefinition+json": { + "application/vnd.ibexa.api.TaxonomyEntry+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": [] - } + "$ref": "#/components/schemas/TaxonomyEntryWrapper" } }, - "application/vnd.ibexa.api.FieldDefinition+xml": { + "application/vnd.ibexa.api.TaxonomyEntry+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" + "$ref": "#/components/schemas/TaxonomyEntry" + } } } }, "401": { - "description": "Error - The user is not authorized to read the content type." + "description": "Error - the user is not authorized to read this Entry." }, "404": { - "description": "Error - The content type does not exist." + "description": "Error - the Entry does not exists." } }, - "summary": "Get Field definition", - "description": "Returns the Field definition by the given ID.", + "summary": "Get Entry by identifier", + "description": "Loads taxonomy Entry by its Entry identifier.", "parameters": [ { - "name": "contentTypeId", + "name": "taxonomyName", "in": "path", - "description": "", + "description": "TaxonomyEntryLoadByIdentifierController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "fieldDefinitionId", + "name": "identifier", "in": "path", - "description": "", + "description": "TaxonomyEntryLoadByIdentifierController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] } }, - "/content/types/{contentTypeId}/groups": { + "/taxonomy/{taxonomyName}/entry/{id}": { "get": { - "operationId": "ibexa.rest.load_groups_of_content_type", + "operationId": "ibexa.taxonomy.rest.entry.load_by_id", "tags": [ - "Type" + "Taxonomy" ], "responses": { "200": { - "description": "If set, the content type group list is returned in XML or JSON format.", + "description": "OK - returns the taxonomy Entry.", "content": { - "application/vnd.ibexa.api.ContentTypeGroupRefList+json": { + "application/vnd.ibexa.api.TaxonomyEntry+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" - } - ] - } + "$ref": "#/components/schemas/TaxonomyEntryWrapper" } }, - "application/vnd.ibexa.api.ContentTypeGroupRefList+xml": { + "application/vnd.ibexa.api.TaxonomyEntry+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/2/types\">\n <ContentTypeGroupRef media-type=\"application/vnd.ibexa.api.ContentTypeGroup+xml\" href=\"/api/ibexa/v2/content/typegroups/1\"/>\n</ContentTypeGroupRefList>\n" + "$ref": "#/components/schemas/TaxonomyEntry" + } } } }, "401": { - "description": "Error - The user is not authorized to read this content type." + "description": "Error - the user is not authorized to read this Entry." }, "404": { - "description": "Error - The content type does not exist." + "description": "Error - the Entry does not exists." } }, - "summary": "Get groups of content type", - "description": "Returns the content type group to which content type belongs to.", + "summary": "Get Entry by ID", + "description": "Loads taxonomy Entry by its Entry ID.", "parameters": [ { - "name": "contentTypeId", + "name": "taxonomyName", "in": "path", - "description": "", + "description": "TaxonomyEntryLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + }, + { + "name": "id", + "in": "path", + "description": "TaxonomyEntryLoadByIdController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } - ], - "deprecated": false - }, - "post": { - "operationId": "ibexa.rest.link_content_type_to_group", + ] + } + }, + "/content/trash": { + "get": { + "operationId": "ibexa.rest.load_trash_items", "tags": [ - "Type" + "Trash" ], "responses": { "200": { - "description": "If set, the updated content type group list is returned in XML or JSON format.", + "description": "OK - returns the list of items in the Trash.", "content": { - "application/vnd.ibexa.api.ContentTypeGroupRefList+json": { + "application/vnd.ibexa.api.Trash+json": { "schema": { - "$ref": "#/components/schemas/ContentTypeGroupRefListWrapper" + "$ref": "#/components/schemas/TrashWrapper" }, "example": { - "ContentTypeGroupRefList": { - "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", - "_href": "/api/ibexa/v2/content/typegroups/2/types", - "ContentTypeGroupRef": [ + "Trash": { + "_media-type": "application/vnd.ibexa.api.Trash+json", + "_href": "/api/ibexa/v2/content/trash", + "TrashItem": [ { - "_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.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.ContentTypeGroup+json", - "_href": "/api/ibexa/v2/content/typegroups/2", - "unlink": { - "_href": "/api/ibexa/v2/content/types/2/groups/2", - "_method": "DELETE" + "_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.ContentTypeGroupRefList+xml": { + "application/vnd.ibexa.api.Trash+xml": { "schema": { - "$ref": "#/components/schemas/ContentTypeGroupRefList" + "$ref": "#/components/schemas/Trash" }, - "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/3\">\n <unlink href=\"/api/ibexa/v2/content/types/15/groups/3\" 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" + "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Trash media-type=\"application/vnd.ibexa.api.Trash+xml\" href=\"/api/ibexa/v2/content/trash\">\n <TrashItem media-type=\"application/vnd.ibexa.api.TrashItem+xml\" href=\"/api/ibexa/v2/content/trash/58\">\n <id>58</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/2/56\"/>\n <pathString>/1/2/56/58/</pathString>\n <depth>3</depth>\n <childCount>0</childCount>\n <remoteId>59800915ad2eb8514de0bebe84f6ccba</remoteId>\n <Content media-type=\"application/vnd.ibexa.api.Content+xml\" href=\"/api/ibexa/v2/content/objects/52\"/>\n <sortField>PATH</sortField>\n <sortOrder>ASC</sortOrder>\n <ContentInfo media-type=\"application/vnd.ibexa.api.ContentInfo+xml\" href=\"/api/ibexa/v2/content/objects/52\">\n <Content media-type=\"application/vnd.ibexa.api.ContentInfo+xml\" href=\"/api/ibexa/v2/content/objects/52\" remoteId=\"881da87102313b0354dc2aa8f0e4b63b\" id=\"52\">\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/1\"/>\n <Name>Folder 1</Name>\n <Versions media-type=\"application/vnd.ibexa.api.VersionList+xml\" href=\"/api/ibexa/v2/content/objects/52/versions\"/>\n <CurrentVersion media-type=\"application/vnd.ibexa.api.Version+xml\" href=\"/api/ibexa/v2/content/objects/52/currentversion\"/>\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/1\"/>\n <Locations media-type=\"application/vnd.ibexa.api.LocationList+xml\" href=\"/api/ibexa/v2/content/objects/52/locations\"/>\n <Owner media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <lastModificationDate>2019-02-06T09:03:09+01:00</lastModificationDate>\n <publishedDate>2019-02-06T09:03:09+01:00</publishedDate>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <currentVersionNo>1</currentVersionNo>\n <alwaysAvailable>true</alwaysAvailable>\n <ObjectStates media-type=\"application/vnd.ibexa.api.ContentObjectStates+xml\" href=\"/api/ibexa/v2/content/objects/52/objectstates\"/>\n </Content>\n </ContentInfo>\n </TrashItem>\n</Trash>\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." + "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": [] + }, + "delete": { + "operationId": "ibexa.rest.empty_trash", + "tags": [ + "Trash" + ], + "responses": { + "204": { + "description": "No Content - Trash emptied." }, - "403": { - "description": "Error - The content type is already assigned to the group." + "401": { + "description": "Error - The user is not authorized to empty all items from Trash." } }, - "summary": "Link group to content type", - "description": "Links a content type group to the content type and returns the updated group list.", + "summary": "Empty Trash", + "description": "Empties the Trash.", "parameters": [ { "name": "X-CSRF-Token", @@ -31594,186 +16811,480 @@ "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "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": "group", - "in": "query", - "description": "Destination content type group URI; for example with content type group 4: `?group=/api/ibexa/v2/content/typegroups/4`", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "form", - "explode": false, - "allowReserved": false + "explode": false } - ], - "requestBody": { - "description": "No payload required", - "content": [], - "required": false - }, - "deprecated": false + ] } }, - "/content/types/{contentTypeId}/groups/{id}": { - "delete": { - "operationId": "ibexa.rest.unlink_content_type_from_group", + "/content/trash/{trashItemid}": { + "get": { + "operationId": "ibexa.rest.load_trash_item", "tags": [ - "Type" + "Trash" ], "responses": { "200": { - "description": "If set, the updated content type group list is returned in XML or JSON format.", + "description": "If set, the item in Trash is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ContentTypeGroupRefList+json": { + "application/vnd.ibexa.api.TrashItem+json": { "schema": { - "$ref": "#/components/schemas/ContentTypeGroupRefListWrapper" + "$ref": "#/components/schemas/TrashItemWrapper" }, "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" + "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.ContentTypeGroupRefList+xml": { + "application/vnd.ibexa.api.TrashItem+xml": { "schema": { - "$ref": "#/components/schemas/ContentTypeGroupRefList" + "$ref": "#/components/schemas/TrashItem" }, - "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" + "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<TrashItem media-type=\"application/vnd.ibexa.api.TrashItem+xml\" href=\"/api/ibexa/v2/content/trash/81\">\n <id>81</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/2/42\"/>\n <pathString>/1/2/42/81/</pathString>\n <depth>3</depth>\n <childCount>0</childCount>\n <remoteId>135e8a84b61848a67be36e9552d2724d</remoteId>\n <Content media-type=\"application/vnd.ibexa.api.Content+xml\" href=\"/api/ibexa/v2/content/objects/99\"/>\n <sortField>PATH</sortField>\n <sortOrder>ASC</sortOrder>\n <ContentInfo media-type=\"application/vnd.ibexa.api.ContentInfo+xml\" href=\"/api/ibexa/v2/content/objects/99\">\n <Content media-type=\"application/vnd.ibexa.api.ContentInfo+xml\" href=\"/api/ibexa/v2/content/objects/99\" remoteId=\"ae2b4568c0d2e7a4a9bca9495e73591a\" id=\"99\">\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/1\"/>\n <Name>Folder 1</Name>\n <Versions media-type=\"application/vnd.ibexa.api.VersionList+xml\" href=\"/api/ibexa/v2/content/objects/99/versions\"/>\n <CurrentVersion media-type=\"application/vnd.ibexa.api.Version+xml\" href=\"/api/ibexa/v2/content/objects/99/currentversion\"/>\n <Section media-type=\"application/vnd.ibexa.api.Section+xml\" href=\"/api/ibexa/v2/content/sections/1\"/>\n <Locations media-type=\"application/vnd.ibexa.api.LocationList+xml\" href=\"/api/ibexa/v2/content/objects/99/locations\"/>\n <Owner media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n <lastModificationDate>2019-04-25T12:45:58+02:00</lastModificationDate>\n <publishedDate>2019-04-25T12:45:58+02:00</publishedDate>\n <mainLanguageCode>eng-GB</mainLanguageCode>\n <currentVersionNo>1</currentVersionNo>\n <alwaysAvailable>true</alwaysAvailable>\n <status>TRASHED</status>\n <ObjectStates media-type=\"application/vnd.ibexa.api.ContentObjectStates+xml\" href=\"/api/ibexa/v2/content/objects/99/objectstates\"/>\n </Content>\n </ContentInfo>\n</TrashItem>\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." + "description": "Error - The user has no permission to read the item in Trash." }, "404": { - "description": "Error - The resource does not exist." - }, - "204": { - "description": "ContentTypeUnlinkFromGroupController resource deleted" + "description": "Error - An item in Trash with the provided ID does not exist." } }, - "summary": "Unlink group from content type", - "description": "Removes the given group from the content type and returns the updated group list.", + "summary": "Get Trash item", + "description": "Returns the item in Trash with the provided ID.", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "name": "trashItemid", + "in": "path", + "description": "TrashItemLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + } + ] + }, + "delete": { + "operationId": "ibexa.rest.delete_trash_item", + "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": "contentTypeId", - "in": "path", - "description": "", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "id", + "name": "trashItemid", "in": "path", - "description": "", + "description": "TrashItemDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] } }, - "/content/typegroups": { + "/content/types": { "get": { - "operationId": "ibexa.rest.load_content_type_group_list", + "operationId": "ibexa.rest.list_content_types", "tags": [ - "Type Groups" + "Type" ], "responses": { "200": { - "description": "OK - returns a list of content type groups.", + "description": "OK - returns a list of content types.", "content": { - "application/vnd.ibexa.api.ContentTypeGroupList+json": { + "application/vnd.ibexa.api.ContentTypeInfoList+json": { "schema": { - "$ref": "#/components/schemas/ContentTypeGroupListWrapper" + "$ref": "#/components/schemas/ContentTypeInfoListWrapper" }, "example": { - "ContentTypeGroupList": { - "_media-type": "application/vnd.ibexa.api.ContentTypeGroupList+json", - "_href": "/api/ibexa/v2/content/typegroups", - "ContentTypeGroup": [ + "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.ContentTypeGroup+json", - "_href": "/api/ibexa/v2/content/typegroups/1", + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/1", "id": 1, - "identifier": "Content", - "created": "2002-09-05T09:08:48+00:00", - "modified": "2002-10-06T16:35:06+00:00", + "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" @@ -31782,18 +17293,172 @@ "_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" + "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.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", + "_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" @@ -31802,18 +17467,117 @@ "_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" + "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.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", + "_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" @@ -31822,148 +17586,192 @@ "_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": [], - "deprecated": false - }, - "post": { - "operationId": "ibexa.rest.create_content_type_group", - "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/6", - "id": 6, - "identifier": "newContentTypeGroup", - "created": "2021-08-11T09:44:18+00:00", - "modified": "2021-08-11T09:44:18+00:00", - "Creator": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "Modifier": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "ContentTypes": { - "_media-type": "application/vnd.ibexa.api.ContentTypeInfoList+json", - "_href": "/api/ibexa/v2/content/typegroups/6/types" - } + "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": { + "application/vnd.ibexa.api.ContentTypeInfoList+xml": { "schema": { - "$ref": "#/components/schemas/ContentTypeGroup" + "$ref": "#/components/schemas/ContentTypeInfoList" }, - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token 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 content type group input schema encoded in XML or JSON.", - "content": { - "application/vnd.ibexa.api.ContentTypeGroupInput+json": { - "schema": { - "$ref": "#/components/schemas/ContentTypeGroupInputWrapper" + "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" }, - "example": { - "ContentTypeGroupInput": { - "identifier": "newContentTypeGroup" + "application/vnd.ibexa.api.ContentTypeList+json": { + "schema": { + "$ref": "#/components/schemas/ContentTypeListWrapper" } - } - }, - "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" + "application/vnd.ibexa.api.ContentTypeList+xml": { + "schema": { + "$ref": "#/components/schemas/ContentTypeList" + } + } } }, - "required": false + "401": { + "description": "Error - The user has no permission to read the content types." + } }, - "deprecated": false + "summary": "List content types", + "description": "Returns a list of content types.", + "parameters": [] } }, - "/content/typegroups/{contentTypeGroupId}": { - "get": { - "operationId": "ibexa.rest.load_content_type_group", + "/content/types/view": { + "post": { + "operationId": "ibexa.rest.content_types.view", "tags": [ - "Type Groups" + "Type" ], "responses": { "200": { - "description": "OK - returns the content type group.", + "description": "The view in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ContentTypeGroup+json": { + "application/vnd.ibexa.api.ContentTypeList+json": { "schema": { - "$ref": "#/components/schemas/ContentTypeListWrapper" + "$ref": "#/components/schemas/ContentTypeInfoListWrapper" }, "example": { "ContentTypeList": { @@ -31985,15 +17793,10 @@ ] }, "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] + "value": [] }, "creationDate": "2002-06-18T09:21:38+00:00", - "modificationDate": "2021-06-28T11:31:22+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" @@ -32011,7 +17814,7 @@ "_href": "/api/ibexa/v2/content/types/2/draft" }, "remoteId": "c15b600eb9198b1924063b5a68758232", - "urlAliasSchema": "", + "urlAliasSchema": null, "nameSchema": "<short_title|title>", "isContainer": true, "mainLanguageCode": "eng-GB", @@ -32044,12 +17847,7 @@ ] }, "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] + "value": [] }, "fieldSettings": [], "validatorConfiguration": { @@ -32081,12 +17879,7 @@ ] }, "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] + "value": [] }, "fieldSettings": [], "validatorConfiguration": { @@ -32118,74 +17911,494 @@ ] }, "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": null + "#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": { - "defaultAuthor": 1 + "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/2/fieldDefinitions/120", - "id": 120, - "identifier": "intro", + "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/156", + "id": 156, + "identifier": "description", "fieldType": "ibexa_richtext", "fieldGroup": "", "position": 4, "isTranslatable": true, - "isRequired": 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": { - "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" + "fields": [], + "content_id": null, + "content_field_id": null, + "language_code": null }, - "isSearchable": true, + "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", - "#text": "Intro" + "#text": "Form" } ] }, "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] + "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/2/fieldDefinitions/121", - "id": 121, - "identifier": "body", - "fieldType": "ibexa_richtext", - "fieldGroup": "", - "position": 5, + "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions/185", + "id": 185, + "identifier": "name", + "fieldType": "ibexa_string", + "fieldGroup": "content", + "position": 10, "isTranslatable": true, - "isRequired": false, + "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" - }, + "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", - "#text": "Body" + "#text": "Title" } ] }, @@ -32193,31 +18406,36 @@ "value": [ { "_languageCode": "eng-GB", - "#text": null + "#text": "Title" } ] }, "fieldSettings": [], - "validatorConfiguration": [] + "validatorConfiguration": { + "StringLengthValidator": { + "maxStringLength": null, + "minStringLength": null + } + } }, { "_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, + "_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": false, - "isSearchable": false, + "defaultValue": null, + "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", - "#text": "Enable comments" + "#text": "Description" } ] }, @@ -32225,35 +18443,45 @@ "value": [ { "_languageCode": "eng-GB", - "#text": null + "#text": "Landing page description" } ] }, "fieldSettings": [], - "validatorConfiguration": [] + "validatorConfiguration": { + "StringLengthValidator": { + "maxStringLength": null, + "minStringLength": null + } + } }, { "_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", + "_href": "/api/ibexa/v2/content/types/42/fieldDefinitions/187", + "id": 187, + "identifier": "page", + "fieldType": "ibexa_landing_page", "fieldGroup": "content", - "position": 7, - "isTranslatable": false, + "position": 30, + "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { - "destinationContentId": null, - "alternativeText": null, - "source": null + "layout": "default", + "zones": [ + { + "id": "default_id", + "name": "default", + "blocks": [] + } + ] }, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", - "#text": "Image" + "#text": "Landing page" } ] }, @@ -32261,2181 +18489,2059 @@ "value": [ { "_languageCode": "eng-GB", - "#text": null + "#text": "Landing page" } ] }, - "fieldSettings": [], + "fieldSettings": { + "availableBlocks": null, + "availableLayouts": null, + "editorMode": "page_view_mode" + }, "validatorConfiguration": [] } ] } - }, - { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/50", - "id": 50, - "status": "DEFINED", - "identifier": "copy_of_article_50", - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Article" + } + ] + } + } + }, + "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": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "The view input in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.ContentTypeViewInput+json": { + "schema": { + "$ref": "#/components/schemas/ContentTypeViewInputWrapper" + }, + "example": { + "ViewInput": { + "identifier": "ContentTypeView", + "ContentTypeQuery": { + "limit": "10", + "offset": "1", + "Query": { + "ContentTypeIdCriterion": [ + 1, + 2 + ], + "ContentTypeIdentifierCriterion": "folder", + "IsSystemCriterion": true, + "ContentTypeGroupIdCriterion": 1, + "ContainsFieldDefinitionIdCriterion": 2 + }, + "SortClauses": { + "Identifier": "descending", + "Id": "ascending" + } + } + } + } + }, + "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 + } + } + }, + "/content/types/{contentTypeId}": { + "get": { + "operationId": "ibexa.rest.load_content_type", + "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 } - ] + } }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": 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 } - ] + } }, - "creationDate": "2021-07-14T10:30:00+00:00", - "modificationDate": "2021-07-14T10:30:00+00:00", - "Creator": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" + { + "_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": [] }, - "Modifier": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" + { + "_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": [] }, - "Groups": { - "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", - "_href": "/api/ibexa/v2/content/types/50/groups" + { + "_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": [] }, - "Draft": { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/50/draft" + { + "_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": [] }, - "remoteId": "fc9434492469d136ffe13377bfdcbb28", - "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/50/fieldDefinitions", - "FieldDefinition": [ - { - "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/50/fieldDefinitions/197", - "id": 197, - "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/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" } - }, - { - "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/50/fieldDefinitions/198", - "id": 198, - "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 - } + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": null } - }, - { - "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/50/fieldDefinitions/199", - "id": 199, - "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/50/fieldDefinitions/200", - "id": 200, - "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/50/fieldDefinitions/201", - "id": 201, - "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/50/fieldDefinitions/202", - "id": 202, - "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/50/fieldDefinitions/203", - "id": 203, - "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": [] - } - ] + ] + }, + "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/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 <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" + } + } + }, + "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": "If-None-Match", + "in": "header", + "description": "ETag", + "required": false, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "contentTypeId", + "in": "path", + "description": "ContentTypeLoadByIdController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + }, + "post": { + "operationId": "ibexa.rest.create_content_type_draft", + "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/1/draft", + "id": 1, + "status": "DRAFT", + "identifier": "folder", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Folder" + } + ] + }, + "descriptions": { + "value": [] + }, + "creationDate": "2002-06-18T09:21:38+00:00", + "modificationDate": "2021-08-11T11:17:58+00:00", + "Creator": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "Modifier": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "Groups": { + "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", + "_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" + } + } + }, + "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/3/draft\">\n <id>3</id>\n <status>DRAFT</status>\n <identifier>user_group</identifier>\n <names>\n <value languageCode=\"eng-GB\">User group</value>\n </names>\n <descriptions/>\n <creationDate>2002-06-18T11:21:38+02:00</creationDate>\n <modificationDate>2019-02-25T14:41:53+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/3/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/3/draft\"/>\n <remoteId>25b4268cdcd01921b808a0d854b877ef</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><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" + } + } + }, + "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": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "contentTypeId", + "in": "path", + "description": "ContentTypeDraftCreateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "The content type Update schema encoded in XML or JSON format.", + "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 + } + }, + "delete": { + "operationId": "ibexa.rest.delete_content_type", + "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": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "contentTypeId", + "in": "path", + "description": "ContentTypeDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + } + }, + "/content/types/{contentTypeId}/draft": { + "get": { + "operationId": "ibexa.rest.load_content_type_draft", + "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" } - }, - { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/44", - "id": 44, - "status": "DEFINED", - "identifier": "dog_breed", - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Dog Breed" - } - ] - }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": null + ] + }, + "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 } - ] - }, - "creationDate": "2021-06-28T11:28:00+00:00", - "modificationDate": "2021-06-28T11:29:02+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/44/groups" - }, - "Draft": { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/44/draft" + } }, - "remoteId": "b348c95f7c573d4d502d6b59f80e618a", - "urlAliasSchema": "", - "nameSchema": "<name>", - "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/44/fieldDefinitions", - "FieldDefinition": [ - { - "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/44/fieldDefinitions/190", - "id": 190, - "identifier": "name", - "fieldType": "ibexa_string", - "fieldGroup": "content", - "position": 1, - "isTranslatable": true, - "isRequired": false, - "isInfoCollector": false, - "defaultValue": null, - "isSearchable": true, - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Name" - } - ] - }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] - }, - "fieldSettings": [], - "validatorConfiguration": { - "StringLengthValidator": { - "maxStringLength": null, - "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" } - }, - { - "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/44/fieldDefinitions/191", - "id": 191, - "identifier": "photo", - "fieldType": "ibexa_image_asset", - "fieldGroup": "content", - "position": 2, - "isTranslatable": true, - "isRequired": false, - "isInfoCollector": false, - "defaultValue": { - "destinationContentId": null, - "alternativeText": null, - "source": null - }, - "isSearchable": true, - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Photo" - } - ] - }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] - }, - "fieldSettings": [], - "validatorConfiguration": [] - }, - { - "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/44/fieldDefinitions/192", - "id": 192, - "identifier": "description", - "fieldType": "ibexa_richtext", - "fieldGroup": "content", - "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": "Full Description" - } - ] - }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] - }, - "fieldSettings": [], - "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": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] + }, + "fieldSettings": [], + "validatorConfiguration": { + "StringLengthValidator": { + "maxStringLength": 255, + "minStringLength": null } - ] - }, - "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" + { + "_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": [] }, - "Groups": { - "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", - "_href": "/api/ibexa/v2/content/types/1/groups" + { + "_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": [] }, - "Draft": { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/1/draft" + { + "_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": [] }, - "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/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" } - }, - { - "_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 - } + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": 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": [] - } - ] + ] + }, + "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": "contentTypeId", + "in": "path", + "description": "ContentTypeDraftLoadController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + }, + "delete": { + "operationId": "ibexa.rest.delete_content_type_draft", + "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": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "contentTypeId", + "in": "path", + "description": "ContentTypeDraftDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + }, + "patch": { + "operationId": "ibexa.rest.update_content_type_draft", + "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": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "contentTypeId", + "in": "path", + "description": "ContentTypeDraftUpdateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "The content type update schema encoded in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.ContentTypeUpdate+json": { + "schema": { + "$ref": "#/components/schemas/ContentTypeUpdateWrapper" + }, + "example": { + "ContentTypeUpdate": { + "_media-type": "application/vnd.ibexa.api.ContentTypeUpdate", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Updated content type name" + } + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "This is an updated content type description" + } + ] + } + } + } + }, + "application/vnd.ibexa.api.ContentTypeUpdate+xml": { + "schema": { + "$ref": "#/components/schemas/ContentTypeUpdate" + }, + "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeUpdate>\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</ContentTypeUpdate>\n" + } + }, + "required": false + } + } + }, + "/content/types/{contentTypeId}/draft/fieldDefinitions": { + "get": { + "operationId": "ibexa.rest.load_content_type_draft_field_definition_list", + "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": "contentTypeId", + "in": "path", + "description": "ContentTypeDraftFieldDefinitionListController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + }, + "post": { + "operationId": "ibexa.rest.add_content_type_draft_field_definition", + "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/14/draft/fieldDefinitions/221\">\n <id>221</id>\n <identifier>name2</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup></fieldGroup>\n <position>0</position>\n <isTranslatable>true</isTranslatable>\n <isRequired>true</isRequired>\n <isInfoCollector>false</isInfoCollector>\n <defaultValue/>\n <isSearchable>true</isSearchable>\n <names/>\n <descriptions/>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">32</value>\n <value key=\"minStringLength\">8</value>\n </value>\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": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "contentTypeId", + "in": "path", + "description": "ContentTypeDraftFieldDefinitionAddController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "The Field Definition Create schema encoded in XML or JSON format.", + "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 + } + } + }, + "/content/types/{contentTypeId}/draft/fieldDefinitions/{fieldDefinitionId}": { + "get": { + "operationId": "ibexa.rest.load_content_type_draft_field_definition", + "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" } - }, - { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/55", - "id": 55, - "status": "DEFINED", - "identifier": "folder_55", - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Folder" - } - ] - }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] - }, - "creationDate": "2021-07-28T07:57:22+00:00", - "modificationDate": "2021-07-28T07:57:34+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/55/groups" - }, - "Draft": { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/55/draft" - }, - "remoteId": "4eb7bc76f6d0bd1d5ded2d8936cc6afb", - "urlAliasSchema": "", - "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/55/fieldDefinitions", - "FieldDefinition": [ - { - "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/55/fieldDefinitions/210", - "id": 210, - "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": [ - { - "_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/55/fieldDefinitions/211", - "id": 211, - "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": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] - }, - "fieldSettings": [], - "validatorConfiguration": { - "StringLengthValidator": { - "maxStringLength": 100, - "minStringLength": null - } - } - }, - { - "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/55/fieldDefinitions/212", - "id": 212, - "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": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] - }, - "fieldSettings": [], - "validatorConfiguration": [] - }, - { - "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/55/fieldDefinitions/213", - "id": 213, - "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": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] - }, - "fieldSettings": [], - "validatorConfiguration": [] - } - ] + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": null } - }, - { - "_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": [] - } - ] + ] + }, + "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": "contentTypeId", + "in": "path", + "description": "ContentTypeDraftFieldDefinitionLoadByIdController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "fieldDefinitionId", + "in": "path", + "description": "ContentTypeDraftFieldDefinitionLoadByIdController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + }, + "delete": { + "operationId": "ibexa.rest.remove_content_type_draft_field_definition", + "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": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "contentTypeId", + "in": "path", + "description": "ContentTypeDraftFieldDefinitionDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "fieldDefinitionId", + "in": "path", + "description": "ContentTypeDraftFieldDefinitionDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + }, + "patch": { + "operationId": "ibexa.rest.update_content_type_draft_field_definition", + "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" } - }, - { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/45", - "id": 45, - "status": "DEFINED", - "identifier": "tip", - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Tip" - } - ] - }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] - }, - "creationDate": "2021-06-28T11:29:19+00:00", - "modificationDate": "2021-07-26T09:33: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" - }, - "Groups": { - "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", - "_href": "/api/ibexa/v2/content/types/45/groups" - }, - "Draft": { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/45/draft" - }, - "remoteId": "e6490e8a785edacd48629f2022be3125", - "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/45/fieldDefinitions", - "FieldDefinition": [ - { - "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/45/fieldDefinitions/193", - "id": 193, - "identifier": "title", - "fieldType": "ibexa_string", - "fieldGroup": "content", - "position": 1, - "isTranslatable": true, - "isRequired": false, - "isInfoCollector": false, - "defaultValue": null, - "isSearchable": true, - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Title" - } - ] - }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] - }, - "fieldSettings": [], - "validatorConfiguration": { - "StringLengthValidator": { - "maxStringLength": null, - "minStringLength": null - } - } - }, - { - "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/45/fieldDefinitions/194", - "id": 194, - "identifier": "body", - "fieldType": "ibexa_text", - "fieldGroup": "content", - "position": 2, - "isTranslatable": true, - "isRequired": false, - "isInfoCollector": false, - "defaultValue": null, - "isSearchable": true, - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Body" - } - ] - }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] - }, - "fieldSettings": { - "textRows": 10 - }, - "validatorConfiguration": [] - }, - { - "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/45/fieldDefinitions/204", - "id": 204, - "identifier": "richtext", - "fieldType": "ibexa_richtext", - "fieldGroup": "content", - "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": "richtext" - } - ] - }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] - }, - "fieldSettings": [], - "validatorConfiguration": [] - } - ] + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": null } - }, - { - "_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": [] - } - ] + ] + }, + "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/15/draft/fieldDefinitions/197\">\n <id>197</id>\n <identifier>author</identifier>\n <fieldType>ibexa_author</fieldType>\n <fieldGroup>new_field_group</fieldGroup>\n <position>10</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" + } + } + }, + "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": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "contentTypeId", + "in": "path", + "description": "ContentTypeDraftFieldDefinitionUpdateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "fieldDefinitionId", + "in": "path", + "description": "ContentTypeDraftFieldDefinitionUpdateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "The Field definition update schema encoded in XML or JSON format.", + "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 + } + } + }, + "/content/types/{contentTypeId}/fieldDefinitions": { + "get": { + "operationId": "ibexa.rest.load_content_type_field_definition_list", + "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": "contentTypeId", + "in": "path", + "description": "ContentTypeFieldDefinitionListController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + } + }, + "/content/types/{contentTypeId}/fieldDefinitions/{fieldDefinitionId}": { + "get": { + "operationId": "ibexa.rest.load_content_type_field_definition", + "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.ContentTypeGroup+xml": { + "application/vnd.ibexa.api.FieldDefinition+xml": { "schema": { - "$ref": "#/components/schemas/ContentTypeList" + "$ref": "#/components/schemas/FieldDefinition" }, - "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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <creationDate>2002-06-18T09:21:38+00:00</creationDate>\n <modificationDate>2021-06-28T11:31:22+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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/>\n </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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/>\n </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 <value languageCode=\"eng-GB\"></value>\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 <value languageCode=\"eng-GB\"></value>\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 <value languageCode=\"eng-GB\"></value>\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 <value languageCode=\"eng-GB\"></value>\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/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 </FieldDefinitions>\n </ContentType>\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/50\">\n <id>50</id>\n <status>DEFINED</status>\n <identifier>copy_of_article_50</identifier>\n <names>\n <value languageCode=\"eng-GB\">Article</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <creationDate>2021-07-14T10:30:00+00:00</creationDate>\n <modificationDate>2021-07-14T10:30:00+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/50/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/50/draft\"/>\n <remoteId>fc9434492469d136ffe13377bfdcbb28</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/50/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/50/fieldDefinitions/197\">\n <id>197</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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/>\n </value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/50/fieldDefinitions/198\">\n <id>198</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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/>\n </value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/50/fieldDefinitions/199\">\n <id>199</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 <value languageCode=\"eng-GB\"></value>\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/50/fieldDefinitions/200\">\n <id>200</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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/50/fieldDefinitions/201\">\n <id>201</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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/50/fieldDefinitions/202\">\n <id>202</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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/50/fieldDefinitions/203\">\n <id>203</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 </FieldDefinitions>\n </ContentType>\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/44\">\n <id>44</id>\n <status>DEFINED</status>\n <identifier>dog_breed</identifier>\n <names>\n <value languageCode=\"eng-GB\">Dog Breed</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <creationDate>2021-06-28T11:28:00+00:00</creationDate>\n <modificationDate>2021-06-28T11:29:02+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/44/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/44/draft\"/>\n <remoteId>b348c95f7c573d4d502d6b59f80e618a</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><name></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/44/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/44/fieldDefinitions/190\">\n <id>190</id>\n <identifier>name</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>1</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\">Name</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\"/>\n <value key=\"minStringLength\"/>\n </value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/44/fieldDefinitions/191\">\n <id>191</id>\n <identifier>photo</identifier>\n <fieldType>ibexa_image_asset</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=\"destinationContentId\"/>\n <value key=\"alternativeText\"/>\n <value key=\"source\"/>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Photo</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/44/fieldDefinitions/192\">\n <id>192</id>\n <identifier>description</identifier>\n <fieldType>ibexa_richtext</fieldType>\n <fieldGroup>content</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\">Full Description</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\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/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\"/>\n </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\"/>\n </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/55\">\n <id>55</id>\n <status>DEFINED</status>\n <identifier>folder_55</identifier>\n <names>\n <value languageCode=\"eng-GB\">Folder</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <creationDate>2021-07-28T07:57:22+00:00</creationDate>\n <modificationDate>2021-07-28T07:57:34+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/55/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/55/draft\"/>\n <remoteId>4eb7bc76f6d0bd1d5ded2d8936cc6afb</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/55/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/55/fieldDefinitions/210\">\n <id>210</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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/>\n </value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/55/fieldDefinitions/211\">\n <id>211</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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">100</value>\n <value key=\"minStringLength\"/>\n </value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/55/fieldDefinitions/212\">\n <id>212</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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/55/fieldDefinitions/213\">\n <id>213</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 <value languageCode=\"eng-GB\"></value>\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\"/>\n </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/45\">\n <id>45</id>\n <status>DEFINED</status>\n <identifier>tip</identifier>\n <names>\n <value languageCode=\"eng-GB\">Tip</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <creationDate>2021-06-28T11:29:19+00:00</creationDate>\n <modificationDate>2021-07-26T09:33:06+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/45/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/45/draft\"/>\n <remoteId>e6490e8a785edacd48629f2022be3125</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/45/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/45/fieldDefinitions/193\">\n <id>193</id>\n <identifier>title</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>1</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\">Title</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\"/>\n <value key=\"minStringLength\"/>\n </value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/45/fieldDefinitions/194\">\n <id>194</id>\n <identifier>body</identifier>\n <fieldType>ibexa_text</fieldType>\n <fieldGroup>content</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\">Body</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings>\n <value key=\"textRows\">10</value>\n </fieldSettings>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/45/fieldDefinitions/204\">\n <id>204</id>\n <identifier>richtext</identifier>\n <fieldType>ibexa_richtext</fieldType>\n <fieldGroup>content</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\">richtext</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\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\"/>\n </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\"/>\n </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\"/>\n </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" + "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 this content type group." + "description": "Error - The user is not authorized to read the content type." }, "404": { - "description": "Error - The content type group does not exist." + "description": "Error - The content type does not exist." } }, - "summary": "Get content type group", - "description": "Returns the content type group with provided ID.", + "summary": "Get Field definition", + "description": "Returns the Field definition by the given ID.", "parameters": [ { - "name": "If-None-Match", - "in": "header", - "description": "ETag", - "required": false, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "contentTypeGroupId", + "name": "contentTypeId", "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "delete": { - "operationId": "ibexa.rest.delete_content_type_group", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "description": "ContentTypeFieldDefinitionLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "contentTypeGroupId", + "name": "fieldDefinitionId", "in": "path", - "description": "", + "description": "ContentTypeFieldDefinitionLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false - }, - "patch": { - "operationId": "ibexa.rest.update_content_type_group", + ] + } + }, + "/content/types/{contentTypeId}/groups": { + "get": { + "operationId": "ibexa.rest.load_groups_of_content_type", "tags": [ - "Type Groups" + "Type" ], "responses": { "200": { - "description": "Content type group updated.", + "description": "If set, the content type group list is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ContentTypeGroup+json": { + "application/vnd.ibexa.api.ContentTypeGroupRefList+json": { "schema": { - "$ref": "#/components/schemas/ContentTypeGroupWrapper" + "$ref": "#/components/schemas/ContentTypeGroupRefListWrapper" }, "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" - } + "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" + } + ] } } }, - "application/vnd.ibexa.api.ContentTypeGroup+xml": { + "application/vnd.ibexa.api.ContentTypeGroupRefList+xml": { "schema": { - "$ref": "#/components/schemas/ContentTypeGroup" + "$ref": "#/components/schemas/ContentTypeGroupRefList" }, - "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeGroup media-type=\"application/vnd.ibexa.api.ContentTypeGroup+xml\" href=\"/api/ibexa/v2/content/typegroups/1\">\n <id>4</id>\n <identifier>updatedIdentifer</identifier>\n <created>2002-09-05T11:08:48+02:00</created>\n <modified>2019-02-22T14:42:55+01: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" + "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeGroupRefList media-type=\"application/vnd.ibexa.api.ContentTypeGroupRefList+xml\" href=\"/api/ibexa/v2/content/typegroups/2/types\">\n <ContentTypeGroupRef media-type=\"application/vnd.ibexa.api.ContentTypeGroup+xml\" href=\"/api/ibexa/v2/content/typegroups/1\"/>\n</ContentTypeGroupRefList>\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." + "description": "Error - The user is not authorized to read this content type." }, - "412": { - "description": "Error - The current ETag does not match the one provided in the If-Match header." + "404": { + "description": "Error - The content type does not exist." } }, - "summary": "Update content type group", - "description": "Updates a content type group. PATCH or POST with header X-HTTP-Method-Override PATCH.", + "summary": "Get groups of content type", + "description": "Returns the content type group to which content type belongs to.", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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", + "name": "contentTypeId", "in": "path", - "description": "", + "description": "ContentTypeGroupListController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "requestBody": { - "description": "The content type group input schema encoded in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.ContentTypeGroupInput+json": { - "schema": { - "$ref": "#/components/schemas/ContentTypeGroupInputWrapper" - }, - "example": { - "ContentTypeGroupInput": { - "identifier": "updatedIdentifer" - } - } - }, - "application/vnd.ibexa.api.ContentTypeGroupInput+xml": { - "schema": { - "$ref": "#/components/schemas/ContentTypeGroupInput" - }, - "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeGroupInput>\n <identifier>updatedIdentifer</identifier>\n</ContentTypeGroupInput>\n" - } - }, - "required": false - }, - "deprecated": false - } - }, - "/content/typegroups/{contentTypeGroupId}/types": { - "get": { - "operationId": "ibexa.rest.list_content_types_for_group", + ] + }, + "post": { + "operationId": "ibexa.rest.link_content_type_to_group", "tags": [ - "Type Groups" + "Type" ], "responses": { "200": { - "description": "OK - returns a list on content types.", + "description": "If set, the updated content type group list is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ContentTypeInfoList+json": { + "application/vnd.ibexa.api.ContentTypeGroupRefList+json": { "schema": { - "$ref": "#/components/schemas/ContentTypeInfoListWrapper" + "$ref": "#/components/schemas/ContentTypeGroupRefListWrapper" }, "example": { - "ContentTypeList": { - "_media-type": "application/vnd.ibexa.api.ContentTypeList+json", - "_href": "/api/ibexa/v2/content/types", - "ContentType": [ - { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/2", - "id": 2, - "status": "DEFINED", - "identifier": "article", - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Article" - } - ] - }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] - }, - "creationDate": "2002-06-18T09:21:38+00:00", - "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": [] - } - ] + "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.ContentType+json", - "_href": "/api/ibexa/v2/content/types/50", - "id": 50, - "status": "DEFINED", - "identifier": "copy_of_article_50", - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Article" - } - ] - }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] - }, - "creationDate": "2021-07-14T10:30:00+00:00", - "modificationDate": "2021-07-14T10:30:00+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/50/groups" - }, - "Draft": { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/50/draft" - }, - "remoteId": "fc9434492469d136ffe13377bfdcbb28", - "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/50/fieldDefinitions", - "FieldDefinition": [ - { - "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/50/fieldDefinitions/197", - "id": 197, - "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/50/fieldDefinitions/198", - "id": 198, - "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/50/fieldDefinitions/199", - "id": 199, - "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/50/fieldDefinitions/200", - "id": 200, - "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/50/fieldDefinitions/201", - "id": 201, - "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/50/fieldDefinitions/202", - "id": 202, - "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/50/fieldDefinitions/203", - "id": 203, - "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": [] - } - ] + "_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/3\">\n <unlink href=\"/api/ibexa/v2/content/types/15/groups/3\" 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": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "contentTypeId", + "in": "path", + "description": "ContentTypeLinkToGroupController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "group", + "in": "query", + "description": "Destination content type group URI; for example with content type group 4: `?group=/api/ibexa/v2/content/typegroups/4`", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "form", + "explode": false + } + ], + "requestBody": { + "description": "No payload required", + "content": [], + "required": false + } + } + }, + "/content/types/{contentTypeId}/groups/{id}": { + "delete": { + "operationId": "ibexa.rest.unlink_content_type_from_group", + "tags": [ + "Type" + ], + "responses": { + "200": { + "description": "If set, the updated content type group list is returned in XML or JSON format.", + "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.ContentType+json", - "_href": "/api/ibexa/v2/content/types/44", - "id": 44, - "status": "DEFINED", - "identifier": "dog_breed", - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Dog Breed" - } - ] - }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] - }, - "creationDate": "2021-06-28T11:28:00+00:00", - "modificationDate": "2021-06-28T11:29:02+00:00", + "_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": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "contentTypeId", + "in": "path", + "description": "ContentTypeUnlinkFromGroupController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "id", + "in": "path", + "description": "ContentTypeUnlinkFromGroupController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + } + }, + "/content/typegroups": { + "get": { + "operationId": "ibexa.rest.load_content_type_group_list", + "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" @@ -34444,156 +20550,18 @@ "_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/44/groups" - }, - "Draft": { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/44/draft" - }, - "remoteId": "b348c95f7c573d4d502d6b59f80e618a", - "urlAliasSchema": "", - "nameSchema": "<name>", - "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/44/fieldDefinitions", - "FieldDefinition": [ - { - "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/44/fieldDefinitions/190", - "id": 190, - "identifier": "name", - "fieldType": "ibexa_string", - "fieldGroup": "content", - "position": 1, - "isTranslatable": true, - "isRequired": false, - "isInfoCollector": false, - "defaultValue": null, - "isSearchable": true, - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Name" - } - ] - }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] - }, - "fieldSettings": [], - "validatorConfiguration": { - "StringLengthValidator": { - "maxStringLength": null, - "minStringLength": null - } - } - }, - { - "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/44/fieldDefinitions/191", - "id": 191, - "identifier": "photo", - "fieldType": "ibexa_image_asset", - "fieldGroup": "content", - "position": 2, - "isTranslatable": true, - "isRequired": false, - "isInfoCollector": false, - "defaultValue": { - "destinationContentId": null, - "alternativeText": null, - "source": null - }, - "isSearchable": true, - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Photo" - } - ] - }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] - }, - "fieldSettings": [], - "validatorConfiguration": [] - }, - { - "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/44/fieldDefinitions/192", - "id": 192, - "identifier": "description", - "fieldType": "ibexa_richtext", - "fieldGroup": "content", - "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": "Full Description" - } - ] - }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": null - } - ] - }, - "fieldSettings": [], - "validatorConfiguration": [] - } - ] + "ContentTypes": { + "_media-type": "application/vnd.ibexa.api.ContentTypeInfoList+json", + "_href": "/api/ibexa/v2/content/typegroups/1/types" } }, { - "_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", + "_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" @@ -34602,172 +20570,18 @@ "_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": [] - } - ] + "ContentTypes": { + "_media-type": "application/vnd.ibexa.api.ContentTypeInfoList+json", + "_href": "/api/ibexa/v2/content/typegroups/2/types" } }, { - "_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", + "_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" @@ -34776,104 +20590,161 @@ "_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": [] - } - ] + "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": [] + }, + "post": { + "operationId": "ibexa.rest.create_content_type_group", + "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/6", + "id": 6, + "identifier": "newContentTypeGroup", + "created": "2021-08-11T09:44:18+00:00", + "modified": "2021-08-11T09:44:18+00:00", + "Creator": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "Modifier": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "ContentTypes": { + "_media-type": "application/vnd.ibexa.api.ContentTypeInfoList+json", + "_href": "/api/ibexa/v2/content/typegroups/6/types" + } + } + } + }, + "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": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "The content type group input schema encoded in XML or JSON.", + "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 + } + } + }, + "/content/typegroups/{contentTypeGroupId}": { + "get": { + "operationId": "ibexa.rest.load_content_type_group", + "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/45", - "id": 45, + "_href": "/api/ibexa/v2/content/types/2", + "id": 2, "status": "DEFINED", - "identifier": "tip", + "identifier": "article", "names": { "value": [ { "_languageCode": "eng-GB", - "#text": "Tip" + "#text": "Article" } ] }, @@ -34885,8 +20756,8 @@ } ] }, - "creationDate": "2021-06-28T11:29:19+00:00", - "modificationDate": "2021-07-26T09:33:06+00:00", + "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" @@ -34897,36 +20768,36 @@ }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", - "_href": "/api/ibexa/v2/content/types/45/groups" + "_href": "/api/ibexa/v2/content/types/2/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/45/draft" + "_href": "/api/ibexa/v2/content/types/2/draft" }, - "remoteId": "e6490e8a785edacd48629f2022be3125", + "remoteId": "c15b600eb9198b1924063b5a68758232", "urlAliasSchema": "", - "nameSchema": "<title>", - "isContainer": false, + "nameSchema": "<short_title|title>", + "isContainer": true, "mainLanguageCode": "eng-GB", - "defaultAlwaysAvailable": true, - "defaultSortField": "PUBLISHED", - "defaultSortOrder": "DESC", + "defaultAlwaysAvailable": false, + "defaultSortField": "PATH", + "defaultSortOrder": "ASC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", - "_href": "/api/ibexa/v2/content/types/45/fieldDefinitions", + "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/45/fieldDefinitions/193", - "id": 193, + "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/1", + "id": 1, "identifier": "title", "fieldType": "ibexa_string", - "fieldGroup": "content", + "fieldGroup": "", "position": 1, "isTranslatable": true, - "isRequired": false, + "isRequired": true, "isInfoCollector": false, - "defaultValue": null, + "defaultValue": "New article", "isSearchable": true, "names": { "value": [ @@ -34947,18 +20818,18 @@ "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { - "maxStringLength": null, + "maxStringLength": 255, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/45/fieldDefinitions/194", - "id": 194, - "identifier": "body", - "fieldType": "ibexa_text", - "fieldGroup": "content", + "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/152", + "id": 152, + "identifier": "short_title", + "fieldType": "ibexa_string", + "fieldGroup": "", "position": 2, "isTranslatable": true, "isRequired": false, @@ -34969,7 +20840,7 @@ "value": [ { "_languageCode": "eng-GB", - "#text": "Body" + "#text": "Short title" } ] }, @@ -34981,32 +20852,32 @@ } ] }, - "fieldSettings": { - "textRows": 10 - }, - "validatorConfiguration": [] + "fieldSettings": [], + "validatorConfiguration": { + "StringLengthValidator": { + "maxStringLength": 255, + "minStringLength": null + } + } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/45/fieldDefinitions/204", - "id": 204, - "identifier": "richtext", - "fieldType": "ibexa_richtext", - "fieldGroup": "content", + "_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": { - "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, + "defaultValue": [], + "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", - "#text": "richtext" + "#text": "Author" } ] }, @@ -35018,119 +20889,32 @@ } ] }, - "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": { + "defaultAuthor": 1 }, - "fieldSettings": [], - "validatorConfiguration": { - "StringLengthValidator": { - "maxStringLength": null, - "minStringLength": null - } - } + "validatorConfiguration": [] }, { "_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, + "_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": null, + "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" + "#text": "Intro" } ] }, @@ -35138,259 +20922,96 @@ "value": [ { "_languageCode": "eng-GB", - "#text": "Landing page description" + "#text": null } ] }, "fieldSettings": [], - "validatorConfiguration": { - "StringLengthValidator": { - "maxStringLength": null, - "minStringLength": null - } - } + "validatorConfiguration": [] }, { "_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, + "_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": { - "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" + "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" }, - "validatorConfiguration": [] - } - ] - } - }, - { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/4", - "id": 4, - "status": "DEFINED", - "identifier": "user", - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "User" - } - ] - }, - "descriptions": { - "value": [] - }, - "creationDate": "2002-06-18T09:21:38+00:00", - "modificationDate": "2004-04-15T08:39: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/4/groups" - }, - "Draft": { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/4/draft" - }, - "remoteId": "40faa822edc579b02c25f6bb7beec3ad", - "urlAliasSchema": null, - "nameSchema": "<first_name> <last_name>", - "isContainer": false, - "mainLanguageCode": "eng-GB", - "defaultAlwaysAvailable": true, - "defaultSortField": "PATH", - "defaultSortOrder": "ASC", - "FieldDefinitions": { - "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", - "_href": "/api/ibexa/v2/content/types/4/fieldDefinitions", - "FieldDefinition": [ - { - "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/4/fieldDefinitions/8", - "id": 8, - "identifier": "first_name", - "fieldType": "ibexa_string", - "fieldGroup": "", - "position": 1, - "isTranslatable": true, - "isRequired": true, - "isInfoCollector": false, - "defaultValue": null, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", - "#text": "First name" + "#text": "Body" } ] }, "descriptions": { - "value": [] - }, - "fieldSettings": [], - "validatorConfiguration": { - "StringLengthValidator": { - "maxStringLength": 255, - "minStringLength": null - } - } - }, - { - "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/4/fieldDefinitions/9", - "id": 9, - "identifier": "last_name", - "fieldType": "ibexa_string", - "fieldGroup": "", - "position": 2, - "isTranslatable": true, - "isRequired": true, - "isInfoCollector": false, - "defaultValue": null, - "isSearchable": true, - "names": { "value": [ { "_languageCode": "eng-GB", - "#text": "Last name" + "#text": null } ] }, - "descriptions": { - "value": [] - }, "fieldSettings": [], - "validatorConfiguration": { - "StringLengthValidator": { - "maxStringLength": 255, - "minStringLength": null - } - } + "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/4/fieldDefinitions/12", - "id": 12, - "identifier": "user_account", - "fieldType": "ibexa_user", + "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/123", + "id": 123, + "identifier": "enable_comments", + "fieldType": "ibexa_boolean", "fieldGroup": "", - "position": 3, + "position": 6, "isTranslatable": false, - "isRequired": true, + "isRequired": false, "isInfoCollector": false, - "defaultValue": null, + "defaultValue": false, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", - "#text": "User account" + "#text": "Enable comments" } ] }, "descriptions": { - "value": [] - }, - "fieldSettings": { - "PasswordTTL": 0, - "PasswordTTLWarning": 0, - "RequireUniqueEmail": false, - "UsernamePattern": "^[^@]+$" - }, - "validatorConfiguration": { - "PasswordValueValidator": { - "requireAtLeastOneUpperCaseCharacter": true, - "requireAtLeastOneLowerCaseCharacter": true, - "requireAtLeastOneNumericCharacter": true, - "requireAtLeastOneNonAlphanumericCharacter": false, - "requireNewPassword": false, - "minLength": 10 - } - } - }, - { - "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/4/fieldDefinitions/179", - "id": 179, - "identifier": "signature", - "fieldType": "ibexa_text", - "fieldGroup": "", - "position": 4, - "isTranslatable": true, - "isRequired": false, - "isInfoCollector": false, - "defaultValue": null, - "isSearchable": true, - "names": { "value": [ { "_languageCode": "eng-GB", - "#text": "Signature" + "#text": null } ] }, - "descriptions": { - "value": [] - }, - "fieldSettings": { - "textRows": 10 - }, + "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/4/fieldDefinitions/180", - "id": 180, + "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/195", + "id": 195, "identifier": "image", - "fieldType": "ibexa_image", - "fieldGroup": "", - "position": 5, - "isTranslatable": true, + "fieldType": "ibexa_image_asset", + "fieldGroup": "content", + "position": 7, + "isTranslatable": false, "isRequired": false, "isInfoCollector": false, - "defaultValue": null, + "defaultValue": { + "destinationContentId": null, + "alternativeText": null, + "source": null + }, "isSearchable": false, "names": { "value": [ @@ -35401,37 +21022,43 @@ ] }, "descriptions": { - "value": [] + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] }, "fieldSettings": [], - "validatorConfiguration": { - "FileSizeValidator": { - "maxFileSize": 10 - } - } + "validatorConfiguration": [] } ] } }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/3", - "id": 3, + "_href": "/api/ibexa/v2/content/types/50", + "id": 50, "status": "DEFINED", - "identifier": "user_group", + "identifier": "copy_of_article_50", "names": { "value": [ { "_languageCode": "eng-GB", - "#text": "User group" + "#text": "Article" } ] }, "descriptions": { - "value": [] - }, - "creationDate": "2002-06-18T09:21:38+00:00", - "modificationDate": "2003-03-24T08:32:23+00:00", + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] + }, + "creationDate": "2021-07-14T10:30:00+00:00", + "modificationDate": "2021-07-14T10:30:00+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" @@ -35442,47 +21069,52 @@ }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", - "_href": "/api/ibexa/v2/content/types/3/groups" + "_href": "/api/ibexa/v2/content/types/50/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/3/draft" + "_href": "/api/ibexa/v2/content/types/50/draft" }, - "remoteId": "25b4268cdcd01921b808a0d854b877ef", - "urlAliasSchema": null, - "nameSchema": "<name>", + "remoteId": "fc9434492469d136ffe13377bfdcbb28", + "urlAliasSchema": "", + "nameSchema": "<short_title|title>", "isContainer": true, "mainLanguageCode": "eng-GB", - "defaultAlwaysAvailable": true, + "defaultAlwaysAvailable": false, "defaultSortField": "PATH", "defaultSortOrder": "ASC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", - "_href": "/api/ibexa/v2/content/types/3/fieldDefinitions", + "_href": "/api/ibexa/v2/content/types/50/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/3/fieldDefinitions/6", - "id": 6, - "identifier": "name", + "_href": "/api/ibexa/v2/content/types/50/fieldDefinitions/197", + "id": 197, + "identifier": "title", "fieldType": "ibexa_string", "fieldGroup": "", "position": 1, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, - "defaultValue": null, + "defaultValue": "New article", "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", - "#text": "Name" + "#text": "Title" } ] }, "descriptions": { - "value": [] + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] }, "fieldSettings": [], "validatorConfiguration": { @@ -35494,9 +21126,9 @@ }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/3/fieldDefinitions/7", - "id": 7, - "identifier": "description", + "_href": "/api/ibexa/v2/content/types/50/fieldDefinitions/198", + "id": 198, + "identifier": "short_title", "fieldType": "ibexa_string", "fieldGroup": "", "position": 2, @@ -35509,12 +21141,17 @@ "value": [ { "_languageCode": "eng-GB", - "#text": "Description" + "#text": "Short title" } ] }, "descriptions": { - "value": [] + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] }, "fieldSettings": [], "validatorConfiguration": { @@ -35523,97 +21160,84 @@ "minStringLength": null } } - } - ] - } - }, - { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/12", - "id": 12, - "status": "DEFINED", - "identifier": "file", - "names": { - "value": [ + }, { - "_languageCode": "eng-GB", - "#text": "File" - } - ] - }, - "descriptions": { - "value": [] - }, - "creationDate": "2003-05-08T09:17:52+00:00", - "modificationDate": "2003-05-08T09:21:09+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/12/groups" - }, - "Draft": { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/12/draft" - }, - "remoteId": "637d58bfddf164627bdfd265733280a0", - "urlAliasSchema": null, - "nameSchema": "<name>", - "isContainer": false, - "mainLanguageCode": "eng-GB", - "defaultAlwaysAvailable": true, - "defaultSortField": "PATH", - "defaultSortOrder": "ASC", - "FieldDefinitions": { - "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", - "_href": "/api/ibexa/v2/content/types/12/fieldDefinitions", - "FieldDefinition": [ + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/50/fieldDefinitions/199", + "id": 199, + "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/12/fieldDefinitions/146", - "id": 146, - "identifier": "name", - "fieldType": "ibexa_string", + "_href": "/api/ibexa/v2/content/types/50/fieldDefinitions/200", + "id": 200, + "identifier": "intro", + "fieldType": "ibexa_richtext", "fieldGroup": "", - "position": 1, + "position": 4, "isTranslatable": true, "isRequired": true, "isInfoCollector": false, - "defaultValue": "New file", + "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": "Name" + "#text": "Intro" } ] }, "descriptions": { - "value": [] + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] }, "fieldSettings": [], - "validatorConfiguration": { - "StringLengthValidator": { - "maxStringLength": null, - "minStringLength": null - } - } + "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/12/fieldDefinitions/147", - "id": 147, - "identifier": "description", + "_href": "/api/ibexa/v2/content/types/50/fieldDefinitions/201", + "id": 201, + "identifier": "body", "fieldType": "ibexa_richtext", "fieldGroup": "", - "position": 2, + "position": 5, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, @@ -35626,69 +21250,116 @@ "value": [ { "_languageCode": "eng-GB", - "#text": "Description" + "#text": "Body" } ] }, "descriptions": { - "value": [] + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/12/fieldDefinitions/148", - "id": 148, - "identifier": "file", - "fieldType": "ibexa_author", + "_href": "/api/ibexa/v2/content/types/50/fieldDefinitions/202", + "id": 202, + "identifier": "enable_comments", + "fieldType": "ibexa_boolean", "fieldGroup": "", - "position": 3, - "isTranslatable": true, - "isRequired": true, + "position": 6, + "isTranslatable": false, + "isRequired": false, "isInfoCollector": false, - "defaultValue": null, + "defaultValue": false, "isSearchable": false, "names": { "value": [ { "_languageCode": "eng-GB", - "#text": "File" + "#text": "Enable comments" } ] }, "descriptions": { - "value": [] + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] }, "fieldSettings": [], - "validatorConfiguration": { - "FileSizeValidator": { - "maxFileSize": null - } - } + "validatorConfiguration": [] + }, + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/50/fieldDefinitions/203", + "id": 203, + "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": [] } ] } }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/5", - "id": 5, + "_href": "/api/ibexa/v2/content/types/44", + "id": 44, "status": "DEFINED", - "identifier": "image", + "identifier": "dog_breed", "names": { "value": [ { "_languageCode": "eng-GB", - "#text": "Image" + "#text": "Dog Breed" } ] }, "descriptions": { - "value": [] + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] }, - "creationDate": "2002-09-08T11:36:32+00:00", - "modificationDate": "2003-03-24T08:33:04+00:00", + "creationDate": "2021-06-28T11:28:00+00:00", + "modificationDate": "2021-06-28T11:29:02+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" @@ -35699,34 +21370,34 @@ }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", - "_href": "/api/ibexa/v2/content/types/5/groups" + "_href": "/api/ibexa/v2/content/types/44/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/5/draft" + "_href": "/api/ibexa/v2/content/types/44/draft" }, - "remoteId": "f6df12aa74e36230eb675f364fccd25a", - "urlAliasSchema": null, + "remoteId": "b348c95f7c573d4d502d6b59f80e618a", + "urlAliasSchema": "", "nameSchema": "<name>", "isContainer": false, "mainLanguageCode": "eng-GB", "defaultAlwaysAvailable": true, - "defaultSortField": "PATH", - "defaultSortOrder": "ASC", + "defaultSortField": "PUBLISHED", + "defaultSortOrder": "DESC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", - "_href": "/api/ibexa/v2/content/types/5/fieldDefinitions", + "_href": "/api/ibexa/v2/content/types/44/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/5/fieldDefinitions/116", - "id": 116, + "_href": "/api/ibexa/v2/content/types/44/fieldDefinitions/190", + "id": 190, "identifier": "name", "fieldType": "ibexa_string", - "fieldGroup": "", + "fieldGroup": "content", "position": 1, "isTranslatable": true, - "isRequired": true, + "isRequired": false, "isInfoCollector": false, "defaultValue": null, "isSearchable": true, @@ -35739,110 +21410,106 @@ ] }, "descriptions": { - "value": [] + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] }, "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { - "maxStringLength": 150, + "maxStringLength": null, "minStringLength": null } } }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/5/fieldDefinitions/117", - "id": 117, - "identifier": "caption", - "fieldType": "ibexa_richtext", - "fieldGroup": "", + "_href": "/api/ibexa/v2/content/types/44/fieldDefinitions/191", + "id": 191, + "identifier": "photo", + "fieldType": "ibexa_image_asset", + "fieldGroup": "content", "position": 2, "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" + "destinationContentId": null, + "alternativeText": null, + "source": null }, "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", - "#text": "Caption" + "#text": "Photo" } ] }, "descriptions": { - "value": [] + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/5/fieldDefinitions/118", - "id": 118, - "identifier": "image", - "fieldType": "ibexa_image", - "fieldGroup": "", + "_href": "/api/ibexa/v2/content/types/44/fieldDefinitions/192", + "id": 192, + "identifier": "description", + "fieldType": "ibexa_richtext", + "fieldGroup": "content", "position": 3, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, - "defaultValue": null, - "isSearchable": 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": "Image" + "#text": "Full Description" } ] }, "descriptions": { - "value": [] + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] }, "fieldSettings": [], - "validatorConfiguration": { - "FileSizeValidator": { - "maxFileSize": 10 - } - } + "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, + "_href": "/api/ibexa/v2/content/types/1", + "id": 1, "status": "DEFINED", - "identifier": "article", + "identifier": "folder", "names": { "value": [ { "_languageCode": "eng-GB", - "#text": "Article" + "#text": "Folder" } ] }, @@ -35850,7 +21517,7 @@ "value": [] }, "creationDate": "2002-06-18T09:21:38+00:00", - "modificationDate": "2004-04-20T09:56:29+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" @@ -35861,42 +21528,42 @@ }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", - "_href": "/api/ibexa/v2/content/types/2/groups" + "_href": "/api/ibexa/v2/content/types/1/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/2/draft" + "_href": "/api/ibexa/v2/content/types/1/draft" }, - "remoteId": "c15b600eb9198b1924063b5a68758232", + "remoteId": "a3d405b81be900468eb153d774f4f0d2", "urlAliasSchema": null, - "nameSchema": "<short_title|title>", + "nameSchema": "<short_name|name>", "isContainer": true, "mainLanguageCode": "eng-GB", - "defaultAlwaysAvailable": false, + "defaultAlwaysAvailable": true, "defaultSortField": "PATH", "defaultSortOrder": "ASC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", - "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions", + "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/1", - "id": 1, - "identifier": "title", + "_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": "New article", + "defaultValue": "Folder", "isSearchable": true, "names": { "value": [ { "_languageCode": "eng-GB", - "#text": "Title" + "#text": "Name" } ] }, @@ -35913,9 +21580,9 @@ }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/2/fieldDefinitions/152", - "id": 152, - "identifier": "short_title", + "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/155", + "id": 155, + "identifier": "short_name", "fieldType": "ibexa_string", "fieldGroup": "", "position": 2, @@ -35928,7 +21595,7 @@ "value": [ { "_languageCode": "eng-GB", - "#text": "Short title" + "#text": "Short name" } ] }, @@ -35938,78 +21605,19 @@ "fieldSettings": [], "validatorConfiguration": { "StringLengthValidator": { - "maxStringLength": 255, + "maxStringLength": 100, "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", + "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/119", + "id": 119, + "identifier": "short_description", "fieldType": "ibexa_richtext", "fieldGroup": "", - "position": 5, + "position": 3, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, @@ -36022,34 +21630,7 @@ "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" + "#text": "Short description" } ] }, @@ -36061,35 +21642,32 @@ }, { "_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", + "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/156", + "id": 156, + "identifier": "description", + "fieldType": "ibexa_richtext", "fieldGroup": "", - "position": 7, + "position": 4, "isTranslatable": true, "isRequired": false, "isInfoCollector": false, "defaultValue": { - "destinationContentId": null + "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": "Image" + "#text": "Description" } ] }, "descriptions": { "value": [] }, - "fieldSettings": { - "selectionMethod": "SELECTION_BROWSE", - "selectionRoot": "", - "selectionContentTypes": [] - }, + "fieldSettings": [], "validatorConfiguration": [] } ] @@ -36097,10 +21675,10 @@ }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/1", - "id": 1, + "_href": "/api/ibexa/v2/content/types/55", + "id": 55, "status": "DEFINED", - "identifier": "folder", + "identifier": "folder_55", "names": { "value": [ { @@ -36110,10 +21688,15 @@ ] }, "descriptions": { - "value": [] + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] }, - "creationDate": "2002-06-18T09:21:38+00:00", - "modificationDate": "2015-11-29T21:14:32+00:00", + "creationDate": "2021-07-28T07:57:22+00:00", + "modificationDate": "2021-07-28T07:57:34+00:00", "Creator": { "_media-type": "application/vnd.ibexa.api.User+json", "_href": "/api/ibexa/v2/user/users/14" @@ -36124,14 +21707,14 @@ }, "Groups": { "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", - "_href": "/api/ibexa/v2/content/types/1/groups" + "_href": "/api/ibexa/v2/content/types/55/groups" }, "Draft": { "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/1/draft" + "_href": "/api/ibexa/v2/content/types/55/draft" }, - "remoteId": "a3d405b81be900468eb153d774f4f0d2", - "urlAliasSchema": null, + "remoteId": "4eb7bc76f6d0bd1d5ded2d8936cc6afb", + "urlAliasSchema": "", "nameSchema": "<short_name|name>", "isContainer": true, "mainLanguageCode": "eng-GB", @@ -36140,12 +21723,12 @@ "defaultSortOrder": "ASC", "FieldDefinitions": { "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", - "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions", + "_href": "/api/ibexa/v2/content/types/55/fieldDefinitions", "FieldDefinition": [ { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/4", - "id": 4, + "_href": "/api/ibexa/v2/content/types/55/fieldDefinitions/210", + "id": 210, "identifier": "name", "fieldType": "ibexa_string", "fieldGroup": "", @@ -36164,7 +21747,12 @@ ] }, "descriptions": { - "value": [] + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] }, "fieldSettings": [], "validatorConfiguration": { @@ -36176,8 +21764,8 @@ }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/155", - "id": 155, + "_href": "/api/ibexa/v2/content/types/55/fieldDefinitions/211", + "id": 211, "identifier": "short_name", "fieldType": "ibexa_string", "fieldGroup": "", @@ -36196,7 +21784,12 @@ ] }, "descriptions": { - "value": [] + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] }, "fieldSettings": [], "validatorConfiguration": { @@ -36208,8 +21801,8 @@ }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/119", - "id": 119, + "_href": "/api/ibexa/v2/content/types/55/fieldDefinitions/212", + "id": 212, "identifier": "short_description", "fieldType": "ibexa_richtext", "fieldGroup": "", @@ -36231,15 +21824,20 @@ ] }, "descriptions": { - "value": [] + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] }, "fieldSettings": [], "validatorConfiguration": [] }, { "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", - "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/156", - "id": 156, + "_href": "/api/ibexa/v2/content/types/55/fieldDefinitions/213", + "id": 213, "identifier": "description", "fieldType": "ibexa_richtext", "fieldGroup": "", @@ -36261,7 +21859,12 @@ ] }, "descriptions": { - "value": [] + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] }, "fieldSettings": [], "validatorConfiguration": [] @@ -36383,6 +21986,167 @@ ] } }, + { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/45", + "id": 45, + "status": "DEFINED", + "identifier": "tip", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Tip" + } + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] + }, + "creationDate": "2021-06-28T11:29:19+00:00", + "modificationDate": "2021-07-26T09:33: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" + }, + "Groups": { + "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", + "_href": "/api/ibexa/v2/content/types/45/groups" + }, + "Draft": { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/45/draft" + }, + "remoteId": "e6490e8a785edacd48629f2022be3125", + "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/45/fieldDefinitions", + "FieldDefinition": [ + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/45/fieldDefinitions/193", + "id": 193, + "identifier": "title", + "fieldType": "ibexa_string", + "fieldGroup": "content", + "position": 1, + "isTranslatable": true, + "isRequired": false, + "isInfoCollector": false, + "defaultValue": null, + "isSearchable": true, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Title" + } + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] + }, + "fieldSettings": [], + "validatorConfiguration": { + "StringLengthValidator": { + "maxStringLength": null, + "minStringLength": null + } + } + }, + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/45/fieldDefinitions/194", + "id": 194, + "identifier": "body", + "fieldType": "ibexa_text", + "fieldGroup": "content", + "position": 2, + "isTranslatable": true, + "isRequired": false, + "isInfoCollector": false, + "defaultValue": null, + "isSearchable": true, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Body" + } + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] + }, + "fieldSettings": { + "textRows": 10 + }, + "validatorConfiguration": [] + }, + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/45/fieldDefinitions/204", + "id": 204, + "identifier": "richtext", + "fieldType": "ibexa_richtext", + "fieldGroup": "content", + "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": "richtext" + } + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] + }, + "fieldSettings": [], + "validatorConfiguration": [] + } + ] + } + }, { "_media-type": "application/vnd.ibexa.api.ContentType+json", "_href": "/api/ibexa/v2/content/types/42", @@ -36519,472 +22283,113 @@ "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-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 <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</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": "contentTypeGroupId", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "post": { - "operationId": "ibexa.rest.create_content_type", - "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/20/draft\">\n <id>20</id>\n <status>DRAFT</status>\n <identifier>newContentType</identifier>\n <names>\n <value languageCode=\"eng-GB\">New content type</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">This is a description</value>\n </descriptions>\n <creationDate>2019-02-26T09:39:58+01:00</creationDate>\n <modificationDate>2019-02-26T09:39:58+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/20/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/20/draft\"/>\n <remoteId>remoteId-qwert548</remoteId>\n <urlAliasSchema><title></urlAliasSchema>\n <nameSchema><title></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/20/draft/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/20/draft/fieldDefinitions/223\">\n <id>223</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>New Title</defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Title</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">This is the title</value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"minStringLength\">0</value>\n <value key=\"maxStringLength\"/></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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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 content type Create schema encoded in XML or JSON format.", - "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": "ibexa.rest.list_global_url_aliases", - "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" + "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.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": [], - "deprecated": false - }, - "post": { - "operationId": "ibexa.rest.create_url_alias", - "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-f530173ad554787c1fe30dc929d98360", - "_id": "0-f530173ad554787c1fe30dc929d98360", - "_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": { + "application/vnd.ibexa.api.ContentTypeGroup+xml": { "schema": { - "$ref": "#/components/schemas/UrlAlias" + "$ref": "#/components/schemas/ContentTypeList" }, - "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-deca3dadca45c3dff7861274b8e67ed7\" id=\"0-deca3dadca45c3dff7861274b8e67ed7\" type=\"LOCATION\">\n <location media-type=\"application/vnd.ibexa.api.Location+xml\" href=\"/api/ibexa/v2/content/locations/59\"/>\n <path>/example-urlalias</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" + "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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <creationDate>2002-06-18T09:21:38+00:00</creationDate>\n <modificationDate>2021-06-28T11:31:22+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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/>\n </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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/>\n </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 <value languageCode=\"eng-GB\"></value>\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 <value languageCode=\"eng-GB\"></value>\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 <value languageCode=\"eng-GB\"></value>\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 <value languageCode=\"eng-GB\"></value>\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/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 </FieldDefinitions>\n </ContentType>\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/50\">\n <id>50</id>\n <status>DEFINED</status>\n <identifier>copy_of_article_50</identifier>\n <names>\n <value languageCode=\"eng-GB\">Article</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <creationDate>2021-07-14T10:30:00+00:00</creationDate>\n <modificationDate>2021-07-14T10:30:00+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/50/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/50/draft\"/>\n <remoteId>fc9434492469d136ffe13377bfdcbb28</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/50/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/50/fieldDefinitions/197\">\n <id>197</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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/>\n </value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/50/fieldDefinitions/198\">\n <id>198</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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/>\n </value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/50/fieldDefinitions/199\">\n <id>199</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 <value languageCode=\"eng-GB\"></value>\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/50/fieldDefinitions/200\">\n <id>200</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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/50/fieldDefinitions/201\">\n <id>201</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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/50/fieldDefinitions/202\">\n <id>202</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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/50/fieldDefinitions/203\">\n <id>203</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 </FieldDefinitions>\n </ContentType>\n <ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/44\">\n <id>44</id>\n <status>DEFINED</status>\n <identifier>dog_breed</identifier>\n <names>\n <value languageCode=\"eng-GB\">Dog Breed</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <creationDate>2021-06-28T11:28:00+00:00</creationDate>\n <modificationDate>2021-06-28T11:29:02+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/44/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/44/draft\"/>\n <remoteId>b348c95f7c573d4d502d6b59f80e618a</remoteId>\n <urlAliasSchema></urlAliasSchema>\n <nameSchema><name></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/44/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/44/fieldDefinitions/190\">\n <id>190</id>\n <identifier>name</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>1</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\">Name</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\"/>\n <value key=\"minStringLength\"/>\n </value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/44/fieldDefinitions/191\">\n <id>191</id>\n <identifier>photo</identifier>\n <fieldType>ibexa_image_asset</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=\"destinationContentId\"/>\n <value key=\"alternativeText\"/>\n <value key=\"source\"/>\n </defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Photo</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/44/fieldDefinitions/192\">\n <id>192</id>\n <identifier>description</identifier>\n <fieldType>ibexa_richtext</fieldType>\n <fieldGroup>content</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\">Full Description</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\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/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\"/>\n </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\"/>\n </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/55\">\n <id>55</id>\n <status>DEFINED</status>\n <identifier>folder_55</identifier>\n <names>\n <value languageCode=\"eng-GB\">Folder</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <creationDate>2021-07-28T07:57:22+00:00</creationDate>\n <modificationDate>2021-07-28T07:57:34+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/55/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/55/draft\"/>\n <remoteId>4eb7bc76f6d0bd1d5ded2d8936cc6afb</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/55/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/55/fieldDefinitions/210\">\n <id>210</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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">255</value>\n <value key=\"minStringLength\"/>\n </value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/55/fieldDefinitions/211\">\n <id>211</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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\">100</value>\n <value key=\"minStringLength\"/>\n </value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/55/fieldDefinitions/212\">\n <id>212</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 <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/55/fieldDefinitions/213\">\n <id>213</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 <value languageCode=\"eng-GB\"></value>\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\"/>\n </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/45\">\n <id>45</id>\n <status>DEFINED</status>\n <identifier>tip</identifier>\n <names>\n <value languageCode=\"eng-GB\">Tip</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <creationDate>2021-06-28T11:29:19+00:00</creationDate>\n <modificationDate>2021-07-26T09:33:06+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/45/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/45/draft\"/>\n <remoteId>e6490e8a785edacd48629f2022be3125</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/45/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/45/fieldDefinitions/193\">\n <id>193</id>\n <identifier>title</identifier>\n <fieldType>ibexa_string</fieldType>\n <fieldGroup>content</fieldGroup>\n <position>1</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\">Title</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"maxStringLength\"/>\n <value key=\"minStringLength\"/>\n </value>\n </validatorConfiguration>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/45/fieldDefinitions/194\">\n <id>194</id>\n <identifier>body</identifier>\n <fieldType>ibexa_text</fieldType>\n <fieldGroup>content</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\">Body</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\n </descriptions>\n <fieldSettings>\n <value key=\"textRows\">10</value>\n </fieldSettings>\n <validatorConfiguration/>\n </FieldDefinition>\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/45/fieldDefinitions/204\">\n <id>204</id>\n <identifier>richtext</identifier>\n <fieldType>ibexa_richtext</fieldType>\n <fieldGroup>content</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\">richtext</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\"></value>\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\"/>\n </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\"/>\n </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\"/>\n </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." - }, "401": { - "description": "Error - The user is not authorized to create a URL alias." + "description": "Error - The user is not authorized to read this content type group." }, - "403": { - "description": "Error - A URL alias with the same identifier already exists." + "404": { + "description": "Error - The content type group does not exist." } }, - "summary": "Create URL alias", - "description": "Creates a URL alias.", + "summary": "Get content type group", + "description": "Returns the content type group with provided ID.", "parameters": [ { - "name": "X-CSRF-Token", + "name": "If-None-Match", "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "required": true, + "description": "ETag", + "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The URL alias input schema encoded in XML or JSON format.", - "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": "ibexa.rest.load_url_alias", - "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" - } - } + "explode": false }, - "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": "urlAliasId", + "name": "contentTypeGroupId", "in": "path", - "description": "", + "description": "ContentTypeGroupLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] }, "delete": { - "operationId": "ibexa.rest.delete_url_alias", + "operationId": "ibexa.rest.delete_content_type_group", "tags": [ - "Url Alias" + "Type Groups" ], "responses": { "204": { - "description": "No Content - URL alias deleted." + "description": "No Content - content type group deleted." }, "401": { - "description": "Error - The user is not authorized to delete a URL alias." + "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 URL alias does not exist." + "description": "Error - The content type group does not exist." } }, - "summary": "Delete URL alias", - "description": "Deletes the provided URL alias.", + "summary": "Delete content type group", + "description": "Deletes the provided content type group.", "parameters": [ { "name": "X-CSRF-Token", @@ -36992,109 +22397,67 @@ "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "urlAliasId", + "name": "contentTypeGroupId", "in": "path", - "description": "", + "description": "ContentTypeGroupDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - } - }, - "/content/urlwildcards": { - "get": { - "operationId": "ibexa.rest.list_url_wildcards", - "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." + "explode": false } - }, - "summary": "List URL wildcards", - "description": "Returns a list of URL wildcards.", - "parameters": [], - "deprecated": false + ] }, - "post": { - "operationId": "ibexa.rest.create_url_wildcard", + "patch": { + "operationId": "ibexa.rest.update_content_type_group", "tags": [ - "Url Wildcard" + "Type Groups" ], "responses": { - "201": { - "description": "URL wildcard created.", + "200": { + "description": "Content type group updated.", "content": { - "application/vnd.ibexa.api.UrlWildcard+json": { + "application/vnd.ibexa.api.ContentTypeGroup+json": { "schema": { - "$ref": "#/components/schemas/UrlWildcardWrapper" + "$ref": "#/components/schemas/ContentTypeGroupWrapper" }, "example": { - "UrlWildcard": { - "_media-type": "application/vnd.ibexa.api.UrlWildcard+json", - "_href": "/api/ibexa/v2/content/urlwildcards/6", - "_id": 6, - "sourceUrl": "/api/ibexa/v2/content/location/2", - "destinationUrl": "/api/ibexa/v2/content/location/59", - "forward": true + "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.UrlWildcard+xml": { + "application/vnd.ibexa.api.ContentTypeGroup+xml": { "schema": { - "$ref": "#/components/schemas/UrlWildcard" + "$ref": "#/components/schemas/ContentTypeGroup" }, - "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\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" + "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeGroup media-type=\"application/vnd.ibexa.api.ContentTypeGroup+xml\" href=\"/api/ibexa/v2/content/typegroups/1\">\n <id>4</id>\n <identifier>updatedIdentifer</identifier>\n <created>2002-09-05T11:08:48+02:00</created>\n <modified>2019-02-22T14:42:55+01: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" } } }, @@ -37102,14 +22465,17 @@ "description": "Error - The input does not match the input schema definition." }, "401": { - "description": "Error - The user is not authorized to create a URL wildcard." + "description": "Error - The user is not authorized to create this content type group." }, "403": { - "description": "Error - A URL wildcard with the same identifier already exists." + "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": "Create URL wildcard", - "description": "Creates a new URL wildcard.", + "summary": "Update content type group", + "description": "Updates a content type group. PATCH or POST with header X-HTTP-Method-Override PATCH.", "parameters": [ { "name": "X-CSRF-Token", @@ -37117,3109 +22483,2894 @@ "description": "The CSRF Token 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 URL Wildcard input schema encoded in XML or JSON format.", - "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": "ibexa.rest.load_url_wildcard", - "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": "wildcardId", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "delete": { - "operationId": "ibexa.rest.delete_url_wildcard", - "tags": [ - "Url Wildcard" - ], - "responses": { - "204": { - "description": "No Content - URL wildcard deleted." - }, - "401": { - "description": "Error - The user is not authorized to delete a URL wildcard." + "explode": false }, - "404": { - "description": "Error - The URL wildcard does not exist." - } - }, - "summary": "Delete URL wildcard", - "description": "Deletes the given URL wildcard.", - "parameters": [ { - "name": "X-CSRF-Token", + "name": "If-Match", "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "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 + "explode": false }, { - "name": "wildcardId", + "name": "contentTypeGroupId", "in": "path", - "description": "", + "description": "ContentTypeGroupUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], - "deprecated": false + "requestBody": { + "description": "The content type group input schema encoded in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.ContentTypeGroupInput+json": { + "schema": { + "$ref": "#/components/schemas/ContentTypeGroupInputWrapper" + }, + "example": { + "ContentTypeGroupInput": { + "identifier": "updatedIdentifer" + } + } + }, + "application/vnd.ibexa.api.ContentTypeGroupInput+xml": { + "schema": { + "$ref": "#/components/schemas/ContentTypeGroupInput" + }, + "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentTypeGroupInput>\n <identifier>updatedIdentifer</identifier>\n</ContentTypeGroupInput>\n" + } + }, + "required": false + } } }, - "/user/current": { + "/content/typegroups/{contentTypeGroupId}/types": { "get": { - "operationId": "api_usercurrent_get", + "operationId": "ibexa.rest.list_content_types_for_group", "tags": [ - "User" + "Type Groups" ], "responses": { "200": { - "description": "OK - the User with the given ID.", + "description": "OK - returns a list on content types.", "content": { - "application/vnd.ibexa.api.User+json": { + "application/vnd.ibexa.api.ContentTypeInfoList+json": { "schema": { - "$ref": "#/components/schemas/UserListWrapper" + "$ref": "#/components/schemas/ContentTypeInfoListWrapper" }, "example": { - "UserList": { - "_media-type": "application/vnd.ibexa.api.UserList+json", - "_href": "/api/ibexa/v2/user/users", - "User": [ + "ContentTypeList": { + "_media-type": "application/vnd.ibexa.api.ContentTypeList+json", + "_href": "/api/ibexa/v2/content/types", + "ContentType": [ { - "_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/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/4" + "_href": "/api/ibexa/v2/content/types/2/draft" }, - "name": "Jose Vargas", - "Versions": { - "_media-type": "application/vnd.ibexa.api.VersionList+json", - "_href": "/api/ibexa/v2/content/objects/79/versions" + "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": [] + } + ] + } + }, + { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/50", + "id": 50, + "status": "DEFINED", + "identifier": "copy_of_article_50", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Article" + } + ] }, - "Section": { - "_media-type": "application/vnd.ibexa.api.Section+json", - "_href": "/api/ibexa/v2/content/sections/2" + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] }, - "MainLocation": { - "_media-type": "application/vnd.ibexa.api.Location+json", - "_href": "/api/ibexa/v2/content/locations/1/5/12/79" + "creationDate": "2021-07-14T10:30:00+00:00", + "modificationDate": "2021-07-14T10:30:00+00:00", + "Creator": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" }, - "Locations": { - "_media-type": "application/vnd.ibexa.api.LocationList+json", - "_href": "/api/ibexa/v2/content/objects/79/locations" + "Modifier": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { - "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", - "_href": "/api/ibexa/v2/user/users/79/groups" + "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", + "_href": "/api/ibexa/v2/content/types/50/groups" }, - "Owner": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/10" + "Draft": { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/50/draft" }, - "publishDate": "2021-06-29T08:23:42+00:00", - "lastModificationDate": "2021-06-29T08:23:42+00:00", + "remoteId": "fc9434492469d136ffe13377bfdcbb28", + "urlAliasSchema": "", + "nameSchema": "<short_title|title>", + "isContainer": true, "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" + "defaultAlwaysAvailable": false, + "defaultSortField": "PATH", + "defaultSortOrder": "ASC", + "FieldDefinitions": { + "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", + "_href": "/api/ibexa/v2/content/types/50/fieldDefinitions", + "FieldDefinition": [ + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/50/fieldDefinitions/197", + "id": 197, + "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 } - ] + } }, - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Jose Vargas" + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/50/fieldDefinitions/198", + "id": 198, + "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/50/fieldDefinitions/199", + "id": 199, + "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/50/fieldDefinitions/200", + "id": 200, + "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/50/fieldDefinitions/201", + "id": 201, + "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": [] }, - "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" + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/50/fieldDefinitions/202", + "id": 202, + "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" + } + ] }, - { - "id": 343, - "fieldDefinitionIdentifier": "last_name", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_string", - "fieldValue": "Vargas" + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] }, - { - "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 - } + "fieldSettings": [], + "validatorConfiguration": [] + }, + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/50/fieldDefinitions/203", + "id": 203, + "identifier": "image", + "fieldType": "ibexa_image_asset", + "fieldGroup": "content", + "position": 7, + "isTranslatable": false, + "isRequired": false, + "isInfoCollector": false, + "defaultValue": { + "destinationContentId": null, + "alternativeText": null, + "source": null }, - { - "id": 345, - "fieldDefinitionIdentifier": "signature", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_text", - "fieldValue": null + "isSearchable": false, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Image" + } + ] }, - { - "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" + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] + }, + "fieldSettings": [], + "validatorConfiguration": [] + } + ] } - } - ] - } - } - }, - "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" + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/44", + "id": 44, + "status": "DEFINED", + "identifier": "dog_breed", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Dog Breed" + } + ] }, - "Section": { - "_media-type": "application/vnd.ibexa.api.Section+json", - "_href": "/api/ibexa/v2/content/sections/2" + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] }, - "MainLocation": { - "_media-type": "application/vnd.ibexa.api.Location+json", - "_href": "/api/ibexa/v2/content/locations/1/5/12/79" + "creationDate": "2021-06-28T11:28:00+00:00", + "modificationDate": "2021-06-28T11:29:02+00:00", + "Creator": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" }, - "Locations": { - "_media-type": "application/vnd.ibexa.api.LocationList+json", - "_href": "/api/ibexa/v2/content/objects/79/locations" + "Modifier": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { - "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", - "_href": "/api/ibexa/v2/user/users/79/groups" + "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", + "_href": "/api/ibexa/v2/content/types/44/groups" }, - "Owner": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/10" + "Draft": { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/44/draft" }, - "publishDate": "2021-06-29T08:23:42+00:00", - "lastModificationDate": "2021-06-29T08:23:42+00:00", + "remoteId": "b348c95f7c573d4d502d6b59f80e618a", + "urlAliasSchema": "", + "nameSchema": "<name>", + "isContainer": false, "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" + "defaultAlwaysAvailable": true, + "defaultSortField": "PUBLISHED", + "defaultSortOrder": "DESC", + "FieldDefinitions": { + "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", + "_href": "/api/ibexa/v2/content/types/44/fieldDefinitions", + "FieldDefinition": [ + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/44/fieldDefinitions/190", + "id": 190, + "identifier": "name", + "fieldType": "ibexa_string", + "fieldGroup": "content", + "position": 1, + "isTranslatable": true, + "isRequired": false, + "isInfoCollector": false, + "defaultValue": null, + "isSearchable": true, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Name" + } + ] }, - { - "id": 343, - "fieldDefinitionIdentifier": "last_name", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_string", - "fieldValue": "Vargas" + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] }, - { - "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 + "fieldSettings": [], + "validatorConfiguration": { + "StringLengthValidator": { + "maxStringLength": null, + "minStringLength": 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.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/44/fieldDefinitions/191", + "id": 191, + "identifier": "photo", + "fieldType": "ibexa_image_asset", + "fieldGroup": "content", + "position": 2, + "isTranslatable": true, + "isRequired": false, + "isInfoCollector": false, + "defaultValue": { + "destinationContentId": null, + "alternativeText": null, + "source": null + }, + "isSearchable": true, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Photo" + } + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] + }, + "fieldSettings": [], + "validatorConfiguration": [] + }, + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/44/fieldDefinitions/192", + "id": 192, + "identifier": "description", + "fieldType": "ibexa_richtext", + "fieldGroup": "content", + "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": "Full Description" + } + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] + }, + "fieldSettings": [], + "validatorConfiguration": [] + } + ] + } + }, { - "_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" + "_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" + } + ] }, - "Section": { - "_media-type": "application/vnd.ibexa.api.Section+json", - "_href": "/api/ibexa/v2/content/sections/2" + "descriptions": { + "value": [] }, - "MainLocation": { - "_media-type": "application/vnd.ibexa.api.Location+json", - "_href": "/api/ibexa/v2/content/locations/1/5/12/79" + "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" }, - "Locations": { - "_media-type": "application/vnd.ibexa.api.LocationList+json", - "_href": "/api/ibexa/v2/content/objects/79/locations" + "Modifier": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" }, "Groups": { - "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", - "_href": "/api/ibexa/v2/user/users/79/groups" + "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", + "_href": "/api/ibexa/v2/content/types/1/groups" }, - "Owner": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/10" + "Draft": { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/1/draft" }, - "publishDate": "2021-06-29T08:23:42+00:00", - "lastModificationDate": "2021-06-29T08:23:42+00:00", + "remoteId": "a3d405b81be900468eb153d774f4f0d2", + "urlAliasSchema": null, + "nameSchema": "<short_name|name>", + "isContainer": true, "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" + "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 } - ] + } }, - "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" + { + "_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" + } + ] }, - { - "id": 343, - "fieldDefinitionIdentifier": "last_name", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_string", - "fieldValue": "Vargas" + "descriptions": { + "value": [] }, - { - "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 + "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" }, - { - "id": 345, - "fieldDefinitionIdentifier": "signature", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_text", - "fieldValue": null + "isSearchable": true, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Short description" + } + ] }, - { - "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": [ + "descriptions": { + "value": [] + }, + "fieldSettings": [], + "validatorConfiguration": [] + }, { - "languageCode": "eng-GB" + "_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": "Jose Vargas" + "#text": "Form" } ] }, - "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 + "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": [] } - }, - { - "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": "ibexa.rest.load_role_assignments_for_user", - "tags": [ - "User" - ], - "responses": { - "200": { - "description": "If set, the Role assignment list is returned in XML or JSON format.", - "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/115/roles", - "RoleAssignment": [ + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/45", + "id": 45, + "status": "DEFINED", + "identifier": "tip", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Tip" + } + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] + }, + "creationDate": "2021-06-28T11:29:19+00:00", + "modificationDate": "2021-07-26T09:33: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" + }, + "Groups": { + "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", + "_href": "/api/ibexa/v2/content/types/45/groups" + }, + "Draft": { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/45/draft" + }, + "remoteId": "e6490e8a785edacd48629f2022be3125", + "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/45/fieldDefinitions", + "FieldDefinition": [ + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/45/fieldDefinitions/193", + "id": 193, + "identifier": "title", + "fieldType": "ibexa_string", + "fieldGroup": "content", + "position": 1, + "isTranslatable": true, + "isRequired": false, + "isInfoCollector": false, + "defaultValue": null, + "isSearchable": true, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Title" + } + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] + }, + "fieldSettings": [], + "validatorConfiguration": { + "StringLengthValidator": { + "maxStringLength": null, + "minStringLength": null + } + } + }, + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/45/fieldDefinitions/194", + "id": 194, + "identifier": "body", + "fieldType": "ibexa_text", + "fieldGroup": "content", + "position": 2, + "isTranslatable": true, + "isRequired": false, + "isInfoCollector": false, + "defaultValue": null, + "isSearchable": true, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Body" + } + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] + }, + "fieldSettings": { + "textRows": 10 + }, + "validatorConfiguration": [] + }, + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/45/fieldDefinitions/204", + "id": 204, + "identifier": "richtext", + "fieldType": "ibexa_richtext", + "fieldGroup": "content", + "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": "richtext" + } + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": null + } + ] + }, + "fieldSettings": [], + "validatorConfiguration": [] + } + ] + } + }, { - "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", - "_href": "/api/ibexa/v2/user/users/115/roles/2", - "limitation": { - "_identifier": "Section", - "values": { - "ref": [ - { - "_media-type": "application/vnd.ibexa.api.ref+json", - "_href": "1" + "_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": [] + } + ] + } + }, + { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/4", + "id": 4, + "status": "DEFINED", + "identifier": "user", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "User" + } + ] + }, + "descriptions": { + "value": [] + }, + "creationDate": "2002-06-18T09:21:38+00:00", + "modificationDate": "2004-04-15T08:39: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/4/groups" + }, + "Draft": { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/4/draft" + }, + "remoteId": "40faa822edc579b02c25f6bb7beec3ad", + "urlAliasSchema": null, + "nameSchema": "<first_name> <last_name>", + "isContainer": false, + "mainLanguageCode": "eng-GB", + "defaultAlwaysAvailable": true, + "defaultSortField": "PATH", + "defaultSortOrder": "ASC", + "FieldDefinitions": { + "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", + "_href": "/api/ibexa/v2/content/types/4/fieldDefinitions", + "FieldDefinition": [ + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/4/fieldDefinitions/8", + "id": 8, + "identifier": "first_name", + "fieldType": "ibexa_string", + "fieldGroup": "", + "position": 1, + "isTranslatable": true, + "isRequired": true, + "isInfoCollector": false, + "defaultValue": null, + "isSearchable": true, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "First name" + } + ] + }, + "descriptions": { + "value": [] + }, + "fieldSettings": [], + "validatorConfiguration": { + "StringLengthValidator": { + "maxStringLength": 255, + "minStringLength": null + } + } + }, + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/4/fieldDefinitions/9", + "id": 9, + "identifier": "last_name", + "fieldType": "ibexa_string", + "fieldGroup": "", + "position": 2, + "isTranslatable": true, + "isRequired": true, + "isInfoCollector": false, + "defaultValue": null, + "isSearchable": true, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Last name" + } + ] + }, + "descriptions": { + "value": [] + }, + "fieldSettings": [], + "validatorConfiguration": { + "StringLengthValidator": { + "maxStringLength": 255, + "minStringLength": null + } } - ] - } - }, - "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</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": "userId", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "post": { - "operationId": "ibexa.rest.assign_role_to_user", - "tags": [ - "User" - ], - "responses": { - "200": { - "description": "If set, the updated Role assignment list is returned in XML or JSON format.", - "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/115/roles", - "RoleAssignment": [ - { - "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", - "_href": "/api/ibexa/v2/user/users/115/roles/2", - "limitation": { - "_identifier": "Section", - "values": { - "ref": [ - { - "_media-type": "application/vnd.ibexa.api.ref+json", - "_href": "2" + }, + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/4/fieldDefinitions/12", + "id": 12, + "identifier": "user_account", + "fieldType": "ibexa_user", + "fieldGroup": "", + "position": 3, + "isTranslatable": false, + "isRequired": true, + "isInfoCollector": false, + "defaultValue": null, + "isSearchable": false, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "User account" + } + ] + }, + "descriptions": { + "value": [] + }, + "fieldSettings": { + "PasswordTTL": 0, + "PasswordTTLWarning": 0, + "RequireUniqueEmail": false, + "UsernamePattern": "^[^@]+$" + }, + "validatorConfiguration": { + "PasswordValueValidator": { + "requireAtLeastOneUpperCaseCharacter": true, + "requireAtLeastOneLowerCaseCharacter": true, + "requireAtLeastOneNumericCharacter": true, + "requireAtLeastOneNonAlphanumericCharacter": false, + "requireNewPassword": false, + "minLength": 10 + } } - ] - } - }, - "Role": { - "_media-type": "application/vnd.ibexa.api.Role+json", - "_href": "/api/ibexa/v2/user/roles/2" + }, + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/4/fieldDefinitions/179", + "id": 179, + "identifier": "signature", + "fieldType": "ibexa_text", + "fieldGroup": "", + "position": 4, + "isTranslatable": true, + "isRequired": false, + "isInfoCollector": false, + "defaultValue": null, + "isSearchable": true, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Signature" + } + ] + }, + "descriptions": { + "value": [] + }, + "fieldSettings": { + "textRows": 10 + }, + "validatorConfiguration": [] + }, + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/4/fieldDefinitions/180", + "id": 180, + "identifier": "image", + "fieldType": "ibexa_image", + "fieldGroup": "", + "position": 5, + "isTranslatable": true, + "isRequired": false, + "isInfoCollector": false, + "defaultValue": null, + "isSearchable": false, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Image" + } + ] + }, + "descriptions": { + "value": [] + }, + "fieldSettings": [], + "validatorConfiguration": { + "FileSizeValidator": { + "maxFileSize": 10 + } + } + } + ] } }, { - "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", - "_href": "/api/ibexa/v2/user/users/115/roles/2", - "limitation": { - "_identifier": "Section", - "values": { - "ref": [ - { - "_media-type": "application/vnd.ibexa.api.ref+json", - "_href": "1" - } - ] - } + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/3", + "id": 3, + "status": "DEFINED", + "identifier": "user_group", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "User group" + } + ] }, - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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 RoleAssignInput schema encoded in XML or JSON format.", - "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" + "descriptions": { + "value": [] }, - { - "_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": "ibexa.rest.load_role_assignment_for_user", - "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": "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": "ibexa.rest.unassign_role_from_user", - "tags": [ - "User" - ], - "responses": { - "200": { - "description": "If set, the updated Role assignment list is returned in XML or JSON format.", - "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" + "creationDate": "2002-06-18T09:21:38+00:00", + "modificationDate": "2003-03-24T08:32:23+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/3/groups" + }, + "Draft": { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/3/draft" + }, + "remoteId": "25b4268cdcd01921b808a0d854b877ef", + "urlAliasSchema": null, + "nameSchema": "<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/3/fieldDefinitions", + "FieldDefinition": [ + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/3/fieldDefinitions/6", + "id": 6, + "identifier": "name", + "fieldType": "ibexa_string", + "fieldGroup": "", + "position": 1, + "isTranslatable": true, + "isRequired": true, + "isInfoCollector": false, + "defaultValue": null, + "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/3/fieldDefinitions/7", + "id": 7, + "identifier": "description", + "fieldType": "ibexa_string", + "fieldGroup": "", + "position": 2, + "isTranslatable": true, + "isRequired": false, + "isInfoCollector": false, + "defaultValue": null, + "isSearchable": true, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Description" + } + ] + }, + "descriptions": { + "value": [] + }, + "fieldSettings": [], + "validatorConfiguration": { + "StringLengthValidator": { + "maxStringLength": 255, + "minStringLength": null + } + } + } + ] } }, { - "_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 href=\"/user/groups/1/5/65/roles\" media-type=\"application/vnd.ibexa.api.RoleAssignmentList+xml\">\n <RoleAssignment href=\"/user/groups/1/5/65/roles/5\" media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\">\n <Role href=\"/user/roles/5\" media-type=\"application/vnd.ibexa.api.Role+xml\"/>\n </RoleAssignment>\n <RoleAssignment href=\"/user/groups/1/5/65/roles/11\" media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\">\n <limitation identifier=\"Section\">\n <values>\n <ref href=\"/content/sections/1\" media-type=\"application/vnd.ibexa.api.Section+xml\" />\n <ref href=\"/content/sections/4\" media-type=\"application/vnd.ibexa.api.Section+xml\" />\n </values>\n </limitation>\n <Role href=\"/user/roles/11\" media-type=\"application/vnd.ibexa.api.Role+xml\"/>\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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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": "ibexa.segmentation.rest.user.segments.view", - "tags": [ - "User" - ], - "responses": { - "200": { - "description": "If set, the user's segment list is returned in XML or JSON format.", - "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", - "source": "ibexa", - "lastUpdatedBy": "14", - "updatedAt": "2026-06-30T12:00:00+00:00", - "SegmentGroup": { - "_media-type": "application/vnd.ibexa.api.SegmentGroup+json", - "_href": "/api/ibexa/v2/segment_groups/corporate_accounts" + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/12", + "id": 12, + "status": "DEFINED", + "identifier": "file", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "File" + } + ] }, - "User": { + "descriptions": { + "value": [] + }, + "creationDate": "2003-05-08T09:17:52+00:00", + "modificationDate": "2003-05-08T09:21:09+00:00", + "Creator": { "_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 <source>ibexa</source>\n <lastUpdatedBy>14</lastUpdatedBy>\n <updatedAt>2026-06-30T12:00:00+00:00</updatedAt>\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": "userId", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "post": { - "operationId": "ibexa.segmentation.rest.user.segments.assign", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token. Used for POST, PATCH and DELETE requests.", - "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 UserSegmentAssignInput schema encoded in XML or JSON format.", - "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": "ibexa.segmentation.rest.user.segments.unnassign", - "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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token. Used for POST, PATCH and DELETE requests.", - "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": "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" + "Modifier": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" }, - "Section": { - "_media-type": "application/vnd.ibexa.api.Section+json", - "_href": "/api/ibexa/v2/content/sections/2" + "Groups": { + "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", + "_href": "/api/ibexa/v2/content/types/12/groups" }, - "MainLocation": { - "_media-type": "application/vnd.ibexa.api.Location+json", - "_href": "/api/ibexa/v2/content/locations/1/5/13/15" + "Draft": { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/12/draft" }, - "Locations": { - "_media-type": "application/vnd.ibexa.api.LocationList+json", - "_href": "/api/ibexa/v2/content/objects/14/locations" + "remoteId": "637d58bfddf164627bdfd265733280a0", + "urlAliasSchema": null, + "nameSchema": "<name>", + "isContainer": false, + "mainLanguageCode": "eng-GB", + "defaultAlwaysAvailable": true, + "defaultSortField": "PATH", + "defaultSortOrder": "ASC", + "FieldDefinitions": { + "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", + "_href": "/api/ibexa/v2/content/types/12/fieldDefinitions", + "FieldDefinition": [ + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/12/fieldDefinitions/146", + "id": 146, + "identifier": "name", + "fieldType": "ibexa_string", + "fieldGroup": "", + "position": 1, + "isTranslatable": true, + "isRequired": true, + "isInfoCollector": false, + "defaultValue": "New file", + "isSearchable": true, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Name" + } + ] + }, + "descriptions": { + "value": [] + }, + "fieldSettings": [], + "validatorConfiguration": { + "StringLengthValidator": { + "maxStringLength": null, + "minStringLength": null + } + } + }, + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/12/fieldDefinitions/147", + "id": 147, + "identifier": "description", + "fieldType": "ibexa_richtext", + "fieldGroup": "", + "position": 2, + "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.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/12/fieldDefinitions/148", + "id": 148, + "identifier": "file", + "fieldType": "ibexa_author", + "fieldGroup": "", + "position": 3, + "isTranslatable": true, + "isRequired": true, + "isInfoCollector": false, + "defaultValue": null, + "isSearchable": false, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "File" + } + ] + }, + "descriptions": { + "value": [] + }, + "fieldSettings": [], + "validatorConfiguration": { + "FileSizeValidator": { + "maxFileSize": null + } + } + } + ] + } + }, + { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/5", + "id": 5, + "status": "DEFINED", + "identifier": "image", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Image" + } + ] }, - "Owner": { + "descriptions": { + "value": [] + }, + "creationDate": "2002-09-08T11:36:32+00:00", + "modificationDate": "2003-03-24T08:33:04+00:00", + "Creator": { "_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", + "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/5/groups" + }, + "Draft": { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/5/draft" + }, + "remoteId": "f6df12aa74e36230eb675f364fccd25a", + "urlAliasSchema": null, + "nameSchema": "<name>", + "isContainer": false, "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" + "defaultAlwaysAvailable": true, + "defaultSortField": "PATH", + "defaultSortOrder": "ASC", + "FieldDefinitions": { + "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", + "_href": "/api/ibexa/v2/content/types/5/fieldDefinitions", + "FieldDefinition": [ + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/5/fieldDefinitions/116", + "id": 116, + "identifier": "name", + "fieldType": "ibexa_string", + "fieldGroup": "", + "position": 1, + "isTranslatable": true, + "isRequired": true, + "isInfoCollector": false, + "defaultValue": null, + "isSearchable": true, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Name" + } + ] + }, + "descriptions": { + "value": [] + }, + "fieldSettings": [], + "validatorConfiguration": { + "StringLengthValidator": { + "maxStringLength": 150, + "minStringLength": null } - ] + } }, - "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" + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/5/fieldDefinitions/117", + "id": 117, + "identifier": "caption", + "fieldType": "ibexa_richtext", + "fieldGroup": "", + "position": 2, + "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" }, - { - "id": 29, - "fieldDefinitionIdentifier": "last_name", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_string", - "fieldValue": "User" + "isSearchable": true, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Caption" + } + ] }, - { - "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 - } + "descriptions": { + "value": [] }, - { - "id": 178, - "fieldDefinitionIdentifier": "signature", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_text", - "fieldValue": null + "fieldSettings": [], + "validatorConfiguration": [] + }, + { + "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", + "_href": "/api/ibexa/v2/content/types/5/fieldDefinitions/118", + "id": 118, + "identifier": "image", + "fieldType": "ibexa_image", + "fieldGroup": "", + "position": 3, + "isTranslatable": true, + "isRequired": false, + "isInfoCollector": false, + "defaultValue": null, + "isSearchable": false, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Image" + } + ] }, - { - "id": 180, - "fieldDefinitionIdentifier": "image", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_image", - "fieldValue": null + "descriptions": { + "value": [] + }, + "fieldSettings": [], + "validatorConfiguration": { + "FileSizeValidator": { + "maxFileSize": 10 + } } - ] - }, - "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": { + "application/vnd.ibexa.api.ContentTypeInfoList+xml": { "schema": { - "$ref": "#/components/schemas/UserGroupList" + "$ref": "#/components/schemas/ContentTypeInfoList" }, - "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" + "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.UserGroupRefList+json": { + "application/vnd.ibexa.api.ContentTypeList+json": { "schema": { - "$ref": "#/components/schemas/UserGroupRefListWrapper" + "$ref": "#/components/schemas/ContentTypeListWrapper" }, "example": { - "UserGroupRefList": { - "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", - "_href": "/api/ibexa/v2/user/users/57/groups", - "UserGroup": [ + "ContentTypeList": { + "_media-type": "application/vnd.ibexa.api.ContentTypeList+json", + "_href": "/api/ibexa/v2/content/typegroups/1/types", + "ContentType": [ { - "_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", + "_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" }, - "creationDate": "2021-08-09T09:06:49+00:00", - "initialLanguageCode": "eng-GB", - "languageCodes": "eng-GB", - "VersionTranslationInfo": { - "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", - "Language": [ + "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": [ { - "languageCode": "eng-GB" + "_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": "UserGroup2" + "#text": "Form" } ] }, - "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", + "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" }, - "creationDate": "2021-08-09T09:06:49+00:00", - "initialLanguageCode": "eng-GB", - "languageCodes": "eng-GB", - "VersionTranslationInfo": { - "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", - "Language": [ + "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" + "_languageCode": "eng-GB", + "#text": "Landing page" } ] }, - "names": { + "descriptions": { "value": [ { "_languageCode": "eng-GB", - "#text": "UserGroup2" + "#text": "" } ] }, - "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", + "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" }, - "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" - } - ] + "Modifier": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" }, - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "UserGroup2" - } - ] + "Groups": { + "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", + "_href": "/api/ibexa/v2/content/types/42/groups" }, - "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": "ibexa.rest.load_role_assignments_for_user_group", - "tags": [ - "User Group" - ], - "responses": { - "200": { - "description": "If set, the Role assignment list is returned in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.RoleAssignmentList+json": { - "schema": { - "$ref": "#/components/schemas/RoleAssignmentListWrapper" - }, - "example": { - "RoleAssignment": { - "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", - "_href": "/api/ibexa/v2/user/groups/1/42/44/roles/1", - "Role": { - "_media-type": "application/vnd.ibexa.api.Role+json", - "_href": "/api/ibexa/v2/user/roles/1" - } + "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.RoleAssignmentList+xml": { + "application/vnd.ibexa.api.ContentTypeList+xml": { "schema": { - "$ref": "#/components/schemas/RoleAssignmentList" + "$ref": "#/components/schemas/ContentTypeList" }, - "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RoleAssignment media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\" href=\"/api/ibexa/v2/user/groups/1/42/44/roles/1\">\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/1\"/>\n</RoleAssignment>\n" + "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-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 <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</ContentTypeList>\n" } } }, - "400": { - "description": "Error - the user has no permission to read Roles." + "401": { + "description": "Error - The user has no permission to read the content types." } }, - "summary": "Load Roles for User Group", - "description": "Returns a list of all Roles assigned to the given User Group.", + "summary": "List content types for group", + "description": "Returns a list of content types in the provided group.", "parameters": [ { - "name": "path", + "name": "contentTypeGroupId", "in": "path", - "description": "", + "description": "ContentTypeListForGroupController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] }, "post": { - "operationId": "ibexa.rest.assign_role_to_user_group", + "operationId": "ibexa.rest.create_content_type", "tags": [ - "User Group" + "Type Groups" ], "responses": { - "200": { - "description": "If set, the updated Role assignment list is returned in XML or JSON format.", + "201": { + "description": "Content type created.", "content": { - "application/vnd.ibexa.api.RoleAssignmentList+json": { + "application/vnd.ibexa.api.ContentType+json": { "schema": { - "$ref": "#/components/schemas/RoleAssignmentListWrapper" - }, - "example": { - "RoleAssignmentList": { - "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", - "_href": "/api/ibexa/v2/user/groups/1/12/2/roles", - "RoleAssignment": [ - { - "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", - "_href": "/api/ibexa/v2/user/groups/1/12/2/roles/2", - "Role": { - "_media-type": "application/vnd.ibexa.api.Role+json", - "_href": "/api/ibexa/v2/user/roles/2" - } - } - ] - } + "$ref": "#/components/schemas/ContentTypeWrapper" } }, - "application/vnd.ibexa.api.RoleAssignmentList+xml": { + "application/vnd.ibexa.api.ContentType+xml": { "schema": { - "$ref": "#/components/schemas/RoleAssignmentList" + "$ref": "#/components/schemas/ContentType" }, - "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RoleAssignmentList media-type=\"application/vnd.ibexa.api.RoleAssignmentList+xml\" href=\"/api/ibexa/v2/user/groups/1/5/65/roles\">\n<RoleAssignment media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\" href=\"/api/ibexa/v2/user/groups/1/5/65/roles/3\">\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/3\"/>\n</RoleAssignment>\n<RoleAssignment media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\" href=\"/api/ibexa/v2/user/groups/1/5/65/roles/10\">\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/10\"/>\n</RoleAssignment>\n<RoleAssignment media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\" href=\"/api/ibexa/v2/user/groups/1/5/65/roles/10\">\n <limitation identifier=\"Section\">\n <values>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"4\"/>\n </values>\n </limitation>\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/10\"/>\n</RoleAssignment>\n</RoleAssignmentList>\n" + "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ContentType media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/20/draft\">\n <id>20</id>\n <status>DRAFT</status>\n <identifier>newContentType</identifier>\n <names>\n <value languageCode=\"eng-GB\">New content type</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">This is a description</value>\n </descriptions>\n <creationDate>2019-02-26T09:39:58+01:00</creationDate>\n <modificationDate>2019-02-26T09:39:58+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/20/groups\"/>\n <Draft media-type=\"application/vnd.ibexa.api.ContentType+xml\" href=\"/api/ibexa/v2/content/types/20/draft\"/>\n <remoteId>remoteId-qwert548</remoteId>\n <urlAliasSchema><title></urlAliasSchema>\n <nameSchema><title></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/20/draft/fieldDefinitions\">\n <FieldDefinition media-type=\"application/vnd.ibexa.api.FieldDefinition+xml\" href=\"/api/ibexa/v2/content/types/20/draft/fieldDefinitions/223\">\n <id>223</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>New Title</defaultValue>\n <isSearchable>true</isSearchable>\n <names>\n <value languageCode=\"eng-GB\">Title</value>\n </names>\n <descriptions>\n <value languageCode=\"eng-GB\">This is the title</value>\n </descriptions>\n <fieldSettings/>\n <validatorConfiguration>\n <value key=\"StringLengthValidator\">\n <value key=\"minStringLength\">0</value>\n <value key=\"maxStringLength\"/></value>\n </validatorConfiguration>\n </FieldDefinition>\n </FieldDefinitions>\n</ContentType>\n" } } }, "400": { - "description": "Error - validation of limitation in RoleAssignInput fails." + "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 assign this Role." + "description": "Error - The user is not authorized to create this content type." + }, + "403": { + "description": "Error - A content type with same identifier already exists." } }, - "summary": "Assign Role to User Group", - "description": "Assigns a Role to a User Group.", + "summary": "Create content type", + "description": "Creates a new content type draft in the given content type group.", "parameters": [ { "name": "X-CSRF-Token", @@ -40227,1649 +25378,1465 @@ "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "path", + "name": "contentTypeGroupId", "in": "path", - "description": "", + "description": "ContentTypeCreateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "The RoleAssignInput schema encoded in XML or JSON format.", + "description": "The content type Create schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.RoleAssignInput+json": { + "application/vnd.ibexa.api.ContentTypeCreate+json": { "schema": { - "$ref": "#/components/schemas/RoleAssignInputWrapper" + "$ref": "#/components/schemas/ContentTypeCreateWrapper" }, "example": { - "RoleAssignInput": { - "Role": { - "_href": "/api/ibexa/v2/user/roles/2", - "_media-type": "application/vnd.ibexa.api.RoleAssignInput+json" + "ContentTypeCreate": { + "identifier": "new_content_type", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "New content type" + } + ] }, - "limitation": { - "_identifier": "Section", - "values": { - "ref": [ - { - "_href": "/api/ibexa/v2/content/sections/1", - "_media-type": "application/vnd.ibexa.api.Section+json" - }, - { - "_href": "/api/ibexa/v2/content/sections/4", - "_media-type": "application/vnd.ibexa.api.Section+json" - } - ] - } - } - } - } - }, - "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": "ibexa.rest.load_role_assignment_for_user_group", - "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/groups/1/11/12/roles/1", - "Role": { - "_media-type": "application/vnd.ibexa.api.Role+json", - "_href": "/api/ibexa/v2/user/roles/1" - } - } - } - }, - "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/groups/1/11/12/roles/1\">\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/1\"/>\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": "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": "ibexa.rest.unassign_role_from_user_group", - "tags": [ - "User Group" - ], - "responses": { - "200": { - "description": "If set, the updated Role assignment list is returned in XML or JSON format.", - "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/groups/1/57/58/roles", - "RoleAssignment": [ + "descriptions": { + "value": [ { - "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", - "_href": "/api/ibexa/v2/user/groups/1/57/58/roles/3", - "limitation": { - "_identifier": "Section", - "values": { - "ref": [ - { - "_media-type": "application/vnd.ibexa.api.ref+json", - "_href": "1" - } - ] - } - }, - "Role": { - "_media-type": "application/vnd.ibexa.api.Role+json", - "_href": "/api/ibexa/v2/user/roles/3" - } + "_languageCode": "eng-GB", + "#text": "This is a description" } ] - } - } - }, - "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/groups/1/5/65/roles\">\n<RoleAssignment media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\" href=\"/api/ibexa/v2/user/groups/1/5/65/roles/3\">\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/3\"/>\n</RoleAssignment>\n</RoleAssignmentList>\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": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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": [ + }, + "remoteId": "remoteId-qwerty548", + "urlAliasSchema": "<title>", + "nameSchema": "<title>", + "isContainer": true, + "mainLanguageCode": "eng-GB", + "defaultAlwaysAvailable": true, + "defaultSortField": "PATH", + "defaultSortOrder": "ASC", + "FieldDefinitions": { + "FieldDefinition": [ { - "_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" + "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" + } + ] }, - "Users": { - "_media-type": "application/vnd.ibexa.api.UserList+json", - "_href": "/api/ibexa/v2/user/groups/1/5/13/15/users" + "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" + } + ] }, - "Roles": { - "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", - "_href": "/api/ibexa/v2/user/groups/1/5/13/15/roles" + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "This is the summary" + } + ] } } ] } } + } + }, + "application/vnd.ibexa.api.ContentTypeCreate+xml": { + "schema": { + "$ref": "#/components/schemas/ContentTypeCreate" }, - "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": { + "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 + } + } + }, + "/content/urlaliases": { + "get": { + "operationId": "ibexa.rest.list_global_url_aliases", + "tags": [ + "Url Alias" + ], + "responses": { + "200": { + "description": "OK - returns the list of URL aliases.", + "content": { + "application/vnd.ibexa.api.UrlAliasRefList+json": { "schema": { - "$ref": "#/components/schemas/UserGroupRefListWrapper" + "$ref": "#/components/schemas/UrlAliasRefListWrapper" }, "example": { - "UserGroupRefList": { - "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", - "_href": "/api/ibexa/v2/user/users/57/groups", - "UserGroup": [ + "UrlAliasRefList": { + "_media-type": "application/vnd.ibexa.api.UrlAliasRefList+json", + "_href": "/api/ibexa/v2/content/urlaliases", + "UrlAlias": [ { - "_media-type": "application/vnd.ibexa.api.UserGroup+json", - "_href": "/api/ibexa/v2/user/groups/1/5/13" + "_media-type": "application/vnd.ibexa.api.UrlAlias+json", + "_href": "/api/ibexa/v2/content/urlaliases/0-2cecdff5f90b8595d76b68c417b09f36" } ] } } }, - "application/vnd.ibexa.api.UserGroupRefList+xml": { + "application/vnd.ibexa.api.UrlAliasRefList+xml": { "schema": { - "$ref": "#/components/schemas/UserGroupRefList" + "$ref": "#/components/schemas/UrlAliasRefList" }, - "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" + "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 User Groups." + "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": [] + }, + "post": { + "operationId": "ibexa.rest.create_url_alias", + "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-f530173ad554787c1fe30dc929d98360", + "_id": "0-f530173ad554787c1fe30dc929d98360", + "_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-deca3dadca45c3dff7861274b8e67ed7\" id=\"0-deca3dadca45c3dff7861274b8e67ed7\" type=\"LOCATION\">\n <location media-type=\"application/vnd.ibexa.api.Location+xml\" href=\"/api/ibexa/v2/content/locations/59\"/>\n <path>/example-urlalias</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" + } + } }, - "404": { - "description": "Error - the User Group does not exist." + "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": "Load subgroups", - "description": "Returns a list of the subgroups.", + "summary": "Create URL alias", + "description": "Creates a URL alias.", "parameters": [ { - "name": "Accept", + "name": "X-CSRF-Token", "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": "", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], - "deprecated": false - }, - "post": { - "operationId": "api_usergroups_pathsubgroups_post", + "requestBody": { + "description": "The URL alias input schema encoded in XML or JSON format.", + "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 + } + } + }, + "/content/urlaliases/{urlAliasId}": { + "get": { + "operationId": "ibexa.rest.load_url_alias", "tags": [ - "User Group" + "Url Alias" ], "responses": { - "201": { - "description": "201", + "200": { + "description": "OK - returns the URL alias.", "content": { - "application/vnd.ibexa.api.UserGroup+json": { + "application/vnd.ibexa.api.UrlAlias+json": { "schema": { - "$ref": "#/components/schemas/UserGroupWrapper" + "$ref": "#/components/schemas/UrlAliasWrapper" }, "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", + "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, - "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" - } + "isHistory": false, + "forward": true, + "custom": true } } }, - "application/vnd.ibexa.api.UserGroup+xml": { + "application/vnd.ibexa.api.UrlAlias+xml": { "schema": { - "$ref": "#/components/schemas/UserGroup" + "$ref": "#/components/schemas/UrlAlias" }, - "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" + "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 this User Group." + "description": "Error - The user is not authorized to read URL aliases." + }, + "404": { + "description": "Error - The URL alias does not exist." } }, - "summary": "Create User Group", - "description": "Creates a new User Group under the given parent. To create a top level group use '/user/groups/subgroups'.", + "summary": "Get URL alias", + "description": "Returns the URL alias with the given ID.", "parameters": [ { - "name": "Accept", - "in": "header", - "description": "If set, the new User Group is returned in XML or JSON format.", + "name": "urlAliasId", + "in": "path", + "description": "URLAliasLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + } + ] + }, + "delete": { + "operationId": "ibexa.rest.delete_url_alias", + "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": "Content-Type", + "name": "X-CSRF-Token", "in": "header", - "description": "The UserGroupCreate schema encoded in XML or JSON format.", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "path", + "name": "urlAliasId", "in": "path", - "description": "", + "description": "URLAliasDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } + ] + } + }, + "/content/urlwildcards": { + "get": { + "operationId": "ibexa.rest.list_url_wildcards", + "tags": [ + "Url Wildcard" ], - "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" - }, + "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": [ { - "fieldDefinitionIdentifier": "description", - "languageCode": "eng-GB", - "fieldValue": "This is the description of the user group" + "_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.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>" + "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" + } } }, - "required": false + "401": { + "description": "Error - The user has no permission to read URL wildcards." + } }, - "deprecated": false - } - }, - "/user/groups/{path}/users": { - "get": { - "operationId": "api_usergroups_pathusers_get", + "summary": "List URL wildcards", + "description": "Returns a list of URL wildcards.", + "parameters": [] + }, + "post": { + "operationId": "ibexa.rest.create_url_wildcard", "tags": [ - "User Group" + "Url Wildcard" ], "responses": { - "200": { - "description": "OK - the Users of the Group with the given ID.", + "201": { + "description": "URL wildcard created.", "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": { + "application/vnd.ibexa.api.UrlWildcard+json": { "schema": { - "$ref": "#/components/schemas/UserRefListWrapper" + "$ref": "#/components/schemas/UrlWildcardWrapper" }, "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" - } - ] + "UrlWildcard": { + "_media-type": "application/vnd.ibexa.api.UrlWildcard+json", + "_href": "/api/ibexa/v2/content/urlwildcards/6", + "_id": 6, + "sourceUrl": "/api/ibexa/v2/content/location/2", + "destinationUrl": "/api/ibexa/v2/content/location/59", + "forward": true } } }, - "application/vnd.ibexa.api.UserRefList+xml": { + "application/vnd.ibexa.api.UrlWildcard+xml": { "schema": { - "$ref": "#/components/schemas/UserRefList" + "$ref": "#/components/schemas/UrlWildcard" }, - "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" + "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\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" } } }, + "400": { + "description": "Error - The input does not match the input schema definition." + }, "401": { - "description": "Error - the user has no permission to read User Groups." + "description": "Error - The user is not authorized to create a URL wildcard." }, - "404": { - "description": "Error - the User Group does not exist." + "403": { + "description": "Error - A URL wildcard with the same identifier already exists." } }, - "summary": "Load Users of Group", - "description": "Loads the Users of the Group with the given ID.", + "summary": "Create URL wildcard", + "description": "Creates a new URL wildcard.", "parameters": [ { - "name": "Accept", + "name": "X-CSRF-Token", "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": "", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], - "deprecated": false - }, - "post": { - "operationId": "api_usergroups_pathusers_post", + "requestBody": { + "description": "The URL Wildcard input schema encoded in XML or JSON format.", + "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 + } + } + }, + "/content/urlwildcards/{wildcardId}": { + "get": { + "operationId": "ibexa.rest.load_url_wildcard", "tags": [ - "User Group" + "Url Wildcard" ], "responses": { - "201": { - "description": "201", + "200": { + "description": "OK - returns the URL wildcard.", "content": { - "application/vnd.ibexa.api.User+json": { + "application/vnd.ibexa.api.UrlWildcard+json": { "schema": { - "$ref": "#/components/schemas/UserWrapper" + "$ref": "#/components/schemas/UrlWildcardWrapper" }, "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" - } + "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.User+xml": { + "application/vnd.ibexa.api.UrlWildcard+xml": { "schema": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UrlWildcard" }, - "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" + "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 this User." - }, - "403": { - "description": "Error - a User with the same login already exists." + "description": "Error - The user is not authorized to read URL wildcards." }, "404": { - "description": "Error - the Group with the given ID does not exist." + "description": "Error - The URL wildcard does not exist." } }, - "summary": "Create User", - "description": "Creates a new User in the given Group.", + "summary": "Get URL wildcard", + "description": "Returns the URL wildcard with the given ID.", "parameters": [ { - "name": "Accept", - "in": "header", - "description": "If set, the new User is returned in XML or JSON format.", + "name": "wildcardId", + "in": "path", + "description": "URLWildcardLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + } + ] + }, + "delete": { + "operationId": "ibexa.rest.delete_url_wildcard", + "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": "Content-Type", + "name": "X-CSRF-Token", "in": "header", - "description": "The UserCreate schema encoded in XML or JSON format.", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "path", + "name": "wildcardId", "in": "path", - "description": "", + "description": "URLWildcardDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": 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": { + "/user/current": { "get": { - "operationId": "ibexa.rest.list_policies_for_user", + "operationId": "api_usercurrent_get", "tags": [ - "User Policy" + "User" ], "responses": { "200": { - "description": "OK - Policies which are applied to a given User.", + "description": "OK - the User with the given ID.", "content": { - "application/vnd.ibexa.api.PolicyList+json": { + "application/vnd.ibexa.api.User+json": { "schema": { - "$ref": "#/components/schemas/PolicyListWrapper" + "$ref": "#/components/schemas/UserListWrapper" }, "example": { - "PolicyList": { - "_media-type": "application/vnd.ibexa.api.PolicyList+json", - "_href": "/api/ibexa/v2/user/policies", - "Policy": [ - { - "_media-type": "application/vnd.ibexa.api.Policy+json", - "_href": "/api/ibexa/v2/user/roles/1/policies/349", - "id": 349, - "module": "content", - "function": "read", - "limitations": { - "limitation": [ - { - "_identifier": "Section", - "values": { - "ref": [ - { - "_media-type": "application/vnd.ibexa.api.ref+json", - "_href": "1" - }, - { - "_media-type": "application/vnd.ibexa.api.ref+json", - "_href": "3" - }, - { - "_media-type": "application/vnd.ibexa.api.ref+json", - "_href": "6" - } - ] - } - } - ] - } - }, + "UserList": { + "_media-type": "application/vnd.ibexa.api.UserList+json", + "_href": "/api/ibexa/v2/user/users", + "User": [ { - "_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.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" } - ] - } - }, - { - "_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" - } - ] + }, + "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" } - }, - { - "_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": { + "application/vnd.ibexa.api.User+xml": { "schema": { - "$ref": "#/components/schemas/PolicyList" + "$ref": "#/components/schemas/UserList" }, - "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<PolicyList media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/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" + "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 Roles." + "description": "Error - the user has no permission to read Users. For example, Anonymous user can't load oneself." } }, - "summary": "List Policies for User", - "description": "Search all Policies which are applied to a given User.", - "parameters": [], - "deprecated": false + "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, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] } }, - "/user/roles": { + "/user/users": { "get": { - "operationId": "ibexa.rest.list_roles", + "operationId": "api_userusers_get", "tags": [ - "User Role" + "User" ], "responses": { "200": { - "description": "OK - list of all Roles.", + "description": "OK - Loads Users either for a given remote ID or Role.", "content": { - "application/vnd.ibexa.api.RoleList+json": { + "application/vnd.ibexa.api.UserList+json": { "schema": { - "$ref": "#/components/schemas/RoleListWrapper" + "$ref": "#/components/schemas/UserListWrapper" }, "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" - } - }, + "UserList": { + "_media-type": "application/vnd.ibexa.api.UserList+json", + "_href": "/api/ibexa/v2/user/users", + "User": [ { - "_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" + "_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.RoleList+xml": { + "application/vnd.ibexa.api.UserList+xml": { "schema": { - "$ref": "#/components/schemas/RoleList" + "$ref": "#/components/schemas/UserList" }, - "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": [], - "deprecated": false - }, - "post": { - "operationId": "ibexa.rest.create_role", - "tags": [ - "User Role" - ], - "responses": { - "201": { - "description": "If set, the new user is returned in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.Role+json": { + "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/RoleWrapper" - }, - "example": { - "Role": { - "_media-type": "application/vnd.ibexa.api.Role+json", - "_href": "/api/ibexa/v2/user/roles/21", - "identifier": "NewRole", - "Policies": { - "_media-type": "application/vnd.ibexa.api.PolicyList+json", - "_href": "/api/ibexa/v2/user/roles/21/policies" - } - } + "$ref": "#/components/schemas/UserRefListWrapper" } }, - "application/vnd.ibexa.api.Role+xml": { + "application/vnd.ibexa.api.UserRefList+xml": { "schema": { - "$ref": "#/components/schemas/Role" + "$ref": "#/components/schemas/UserRefList" }, - "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/19\">\n <identifier>NewRole</identifier>\n <Policies media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/19/policies\"/>\n</Role>\n" + "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" } } }, - "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." + "404": { + "description": "If there are no visible Users matching the filter." } }, - "summary": "Create Role or Role draft", - "description": "Creates a new Role or Role draft.", + "summary": "List Users", + "description": "Load Users either for a given remote ID or Role.", "parameters": [ { - "name": "X-CSRF-Token", + "name": "Accept", "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "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 + "explode": false } + ] + }, + "head": { + "operationId": "api_userusers_head", + "tags": [ + "User" ], - "requestBody": { - "description": "The RoleInput schema encoded in XML or JSON.", - "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>" - } + "responses": { + "200": { + "description": "OK - verifies if there are Users matching the given filter." }, - "required": false + "404": { + "description": "Error - there are no visible Users matching the filter." + } }, - "deprecated": false + "summary": "Verify Users", + "description": "Verifies if there are Users matching given filter.", + "parameters": [] } }, - "/user/roles/{id}": { + "/user/users/{userId}": { "get": { - "operationId": "ibexa.rest.load_role", + "operationId": "api_userusers_userId_get", "tags": [ - "User Role" + "User" ], "responses": { "200": { - "description": "OK - Role for the given ID.", + "description": "OK - the User with the given ID.", "content": { - "application/vnd.ibexa.api.Role+json": { + "application/vnd.ibexa.api.User+json": { "schema": { - "$ref": "#/components/schemas/RoleWrapper" + "$ref": "#/components/schemas/UserListWrapper" }, "example": { - "Role": { - "_media-type": "application/vnd.ibexa.api.Role+json", - "_href": "/api/ibexa/v2/user/roles/21", - "identifier": "NewRole", - "Policies": { - "_media-type": "application/vnd.ibexa.api.PolicyList+json", - "_href": "/api/ibexa/v2/user/roles/21/policies" - } + "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.Role+xml": { + "application/vnd.ibexa.api.User+xml": { "schema": { - "$ref": "#/components/schemas/Role" + "$ref": "#/components/schemas/UserList" }, - "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/21\">\n <identifier>NewRole</identifier>\n <Policies media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/21/policies\"/>\n</Role>\n" + "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 Roles." + "description": "Error - the user has no permission to read Users." }, "404": { - "description": "Error - the Role does not exist." + "description": "Error - the User does not exist." } }, - "summary": "Load Role", - "description": "Loads a Role for the given ID.", + "summary": "Load User", + "description": "Loads User with the given ID.", "parameters": [ { - "name": "If-None-Match", + "name": "Accept", "in": "header", - "description": "ETag", - "required": false, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "id", - "in": "path", - "description": "", + "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 - }, - "post": { - "operationId": "ibexa.rest.create_role_draft", - "tags": [ - "User Role" - ], - "responses": { - "201": { - "description": "If set, the new user is returned in XML or JSON format.", - "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": "Editor", - "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" - } - } + "explode": false }, - "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": "X-CSRF-Token", + "name": "If-None-Match", "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "description": "ETag", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "id", + "name": "userId", "in": "path", - "description": "", + "description": "UserLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "requestBody": { - "description": "No payload required", - "content": [], - "required": false - }, - "deprecated": false + ] }, "delete": { - "operationId": "ibexa.rest.delete_role", + "operationId": "api_userusers_userId_delete", "tags": [ - "User Role" + "User" ], "responses": { "204": { "description": "No Content." }, "401": { - "description": "Error - the User is not authorized to delete this Role." + "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 Role", - "description": "The given Role and all assignments to Users or User Groups are deleted.", + "summary": "Delete User", + "description": "Deletes the given User.", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "id", + "name": "userId", "in": "path", - "description": "", + "description": "UserDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] }, "patch": { - "operationId": "ibexa.rest.update_role", + "operationId": "api_userusers_userId_patch", "tags": [ - "User Role" + "User" ], "responses": { "200": { - "description": "OK - Role updated", + "description": "OK - User updated.", "content": { - "application/vnd.ibexa.api.Role+json": { + "application/vnd.ibexa.api.User+json": { "schema": { - "$ref": "#/components/schemas/RoleWrapper" + "$ref": "#/components/schemas/UserWrapper" }, "example": { - "Role": { - "_media-type": "application/vnd.ibexa.api.Role+json", - "_href": "/api/ibexa/v2/user/roles/21", - "identifier": "NewIdentifier", - "Policies": { - "_media-type": "application/vnd.ibexa.api.PolicyList+json", - "_href": "/api/ibexa/v2/user/roles/21/policies" + "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.Role+xml": { + "application/vnd.ibexa.api.User+xml": { "schema": { - "$ref": "#/components/schemas/Role" + "$ref": "#/components/schemas/User" }, - "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/5\">\n <identifier>NewIdentifier</identifier>\n <Policies media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/5/policies\"/>\n</Role>\n" + "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" } } }, @@ -41877,583 +26844,733 @@ "description": "Error - the input does not match the input schema definition." }, "401": { - "description": "Error - the user is not authorized to update the Role." + "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 Role", - "description": "Updates a Role. PATCH or POST with header X-HTTP-Method-Override PATCH", + "summary": "Update User", + "description": "Updates a User.", "parameters": [ { - "name": "X-CSRF-Token", + "name": "Accept", "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "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 + "explode": false + }, + { + "name": "Content-Type", + "in": "header", + "description": "The UserUpdate schema encoded in XML or JSON format.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": 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.", + "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 + "explode": false }, { - "name": "id", + "name": "userId", "in": "path", - "description": "", + "description": "UserUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "The RoleInput schema encoded in XML or JSON format.", + "description": "The updated UserUpdateController resource", "content": { - "application/vnd.ibexa.api.RoleInput+json": { + "application/vnd.ibexa.api.UserUpdate+json": { "schema": { - "$ref": "#/components/schemas/RoleInputWrapper" + "$ref": "#/components/schemas/UserUpdateWrapper" }, "example": { - "RoleInput": { - "identifier": "NewIdentifier" + "UserUpdate": { + "login": "josevargas", + "enabled": false } } }, - "application/vnd.ibexa.api.RoleInput+xml": { + "application/vnd.ibexa.api.UserUpdate+xml": { "schema": { - "$ref": "#/components/schemas/RoleInput" + "$ref": "#/components/schemas/UserUpdate" }, - "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RoleInput>\n <identifier>NewIdentifier</identifier>\n</RoleInput>\n" + "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserUpdate>\n <login>josevargas</login>\n <enabled>false</enabled>\n</UserUpdate>\n" } }, "required": 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." + } }, - "deprecated": false + "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, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "userId", + "in": "path", + "description": "UserDraftListController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] } }, - "/user/roles/{id}/draft": { + "/user/users/{userId}/groups": { "get": { - "operationId": "ibexa.rest.load_role_draft", + "operationId": "api_userusers_userIdgroups_get", "tags": [ - "User Role" + "User" ], "responses": { "200": { - "description": "OK - Role draft by original Role ID.", + "description": "OK - list of the User Groups the User belongs to.", "content": { - "application/vnd.ibexa.api.Role+json": { + "application/vnd.ibexa.api.UserGroupRefList+json": { "schema": { - "$ref": "#/components/schemas/RoleWrapper" + "$ref": "#/components/schemas/UserGroupRefListWrapper" }, "example": { - "Role": { - "_media-type": "application/vnd.ibexa.api.Role+json", - "_href": "/api/ibexa/v2/user/roles/27", - "identifier": "Anonymous", - "Policies": { - "_media-type": "application/vnd.ibexa.api.PolicyList+json", - "_href": "/api/ibexa/v2/user/roles/27/policies" - } + "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.Role+xml": { + "application/vnd.ibexa.api.UserGroupRefList+xml": { "schema": { - "$ref": "#/components/schemas/Role" + "$ref": "#/components/schemas/UserGroupRefList" }, - "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/27\">\n <identifier>Anonymous</identifier>\n <Policies media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/27/policies\"/>\n</Role>\n" + "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 Roles." + "description": "Error - the user has no permission to read User Groups." }, "404": { - "description": "Error - there is no draft or Role with the given ID." + "description": "Error - the user does not exist." } }, - "summary": "Load Role draft", - "description": "Loads a Role draft by original Role ID.", + "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": "If-None-Match", + "name": "Accept", "in": "header", - "description": "ETag", - "required": false, + "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 + "explode": false }, { - "name": "id", + "name": "userId", "in": "path", - "description": "", + "description": "UserGroupsOfUserListController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] }, - "delete": { - "operationId": "ibexa.rest.delete_role_draft", + "post": { + "operationId": "api_userusers_userIdgroups_post", "tags": [ - "User Role" + "User" ], "responses": { - "204": { - "description": "No Content." + "200": { + "description": "OK - the User has been assigned to the User Group.", + "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 delete this Role." + "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": "Delete Role draft", - "description": "The given Role draft is deleted.", + "summary": "Assign User Group", + "description": "Assigns the User to a User Group.", "parameters": [ { - "name": "X-CSRF-Token", + "name": "Accept", "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "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 + "explode": false }, { - "name": "id", + "name": "userId", "in": "path", - "description": "", + "description": "UserAssignToUserGroupController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], - "deprecated": false - }, - "patch": { - "operationId": "ibexa.rest.update_role_draft", + "requestBody": { + "description": "The new UserAssignToUserGroupController resource", + "content": [], + "required": false + } + } + }, + "/user/users/{userId}/groups/{groupId}": { + "delete": { + "operationId": "api_userusers_userIdgroups_groupId_delete", "tags": [ - "User Role" + "User" ], "responses": { "200": { - "description": "OK - Role draft updated.", + "description": "OK - the User has been unassigned from the User Group.", "content": { - "application/vnd.ibexa.api.Role+json": { + "application/vnd.ibexa.api.UserGroupRefList+json": { "schema": { - "$ref": "#/components/schemas/RoleWrapper" + "$ref": "#/components/schemas/UserGroupRefListWrapper" }, "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" - } + "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.Role+xml": { + "application/vnd.ibexa.api.UserGroupRefList+xml": { "schema": { - "$ref": "#/components/schemas/Role" + "$ref": "#/components/schemas/UserGroupRefList" }, - "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" + "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" } } }, - "400": { - "description": "Error - the input does not match the input schema definition." - }, "401": { - "description": "Error - the user is not authorized to update the Role." + "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 - there is no draft or Role with the given ID." + "description": "Error - the User does not exist." }, - "412": { - "description": "Error - the current ETag does not match with the one provided in the If-Match header." + "204": { + "description": "UserUnassignFromUserGroupController resource deleted" } }, - "summary": "Update Role draft", - "description": "Updates a Role draft. PATCH or POST with header X-HTTP-Method-Override PATCH.", + "summary": "Unassign User Group", + "description": "Unassigns the User from a User Group.", "parameters": [ { - "name": "X-CSRF-Token", + "name": "Accept", "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "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 + "explode": false }, { - "name": "If-Match", - "in": "header", - "description": "Performs a PATCH only if the specified ETag is the current one. Otherwise a 412 is returned.", + "name": "userId", + "in": "path", + "description": "UserUnassignFromUserGroupController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "id", + "name": "groupId", "in": "path", - "description": "", + "description": "UserUnassignFromUserGroupController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "requestBody": { - "description": "The RoleInput schema encoded in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.RoleInput+json": { - "schema": { - "$ref": "#/components/schemas/RoleInputWrapper" - }, - "example": { - "RoleInput": { - "identifier": "UpdatedIdentifier" - } - } - }, - "application/vnd.ibexa.api.RoleInput+xml": { - "schema": { - "$ref": "#/components/schemas/RoleInput" - }, - "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RoleInput>\n <identifier>UpdatedIdentifier</identifier>\n</RoleInput>\n" - } - }, - "required": false - }, - "deprecated": false + ] } }, - "/user/roles/{id}/policies": { + "/user/users/{userId}/roles": { "get": { - "operationId": "ibexa.rest.load_policies", + "operationId": "ibexa.rest.load_role_assignments_for_user", "tags": [ - "User Role" + "User" ], "responses": { "200": { - "description": "If set, the Policy list is returned in XML or JSON format.", + "description": "If set, the Role assignment list is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.PolicyList+json": { + "application/vnd.ibexa.api.RoleAssignmentList+json": { "schema": { - "$ref": "#/components/schemas/PolicyListWrapper" + "$ref": "#/components/schemas/RoleAssignmentListWrapper" }, "example": { - "PolicyList": { - "_media-type": "application/vnd.ibexa.api.PolicyList+json", - "_href": "/api/ibexa/v2/user/roles/1/policies", - "Policy": [ + "RoleAssignmentList": { + "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", + "_href": "/api/ibexa/v2/user/users/115/roles", + "RoleAssignment": [ { - "_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.RoleAssignment+json", + "_href": "/api/ibexa/v2/user/users/115/roles/2", + "limitation": { + "_identifier": "Section", + "values": { + "ref": [ + { + "_media-type": "application/vnd.ibexa.api.ref+json", + "_href": "1" } - } - ] + ] + } + }, + "Role": { + "_media-type": "application/vnd.ibexa.api.Role+json", + "_href": "/api/ibexa/v2/user/roles/2" } - }, + } + ] + } + } + }, + "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</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": "userId", + "in": "path", + "description": "RoleAssignmentForUserListController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + }, + "post": { + "operationId": "ibexa.rest.assign_role_to_user", + "tags": [ + "User" + ], + "responses": { + "200": { + "description": "If set, the updated Role assignment list is returned in XML or JSON format.", + "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/115/roles", + "RoleAssignment": [ { - "_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.RoleAssignment+json", + "_href": "/api/ibexa/v2/user/users/115/roles/2", + "limitation": { + "_identifier": "Section", + "values": { + "ref": [ + { + "_media-type": "application/vnd.ibexa.api.ref+json", + "_href": "2" } - } - ] + ] + } + }, + "Role": { + "_media-type": "application/vnd.ibexa.api.Role+json", + "_href": "/api/ibexa/v2/user/roles/2" } }, { - "_media-type": "application/vnd.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.RoleAssignment+json", + "_href": "/api/ibexa/v2/user/users/115/roles/2", + "limitation": { + "_identifier": "Section", + "values": { + "ref": [ + { + "_media-type": "application/vnd.ibexa.api.ref+json", + "_href": "1" } - } - ] + ] + } + }, + "Role": { + "_media-type": "application/vnd.ibexa.api.Role+json", + "_href": "/api/ibexa/v2/user/roles/2" } - }, - { - "_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": { + "application/vnd.ibexa.api.RoleAssignmentList+xml": { "schema": { - "$ref": "#/components/schemas/PolicyList" + "$ref": "#/components/schemas/RoleAssignmentList" }, - "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" + "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 has no permission to read Roles." + "400": { + "description": "Error - validation of limitation in RoleAssignInput fails." }, - "404": { - "description": "Error - the Role does not exist." + "401": { + "description": "Error - the user is not authorized to assign this Role." } }, - "summary": "Load Policies", - "description": "Loads Policies for the given Role.", + "summary": "Assign Role to User", + "description": "Assigns a Role to a user.", "parameters": [ { - "name": "id", + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "userId", "in": "path", - "description": "", + "description": "RoleAssignToUserController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], - "deprecated": false - }, - "post": { - "operationId": "ibexa.rest.add_policy", + "requestBody": { + "description": "The RoleAssignInput schema encoded in XML or JSON format.", + "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 + } + } + }, + "/user/users/{userId}/roles/{roleId}": { + "get": { + "operationId": "ibexa.rest.load_role_assignment_for_user", "tags": [ - "User Role" + "User" ], "responses": { - "201": { - "description": "If set, the updated Policy is returned in XML or JSON format.", + "200": { + "description": "OK - Role assignment to the given User Group.", "content": { - "application/vnd.ibexa.api.Policy+json": { + "application/vnd.ibexa.api.RoleAssignment+json": { "schema": { - "$ref": "#/components/schemas/PolicyWrapper" + "$ref": "#/components/schemas/RoleAssignmentWrapper" }, "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" + "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.Policy+xml": { + "application/vnd.ibexa.api.RoleAssignment+xml": { "schema": { - "$ref": "#/components/schemas/Policy" + "$ref": "#/components/schemas/RoleAssignment" }, - "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/13\"/>\n </values>\n </limitation>\n <limitation identifier=\"ParentClass\">\n <values>\n <ref href=\"/content/types/12\"/>\n </values>\n </limitation>\n </limitations>\n </Policy>\n" + "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 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." + "description": "Error - the user has no permission to read Roles." } }, - "summary": "Create Policy", - "description": "Creates a Policy", + "summary": "Load User Role Assignment", + "description": "Returns a Role assignment to the given User.", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "name": "userId", + "in": "path", + "description": "RoleAssignmentForUserLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "id", + "name": "roleId", "in": "path", - "description": "", + "description": "RoleAssignmentForUserLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "requestBody": { - "description": "If set, the updated Policy is returned in XML or JSON format.", - "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": "ibexa.rest.delete_policies", + "operationId": "ibexa.rest.unassign_role_from_user", "tags": [ - "User Role" + "User" ], "responses": { - "204": { - "description": "No Content - all Policies of the given Role are deleted." + "200": { + "description": "If set, the updated Role assignment list is returned in XML or JSON format.", + "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 href=\"/user/groups/1/5/65/roles\" media-type=\"application/vnd.ibexa.api.RoleAssignmentList+xml\">\n <RoleAssignment href=\"/user/groups/1/5/65/roles/5\" media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\">\n <Role href=\"/user/roles/5\" media-type=\"application/vnd.ibexa.api.Role+xml\"/>\n </RoleAssignment>\n <RoleAssignment href=\"/user/groups/1/5/65/roles/11\" media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\">\n <limitation identifier=\"Section\">\n <values>\n <ref href=\"/content/sections/1\" media-type=\"application/vnd.ibexa.api.Section+xml\" />\n <ref href=\"/content/sections/4\" media-type=\"application/vnd.ibexa.api.Section+xml\" />\n </values>\n </limitation>\n <Role href=\"/user/roles/11\" media-type=\"application/vnd.ibexa.api.Role+xml\"/>\n </RoleAssignment>\n</RoleAssignmentList>\n" + } + } }, "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.", + "summary": "Unassign Role from User", + "description": "The given Role is removed from the user.", "parameters": [ { "name": "X-CSRF-Token", @@ -42461,7657 +27578,9493 @@ "description": "The CSRF Token needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "id", + "name": "userId", "in": "path", - "description": "", + "description": "RoleUnassignFromUserController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + }, + { + "name": "roleId", + "in": "path", + "description": "RoleUnassignFromUserController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } - ], - "deprecated": false + ] } }, - "/user/roles/{roleId}/policies/{policyId}": { + "/user/users/{userId}/segments": { "get": { - "operationId": "ibexa.rest.load_policy", + "operationId": "ibexa.segmentation.rest.user.segments.view", "tags": [ - "User Role" + "User" ], "responses": { "200": { - "description": "If set, the Policy is returned in XML or JSON format.", + "description": "If set, the user's segment list is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Policy+json": { + "application/vnd.ibexa.api.UserSegmentList+json": { "schema": { - "$ref": "#/components/schemas/PolicyWrapper" + "$ref": "#/components/schemas/UserSegmentListWrapper" }, "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" + "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", + "source": "cohesivo", + "lastUpdatedBy": "14", + "updatedAt": "2026-06-30T12:00:00+00:00", + "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.Policy+xml": { + "application/vnd.ibexa.api.UserSegmentList+xml": { "schema": { - "$ref": "#/components/schemas/Policy" + "$ref": "#/components/schemas/UserSegmentList" }, - "example": "<Policy href=\"/user/roles/11/policies/45\" media-type=\"application/vnd.ibexa.api.Policy+xml\">\n <id>45</id>\n <module>content</module>\n <function>create</function>\n <limitations>\n <limitation identifier=\"Class\">\n <values>\n <ref href=\"/content/types/10\" media-type=\"application/vnd.ibexa.api.ContentType+xml\" />\n <ref href=\"/content/types/11\" media-type=\"application/vnd.ibexa.api.ContentType+xml\" />\n <ref href=\"/content/types/12\" media-type=\"application/vnd.ibexa.api.ContentType+xml\" />\n </values>\n </limitation>\n <limitation identifier=\"ParentClass\">\n <values>\n <ref href=\"/content/types/4\" media-type=\"application/vnd.ibexa.api.ContentType+xml\" />\n </values>\n </limitation>\n </limitations>\n</Policy>\n" + "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 <source>cohesivo</source>\n <lastUpdatedBy>14</lastUpdatedBy>\n <updatedAt>2026-06-30T12:00:00+00:00</updatedAt>\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" } } }, - "401": { - "description": "Error - the user has no permission to read Roles." - }, "404": { - "description": "Error - the Role or Policy does not exist." + "description": "Error - the user doesn't exist." } }, - "summary": "Load Policy", - "description": "Loads a Policy for the given module and function.", + "summary": "View user segments", + "description": "Return user's segment list.", "parameters": [ { - "name": "If-None-Match", - "in": "header", - "description": "ETag", - "required": false, - "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", + "name": "userId", "in": "path", - "description": "RolePolicyLoadByIdController identifier", + "description": "UserSegmentListController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] }, - "delete": { - "operationId": "ibexa.rest.delete_policy", + "post": { + "operationId": "ibexa.segmentation.rest.user.segments.assign", "tags": [ - "User Role" + "User" ], "responses": { "204": { - "description": "No Content - the given Policy is deleted." + "description": "No Content - segments assigned to user" }, "401": { - "description": "Error - the user is not authorized to delete this content type." + "description": "Error - the requesting user is not authorized to assign this segment to the given user." }, "404": { - "description": "Error - the Role or Policy does not exist." + "description": "Error - the user doesn't exist." } }, - "summary": "Delete Policy", - "description": "Deletes given Policy.", + "summary": "Assign Segments to User", + "description": "Assigns Segments from payload to User given by ID.", "parameters": [ { "name": "X-CSRF-Token", "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "policyId", - "in": "path", - "description": "", + "description": "The CSRF token. Used for POST, PATCH and DELETE requests.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "roleId", + "name": "userId", "in": "path", - "description": "RolePolicyDeleteController identifier", + "description": "UserSegmentAssignController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], - "deprecated": false - }, - "patch": { - "operationId": "ibexa.rest.update_policy", - "tags": [ - "User Role" - ], - "responses": { - "200": { - "description": "If set, the updated Policy is returned in XML or JSON format.", - "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" - } - } + "requestBody": { + "description": "The UserSegmentAssignInput schema encoded in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.UserSegmentAssignInput+json": { + "schema": { + "$ref": "#/components/schemas/UserSegmentAssignInputWrapper" }, - "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" + "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" } }, - "400": { - "description": "Error - the input does not match the input schema definition or validation of limitation in PolicyUpdate fails." + "required": false + } + } + }, + "/user/users/{userId}/segments/{segmentIdentifier}": { + "delete": { + "operationId": "ibexa.segmentation.rest.user.segments.unnassign", + "tags": [ + "User" + ], + "responses": { + "204": { + "description": "No Content - segments unassigned from user" }, "401": { - "description": "Error - the user is not authorized to update the Policy." + "description": "Error - the requesting user is not authorized to unassign this segment from the given user." }, "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." + "description": "Error - the segment or the user doesn't exist." } }, - "summary": "Update Policy", - "description": "Updates a Policy. PATCH or POST with header X-HTTP-Method-Override PATCH.", + "summary": "Unassign Segment from User", + "description": "The Segment designated by its identifier is unassigned from the User given by ID.", "parameters": [ { "name": "X-CSRF-Token", "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", - "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.", + "description": "The CSRF token. Used for POST, PATCH and DELETE requests.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "policyId", + "name": "userId", "in": "path", - "description": "", + "description": "UserSegmentUnassignController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "roleId", + "name": "segmentIdentifier", "in": "path", - "description": "RolePolicyUpdateController identifier", + "description": "UserSegmentUnassignController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "requestBody": { - "description": "If set, the updated Policy is returned in XML or JSON format.", - "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", + "/user/groups": { + "get": { + "operationId": "api_usergroups_get", "tags": [ - "User Session" + "User Group" ], "responses": { "200": { - "description": "Session already exists.", + "description": "OK - list of User Groups.", "content": { - "application/vnd.ibexa.api.Session+json": { + "application/vnd.ibexa.api.UserGroupList+json": { "schema": { - "$ref": "#/components/schemas/SessionWrapper" + "$ref": "#/components/schemas/UserGroupListWrapper" }, "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": { + "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/SessionWrapper" + "$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": { - "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" - } + "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.Session+xml": { + "application/vnd.ibexa.api.UserGroupRefList+xml": { "schema": { - "$ref": "#/components/schemas/Session" + "$ref": "#/components/schemas/UserGroupRefList" }, - "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" + "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" } } }, - "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." + "description": "Error - the user has no permission to read User Groups." } }, - "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.", + "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": "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.", + "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 + "explode": false } + ] + } + }, + "/user/groups/root": { + "get": { + "operationId": "api_usergroupsroot_get", + "tags": [ + "User Group" ], - "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 + "responses": { + "301": { + "description": "Moved permanently." + } }, - "deprecated": false + "summary": "Get root User Group", + "description": "Redirects to the root User Group.", + "parameters": [] } }, - "/user/sessions/current": { - "get": { - "operationId": "api_usersessionscurrent_get", + "/user/groups/subgroups": { + "post": { + "operationId": "api_usergroupssubgroups_post", "tags": [ - "User Session" + "User Group" ], "responses": { - "200": { - "description": "User is currently logged in and has a valid session.", + "201": { + "description": "Created - the User Group has been created", "content": { - "application/vnd.ibexa.api.Session+json": { + "application/vnd.ibexa.api.UserGroup+json": { "schema": { - "$ref": "#/components/schemas/SessionWrapper" + "$ref": "#/components/schemas/UserGroupWrapper" }, "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" + "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.Session+xml": { + "application/vnd.ibexa.api.UserGroup+xml": { "schema": { - "$ref": "#/components/schemas/Session" + "$ref": "#/components/schemas/UserGroup" }, - "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" + "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" } } }, - "404": { - "description": "User does not have a valid session, or it has expired." + "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": "Get current session", - "description": "Get current user session, if any.", + "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": "Cookie", + "name": "Accept", "in": "header", - "description": "Only needed for session's checking {sessionName}={sessionID}.", + "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 + "explode": false }, { - "name": "Accept", + "name": "Content-Type", "in": "header", - "description": "If set, the session is returned in XML or JSON format.", + "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 + "explode": 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" + "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" + } + ] + } + } + } }, - "style": "simple", - "explode": false, - "allowReserved": false + "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>" + } }, - { - "name": "sessionId", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false + "required": false + } } }, - "/user/sessions/{sessionId}/refresh": { - "post": { - "operationId": "api_usersessions_sessionIdrefresh_post", + "/user/groups/{path}": { + "get": { + "operationId": "api_usergroups_path_get", "tags": [ - "User Session" + "User Group" ], "responses": { "200": { - "description": "200", + "description": "OK - loads User Groups.", "content": { - "application/vnd.ibexa.api.Session+json": { + "application/vnd.ibexa.api.UserGroup+json": { "schema": { - "$ref": "#/components/schemas/SessionWrapper" + "$ref": "#/components/schemas/UserGroupWrapper" }, "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" + "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.Session+xml": { + "application/vnd.ibexa.api.UserGroup+xml": { "schema": { - "$ref": "#/components/schemas/Session" + "$ref": "#/components/schemas/UserGroup" }, - "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" + "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 session does not exist." + "description": "Error - the User Group 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.", + "summary": "Load User Group", + "description": "Loads User Groups for the given {path}.", "parameters": [ { - "name": "Cookie", + "name": "Accept", "in": "header", - "description": "{sessionName}={sessionID}", + "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 + "explode": false }, { - "name": "X-CSRF-Token", + "name": "If-None-Match", "in": "header", - "description": "The {csrfToken} needed on all unsafe HTTP methods with session.", + "description": "ETag", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "Accept", - "in": "header", - "description": "", + "name": "path", + "in": "path", + "description": "UserGroupLoadByPathController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": 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": "sessionId", + "name": "path", "in": "path", - "description": "", + "description": "UserGroupDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "requestBody": { - "description": "The new SessionRefreshController resource", - "content": [], - "required": false - }, - "deprecated": false - } - }, - "/user/token/jwt": { - "post": { - "operationId": "api_usertokenjwt_post", + ] + }, + "patch": { + "operationId": "api_usergroups_path_patch", "tags": [ - "User Token" + "User Group" ], "responses": { "200": { - "description": "OK - returns the JWT in JSON format.", + "description": "OK - updated User Group.", "content": { - "application/vnd.ibexa.api.JWT+json": { + "application/vnd.ibexa.api.UserGroup+json": { "schema": { - "$ref": "#/components/schemas/JWTWrapper" + "$ref": "#/components/schemas/UserGroupWrapper" }, "example": { - "JWT": { - "_media-type": "application/vnd.ibexa.api.JWT+json", - "_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MDI4NDA3ODAsImV4cCI6MTYwMjg0NDM4MCwicm9sZXMiOlsiUk9MRV9VU0VSIl0sInVzZXJuYW1lIjoiYWRtaW4ifQ.0LHa799HwSwwfDBZd2V0q2xHwGt86PpyZamKnXHQyYI", - "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MDI4NDA3ODAsImV4cCI6MTYwMjg0NDM4MCwicm9sZXMiOlsiUk9MRV9VU0VSIl0sInVzZXJuYW1lIjoiYWRtaW4ifQ.0LHa799HwSwwfDBZd2V0q2xHwGt86PpyZamKnXHQyYI" + "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" + } } } - } - } - }, - "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": "ibexa.rest.views.create", - "tags": [ - "Views" - ], - "responses": { - "200": { - "description": "The view in XML or JSON format.", - "content": { - "application/vnd.ibexa.api.View+xml; version=1.1": { + "application/vnd.ibexa.api.UserGroup+xml": { "schema": { - "$ref": "#/components/schemas/View" + "$ref": "#/components/schemas/UserGroup" }, - "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" + "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": "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/)", + "summary": "Update User Group", + "description": "Updates a User Group. PATCH or POST with header X-HTTP-Method-Override PATCH.", "parameters": [ { - "name": "X-CSRF-Token", + "name": "Accept", "in": "header", - "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "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 - } - ], - "requestBody": { - "description": "The view input in XML or JSON format.", - "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" + "explode": false }, - "_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" + { + "name": "Content-Type", + "in": "header", + "description": "The UserGroupUpdate schema encoded in XML or JSON format.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" }, - "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" + "style": "simple", + "explode": false }, - "#text": { - "type": [ - "string", - "null" - ] - } - } - }, - "DateRange": { - "allOf": [ { - "$ref": "#/components/schemas/BaseObject" + "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, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "description": "Representation of date range.", - "type": "object", - "required": [ - "startDate", - "endDate" - ], - "properties": { - "startDate": { - "type": "string" + "name": "path", + "in": "path", + "description": "UserGroupUpdateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "The updated UserGroupUpdateController resource", + "content": { + "application/vnd.ibexa.api.UserGroupUpdate+json": { + "schema": { + "$ref": "#/components/schemas/UserGroupUpdateWrapper" }, - "endDate": { - "type": "string" + "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" } - } - ] - }, - "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" + "required": false + } + } + }, + "/user/groups/{path}/roles": { + "get": { + "operationId": "ibexa.rest.load_role_assignments_for_user_group", + "tags": [ + "User Group" + ], + "responses": { + "200": { + "description": "If set, the Role assignment list is returned in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.RoleAssignmentList+json": { + "schema": { + "$ref": "#/components/schemas/RoleAssignmentListWrapper" }, - "__href": { - "type": "string" + "example": { + "RoleAssignment": { + "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", + "_href": "/api/ibexa/v2/user/groups/1/42/44/roles/1", + "Role": { + "_media-type": "application/vnd.ibexa.api.Role+json", + "_href": "/api/ibexa/v2/user/roles/1" + } + } } + }, + "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/groups/1/42/44/roles/1\">\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/1\"/>\n</RoleAssignment>\n" } } + }, + "400": { + "description": "Error - the user has no permission to read Roles." } - } - }, - "BookmarkListWrapper": { - "type": "object", - "required": [ - "BookmarkList" - ], - "properties": { - "BookmarkList": { - "$ref": "#/components/schemas/BookmarkList" + }, + "summary": "Load Roles for User Group", + "description": "Returns a list of all Roles assigned to the given User Group.", + "parameters": [ + { + "name": "path", + "in": "path", + "description": "RoleAssignmentForUserGroupListController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } - } + ] }, - "SummaryEntry": { - "type": "object", - "required": [ - "identifier", - "id", - "names", - "quantity", - "Price", - "PriceInclVat", - "SubtotalPrice", - "SubtotalPriceInclVat", - "VatCategory", - "Product" + "post": { + "operationId": "ibexa.rest.assign_role_to_user_group", + "tags": [ + "User Group" ], - "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" + "responses": { + "200": { + "description": "If set, the updated Role assignment list is returned in XML or JSON format.", + "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/groups/1/12/2/roles", + "RoleAssignment": [ + { + "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", + "_href": "/api/ibexa/v2/user/groups/1/12/2/roles/2", + "Role": { + "_media-type": "application/vnd.ibexa.api.Role+json", + "_href": "/api/ibexa/v2/user/roles/2" + } + } + ] + } + } + }, + "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/groups/1/5/65/roles\">\n<RoleAssignment media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\" href=\"/api/ibexa/v2/user/groups/1/5/65/roles/3\">\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/3\"/>\n</RoleAssignment>\n<RoleAssignment media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\" href=\"/api/ibexa/v2/user/groups/1/5/65/roles/10\">\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/10\"/>\n</RoleAssignment>\n<RoleAssignment media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\" href=\"/api/ibexa/v2/user/groups/1/5/65/roles/10\">\n <limitation identifier=\"Section\">\n <values>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"4\"/>\n </values>\n </limitation>\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/10\"/>\n</RoleAssignment>\n</RoleAssignmentList>\n" + } + } }, - "VatCategory": { - "$ref": "#/components/schemas/VatCategory" + "400": { + "description": "Error - validation of limitation in RoleAssignInput fails." }, - "Product": { - "$ref": "#/components/schemas/Product" + "401": { + "description": "Error - the user is not authorized to assign this Role." } - } - }, - "SummaryEntryNames": { - "$ref": "#/components/schemas/ValueObject" - }, - "Location": { - "allOf": [ + }, + "summary": "Assign Role to User Group", + "description": "Assigns a Role to a User Group.", + "parameters": [ { - "$ref": "#/components/schemas/BaseObject" + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "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" + "name": "path", + "in": "path", + "description": "RoleAssignToUserGroupController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "The RoleAssignInput schema encoded in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.RoleAssignInput+json": { + "schema": { + "$ref": "#/components/schemas/RoleAssignInputWrapper" }, - "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" + "example": { + "RoleAssignInput": { + "Role": { + "_href": "/api/ibexa/v2/user/roles/2", + "_media-type": "application/vnd.ibexa.api.RoleAssignInput+json" + }, + "limitation": { + "_identifier": "Section", + "values": { + "ref": [ + { + "_href": "/api/ibexa/v2/content/sections/1", + "_media-type": "application/vnd.ibexa.api.Section+json" + }, + { + "_href": "/api/ibexa/v2/content/sections/4", + "_media-type": "application/vnd.ibexa.api.Section+json" + } + ] + } + } + } + } + }, + "application/vnd.ibexa.api.RoleAssignInput+xml": { + "schema": { + "$ref": "#/components/schemas/RoleAssignInput" }, - "Content": { - "description": "Represents a content item in a specific version." + "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 + } + } + }, + "/user/groups/{path}/roles/{roleId}": { + "get": { + "operationId": "ibexa.rest.load_role_assignment_for_user_group", + "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/groups/1/11/12/roles/1", + "Role": { + "_media-type": "application/vnd.ibexa.api.Role+json", + "_href": "/api/ibexa/v2/user/roles/1" + } + } + } }, - "UrlAliases": { - "description": "This class represents URL aliases." + "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/groups/1/11/12/roles/1\">\n <Role media-type=\"application/vnd.ibexa.api.Role+xml\" href=\"/api/ibexa/v2/user/roles/1\"/>\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": "path", + "in": "path", + "description": "RoleAssignmentForUserGroupLoadByIdController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "roleId", + "in": "path", + "description": "RoleAssignmentForUserGroupLoadByIdController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] }, - "LocationWrapper": { - "type": "object", - "required": [ - "Location" + "delete": { + "operationId": "ibexa.rest.unassign_role_from_user_group", + "tags": [ + "User Group" ], - "properties": { - "Location": { - "$ref": "#/components/schemas/Location" + "responses": { + "200": { + "description": "If set, the updated Role assignment list is returned in XML or JSON format.", + "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/groups/1/57/58/roles", + "RoleAssignment": [ + { + "_media-type": "application/vnd.ibexa.api.RoleAssignment+json", + "_href": "/api/ibexa/v2/user/groups/1/57/58/roles/3", + "limitation": { + "_identifier": "Section", + "values": { + "ref": [ + { + "_media-type": "application/vnd.ibexa.api.ref+json", + "_href": "1" + } + ] + } + }, + "Role": { + "_media-type": "application/vnd.ibexa.api.Role+json", + "_href": "/api/ibexa/v2/user/roles/3" + } + } + ] + } + } + }, + "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/groups/1/5/65/roles\">\n<RoleAssignment media-type=\"application/vnd.ibexa.api.RoleAssignment+xml\" href=\"/api/ibexa/v2/user/groups/1/5/65/roles/3\">\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/3\"/>\n</RoleAssignment>\n</RoleAssignmentList>\n" + } + } + }, + "401": { + "description": "Error - the user is not authorized to delete this Role assignment." } - } - }, - "LocationCreate": { - "allOf": [ + }, + "summary": "Unassign Role from User Group", + "description": "The given Role is removed from the User or User Group.", + "parameters": [ { - "$ref": "#/components/schemas/BaseObject" + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "path", + "in": "path", + "description": "RoleUnassignFromUserGroupController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "type": "object", - "required": [ - "ParentLocation", - "priority", - "hidden", - "sortField", - "sortOrder" - ], - "properties": { - "ParentLocation": { - "type": "object", - "required": [ - "_href" - ], - "properties": { - "_href": { - "xml": { - "attribute": true, - "name": "href" - }, - "type": "string" + "name": "roleId", + "in": "path", + "description": "RoleUnassignFromUserGroupController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": 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" + } + } + ] } } }, - "priority": { - "type": "string" - }, - "hidden": { - "type": [ - "string", - "boolean" - ] + "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" }, - "sortField": { - "type": "string" + "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" + } + ] + } + } }, - "sortOrder": { - "type": "string" + "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" } } - } - ] - }, - "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" + "401": { + "description": "Error - the user has no permission to read User Groups." }, - "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" + "404": { + "description": "Error - the User Group does not exist." } - } - }, - "LocationList": { - "allOf": [ + }, + "summary": "Load subgroups", + "description": "Returns a list of the subgroups.", + "parameters": [ { - "$ref": "#/components/schemas/BaseObject" + "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, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "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" - } - } - } + "name": "path", + "in": "path", + "description": "UserSubGroupListController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] }, - "LocationListWrapper": { - "type": "object", - "required": [ - "LocationList" + "post": { + "operationId": "api_usergroups_pathsubgroups_post", + "tags": [ + "User Group" ], - "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" + "responses": { + "201": { + "description": "Created - the User Group has been created.", + "content": { + "application/vnd.ibexa.api.UserGroup+json": { + "schema": { + "$ref": "#/components/schemas/UserGroupWrapper" }, - "type": "string" + "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" + } + } + } }, - "_id": { - "description": "Unique ID of the content type.", - "xml": { - "attribute": true, - "name": "id" + "application/vnd.ibexa.api.UserGroup+xml": { + "schema": { + "$ref": "#/components/schemas/UserGroup" }, - "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" + "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" } } - } - ] - }, - "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" + "400": { + "description": "Error - the input does not match the input schema definition." }, - "modificationDate": { - "description": "Modification date. If not given, the current integer is used.", - "type": "string", - "format": "date-time" + "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, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, - "LocationCreate": { - "type": "object" + { + "name": "Content-Type", + "in": "header", + "description": "The UserGroupCreate schema encoded in XML or JSON format.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, - "fields": { - "type": "object", - "required": [ - "field" - ], - "properties": { - "field": { - "type": "array", - "items": { - "type": "object" + { + "name": "path", + "in": "path", + "description": "UserGroupCreateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": 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>" } - } - } - }, - "ContentCreateWrapper": { - "type": "object", - "required": [ - "ContentCreate" - ], - "properties": { - "ContentCreate": { - "$ref": "#/components/schemas/ContentCreate" - } + }, + "required": false } - }, - "ContentUpdate": { - "description": "This class is used to update a Content.", - "type": "object", - "required": [ - "mainLanguageCode", - "Section", - "MainLocation", - "Owner", - "alwaysAvailable", - "remoteId" + } + }, + "/user/groups/{path}/users": { + "get": { + "operationId": "api_usergroups_pathusers_get", + "tags": [ + "User Group" ], - "properties": { - "mainLanguageCode": { - "type": "string" - }, - "Section": { - "$ref": "#/components/schemas/Section" - }, - "MainLocation": { - "$ref": "#/components/schemas/Location" - }, - "Owner": { - "$ref": "#/components/schemas/User" + "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" + } + } }, - "alwaysAvailable": { - "type": "boolean" + "401": { + "description": "Error - the user has no permission to read User Groups." }, - "remoteId": { - "type": "string" + "404": { + "description": "Error - the User Group does not exist." } - } - }, - "ContentInfo": { - "allOf": [ + }, + "summary": "Load Users of Group", + "description": "Loads the Users of the Group with the given ID.", + "parameters": [ { - "$ref": "#/components/schemas/BaseObject" + "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, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "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" + "name": "path", + "in": "path", + "description": "UserGroupUsersListController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + }, + "post": { + "operationId": "api_usergroups_pathusers_post", + "tags": [ + "User Group" + ], + "responses": { + "201": { + "description": "Created - the User has been created.", + "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" } } - } - ] - }, - "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" + "400": { + "description": "Error - the input does not match the input schema definition." }, - "mainLanguageCode": { - "type": "string" + "401": { + "description": "Error - the user is not authorized to create this User." }, - "alwaysAvailable": { - "type": "boolean" + "403": { + "description": "Error - a User with the same login already exists." }, - "remoteId": { - "type": "string" + "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, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, - "mainLocationId": { - "type": [] + { + "name": "Content-Type", + "in": "header", + "description": "The UserCreate schema encoded in XML or JSON format.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, - "name": { - "type": "string" + { + "name": "path", + "in": "path", + "description": "UserCreateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } - } - }, - "ContentCreateContentType": { - "type": "object", - "required": [ - "_href", - "FieldDefinitions" ], - "properties": { - "_href": { - "xml": { - "attribute": true, - "name": "href" - }, - "type": "string" - }, - "FieldDefinitions": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "requestBody": { + "description": "The new UserCreateController resource", + "content": { + "application/vnd.ibexa.api.UserCreate+json": { + "schema": { + "$ref": "#/components/schemas/UserCreateWrapper" }, - { - "type": "object", - "properties": { - "FieldDefinitions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FieldDefinition" - } + "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 + } + } + ] } } } - ] - } - } - }, - "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" + }, + "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" } - } - } - }, - "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" - } + "required": false } - }, - "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" - } + } + }, + "/user/policies": { + "get": { + "operationId": "ibexa.rest.list_policies_for_user", + "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/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" + } + ] } } }, - "Relations": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - }, - { - "description": "Relations of the user.", - "type": "object", - "required": [ - "Relation" - ], - "properties": { - "Relation": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Relation" + "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/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": [] + } + }, + "/user/roles": { + "get": { + "operationId": "ibexa.rest.list_roles", + "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": [] }, - "VersionWrapper": { - "type": "object", - "required": [ - "Version" + "post": { + "operationId": "ibexa.rest.create_role", + "tags": [ + "User Role" ], - "properties": { - "Version": { - "$ref": "#/components/schemas/Version" - } - } - }, - "VersionUpdate": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "responses": { + "201": { + "description": "If set, the new user is returned in XML or JSON format.", + "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/21", + "identifier": "NewRole", + "Policies": { + "_media-type": "application/vnd.ibexa.api.PolicyList+json", + "_href": "/api/ibexa/v2/user/roles/21/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/19\">\n <identifier>NewRole</identifier>\n <Policies media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/19/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": [ { - "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" + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "The RoleInput schema encoded in XML or JSON.", + "content": { + "application/vnd.ibexa.api.RoleInput+json": { + "schema": { + "$ref": "#/components/schemas/RoleInputWrapper" }, - "fields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Field" + "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>" } - } - ] - }, - "VersionUpdateWrapper": { - "type": "object", - "required": [ - "VersionUpdate" + }, + "required": false + } + } + }, + "/user/roles/{id}": { + "get": { + "operationId": "ibexa.rest.load_role", + "tags": [ + "User Role" ], - "properties": { - "VersionUpdate": { - "$ref": "#/components/schemas/VersionUpdate" + "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/21", + "identifier": "NewRole", + "Policies": { + "_media-type": "application/vnd.ibexa.api.PolicyList+json", + "_href": "/api/ibexa/v2/user/roles/21/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/21\">\n <identifier>NewRole</identifier>\n <Policies media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/21/policies\"/>\n</Role>\n" + } + } + }, + "401": { + "description": "Error - the user has no permission to read Roles." + }, + "404": { + "description": "Error - the Role does not exist." } - } - }, - "VersionList": { - "allOf": [ + }, + "summary": "Load Role", + "description": "Loads a Role for the given ID.", + "parameters": [ { - "$ref": "#/components/schemas/BaseObject" + "name": "If-None-Match", + "in": "header", + "description": "ETag", + "required": false, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "description": "List of all versions of the content.", - "type": "object", - "required": [ - "VersionItem" - ], - "properties": { - "VersionItem": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VersionItem" - } - } - } + "name": "id", + "in": "path", + "description": "RoleLoadByIdController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] }, - "VersionListWrapper": { - "type": "object", - "required": [ - "VersionList" - ], - "properties": { - "VersionList": { - "$ref": "#/components/schemas/VersionList" - } - } - }, - "VersionItem": { - "description": "Version of content.", - "type": "object", - "required": [ - "Version", - "VersionInfo" + "post": { + "operationId": "ibexa.rest.create_role_draft", + "tags": [ + "User Role" ], - "properties": { - "Version": { - "description": "Returns the VersionInfo for this version.", - "$ref": "#/components/schemas/BaseObject" + "responses": { + "201": { + "description": "If set, the new user is returned in XML or JSON format.", + "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": "Editor", + "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" + } + } }, - "VersionInfo": { - "$ref": "#/components/schemas/VersionInfo" + "401": { + "description": "Error - the user is not authorized to create a Role or a Role draft" } - } - }, - "VersionTranslationInfo": { - "description": "Translation information.", - "type": "object", - "required": [ - "_media-type", - "Language" - ], - "properties": { - "_media-type": { - "type": "string" + }, + "summary": "Create Role Draft", + "description": "Creates a new Role draft from an existing Role.", + "parameters": [ + { + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, - "Language": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LanguageCode" - } + { + "name": "id", + "in": "path", + "description": "RoleDraftCreateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } + ], + "requestBody": { + "description": "No payload required", + "content": [], + "required": false } }, - "LanguageCode": { - "description": "Language code.", - "type": "object", - "required": [ - "languageCode" + "delete": { + "operationId": "ibexa.rest.delete_role", + "tags": [ + "User Role" ], - "properties": { - "languageCode": { - "type": "string" + "responses": { + "204": { + "description": "No Content." + }, + "401": { + "description": "Error - the User is not authorized to delete this Role." } - } - }, - "Relation": { - "allOf": [ + }, + "summary": "Delete Role", + "description": "The given Role and all assignments to Users or User Groups are deleted.", + "parameters": [ { - "$ref": "#/components/schemas/BaseObject" + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "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" - } - } + "name": "id", + "in": "path", + "description": "RoleDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] }, - "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" + "patch": { + "operationId": "ibexa.rest.update_role", + "tags": [ + "User Role" ], - "properties": { - "RelationCreate": { - "$ref": "#/components/schemas/RelationCreate" + "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/21", + "identifier": "NewIdentifier", + "Policies": { + "_media-type": "application/vnd.ibexa.api.PolicyList+json", + "_href": "/api/ibexa/v2/user/roles/21/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/5\">\n <identifier>NewIdentifier</identifier>\n <Policies media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/5/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." } - } - }, - "RelationList": { - "allOf": [ + }, + "summary": "Update Role", + "description": "Updates a Role. PATCH or POST with header X-HTTP-Method-Override PATCH", + "parameters": [ { - "$ref": "#/components/schemas/BaseObject" + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "description": "Class representing a list of relations between content.", - "type": "object", - "required": [ - "Relation" - ], - "properties": { - "Relation": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Relation" + "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, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "id", + "in": "path", + "description": "RoleUpdateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "The RoleInput schema encoded in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.RoleInput+json": { + "schema": { + "$ref": "#/components/schemas/RoleInputWrapper" + }, + "example": { + "RoleInput": { + "identifier": "NewIdentifier" } } + }, + "application/vnd.ibexa.api.RoleInput+xml": { + "schema": { + "$ref": "#/components/schemas/RoleInput" + }, + "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RoleInput>\n <identifier>NewIdentifier</identifier>\n</RoleInput>\n" } - } - ] - }, - "RelationListWrapper": { - "type": "object", - "required": [ - "Relations" - ], - "properties": { - "Relations": { - "$ref": "#/components/schemas/RelationList" - } + }, + "required": false } - }, - "Fields": { - "type": "object", - "required": [ - "field" + } + }, + "/user/roles/{id}/draft": { + "get": { + "operationId": "ibexa.rest.load_role_draft", + "tags": [ + "User Role" ], - "properties": { - "field": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Field" + "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/27", + "identifier": "Anonymous", + "Policies": { + "_media-type": "application/vnd.ibexa.api.PolicyList+json", + "_href": "/api/ibexa/v2/user/roles/27/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/27\">\n <identifier>Anonymous</identifier>\n <Policies media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/27/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." } - } - }, - "Section": { - "allOf": [ + }, + "summary": "Load Role draft", + "description": "Loads a Role draft by original Role ID.", + "parameters": [ { - "$ref": "#/components/schemas/BaseObject" + "name": "If-None-Match", + "in": "header", + "description": "ETag", + "required": false, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "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" - } - } + "name": "id", + "in": "path", + "description": "RoleDraftLoadByRoleIdController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] }, - "SectionWrapper": { - "type": "object", - "required": [ - "Section" - ], - "properties": { - "Section": { - "$ref": "#/components/schemas/Section" - } - } - }, - "SectionInput": { - "type": "object", - "required": [ - "identifier", - "name" + "delete": { + "operationId": "ibexa.rest.delete_role_draft", + "tags": [ + "User Role" ], - "properties": { - "identifier": { - "type": "string" + "responses": { + "204": { + "description": "No Content." }, - "name": { - "type": "string" - } - } - }, - "SectionInputWrapper": { - "type": "object", - "required": [ - "SectionInput" - ], - "properties": { - "SectionInput": { - "$ref": "#/components/schemas/SectionInput" + "401": { + "description": "Error - the user is not authorized to delete this Role." } - } - }, - "SectionList": { - "allOf": [ + }, + "summary": "Delete Role draft", + "description": "The given Role draft is deleted.", + "parameters": [ { - "$ref": "#/components/schemas/BaseObject" + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "description": "This class represents a Section list.", - "type": "object", - "required": [ - "Section" - ], - "properties": { - "Section": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Section" - } - } - } + "name": "id", + "in": "path", + "description": "RoleDraftDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] }, - "SectionListWrapper": { - "type": "object", - "required": [ - "SectionList" + "patch": { + "operationId": "ibexa.rest.update_role_draft", + "tags": [ + "User Role" ], - "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" + "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." } - ] - }, - "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": [ + }, + "summary": "Update Role draft", + "description": "Updates a Role draft. PATCH or POST with header X-HTTP-Method-Override PATCH.", + "parameters": [ { - "$ref": "#/components/schemas/BaseObject" + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "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" + "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, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "id", + "in": "path", + "description": "RoleDraftUpdateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "The RoleInput schema encoded in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.RoleInput+json": { + "schema": { + "$ref": "#/components/schemas/RoleInputWrapper" }, - "Creator": { - "description": "Creator User ID.", - "$ref": "#/components/schemas/BaseObject" + "example": { + "RoleInput": { + "identifier": "UpdatedIdentifier" + } + } + }, + "application/vnd.ibexa.api.RoleInput+xml": { + "schema": { + "$ref": "#/components/schemas/RoleInput" }, - "Modifier": { - "description": "Modifier User ID.", - "$ref": "#/components/schemas/BaseObject" + "example": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<RoleInput>\n <identifier>UpdatedIdentifier</identifier>\n</RoleInput>\n" + } + }, + "required": false + } + } + }, + "/user/roles/{id}/policies": { + "get": { + "operationId": "ibexa.rest.load_policies", + "tags": [ + "User Role" + ], + "responses": { + "200": { + "description": "If set, the Policy list is returned in XML or JSON format.", + "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" + } + ] + } + } }, - "ContentTypes": { - "description": "Content types.", - "$ref": "#/components/schemas/BaseObject" + "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." } - ] - }, - "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" + }, + "summary": "Load Policies", + "description": "Loads Policies for the given Role.", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "RolePolicyListController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } - } + ] }, - "ContentTypeGroupListWrapper": { - "type": "object", - "required": [ - "ContentTypeGroupList" + "post": { + "operationId": "ibexa.rest.add_policy", + "tags": [ + "User Role" ], - "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" + "responses": { + "201": { + "description": "If set, the updated Policy is returned in XML or JSON format.", + "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/13\"/>\n </values>\n </limitation>\n <limitation identifier=\"ParentClass\">\n <values>\n <ref href=\"/content/types/12\"/>\n </values>\n </limitation>\n </limitations>\n </Policy>\n" } } - ] - } - }, - "ContentTypeGroupRefList": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" }, - { - "description": "List of content type groups references.", - "type": "object", - "required": [ - "ContentTypeGroupRef" - ], - "properties": { - "ContentTypeGroupRef": { - "$ref": "#/components/schemas/ContentTypeGroupRef" - } - } + "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." } - ] - }, - "ContentTypeGroupList": { - "allOf": [ + }, + "summary": "Create Policy", + "description": "Creates a Policy", + "parameters": [ { - "$ref": "#/components/schemas/BaseObject" + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "description": "List of content type groups.", - "type": "object", - "required": [ - "ContentTypeGroup" - ], - "properties": { - "ContentTypeGroup": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ContentTypeGroup" - } + "name": "id", + "in": "path", + "description": "RolePolicyCreateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "If set, the updated Policy is returned in XML or JSON format.", + "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 + } }, - "ContentTypeGroupRefListWrapper": { - "type": "object", - "required": [ - "ContentTypeGroupRefList" + "delete": { + "operationId": "ibexa.rest.delete_policies", + "tags": [ + "User Role" ], - "properties": { - "ContentTypeGroupRefList": { - "$ref": "#/components/schemas/ContentTypeGroupRefList" + "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." } - } - }, - "ContentType": { - "allOf": [ + }, + "summary": "Delete Policies", + "description": "All Policies of the given Role are deleted.", + "parameters": [ { - "$ref": "#/components/schemas/BaseObject" + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "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." - } - } + "name": "id", + "in": "path", + "description": "RolePolicyDeleteAllFromRoleController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] - }, - "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" + } + }, + "/user/roles/{roleId}/policies/{policyId}": { + "get": { + "operationId": "ibexa.rest.load_policy", + "tags": [ + "User Role" ], - "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" + "responses": { + "200": { + "description": "If set, the Policy is returned in XML or JSON format.", + "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/45\" media-type=\"application/vnd.ibexa.api.Policy+xml\">\n <id>45</id>\n <module>content</module>\n <function>create</function>\n <limitations>\n <limitation identifier=\"Class\">\n <values>\n <ref href=\"/content/types/10\" media-type=\"application/vnd.ibexa.api.ContentType+xml\" />\n <ref href=\"/content/types/11\" media-type=\"application/vnd.ibexa.api.ContentType+xml\" />\n <ref href=\"/content/types/12\" media-type=\"application/vnd.ibexa.api.ContentType+xml\" />\n </values>\n </limitation>\n <limitation identifier=\"ParentClass\">\n <values>\n <ref href=\"/content/types/4\" media-type=\"application/vnd.ibexa.api.ContentType+xml\" />\n </values>\n </limitation>\n </limitations>\n</Policy>\n" + } + } }, - "descriptions": { - "$ref": "#/components/schemas/ValueObject" + "401": { + "description": "Error - the user has no permission to read Roles." }, - "FieldDefinition": { - "$ref": "#/components/schemas/FieldDefinition" + "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": "If-None-Match", + "in": "header", + "description": "ETag", + "required": false, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, - "creatorId": { - "description": "If set, this value overrides the current user as creator." + { + "name": "policyId", + "in": "path", + "description": "RolePolicyLoadByIdController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, - "creationDate": { - "type": "string", - "format": "date-time" + { + "name": "roleId", + "in": "path", + "description": "RolePolicyLoadByIdController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } - } + ] }, - "ContentTypeCreateWrapper": { - "type": "object", - "required": [ - "ContentTypeCreate" + "delete": { + "operationId": "ibexa.rest.delete_policy", + "tags": [ + "User Role" ], - "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" + "responses": { + "204": { + "description": "No Content - the given Policy is deleted." }, - "nameSchema": { - "description": "f set the name schema is changed to this value.", - "type": "string" + "401": { + "description": "Error - the user is not authorized to delete this content type." }, - "isContainer": { - "description": "If set the container flag is set to this value.", - "type": "boolean" + "404": { + "description": "Error - the Role or Policy does not exist." + } + }, + "summary": "Delete Policy", + "description": "Deletes given Policy.", + "parameters": [ + { + "name": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, - "mainLanguageCode": { - "description": "If set the main language is changed to this value.", - "type": "string" + { + "name": "policyId", + "in": "path", + "description": "RolePolicyDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, - "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" + { + "name": "roleId", + "in": "path", + "description": "RolePolicyDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + }, + "patch": { + "operationId": "ibexa.rest.update_policy", + "tags": [ + "User Role" + ], + "responses": { + "200": { + "description": "If set, the updated Policy is returned in XML or JSON format.", + "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" + } + } }, - "defaultSortOrder": { - "description": "If set the default sort order is set to this value.", - "enum": [ - "ASC", - "DESC" - ], - "type": "string" + "400": { + "description": "Error - the input does not match the input schema definition or validation of limitation in PolicyUpdate fails." }, - "defaultAlwaysAvailable": { - "description": "If set the default always available flag is set to this value.", - "type": "boolean" + "401": { + "description": "Error - the user is not authorized to update the Policy." }, - "modifierId": { - "description": "If set this value overrides the current User as creator.", - "type": "integer" + "404": { + "description": "Error - the Role does not exist." }, - "modificationDate": { - "description": "If set this value overrides the current time for creation.", - "type": "string", - "format": "date-time" + "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": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, - "names": { - "description": "If set this array of names with languageCode keys replace the complete name collection." + { + "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, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, - "descriptions": { - "description": "If set this array of descriptions with languageCode keys replace the complete description collection." - } - } - }, - "ContentTypeUpdate": { - "allOf": [ { - "$ref": "#/components/schemas/BaseObject" + "name": "policyId", + "in": "path", + "description": "RolePolicyUpdateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "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" + "name": "roleId", + "in": "path", + "description": "RolePolicyUpdateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "If set, the updated Policy is returned in XML or JSON format.", + "content": { + "application/vnd.ibexa.api.PolicyUpdate+json": { + "schema": { + "$ref": "#/components/schemas/PolicyUpdateWrapper" + } + }, + "application/vnd.ibexa.api.PolicyUpdate+xml": { + "schema": { + "$ref": "#/components/schemas/PolicyUpdate" }, - "modifierId": { - "description": "If set, this value overrides the current user as creator." + "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 + } + } + }, + "/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" + } + } + } }, - "modificationDate": { - "type": "string", - "format": "date-time" + "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" } } - } - ] - }, - "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" + "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." } - ] - }, - "ContentTypeListWrapper": { - "type": "object", - "required": [ - "ContentTypeList" - ], - "properties": { - "ContentTypeList": { - "$ref": "#/components/schemas/ContentTypeList" - } - } - }, - "ContentTypeInfo": { - "allOf": [ + }, + "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": [ { - "$ref": "#/components/schemas/BaseObject" + "name": "Accept", + "in": "header", + "description": "If set, the session is returned in XML or JSON format.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "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" + "name": "Content-Type", + "in": "header", + "description": "The SessionInput schema encoded in XML or JSON format.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "Cookie", + "in": "header", + "description": "Only needed for session's checking {sessionName}={sessionID}.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": 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, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ], + "requestBody": { + "description": "The new SessionCreateController resource", + "content": { + "application/vnd.ibexa.api.SessionInput+json": { + "schema": { + "$ref": "#/components/schemas/SessionInputWrapper" }, - "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" + "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" } - } - ] - }, - "ContentTypeInfoWrapper": { - "type": "object", - "required": [ - "ContentTypeInfo" + }, + "required": false + } + } + }, + "/user/sessions/current": { + "get": { + "operationId": "api_usersessionscurrent_get", + "tags": [ + "User Session" ], - "properties": { - "ContentTypeInfo": { - "$ref": "#/components/schemas/ContentTypeInfo" + "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." } - } - }, - "ContentTypeInfoList": { - "allOf": [ + }, + "summary": "Get current session", + "description": "Get current user session, if any.", + "parameters": [ { - "$ref": "#/components/schemas/BaseObject" + "name": "Cookie", + "in": "header", + "description": "Only needed for session's checking {sessionName}={sessionID}.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, { - "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" - } - } - } + "name": "Accept", + "in": "header", + "description": "If set, the session is returned in XML or JSON format.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] - }, - "ContentTypeInfoListWrapper": { - "type": "object", - "required": [ - "ContentTypeList" + } + }, + "/user/sessions/{sessionId}": { + "delete": { + "operationId": "api_usersessions_sessionId_delete", + "tags": [ + "User Session" ], - "properties": { - "ContentTypeList": { - "$ref": "#/components/schemas/ContentTypeInfoList" + "responses": { + "204": { + "description": "OK - session deleted." + }, + "404": { + "description": "Error - the session does not exist." } - } - }, - "ContentTypeQuery": { - "description": "This class represents a content type query.", - "type": "object", - "properties": { - "limit": { - "description": "The maximum number of results to return.", - "type": "integer" + }, + "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, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, - "offset": { - "description": "The offset to start returning results from.", - "type": "integer" + { + "name": "X-CSRF-Token", + "in": "header", + "description": "The {csrfToken} needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, - "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" + { + "name": "sessionId", + "in": "path", + "description": "SessionDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + } + }, + "/user/sessions/{sessionId}/refresh": { + "post": { + "operationId": "api_usersessions_sessionIdrefresh_post", + "tags": [ + "User Session" + ], + "responses": { + "200": { + "description": "OK - session refreshed.", + "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" } - }, - { - "type": "integer" } - ] + } }, - "ContainsFieldDefinitionIdCriterion": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "integer" - } - }, - { - "type": "integer" - } - ] + "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" } } }, - "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" - ] - } - } + "404": { + "description": "Error - the session does not exist." } - } - }, - "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" + "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, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, - "ContentTypeQuery": { - "$ref": "#/components/schemas/ContentTypeQuery" + { + "name": "X-CSRF-Token", + "in": "header", + "description": "The {csrfToken} needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "Accept", + "in": "header", + "description": "", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "sessionId", + "in": "path", + "description": "SessionRefreshController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } - } - }, - "ContentTypeViewInputWrapper": { - "type": "object", - "required": [ - "ViewInput" ], - "properties": { - "ViewInput": { - "$ref": "#/components/schemas/ContentTypeViewInput" - } + "requestBody": { + "description": "The new SessionRefreshController resource", + "content": [], + "required": false } - }, - "Field": { - "description": "This class represents a field of a content item.", - "type": "object", - "required": [ - "fieldDefinitionIdentifier", - "fieldValue" + } + }, + "/user/token/jwt": { + "post": { + "operationId": "api_usertokenjwt_post", + "tags": [ + "User Token" ], - "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" + "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" + } + } + } + } }, - "fieldValue": { - "description": "A Field Type value or a value type which can be converted by the corresponding field type." + "401": { + "description": "Error - Unauthorized" } - } - }, - "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." + }, + "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" }, - "validatorConfiguration": { - "description": "Validator configuration of this Field definition supported by the field type.", - "oneOf": [ - { - "$ref": "#/components/schemas/StringLengthValidator" - }, - { - "$ref": "#/components/schemas/StringLengthValidatorWrapper" - }, - { - "type": "array" - } - ] + "example": { + "JWTInput": { + "_media-type": "application/vnd.ibexa.api.JWTInput", + "username": "admin", + "password": "publish" + } } } - } - ] - }, - "FieldDefinitionWrapper": { - "type": "object", - "required": [ - "FieldDefinition" + }, + "required": false + } + } + }, + "/views": { + "post": { + "operationId": "ibexa.rest.views.create", + "tags": [ + "Views" ], - "properties": { - "FieldDefinition": { - "$ref": "#/components/schemas/FieldDefinition" + "responses": { + "200": { + "description": "The view in XML or JSON format.", + "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": "X-CSRF-Token", + "in": "header", + "description": "The CSRF Token needed on all unsafe HTTP methods with session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } + ], + "requestBody": { + "description": "The view input in XML or JSON format.", + "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 } - }, - "FieldDefinitionCreate": { - "$ref": "#/components/schemas/BaseObject" - }, - "FieldDefinitionCreateWrapper": { + } + } + }, + "components": { + "schemas": { + "BaseObject": { "type": "object", "required": [ - "FieldDefinitionCreate" + "_media-type" ], "properties": { - "FieldDefinitionCreate": { - "$ref": "#/components/schemas/FieldDefinitionCreate" + "_media-type": { + "xml": { + "attribute": true, + "name": "media-type" + }, + "type": "string" + }, + "_href": { + "xml": { + "attribute": true, + "name": "href" + }, + "type": "string" } } }, - "FieldDefinitionUpdate": { + "Ref": { "$ref": "#/components/schemas/BaseObject" }, - "FieldDefinitionUpdateWrapper": { - "type": "object", - "required": [ - "FieldDefinitionUpdate" - ], - "properties": { - "FieldDefinitionUpdate": { - "$ref": "#/components/schemas/FieldDefinitionUpdate" - } - } + "UnixTimestamp": { + "type": "integer" }, - "FieldDefinitions": { + "Href": { "type": "object", "required": [ - "FieldDefinition" + "_href" ], "properties": { - "FieldDefinition": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FieldDefinition" - } + "_href": { + "xml": { + "attribute": true, + "name": "href" + }, + "type": "string" } } }, - "FieldDefinitionsWrapper": { - "type": "object", - "required": [ - "FieldDefinitions" - ], - "properties": { - "FieldDefinitions": { - "$ref": "#/components/schemas/FieldDefinitions" - } - } + "Target": { + "description": "Struct that stores extra target information for a SortClause object.", + "type": "object" }, - "StringLengthValidator": { - "description": "Validator for checking min. and max. length of strings.", + "SortClause": { + "description": "This class is the base for SortClause classes, used to set sorting of content queries.", "type": "object", "required": [ - "maxStringLength", - "minStringLength" + "direction", + "target", + "targetData" ], "properties": { - "maxStringLength": { - "description": "Maximum length of strings.", - "type": [ - "integer", - "null" - ] + "direction": { + "description": "Sort direction. One of Query::SORT_ASC or Query::SORT_DESC.", + "type": "string" }, - "minStringLength": { - "description": "Minimum length of strings.", - "type": [ - "integer", - "null" - ] + "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" } } }, - "StringLengthValidatorWrapper": { + "ErrorMessage": { + "description": "Represents an error response. Might contain additional properties depending on an error type.", "type": "object", "required": [ - "StringLengthValidator" + "errorCode", + "errorMessage", + "errorDescription" ], "properties": { - "StringLengthValidator": { - "$ref": "#/components/schemas/StringLengthValidator" - } - } - }, - "UrlAlias": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "errorCode": { + "type": "integer" }, - { - "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" + "errorMessage": { + "type": "string" + }, + "errorDescription": { + "type": "string" } } }, - "UrlAliasCreate": { + "Value": { + "description": "Struct that stores extra value information for a Criterion object.", "type": "object", "required": [ - "_type" + "_languageCode", + "#text" ], "properties": { - "_type": { - "type": "string" - }, - "location": { - "$ref": "#/components/schemas/Href" - }, - "resource": { - "type": "string" - }, - "languageCode": { + "_languageCode": { + "description": "Language code.", "type": "string" }, - "alwaysAvailable": { - "type": [ - "string", - "boolean" - ] - }, - "forward": { + "#text": { + "description": "Content type description.", "type": [ "string", - "boolean" + "null" ] } } }, - "UrlAliasCreateWrapper": { + "ValueObject": { "type": "object", "required": [ - "UrlAliasCreate" + "value" ], "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" - } - } + "value": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Value" } } - ] - }, - "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": { + "ValueArray": { "type": "object", "required": [ - "UrlWildcard" + "value" ], "properties": { - "UrlWildcard": { - "$ref": "#/components/schemas/UrlWildcard" + "value": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Value" + } } } }, - "UrlWildcardCreate": { - "description": "Creates a new URL wildcard.", + "MultilingualValue": { + "description": "Object that represents a multilingual (translated) value.", "type": "object", "required": [ - "sourceUrl", - "destinationUrl", - "forward" + "_languageCode", + "#text" ], "properties": { - "sourceUrl": { - "type": "string" - }, - "destinationUrl": { + "_languageCode": { + "description": "Language code.", "type": "string" }, - "forward": { + "#text": { + "description": "Translation contents.", "type": [ "string", - "boolean" + "null" ] } } }, - "UrlWildcardCreateWrapper": { + "KeyValue": { + "description": "Key-value structure", "type": "object", "required": [ - "URLWildcardCreate" + "_key", + "#text" ], "properties": { - "URLWildcardCreate": { - "$ref": "#/components/schemas/UrlWildcardCreate" + "_key": { + "type": "string" + }, + "#text": { + "type": [ + "string", + "null" + ] } } }, - "UrlWildcardList": { + "DateRange": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "List of URL alias in the Repository.", + "description": "Representation of date range.", "type": "object", "required": [ - "UrlWildcard" + "startDate", + "endDate" ], "properties": { - "UrlWildcard": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UrlWildcard" - } + "startDate": { + "type": "string" + }, + "endDate": { + "type": "string" } } } ] }, - "UrlWildcardListWrapper": { + "BookmarkList": { + "description": "List of bookmarked Locations.", "type": "object", "required": [ - "UrlWildcardList" + "count", + "items" ], "properties": { - "UrlWildcardList": { - "$ref": "#/components/schemas/UrlWildcardList" - } - } - }, - "Language": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "count": { + "description": "The total number of bookmarks.", + "type": "integer" }, - { - "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" + "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" + } } } } - ] + } }, - "LanguageWrapper": { + "BookmarkListWrapper": { "type": "object", "required": [ - "Language" + "BookmarkList" ], "properties": { - "Language": { - "$ref": "#/components/schemas/Language" + "BookmarkList": { + "$ref": "#/components/schemas/BookmarkList" } } }, - "LanguageList": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - }, - { - "description": "List of languages.", - "type": "object", - "required": [ - "Language" - ], - "properties": { - "Language": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Language" - } - } - } - } - ] - }, - "LanguageListWrapper": { + "SummaryEntry": { "type": "object", "required": [ - "LanguageList" + "identifier", + "id", + "names", + "quantity", + "Price", + "PriceInclVat", + "SubtotalPrice", + "SubtotalPriceInclVat", + "VatCategory", + "Product" ], "properties": { - "LanguageList": { - "$ref": "#/components/schemas/LanguageList" + "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" } } }, - "ObjectState": { + "SummaryEntryNames": { + "$ref": "#/components/schemas/ValueObject" + }, + "Location": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class represents a Object state value.", + "description": "This class represents a Location in the Repository.", "type": "object", "required": [ "id", - "identifier", "priority", - "ObjectStateGroup", - "languageCodes", - "names", - "descriptions" + "hidden", + "invisible", + "remoteId", + "ContentInfo", + "ParentLocation", + "pathString", + "depth", + "childCount", + "sortField", + "sortOrder", + "Content" ], "properties": { "id": { - "description": "Primary key.", + "description": "The ID of the Location.", "type": "integer" }, - "identifier": { - "description": "Readable string identifier of the Object state.", + "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" }, - "priority": { - "description": "Priority for ordering.", + "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" }, - "ObjectStateGroup": { - "description": "The Object state group this Object state belongs to.", - "$ref": "#/components/schemas/BaseObject" + "childCount": { + "description": "Depth Location has in the Location tree.", + "type": "integer" }, - "languageCodes": { - "description": "The available language codes for names an descriptions.", + "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" }, - "names": { - "description": "Names." + "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" }, - "descriptions": { - "description": "Descriptions." + "Content": { + "description": "Represents a content item in a specific version." + }, + "UrlAliases": { + "description": "This class represents URL aliases." } } } ] }, - "ObjectStateWrapper": { + "LocationWrapper": { "type": "object", "required": [ - "ObjectState" + "Location" ], "properties": { - "ObjectState": { - "$ref": "#/components/schemas/ObjectState" + "Location": { + "$ref": "#/components/schemas/Location" } } }, - "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" - } - } - } + "LocationCreate": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "descriptions": { - "description": "An array of descriptions with languageCode keys.", + { "type": "object", "required": [ - "value" + "ParentLocation", + "priority", + "hidden", + "sortField", + "sortOrder" ], "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Value" + "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" } } } - } + ] }, - "ObjectStateCreateWrapper": { + "LocationCreateWrapper": { "type": "object", "required": [ - "ObjectStateCreate" + "LocationCreate" ], "properties": { - "ObjectStateCreate": { - "$ref": "#/components/schemas/ObjectStateCreate" + "LocationCreate": { + "$ref": "#/components/schemas/LocationCreate" } } }, - "ObjectStateUpdate": { - "description": "This class represents a value for updating Object states.", + "LocationUpdateStruct": { + "description": "This class is used for updating Location meta data.", "type": "object", + "required": [ + "priority", + "remoteId", + "hidden", + "sortField", + "sortOrder" + ], "properties": { - "identifier": { - "description": "Readable unique string identifier of a group.", + "priority": { + "description": "If set the Location priority is changed to the new value.", "type": "string" }, - "defaultLanguageCode": { - "description": "The default language code.", + "remoteId": { + "description": "If set the Location gets a new remoteId. Needs to be a unique Location->remoteId string value.", "type": "string" }, - "names": { - "description": "An array of names with languageCode keys." + "hidden": { + "type": "boolean" }, - "descriptions": { - "description": "An array of descriptions with languageCode keys." + "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" } } }, - "ObjectStateUpdateWrapper": { + "LocationUpdateStructWrapper": { "type": "object", "required": [ - "ObjectStateUpdate" + "LocationUpdate" ], "properties": { - "ObjectStateUpdate": { - "$ref": "#/components/schemas/ObjectStateUpdate" + "LocationUpdate": { + "$ref": "#/components/schemas/LocationUpdateStruct" } } }, - "ObjectStateList": { + "LocationList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "List of Object states.", + "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": [ - "ObjectState" + "Location" ], "properties": { - "ObjectState": { + "Location": { + "description": "The partial list of Locations controlled by offset/limit.", "type": "array", "items": { - "$ref": "#/components/schemas/ObjectState" + "$ref": "#/components/schemas/Ref" } } } } ] }, - "ObjectStateListWrapper": { + "LocationListWrapper": { "type": "object", "required": [ - "ObjectStateList" + "LocationList" ], "properties": { - "ObjectStateList": { - "$ref": "#/components/schemas/ObjectStateList" + "LocationList": { + "$ref": "#/components/schemas/LocationList" } } }, - "ObjectStateGroup": { + "Content": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class represents an Object state group value.", + "description": "Content ID matcher class.", "type": "object", "required": [ - "id", - "identifier", - "defaultLanguageCode", - "languageCodes", - "ObjectStates", - "names", - "descriptions" + "_remoteId", + "_id", + "ContentType", + "Name", + "Versions", + "CurrentVersion", + "Section", + "Locations", + "Owner", + "mainLanguageCode", + "currentVersionNo", + "alwaysAvailable", + "status", + "ObjectStates" ], "properties": { - "id": { - "description": "Primary key.", + "_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" }, - "identifier": { - "description": "Readable string identifier of a group.", - "type": "string" + "ContentType": { + "description": "Content type.", + "$ref": "#/components/schemas/BaseObject" }, - "defaultLanguageCode": { - "description": "The default language code.", + "Name": { + "description": "Name of the domain object in a given language.", "type": "string" }, - "languageCodes": { - "description": "The available language codes for names an descriptions.", - "type": "string" + "Versions": { + "description": "Returns the VersionInfo for this version.", + "$ref": "#/components/schemas/BaseObject" }, - "ObjectStates": { - "description": "Object States.", + "CurrentVersion": { + "description": "Current version.", "$ref": "#/components/schemas/BaseObject" }, - "names": { - "description": "List of names." + "Section": { + "description": "The Section to which the content item is assigned to.", + "$ref": "#/components/schemas/BaseObject" }, - "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." + "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" + } + } } - } + ] }, - "ObjectStateGroupCreateWrapper": { + "ContentWrapper": { "type": "object", "required": [ - "ObjectStateGroupCreate" + "Content" ], "properties": { - "ObjectStateGroupCreate": { - "$ref": "#/components/schemas/ObjectStateGroupCreate" + "Content": { + "$ref": "#/components/schemas/Content" } } }, - "ObjectStateGroupUpdate": { - "description": "This class represents a value for updating Object state groups.", + "ContentCreate": { + "description": "This class is used for creating a new content item.", "type": "object", + "required": [ + "ContentType", + "mainLanguageCode", + "LocationCreate", + "fields" + ], "properties": { - "identifier": { - "description": "Readable unique string identifier of a group.", + "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" }, - "defaultLanguageCode": { - "description": "The default language code.", + "remoteId": { + "description": "Remote identifier used as a custom identifier for the content item. Needs to be a unique Content->remoteId string value.", "type": "string" }, - "names": { - "description": "An array of names with languageCode keys." + "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" }, - "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" + "modificationDate": { + "description": "Modification date. If not given, the current integer is used.", + "type": "string", + "format": "date-time" }, - { - "description": "List of Object state groups.", + "LocationCreate": { + "type": "object" + }, + "fields": { "type": "object", "required": [ - "ObjectStateGroup" + "field" ], "properties": { - "ObjectStateGroup": { - "description": "This class represents an Object state group value.", + "field": { "type": "array", "items": { - "$ref": "#/components/schemas/ObjectStateGroup" + "type": "object" } } } } - ] + } }, - "ObjectStateGroupListWrapper": { + "ContentCreateWrapper": { "type": "object", "required": [ - "ObjectStateGroupList" + "ContentCreate" ], "properties": { - "ObjectStateGroupList": { - "$ref": "#/components/schemas/ObjectStateGroupList" + "ContentCreate": { + "$ref": "#/components/schemas/ContentCreate" } } }, - "CountryList": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "ContentUpdate": { + "description": "This class is used to update a Content.", + "type": "object", + "required": [ + "mainLanguageCode", + "Section", + "MainLocation", + "Owner", + "alwaysAvailable", + "remoteId" + ], + "properties": { + "mainLanguageCode": { + "type": "string" }, - { - "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" - } - } - } + "Section": { + "$ref": "#/components/schemas/Section" + }, + "MainLocation": { + "$ref": "#/components/schemas/Location" + }, + "Owner": { + "$ref": "#/components/schemas/User" + }, + "alwaysAvailable": { + "type": "boolean" + }, + "remoteId": { + "type": "string" } - ] + } }, - "Country": { + "ContentInfo": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class is representing a country.", + "description": "This class provides all version independent information of the content item.", "type": "object", "required": [ - "_id", - "name", - "Alpha2", - "Alpha3", - "IDC" + "Content" ], "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" + "Content": { + "description": "Content ID matcher class.", + "$ref": "#/components/schemas/Content" } } } ] }, - "CountryListWrapper": { + "ContentInfoWrapper": { "type": "object", "required": [ - "CountryList" + "ContentInfo" ], "properties": { - "CountryList": { - "$ref": "#/components/schemas/CountryList" + "ContentInfo": { + "$ref": "#/components/schemas/ContentInfo" } } }, - "View": { - "description": "View.", + "ContentMetadataUpdate": { + "description": "This class is used to update a Content metadata.", "type": "object", "required": [ - "identifier", - "User", - "public", - "LocationQuery", - "Result" + "ownerId", + "publishedDate", + "modificationDate", + "mainLanguageCode", + "alwaysAvailable", + "remoteId", + "mainLocationId", + "name" ], "properties": { - "identifier": { - "description": "Content identifier.", - "type": "string" + "ownerId": { + "type": [] }, - "User": { - "$ref": "#/components/schemas/User" + "publishedDate": { + "type": "string", + "format": "date-time" }, - "public": { + "modificationDate": { + "type": "string", + "format": "date-time" + }, + "mainLanguageCode": { + "type": "string" + }, + "alwaysAvailable": { "type": "boolean" }, - "LocationQuery": { - "$ref": "#/components/schemas/LocationQuery" + "remoteId": { + "type": "string" }, - "Result": { - "$ref": "#/components/schemas/BaseObject" + "mainLocationId": { + "type": [] + }, + "name": { + "type": "string" } } }, - "ViewInput": { - "description": "This class represents a View input.", + "ContentCreateContentType": { "type": "object", "required": [ - "identifier", - "Query" + "_href", + "FieldDefinitions" ], "properties": { - "identifier": { - "description": "Content identifier.", - "type": "string" - }, - "languageCode": { - "type": "string" - }, - "useAlwaysAvailable": { + "_href": { + "xml": { + "attribute": true, + "name": "href" + }, "type": "string" }, - "Query": { - "$ref": "#/components/schemas/Query" + "FieldDefinitions": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + }, + { + "type": "object", + "properties": { + "FieldDefinitions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FieldDefinition" + } + } + } + } + ] } } }, - "ViewInputWrapper": { + "ContentObjectStates": { + "description": "Represents a list of object states.", "type": "object", "required": [ - "ViewInput" + "ObjectState" ], "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.", + "ObjectState": { + "description": "List of object state values.", "type": "array", "items": { - "$ref": "#/components/schemas/FacetBuilder" + "$ref": "#/components/schemas/Href" } - }, - "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.", + "ContentObjectStatesWrapper": { "type": "object", + "required": [ + "ContentObjectStates" + ], "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" - } + "ContentObjectStates": { + "$ref": "#/components/schemas/ContentObjectStates" } } }, - "FacetBuilder": { - "description": "This class is the base class for facet builders.", + "VersionInfo": { + "description": "This class holds version information data. It also contains the corresponding {@link Content} to which the version belongs to.", "type": "object", "required": [ - "name", - "global", - "filter", - "limit", - "minCount" + "id", + "versionNo", + "status", + "modificationDate", + "Creator", + "creationDate", + "initialLanguageCode", + "languageCodes", + "VersionTranslationInfo", + "names", + "Content" ], "properties": { - "name": { - "description": "The name of the facet.", + "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" }, - "global": { - "description": "If true the facet runs in a global mode not restricted by the query.", - "type": "boolean" + "modificationDate": { + "description": "The last modified date of this version.", + "type": "string", + "format": "date-time" }, - "filter": { - "description": "An additional facet filter that will further filter the documents the facet will be executed on.", - "$ref": "#/components/schemas/Criterion" + "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" }, - "limit": { - "description": "Number of facets (terms) returned.", - "type": "integer" + "creationDate": { + "description": "Content creation date.", + "type": "string", + "format": "date-time" }, - "minCount": { - "description": "Specifies the minimum count. Only facet groups with more or equal results are returned.", - "type": "integer" + "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" } } }, - "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.", + "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": [ - "operator", - "valueFormat", - "valueTypes", - "valueCount" + "Version" ], "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" + "Version": { + "$ref": "#/components/schemas/Version" } } }, - "Role": { + "VersionUpdate": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class represents a role.", + "description": "This class is used to update a content version.", "type": "object", "required": [ - "identifier", - "Policies" + "modificationDate", + "initialLanguageCode", + "fields" ], "properties": { - "identifier": { - "description": "Readable string identifier of a role.", + "modificationDate": { + "type": "string", + "format": "date-time" + }, + "initialLanguageCode": { "type": "string" }, - "Policies": { - "description": "Returns the list of policies of this role.", - "$ref": "#/components/schemas/BaseObject" + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Field" + } } } } ] }, - "RoleWrapper": { + "VersionUpdateWrapper": { "type": "object", "required": [ - "Role" + "VersionUpdate" ], "properties": { - "Role": { - "$ref": "#/components/schemas/Role" + "VersionUpdate": { + "$ref": "#/components/schemas/VersionUpdate" } } }, - "RoleDraft": { - "description": "This class represents a draft of a role, extends Role.", - "$ref": "#/components/schemas/Role" + "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" + } + } + } + } + ] }, - "RoleDraftWrapper": { + "VersionListWrapper": { "type": "object", "required": [ - "Role" + "VersionList" ], "properties": { - "Role": { - "$ref": "#/components/schemas/RoleDraft" + "VersionList": { + "$ref": "#/components/schemas/VersionList" } } }, - "RoleInput": { - "description": "This class represents a Role input.", + "VersionItem": { + "description": "Version of content.", "type": "object", "required": [ - "identifier" + "Version", + "VersionInfo" ], "properties": { - "identifier": { - "type": "string" + "Version": { + "description": "Returns the VersionInfo for this version.", + "$ref": "#/components/schemas/BaseObject" + }, + "VersionInfo": { + "$ref": "#/components/schemas/VersionInfo" } } }, - "RoleInputWrapper": { + "VersionTranslationInfo": { + "description": "Translation information.", "type": "object", "required": [ - "RoleInput" + "_media-type", + "Language" ], "properties": { - "RoleInput": { - "$ref": "#/components/schemas/RoleInput" - } - } - }, - "RoleList": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "_media-type": { + "type": "string" }, - { - "description": "This class represents a list roles.", - "type": "object", - "required": [ - "Role" - ], - "properties": { - "Role": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Role" - } - } + "Language": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LanguageCode" } } - ] + } }, - "RoleListWrapper": { + "LanguageCode": { + "description": "Language code.", "type": "object", "required": [ - "RoleList" + "languageCode" ], "properties": { - "RoleList": { - "$ref": "#/components/schemas/RoleList" + "languageCode": { + "type": "string" } } }, - "Policy": { + "Relation": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class represents a policy value.", + "description": "Class representing a relation between content.", "type": "object", "required": [ - "id", - "module", - "function" + "SourceContent", + "DestinationContent", + "RelationType" ], "properties": { - "id": { - "description": "ID of the policy.", - "type": "integer" + "SourceContent": { + "description": "The content of the source content of the relation.", + "$ref": "#/components/schemas/Ref" }, - "module": { - "description": "Name of module, associated with the Policy e.g. content.", - "type": "string" + "DestinationContent": { + "description": "The content of the destination content of the relation.", + "$ref": "#/components/schemas/Ref" }, - "function": { - "description": "Name of the module function Or all functions with '*' e.g. read.", + "RelationType": { + "description": "The relation type bitmask. Relations: Relation::COMMON = 1, Relation::EMBED = 2, Relation::LINK = 4, Relation::FIELD = 8, Relation::ASSET = 16", "type": "string" - }, - "limitations": { - "description": "Limitations.", - "type": "object", - "required": [ - "limitation" - ], - "properties": { - "limitation": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Limitation" - } - } - } } } } ] }, - "PolicyWrapper": { + "RelationWrapper": { "type": "object", "required": [ - "Policy" + "Relation" ], "properties": { - "Policy": { - "$ref": "#/components/schemas/Policy" + "Relation": { + "$ref": "#/components/schemas/Relation" } } }, - "Limitation": { - "description": "This class represents a Limitation applied to a policy.", + "RelationCreate": { "type": "object", "required": [ - "_identifier", - "values" + "Destination" ], "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" - } - } - } + "Destination": { + "$ref": "#/components/schemas/Href" } } }, - "PolicyList": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - }, - { - "description": "List of policies.", - "type": "object", - "required": [ - "Policy" - ], - "properties": { - "Policy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Policy" - } - } - } - } - ] - }, - "PolicyListWrapper": { + "RelationCreateWrapper": { "type": "object", "required": [ - "PolicyList" + "RelationCreate" ], "properties": { - "PolicyList": { - "$ref": "#/components/schemas/PolicyList" + "RelationCreate": { + "$ref": "#/components/schemas/RelationCreate" } } }, - "PolicyCreate": { + "RelationList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class is used to create a Policy.", + "description": "Class representing a list of relations between content.", "type": "object", "required": [ - "module", - "function", - "Limitations" + "Relation" ], "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": { + "Relation": { "type": "array", "items": { - "$ref": "#/components/schemas/Limitation" + "$ref": "#/components/schemas/Relation" } } } } ] }, - "PolicyCreateWrapper": { + "RelationListWrapper": { "type": "object", "required": [ - "PolicyCreate" + "Relations" ], "properties": { - "PolicyCreate": { - "$ref": "#/components/schemas/PolicyCreate" + "Relations": { + "$ref": "#/components/schemas/RelationList" } } }, - "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": { + "Fields": { "type": "object", "required": [ - "PolicyUpdate" + "field" ], "properties": { - "PolicyUpdate": { - "$ref": "#/components/schemas/PolicyUpdate" + "field": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Field" + } } } }, - "RoleAssignment": { + "Section": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This value object represents an assignment of a User or User group to a role including a limitation.", + "description": "This class represents a Section.", "type": "object", "required": [ - "Role" + "sectionId", + "identifier", + "name" ], "properties": { - "limitation": { - "description": "Returns the limitation of the role assignment." + "sectionId": { + "description": "ID of the Section.", + "type": "integer" }, - "Role": { - "description": "Returns the role to which the User or User group is assigned to.", - "$ref": "#/components/schemas/Ref" + "identifier": { + "description": "Unique identifier of the Section.", + "type": "string" + }, + "name": { + "description": "Name of the Section.", + "type": "string" } } } ] }, - "RoleAssignmentWrapper": { + "SectionWrapper": { "type": "object", "required": [ - "RoleAssignment" + "Section" ], "properties": { - "RoleAssignment": { - "$ref": "#/components/schemas/RoleAssignment" + "Section": { + "$ref": "#/components/schemas/Section" } } }, - "RoleAssignInput": { - "description": "This class represents a Role assign input.", + "SectionInput": { "type": "object", "required": [ - "Role", - "limitation" + "identifier", + "name" ], "properties": { - "Role": { - "description": "Returns the Role to which the user or user group is assigned to.", - "$ref": "#/components/schemas/Ref" + "identifier": { + "type": "string" }, - "limitation": { - "description": "Returns the Limitation of the Role assignment.", - "$ref": "#/components/schemas/Limitation" + "name": { + "type": "string" } } }, - "RoleAssignInputWrapper": { + "SectionInputWrapper": { "type": "object", "required": [ - "RoleAssignInput" + "SectionInput" ], "properties": { - "RoleAssignInput": { - "$ref": "#/components/schemas/RoleAssignInput" + "SectionInput": { + "$ref": "#/components/schemas/SectionInput" } } }, - "RoleAssignmentList": { + "SectionList": { "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.", + "description": "This class represents a Section list.", "type": "object", "required": [ - "RoleAssignment" + "Section" ], "properties": { - "RoleAssignment": { + "Section": { "type": "array", "items": { - "$ref": "#/components/schemas/RoleAssignment" + "$ref": "#/components/schemas/Section" } } } } ] }, - "RoleAssignmentListWrapper": { + "SectionListWrapper": { "type": "object", "required": [ - "RoleAssignmentList" + "SectionList" ], "properties": { - "RoleAssignmentList": { - "$ref": "#/components/schemas/RoleAssignmentList" + "SectionList": { + "$ref": "#/components/schemas/SectionList" } } }, - "Session": { + "Trash": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "Value for session.", "type": "object", "required": [ - "name", - "identifier", - "csrfToken", - "User" + "TrashItem" ], "properties": { - "name": { - "description": "Name.", - "type": "string" - }, - "identifier": { - "description": "Identifier.", - "type": "string" - }, - "csrfToken": { - "description": "csrfToken.", - "type": "string" - }, - "User": { - "description": "User.", - "$ref": "#/components/schemas/BaseObject" + "TrashItem": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TrashItem" + } } } } ] }, - "SessionWrapper": { + "TrashWrapper": { "type": "object", "required": [ - "Session" + "Trash" ], "properties": { - "Session": { - "$ref": "#/components/schemas/Session" + "Trash": { + "$ref": "#/components/schemas/Trash" } } }, - "SessionInput": { + "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 session input.", + "description": "This class represents a content type group value.", "type": "object", "required": [ - "login", - "password" + "id", + "identifier", + "created", + "modified", + "Creator", + "Modifier", + "ContentTypes" ], "properties": { - "login": { - "type": "string" + "id": { + "description": "Primary key.", + "type": "integer" }, - "password": { + "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" } } } ] }, - "SessionInputWrapper": { + "ContentTypeGroupWrapper": { "type": "object", "required": [ - "SessionInput" + "ContentTypeGroup" ], "properties": { - "SessionInput": { - "$ref": "#/components/schemas/SessionInput" + "ContentTypeGroup": { + "$ref": "#/components/schemas/ContentTypeGroup" } } }, - "JWT": { - "description": "This class represents the JWT authentication token", + "ContentTypeGroupInput": { + "type": "object" + }, + "ContentTypeGroupInputWrapper": { "type": "object", "required": [ - "token" + "ContentTypeGroupInput" ], "properties": { - "token": { - "description": "JWT authentication token", - "type": "string" + "ContentTypeGroupInput": { + "$ref": "#/components/schemas/ContentTypeGroupInput" } } }, - "JWTWrapper": { + "ContentTypeGroupListWrapper": { "type": "object", "required": [ - "JWT" + "ContentTypeGroupList" ], "properties": { - "JWT": { - "$ref": "#/components/schemas/JWT" + "ContentTypeGroupList": { + "$ref": "#/components/schemas/ContentTypeGroupList" } } }, - "JWTInput": { + "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": "This class represents the input for a JWT authentication token", + "description": "List of content type groups references.", "type": "object", "required": [ - "username", - "password" + "ContentTypeGroupRef" ], "properties": { - "username": { - "description": "User name", - "type": "string" - }, - "password": { - "description": "User password", - "type": "string" + "ContentTypeGroupRef": { + "$ref": "#/components/schemas/ContentTypeGroupRef" } } } ] }, - "JWTInputWrapper": { + "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": [ - "JWTInput" + "ContentTypeGroupRefList" ], "properties": { - "JWTInput": { - "$ref": "#/components/schemas/JWTInput" + "ContentTypeGroupRefList": { + "$ref": "#/components/schemas/ContentTypeGroupRefList" } } }, - "UserGroup": { + "ContentType": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "Content ID matcher class.", + "description": "This class represents a content type.", "type": "object", "required": [ - "_remoteId", - "_id", - "ContentType", - "name", - "Versions", - "Section", - "MainLocation", - "Locations", - "Owner", - "lastModificationDate", - "mainLanguageCode", - "alwaysAvailable", - "Version", - "ParentUserGroup", - "Subgroups", - "Users", - "Roles" + "id", + "status", + "identifier", + "names", + "descriptions", + "creationDate", + "modificationDate", + "Creator", + "Modifier", + "Groups", + "Draft", + "remoteId", + "urlAliasSchema", + "nameSchema", + "isContainer", + "defaultAlwaysAvailable", + "defaultSortField", + "defaultSortOrder", + "FieldDefinitions" ], "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" - }, + "id": { + "description": "Content type ID.", "type": "integer" }, - "ContentType": { - "description": "Content type.", - "$ref": "#/components/schemas/Ref" - }, - "name": { + "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" }, - "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" + "identifier": { + "description": "String identifier of a content type.", + "type": "string" }, - "MainLocation": { - "$ref": "#/components/schemas/Ref" + "names": { + "description": "Name of a content type." }, - "Locations": { - "description": "Location of the content item.", - "$ref": "#/components/schemas/Ref" + "descriptions": { + "description": "Description of a content type." }, - "Owner": { - "description": "The owner of the content item.", - "$ref": "#/components/schemas/Ref" + "creationDate": { + "description": "Creation date of the content type.", + "type": "string", + "format": "date-time" }, - "lastModificationDate": { - "description": "Content item modification date.", + "modificationDate": { + "description": "Modification date of the content type.", "type": "string", "format": "date-time" }, - "mainLanguageCode": { - "description": "The main language code of the content item.", + "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" }, - "alwaysAvailable": { - "type": "boolean" + "urlAliasSchema": { + "description": "URL alias schema. If nothing is provided, $nameSchema will be used instead.", + "type": [ + "string", + "null" + ] }, - "Version": { - "$ref": "#/components/schemas/Version" + "nameSchema": { + "description": "Name schema. Can be composed of FieldDefinition identifier place holders.", + "type": "string" }, - "ParentUserGroup": { - "$ref": "#/components/schemas/Ref" + "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" }, - "Subgroups": { - "$ref": "#/components/schemas/Ref" + "defaultAlwaysAvailable": { + "description": "If an instance of a content type is created the always available flag is set by default to this value.", + "type": "boolean" }, - "Users": { - "$ref": "#/components/schemas/Ref" + "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" }, - "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" - } + "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." } } } ] }, - "UserGroupRefListWrapper": { + "ContentTypeWrapper": { "type": "object", "required": [ - "UserGroupRefList" + "ContentType" ], "properties": { - "UserGroupRefList": { - "$ref": "#/components/schemas/UserGroupRefList" + "ContentType": { + "$ref": "#/components/schemas/ContentType" } } }, - "UserGroupCreate": { - "description": "This class is used to create a User Group.", + "ContentTypeCreate": { + "description": "This class is used to create a content type.", "type": "object", "required": [ + "identifier", "mainLanguageCode", "remoteId", - "fields" + "urlAliasSchema", + "nameSchema", + "isContainer", + "defaultSortField", + "defaultSortOrder", + "defaultAlwaysAvailable", + "names", + "descriptions" ], "properties": { + "identifier": { + "type": "string" + }, "mainLanguageCode": { "type": "string" }, "remoteId": { "type": "string" }, - "fields": { - "$ref": "#/components/schemas/Fields" - } - } - }, - "UserGroupCreateWrapper": { - "type": "object", - "required": [ - "UserGroupCreate" - ], - "properties": { - "UserGroupCreate": { - "$ref": "#/components/schemas/UserGroupCreate" + "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" } } }, - "UserGroupUpdate": { - "description": "This class is used to update a User group in the Repository.", + "ContentTypeCreateWrapper": { "type": "object", "required": [ - "Section" + "ContentTypeCreate" ], "properties": { - "Section": { - "type": "object", - "required": [ - "_href" - ], - "properties": { - "_href": { - "xml": { - "attribute": true, - "name": "href" - }, - "type": "string" - } - } + "ContentTypeCreate": { + "$ref": "#/components/schemas/ContentTypeCreate" } } }, - "UserGroupUpdateWrapper": { + "ContentTypeUpdateStruct": { + "description": "This class is used for updating a content type.", "type": "object", - "required": [ - "UserGroupUpdate" - ], "properties": { - "UserGroupUpdate": { - "$ref": "#/components/schemas/UserGroupUpdate" - } - } - }, - "UserGroupUnassign": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "identifier": { + "description": "If set the unique identifier of a type is changed to this value.", + "type": "string" }, - { - "description": "This class represents a User group.", - "type": "object", - "required": [ - "Unassign" + "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" ], - "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": { + "defaultSortOrder": { + "description": "If set the default sort order is set to this value.", "enum": [ - "DELETE" + "ASC", + "DESC" ], "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" + "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." } } }, - "UserList": { + "ContentTypeUpdate": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class represents a list of users.", + "description": "This class is used to update a content type.", "type": "object", - "required": [ - "User" - ], "properties": { - "User": { - "type": "array", - "items": { - "$ref": "#/components/schemas/User" - } + "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" } } } ] }, - "UserListWrapper": { + "ContentTypeUpdateWrapper": { "type": "object", "required": [ - "UserList" + "ContentTypeUpdate" ], "properties": { - "UserList": { - "$ref": "#/components/schemas/UserList" + "ContentTypeUpdate": { + "$ref": "#/components/schemas/ContentTypeUpdate" } } }, - "UserRefList": { + "ContentTypeList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "Returns a list of the users.", + "description": "List of content types.", "type": "object", "required": [ - "User" + "ContentType" ], "properties": { - "User": { - "description": "This class represents a User.", + "ContentType": { "type": "array", "items": { - "$ref": "#/components/schemas/BaseObject" + "$ref": "#/components/schemas/ContentType" } } } } ] }, - "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": { + "ContentTypeListWrapper": { "type": "object", "required": [ - "UserCreate" + "ContentTypeList" ], "properties": { - "UserCreate": { - "$ref": "#/components/schemas/UserCreate" + "ContentTypeList": { + "$ref": "#/components/schemas/ContentTypeList" } } }, - "Event": { + "ContentTypeInfo": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "Calendar event.", + "description": "This class stores content type information.", "type": "object", "required": [ "id", - "datetime", - "type", - "name", - "attributes" + "status", + "identifier", + "names", + "descriptions", + "creationDate", + "modificationDate", + "Creator", + "Modifier", + "Groups", + "Draft", + "remoteId", + "urlAliasSchema", + "nameSchema", + "isContainer", + "mainLanguageCode", + "defaultAlwaysAvailable", + "defaultSortField", + "defaultSortOrder" ], "properties": { "id": { - "description": "The unique 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" }, - "datetime": { + "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" }, - "type": { - "description": "Event type identifier or name.", + "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" }, - "name": { - "description": "Name of the calendar event.", + "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" }, - "attributes": { - "description": "List of event attributes.", - "type": "array", - "items": { - "$ref": "#/components/schemas/EventAttribute" - } + "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" } } } ] }, - "EventAttribute": { + "ContentTypeInfoWrapper": { "type": "object", "required": [ - "label", - "value" + "ContentTypeInfo" ], "properties": { - "label": { - "description": "Label of the attribute.", - "type": "string" - }, - "value": { - "description": "Value of the attribute.", - "type": "string" + "ContentTypeInfo": { + "$ref": "#/components/schemas/ContentTypeInfo" } } }, - "EventList": { + "ContentTypeInfoList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "List of calendar events.", + "description": "List of content type information.", "type": "object", "required": [ - "_currentPage", - "totalCount", - "events" + "ContentType" ], "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": { + "ContentType": { + "description": "This class stores content type information.", "type": "array", "items": { - "$ref": "#/components/schemas/Event" + "$ref": "#/components/schemas/ContentTypeInfo" } } } } ] }, - "EventListWrapper": { + "ContentTypeInfoListWrapper": { "type": "object", "required": [ - "EventList" + "ContentTypeList" ], "properties": { - "EventList": { - "$ref": "#/components/schemas/EventList" + "ContentTypeList": { + "$ref": "#/components/schemas/ContentTypeInfoList" } } }, - "EventGroup": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "ContentTypeQuery": { + "description": "This class represents a content type query.", + "type": "object", + "properties": { + "limit": { + "description": "The maximum number of results to return.", + "type": "integer" }, - { - "description": "Event group.", + "offset": { + "description": "The offset to start returning results from.", + "type": "integer" + }, + "Query": { + "description": "An array of filters to apply to the query.", "type": "object", - "required": [ - "_currentPage", - "totalCount", - "events" - ], "properties": { - "_currentPage": { - "description": "Current page representation.", - "xml": { - "attribute": true, - "name": "currentPage" - }, - "type": "string" + "ContentTypeIdCriterion": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "integer" + } + }, + { + "type": "integer" + } + ] }, - "nextPage": { - "description": "Next page representation.", - "type": "string" + "ContentTypeIdentifierCriterion": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "string" + } + ] }, - "groupKey": { - "$ref": "#/components/schemas/DateRange" + "IsSystemCriterion": { + "type": "boolean" }, - "totalCount": { - "description": "Total count of events.", - "type": "integer" + "ContentTypeGroupIdCriterion": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "integer" + } + }, + { + "type": "integer" + } + ] }, - "events": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Event" - } + "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." + } + } }, - "EventGroupList": { + "FieldDefinition": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "Grouped calendar event list.", + "description": "This class represents a Field definition.", "type": "object", "required": [ - "groups" + "id", + "identifier", + "fieldType", + "fieldGroup", + "position", + "isTranslatable", + "isRequired", + "isInfoCollector", + "defaultValue", + "isSearchable", + "names", + "descriptions", + "fieldSettings", + "validatorConfiguration" ], "properties": { - "groups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EventGroup" - } + "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" + } + ] } } } ] }, - "EventGroupListWrapper": { + "FieldDefinitionWrapper": { "type": "object", "required": [ - "EventGroupList" + "FieldDefinition" ], "properties": { - "EventGroupList": { - "$ref": "#/components/schemas/EventGroupList" + "FieldDefinition": { + "$ref": "#/components/schemas/FieldDefinition" } } }, - "RescheduleAction": { - "description": "This class represents events to reschedule", + "FieldDefinitionCreate": { + "$ref": "#/components/schemas/BaseObject" + }, + "FieldDefinitionCreateWrapper": { "type": "object", "required": [ - "events", - "dateTime" + "FieldDefinitionCreate" ], "properties": { - "events": { - "description": "list of events", - "type": "array", - "items": { - "type": "string" - } - }, - "dateTime": { - "description": "timestamp to reschedule events to", - "type": "integer" + "FieldDefinitionCreate": { + "$ref": "#/components/schemas/FieldDefinitionCreate" } } }, - "RescheduleActionWrapper": { + "FieldDefinitionUpdate": { + "$ref": "#/components/schemas/BaseObject" + }, + "FieldDefinitionUpdateWrapper": { "type": "object", "required": [ - "RescheduleAction" + "FieldDefinitionUpdate" ], "properties": { - "RescheduleAction": { - "$ref": "#/components/schemas/RescheduleAction" + "FieldDefinitionUpdate": { + "$ref": "#/components/schemas/FieldDefinitionUpdate" } } }, - "UnscheduleAction": { - "description": "This class represents events to unschedule", + "FieldDefinitions": { "type": "object", "required": [ - "events" + "FieldDefinition" ], "properties": { - "events": { - "description": "list of events", + "FieldDefinition": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/FieldDefinition" } } } }, - "UnscheduleActionWrapper": { + "FieldDefinitionsWrapper": { "type": "object", "required": [ - "UnscheduleAction" + "FieldDefinitions" ], "properties": { - "UnscheduleAction": { - "$ref": "#/components/schemas/UnscheduleAction" + "FieldDefinitions": { + "$ref": "#/components/schemas/FieldDefinitions" } } }, - "AttributeGroup": { - "description": "This class represents an attribute group.", + "StringLengthValidator": { + "description": "Validator for checking min. and max. length of strings.", "type": "object", "required": [ - "name", - "identifier", - "position" + "maxStringLength", + "minStringLength" ], "properties": { - "name": { - "type": "string" - }, - "identifier": { - "type": "string" + "maxStringLength": { + "description": "Maximum length of strings.", + "type": [ + "integer", + "null" + ] }, - "position": { - "type": "integer" + "minStringLength": { + "description": "Minimum length of strings.", + "type": [ + "integer", + "null" + ] } } }, - "AttributeGroupWrapper": { + "StringLengthValidatorWrapper": { "type": "object", "required": [ - "AttributeGroup" + "StringLengthValidator" ], "properties": { - "AttributeGroup": { - "$ref": "#/components/schemas/AttributeGroup" + "StringLengthValidator": { + "$ref": "#/components/schemas/StringLengthValidator" } } }, - "AttributeGroupCreate": { - "description": "This class is used to create an attribute group.", - "type": "object", - "required": [ - "identifier", - "names", - "position" - ], - "properties": { - "identifier": { - "type": "string" - }, - "names": { - "type": "object" + "UrlAlias": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "position": { - "type": "integer" + { + "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" + } + } } - } + ] }, - "AttributeGroupCreateWrapper": { + "UrlAliasWrapper": { "type": "object", "required": [ - "AttributeGroupCreate" + "UrlAlias" ], "properties": { - "AttributeGroupCreate": { - "$ref": "#/components/schemas/AttributeGroupCreate" + "UrlAlias": { + "$ref": "#/components/schemas/UrlAlias" } } }, - "AttributeGroupUpdate": { - "description": "This class is used to update an attribute group.", + "UrlAliasCreate": { "type": "object", "required": [ - "identifier", - "names", - "position" + "_type" ], "properties": { - "identifier": { + "_type": { "type": "string" }, - "names": { - "type": "object" + "location": { + "$ref": "#/components/schemas/Href" }, - "position": { - "type": "integer" + "resource": { + "type": "string" + }, + "languageCode": { + "type": "string" + }, + "alwaysAvailable": { + "type": [ + "string", + "boolean" + ] + }, + "forward": { + "type": [ + "string", + "boolean" + ] } } }, - "AttributeGroupUpdateWrapper": { + "UrlAliasCreateWrapper": { "type": "object", "required": [ - "AttributeGroupUpdate" + "UrlAliasCreate" ], "properties": { - "AttributeGroupUpdate": { - "$ref": "#/components/schemas/AttributeGroupUpdate" + "UrlAliasCreate": { + "$ref": "#/components/schemas/UrlAliasCreate" } } }, - "AttributeGroupList": { + "UrlAliasRefList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class represents an attribute group list.", + "description": "List of URL alias in the Repository.", "type": "object", "required": [ - "AttributeGroup" + "UrlAlias" ], "properties": { - "AttributeGroup": { + "UrlAlias": { "type": "array", "items": { - "$ref": "#/components/schemas/AttributeGroup" + "$ref": "#/components/schemas/Ref" } } } } ] }, - "AttributeGroupListWrapper": { + "UrlAliasRefListWrapper": { "type": "object", "required": [ - "AttributeGroupList" + "UrlAliasRefList" ], "properties": { - "AttributeGroupList": { - "$ref": "#/components/schemas/AttributeGroupList" + "UrlAliasRefList": { + "$ref": "#/components/schemas/UrlAliasRefList" } } }, - "AttributeGroupListGet": { - "description": "This class represents an attribute group list request.", + "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": [ - "prefix", - "offset", - "limit" + "UrlWildcard" ], "properties": { - "prefix": { + "UrlWildcard": { + "$ref": "#/components/schemas/UrlWildcard" + } + } + }, + "UrlWildcardCreate": { + "description": "Creates a new URL wildcard.", + "type": "object", + "required": [ + "sourceUrl", + "destinationUrl", + "forward" + ], + "properties": { + "sourceUrl": { "type": "string" }, - "offset": { - "type": "integer" + "destinationUrl": { + "type": "string" }, - "limit": { - "type": "integer" + "forward": { + "type": [ + "string", + "boolean" + ] } } }, - "AttributeGroupListGetWrapper": { + "UrlWildcardCreateWrapper": { "type": "object", "required": [ - "AttributeGroupListGet" + "URLWildcardCreate" ], "properties": { - "AttributeGroupListGet": { - "$ref": "#/components/schemas/AttributeGroupListGet" + "URLWildcardCreate": { + "$ref": "#/components/schemas/UrlWildcardCreate" } } }, - "AttributeGroupGet": { - "description": "This class represents an attribute group query.", + "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": [ - "languages" + "UrlWildcardList" ], "properties": { - "languages": { - "type": "array", - "items": { - "type": "string" - } + "UrlWildcardList": { + "$ref": "#/components/schemas/UrlWildcardList" } } }, - "AttributeGroupGetWrapper": { + "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": [ - "AttributeGroupGet" + "Language" ], "properties": { - "AttributeGroupGet": { - "$ref": "#/components/schemas/AttributeGroupGet" + "Language": { + "$ref": "#/components/schemas/Language" } } }, - "AttributeGroupListResult": { + "LanguageList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { + "description": "List of languages.", "type": "object", - "required": [ - "count", - "AttributeGroupList" + "required": [ + "Language" ], "properties": { - "count": { - "type": "integer" - }, - "AttributeGroupList": { - "$ref": "#/components/schemas/AttributeGroupList" + "Language": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } } } } ] }, - "AttributeGroupView": { + "LanguageListWrapper": { + "type": "object", + "required": [ + "LanguageList" + ], + "properties": { + "LanguageList": { + "$ref": "#/components/schemas/LanguageList" + } + } + }, + "ObjectState": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class represents an attribute group view.", + "description": "This class represents a Object state value.", "type": "object", "required": [ + "id", "identifier", - "Result" + "priority", + "ObjectStateGroup", + "languageCodes", + "names", + "descriptions" ], "properties": { + "id": { + "description": "Primary key.", + "type": "integer" + }, "identifier": { + "description": "Readable string identifier of the Object state.", "type": "string" }, - "Result": { - "$ref": "#/components/schemas/AttributeGroupListResult" + "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." } } } ] }, - "AttributeGroupViewWrapper": { + "ObjectStateWrapper": { "type": "object", "required": [ - "AttributeGroupView" + "ObjectState" ], "properties": { - "AttributeGroupView": { - "$ref": "#/components/schemas/AttributeGroupView" + "ObjectState": { + "$ref": "#/components/schemas/ObjectState" } } }, - "AttributeGroupViewInput": { - "description": "This class represents an attribute group view input.", - "xml": { - "name": "ViewInput" - }, + "ObjectStateCreate": { + "description": "This class represents a value for creating Object states.", "type": "object", "required": [ "identifier", - "AttributeGroupQuery" + "priority", + "defaultLanguageCode", + "languageCodes", + "names", + "descriptions" ], "properties": { "identifier": { + "description": "Readable unique string identifier of a group.", "type": "string" }, - "AttributeGroupQuery": { + "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": [ - "limit", - "offset", - "name_prefix" + "value" ], "properties": { - "limit": { - "type": "string" - }, - "offset": { - "type": "string" - }, - "name_prefix": { - "type": "string" + "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" + } } } } } }, - "AttributeGroupViewInputWrapper": { + "ObjectStateCreateWrapper": { "type": "object", "required": [ - "ViewInput" + "ObjectStateCreate" ], "properties": { - "ViewInput": { - "$ref": "#/components/schemas/AttributeGroupViewInput" + "ObjectStateCreate": { + "$ref": "#/components/schemas/ObjectStateCreate" } } }, - "AttributeType": { - "description": "This class represents an attribute type.", + "ObjectStateUpdate": { + "description": "This class represents a value for updating Object states.", "type": "object", - "required": [ - "identifier", - "name" - ], "properties": { "identifier": { + "description": "Readable unique string identifier of a group.", "type": "string" }, - "name": { + "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." } } }, - "AttributeTypeWrapper": { + "ObjectStateUpdateWrapper": { "type": "object", "required": [ - "AttributeType" + "ObjectStateUpdate" ], "properties": { - "AttributeType": { - "$ref": "#/components/schemas/AttributeType" + "ObjectStateUpdate": { + "$ref": "#/components/schemas/ObjectStateUpdate" } } }, - "AttributeTypeList": { - "description": "This class represents an attribute type list.", - "type": "object", - "required": [ - "attributeTypes" - ], - "properties": { - "attributeTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttributeType" + "ObjectStateList": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + }, + { + "description": "List of Object states.", + "type": "object", + "required": [ + "ObjectState" + ], + "properties": { + "ObjectState": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectState" + } + } } } - } + ] }, - "AttributeTypeListWrapper": { + "ObjectStateListWrapper": { "type": "object", "required": [ - "AttributeTypeList" + "ObjectStateList" ], "properties": { - "AttributeTypeList": { - "$ref": "#/components/schemas/AttributeTypeList" + "ObjectStateList": { + "$ref": "#/components/schemas/ObjectStateList" } } }, - "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" + "ObjectStateGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "options": { - "type": [ - "object", - "array" - ] + { + "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." + } + } } - } + ] }, - "AttributeWrapper": { + "ObjectStateGroupWrapper": { "type": "object", "required": [ - "Attribute" + "ObjectStateGroup" ], "properties": { - "Attribute": { - "$ref": "#/components/schemas/Attribute" + "ObjectStateGroup": { + "$ref": "#/components/schemas/ObjectStateGroup" } } }, - "AttributeCreate": { - "description": "This class is used to create an attribute.", + "ObjectStateGroupCreate": { + "description": "This class represents a value for creating Object state groups.", "type": "object", "required": [ "identifier", - "type", - "group", + "defaultLanguageCode", "names", - "descriptions", - "position", - "options" + "descriptions" ], "properties": { "identifier": { + "description": "Readable unique string identifier of a group.", "type": "string" }, - "type": { - "type": "string" - }, - "group": { + "defaultLanguageCode": { + "description": "The default language code.", "type": "string" }, "names": { - "type": "object" + "description": "An array of names with languageCode keys. At least one name in the main language is required." }, "descriptions": { - "type": "object" - }, - "position": { - "type": "integer" - }, - "options": { - "type": [ - "object", - "array" - ] + "description": "An array of descriptions with languageCode keys." } } }, - "AttributeCreateWrapper": { + "ObjectStateGroupCreateWrapper": { "type": "object", "required": [ - "AttributeCreate" + "ObjectStateGroupCreate" ], "properties": { - "AttributeCreate": { - "$ref": "#/components/schemas/AttributeCreate" + "ObjectStateGroupCreate": { + "$ref": "#/components/schemas/ObjectStateGroupCreate" } } }, - "AttributeUpdate": { - "description": "This class is used to update an attribute.", + "ObjectStateGroupUpdate": { + "description": "This class represents a value for updating Object state groups.", "type": "object", - "required": [ - "identifier", - "names", - "descriptions", - "position", - "options" - ], "properties": { "identifier": { + "description": "Readable unique string identifier of a group.", + "type": "string" + }, + "defaultLanguageCode": { + "description": "The default language code.", "type": "string" }, "names": { - "type": "object" + "description": "An array of names with languageCode keys." }, "descriptions": { - "type": "object" - }, - "position": { - "type": "integer" - }, - "options": { - "type": "object" + "description": "An array of descriptions with languageCode keys." } } }, - "AttributeUpdateWrapper": { + "ObjectStateGroupUpdateWrapper": { "type": "object", "required": [ - "AttributeUpdate" + "ObjectStateGroupUpdate" ], "properties": { - "AttributeUpdate": { - "$ref": "#/components/schemas/AttributeUpdate" + "ObjectStateGroupUpdate": { + "$ref": "#/components/schemas/ObjectStateGroupUpdate" } } }, - "AttributeListGet": { - "description": "This class represents an attribute list query", - "type": "object", - "properties": { - "group_name_prefix": { - "type": "string" - }, - "name_prefix": { - "type": "string" - }, - "offset": { - "type": "integer" + "ObjectStateGroupList": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "limit": { - "type": "integer" + { + "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" + } + } + } } - } + ] }, - "AttributeListGetWrapper": { + "ObjectStateGroupListWrapper": { "type": "object", "required": [ - "AttributeListGet" + "ObjectStateGroupList" ], "properties": { - "AttributeListGet": { - "$ref": "#/components/schemas/AttributeListGet" + "ObjectStateGroupList": { + "$ref": "#/components/schemas/ObjectStateGroupList" } } }, - "AttributeList": { - "description": "This class represents an attribute list.", - "type": "object", - "required": [ - "Attribute" - ], - "properties": { - "Attribute": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Attribute" + "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" + } + } } } - } + ] }, - "AttributeListWrapper": { + "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": [ - "AttributeList" + "CountryList" ], "properties": { - "AttributeList": { - "$ref": "#/components/schemas/AttributeList" + "CountryList": { + "$ref": "#/components/schemas/CountryList" } } }, - "AttributeView": { - "description": "This class represents an attribute view.", + "View": { + "description": "View.", "type": "object", "required": [ "identifier", - "AttributeQuery", + "User", + "public", + "LocationQuery", "Result" ], "properties": { "identifier": { + "description": "Content identifier.", "type": "string" }, - "AttributeQuery": { - "type": "object" + "User": { + "$ref": "#/components/schemas/User" + }, + "public": { + "type": "boolean" + }, + "LocationQuery": { + "$ref": "#/components/schemas/LocationQuery" }, "Result": { - "type": "object" - } - } - }, - "AttributeViewWrapper": { - "type": "object", - "required": [ - "AttributeView" - ], - "properties": { - "AttributeView": { - "$ref": "#/components/schemas/AttributeView" + "$ref": "#/components/schemas/BaseObject" } } }, - "AttributeViewInput": { - "description": "This class represents an attribute view input.", - "xml": { - "name": "ViewInput" - }, + "ViewInput": { + "description": "This class represents a View input.", "type": "object", "required": [ "identifier", - "AttributeQuery" + "Query" ], "properties": { "identifier": { + "description": "Content identifier.", "type": "string" }, - "AttributeQuery": { - "type": "object" + "languageCode": { + "type": "string" + }, + "useAlwaysAvailable": { + "type": "string" + }, + "Query": { + "$ref": "#/components/schemas/Query" } } }, - "AttributeViewInputWrapper": { + "ViewInputWrapper": { "type": "object", "required": [ "ViewInput" ], "properties": { "ViewInput": { - "$ref": "#/components/schemas/AttributeViewInput" + "$ref": "#/components/schemas/ViewInput" } } }, - "AttributeAssignment": { + "Query": { + "description": "This class is used to perform a Content query.", "type": "object", - "required": [ - "is_required", - "is_discriminator", - "Attribute" - ], "properties": { - "is_required": { - "type": "boolean" + "Filter": { + "description": "The Query filter. Can contain multiple criterion, as items of a logical one (by default AND).", + "$ref": "#/components/schemas/Criterion" }, - "is_discriminator": { + "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" }, - "Attribute": { - "$ref": "#/components/schemas/Attribute" + "performCount": { + "description": "If true, search engine should perform count even if that means extra lookup.", + "type": "boolean" } } }, - "Catalog": { - "description": "This class represents a catalog.", + "LocationQuery": { + "description": "This class is used to perform a Location query.", + "$ref": "#/components/schemas/Query" + }, + "Criterion": { + "description": "Criterion implementations.", "type": "object", - "required": [ - "identifier", - "name", - "description", - "created", - "modified", - "status", - "User", - "Criteria" - ], "properties": { - "identifier": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { + "operator": { + "description": "The operator used by the Criterion.", "type": "string" }, - "created": { - "type": "integer" - }, - "modified": { - "type": "integer" + "value": { + "description": "The value(s) matched by the Criteria.", + "type": "array", + "items": { + "type": [] + } }, - "status": { + "target": { + "description": "The target used by the Criteria (field, metadata...).", "type": "string" }, - "User": { - "$ref": "#/components/schemas/Ref" + "valueData": { + "description": "Additional value data, required by some Criteria, MapLocationDistance for instance." }, - "Criteria": { + "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/Criterion" + "$ref": "#/components/schemas/Specifications" } } } }, - "CatalogWrapper": { + "FacetBuilder": { + "description": "This class is the base class for facet builders.", "type": "object", "required": [ - "Catalog" + "name", + "global", + "filter", + "limit", + "minCount" ], "properties": { - "Catalog": { - "$ref": "#/components/schemas/Catalog" + "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" } } }, - "CatalogCreate": { - "description": "This class is used to create a catalog.", + "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": [ - "identifier", - "criteria", - "names", - "status" + "operator", + "valueFormat", + "valueTypes", + "valueCount" ], "properties": { - "identifier": { + "operator": { + "description": "Specified operator, as one of the Operator::* constants.", "type": "string" }, - "criteria": { - "$ref": "#/components/schemas/Criterion" - }, - "names": { - "type": "object" - }, - "descriptions": { - "type": "object" - }, - "status": { + "valueFormat": { + "description": "Format supported for the Criterion value, either {@see self::FORMAT_SINGLE} for single or {@see self::FORMAT_ARRAY} for multiple.", "type": "string" }, - "creator_id": { + "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" } } }, - "CatalogCreateWrapper": { + "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": [ - "CatalogCreate" + "Role" ], "properties": { - "CatalogCreate": { - "$ref": "#/components/schemas/CatalogCreate" + "Role": { + "$ref": "#/components/schemas/Role" } } }, - "CatalogUpdate": { - "description": "This class is used to update a catalog.", + "RoleDraft": { + "description": "This class represents a draft of a role, extends Role.", + "$ref": "#/components/schemas/Role" + }, + "RoleDraftWrapper": { "type": "object", "required": [ - "identifier", - "transition", - "criteria", - "names", - "descriptions" + "Role" + ], + "properties": { + "Role": { + "$ref": "#/components/schemas/RoleDraft" + } + } + }, + "RoleInput": { + "description": "This class represents a Role input.", + "type": "object", + "required": [ + "identifier" ], "properties": { "identifier": { "type": "string" - }, - "transition": { - "type": "string" - }, - "criteria": { - "$ref": "#/components/schemas/Criterion" - }, - "names": { - "type": "object" - }, - "descriptions": { - "type": "object" } } }, - "CatalogUpdateWrapper": { + "RoleInputWrapper": { "type": "object", "required": [ - "CatalogUpdate" + "RoleInput" ], "properties": { - "CatalogUpdate": { - "$ref": "#/components/schemas/CatalogUpdate" + "RoleInput": { + "$ref": "#/components/schemas/RoleInput" } } }, - "CatalogCopy": { - "description": "This class is used to copy a catalog.", + "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": [ - "identifier", - "creator_id" + "RoleList" ], "properties": { - "identifier": { - "type": "string" - }, - "creator_id": { - "description": "Optional", - "type": "integer" + "RoleList": { + "$ref": "#/components/schemas/RoleList" } } }, - "CatalogCopyWrapper": { + "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": [ - "CatalogCopy" + "Policy" ], "properties": { - "CatalogCopy": { - "$ref": "#/components/schemas/CatalogCopy" + "Policy": { + "$ref": "#/components/schemas/Policy" } } }, - "CatalogList": { - "description": "This class represents a catalog list.", + "Limitation": { + "description": "This class represents a Limitation applied to a policy.", "type": "object", "required": [ - "Catalog" + "_identifier", + "values" ], "properties": { - "Catalog": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Catalog" + "_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" + } + } } } } }, - "CatalogListViewResult": { + "PolicyList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { + "description": "List of policies.", "type": "object", "required": [ - "CatalogList" + "Policy" ], "properties": { - "CatalogList": { - "$ref": "#/components/schemas/CatalogList" + "Policy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Policy" + } } } } ] }, - "CatalogView": { + "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": [ - "identifier", - "CatalogQuery", - "Result" + "module", + "function", + "Limitations" ], "properties": { - "identifier": { + "module": { + "description": "Name of module associated with the Policy. For example, content.", "type": "string" }, - "CatalogQuery": { - "$ref": "#/components/schemas/Ref" + "function": { + "description": "Name of the module function, or all functions with ''*''. For example, read.", + "type": "string" }, - "Result": { - "$ref": "#/components/schemas/CatalogListViewResult" + "Limitations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Limitation" + } } } } ] }, - "CatalogViewWrapper": { + "PolicyCreateWrapper": { "type": "object", "required": [ - "CatalogView" + "PolicyCreate" ], "properties": { - "CatalogView": { - "$ref": "#/components/schemas/CatalogView" + "PolicyCreate": { + "$ref": "#/components/schemas/PolicyCreate" } } }, - "CatalogViewInput": { - "description": "This class represents a catalog view input.", - "xml": { - "name": "ViewInput" - }, - "type": "object", - "required": [ - "CatalogQuery" - ], - "properties": { - "CatalogQuery": { - "type": "object" + "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" + } + } + } } - } + ] }, - "CatalogViewInputWrapper": { + "PolicyUpdateWrapper": { "type": "object", "required": [ - "ViewInput" + "PolicyUpdate" ], "properties": { - "ViewInput": { - "$ref": "#/components/schemas/CatalogViewInput" + "PolicyUpdate": { + "$ref": "#/components/schemas/PolicyUpdate" } } }, - "Currency": { + "RoleAssignment": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class represents currency.", + "description": "This value object represents an assignment of a User or User group to a role including a limitation.", "type": "object", "required": [ - "id", - "code", - "subunits", - "enabled" + "Role" ], "properties": { - "id": { - "type": "integer" - }, - "code": { - "type": "string" - }, - "subunits": { - "type": "integer" + "limitation": { + "description": "Returns the limitation of the role assignment." }, - "enabled": { - "type": "boolean" + "Role": { + "description": "Returns the role to which the User or User group is assigned to.", + "$ref": "#/components/schemas/Ref" } } } ] }, - "CurrencyWrapper": { + "RoleAssignmentWrapper": { "type": "object", "required": [ - "Currency" + "RoleAssignment" ], "properties": { - "Currency": { - "$ref": "#/components/schemas/Currency" + "RoleAssignment": { + "$ref": "#/components/schemas/RoleAssignment" } } }, - "CurrencyCreate": { - "description": "This class is used to create currency.", + "RoleAssignInput": { + "description": "This class represents a Role assign input.", "type": "object", "required": [ - "code", - "subunits", - "enabled" + "Role", + "limitation" ], "properties": { - "code": { - "type": "string" - }, - "subunits": { - "type": "integer" + "Role": { + "description": "Returns the Role to which the user or user group is assigned to.", + "$ref": "#/components/schemas/Ref" }, - "enabled": { - "type": "boolean" + "limitation": { + "description": "Returns the Limitation of the Role assignment.", + "$ref": "#/components/schemas/Limitation" } } }, - "CurrencyCreateWrapper": { + "RoleAssignInputWrapper": { "type": "object", "required": [ - "CurrencyCreate" + "RoleAssignInput" ], "properties": { - "CurrencyCreate": { - "$ref": "#/components/schemas/CurrencyCreate" + "RoleAssignInput": { + "$ref": "#/components/schemas/RoleAssignInput" } } }, - "CurrencyUpdate": { - "description": "This class is used to update currency.", - "type": "object", - "required": [ - "subunits", - "enabled" - ], - "properties": { - "subunits": { - "type": "integer" + "RoleAssignmentList": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "enabled": { - "type": "boolean" + { + "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" + } + } + } } - } + ] }, - "CurrencyUpdateWrapper": { + "RoleAssignmentListWrapper": { "type": "object", "required": [ - "CurrencyUpdate" + "RoleAssignmentList" ], "properties": { - "CurrencyUpdate": { - "$ref": "#/components/schemas/CurrencyUpdate" + "RoleAssignmentList": { + "$ref": "#/components/schemas/RoleAssignmentList" } } }, - "CurrencyView": { - "description": "This class represents a currency view.", - "type": "object", - "required": [ - "identifier", - "CurrencyQuery", - "Result" - ], - "properties": { - "identifier": { - "type": "string" - }, - "CurrencyQuery": { - "type": "object" + "Session": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "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" + { + "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" + } } } - } + ] }, - "CurrencyListWrapper": { + "SessionWrapper": { "type": "object", "required": [ - "CurrencyList" + "Session" ], "properties": { - "CurrencyList": { - "$ref": "#/components/schemas/CurrencyList" + "Session": { + "$ref": "#/components/schemas/Session" } } }, - "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" + "SessionInput": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "users": { - "description": "A list of users attached to the customer group.", - "type": "array", - "items": { - "$ref": "#/components/schemas/User" + { + "description": "This class represents a session input.", + "type": "object", + "required": [ + "login", + "password" + ], + "properties": { + "login": { + "type": "string" + }, + "password": { + "type": "string" + } } - }, - "global_price_rate": { - "description": "A numeric string", - "type": "string" } - } + ] }, - "CustomerGroupWrapper": { + "SessionInputWrapper": { "type": "object", "required": [ - "CustomerGroup" + "SessionInput" ], "properties": { - "CustomerGroup": { - "$ref": "#/components/schemas/CustomerGroup" + "SessionInput": { + "$ref": "#/components/schemas/SessionInput" } } }, - "CustomerGroupCreate": { - "description": "This class is used to create a customer group.", + "JWT": { + "description": "This class represents the JWT authentication token", "type": "object", "required": [ - "identifier", - "names", - "descriptions", - "global_price_rate" + "token" ], "properties": { - "identifier": { - "type": "string" - }, - "names": { - "type": "object" - }, - "descriptions": { - "type": "object" - }, - "global_price_rate": { - "description": "numeric-string", + "token": { + "description": "JWT authentication token", "type": "string" } } }, - "CustomerGroupCreateWrapper": { + "JWTWrapper": { "type": "object", "required": [ - "CustomerGroupCreate" + "JWT" ], "properties": { - "CustomerGroupCreate": { - "$ref": "#/components/schemas/CustomerGroupCreate" + "JWT": { + "$ref": "#/components/schemas/JWT" } } }, - "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" + "JWTInput": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "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" + { + "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" + } } } - } + ] }, - "CustomerGroupListWrapper": { + "JWTInputWrapper": { "type": "object", "required": [ - "CustomerGroupList" + "JWTInput" ], "properties": { - "CustomerGroupList": { - "$ref": "#/components/schemas/CustomerGroupList" + "JWTInput": { + "$ref": "#/components/schemas/JWTInput" } } }, - "CustomerGroupListResult": { + "UserGroup": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { + "description": "Content ID matcher class.", "type": "object", "required": [ - "CustomerGroupList" + "_remoteId", + "_id", + "ContentType", + "name", + "Versions", + "Section", + "MainLocation", + "Locations", + "Owner", + "lastModificationDate", + "mainLanguageCode", + "alwaysAvailable", + "Version", + "ParentUserGroup", + "Subgroups", + "Users", + "Roles" ], "properties": { - "CustomerGroupList": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - }, - { - "type": "object", - "required": [ - "CustomerGroup" - ], - "properties": { - "CustomerGroup": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerGroup" - } - } - } - } - ] + "_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" } } } ] }, - "CustomerGroupViewInput": { - "description": "This class represents a customer group view input.", - "xml": { - "name": "ViewInput" - }, + "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": [ - "CustomerGroupQuery" + "UserGroupList" ], "properties": { - "CustomerGroupQuery": { - "type": "object" + "UserGroupList": { + "$ref": "#/components/schemas/UserGroupList" } } }, - "CustomerGroupViewInputWrapper": { + "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": [ - "ViewInput" + "UserGroupRefList" ], "properties": { - "ViewInput": { - "$ref": "#/components/schemas/CustomerGroupViewInput" + "UserGroupRefList": { + "$ref": "#/components/schemas/UserGroupRefList" } } }, - "CustomerGroupView": { - "description": "This class represents a customer group view.", + "UserGroupCreate": { + "description": "This class is used to create a User Group.", "type": "object", "required": [ - "identifier", - "CustomerGroupQuery", - "Result" + "mainLanguageCode", + "remoteId", + "fields" ], "properties": { - "identifier": { + "mainLanguageCode": { "type": "string" }, - "CustomerGroupQuery": { - "type": "object" + "remoteId": { + "type": "string" }, - "Result": { - "$ref": "#/components/schemas/CustomerGroupListResult" + "fields": { + "$ref": "#/components/schemas/Fields" } } }, - "CustomerGroupViewWrapper": { + "UserGroupCreateWrapper": { "type": "object", "required": [ - "CustomerGroupView" + "UserGroupCreate" ], "properties": { - "CustomerGroupView": { - "$ref": "#/components/schemas/CustomerGroupView" + "UserGroupCreate": { + "$ref": "#/components/schemas/UserGroupCreate" } } }, - "Region": { - "description": "This class represents a region.", + "UserGroupUpdate": { + "description": "This class is used to update a User group in the Repository.", "type": "object", "required": [ - "identifier" + "Section" ], "properties": { - "identifier": { - "type": "string" + "Section": { + "type": "object", + "required": [ + "_href" + ], + "properties": { + "_href": { + "xml": { + "attribute": true, + "name": "href" + }, + "type": "string" + } + } } } }, - "RegionWrapper": { + "UserGroupUpdateWrapper": { "type": "object", "required": [ - "Region" + "UserGroupUpdate" ], "properties": { - "Region": { - "$ref": "#/components/schemas/Region" + "UserGroupUpdate": { + "$ref": "#/components/schemas/UserGroupUpdate" } } }, - "RegionList": { - "description": "This class represents a region list.", - "type": "object", - "required": [ - "Region" - ], - "properties": { - "Region": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Ref" + "UserGroupUnassign": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + }, + { + "description": "This class represents a User group.", + "type": "object", + "required": [ + "Unassign" + ], + "properties": { + "Unassign": { + "$ref": "#/components/schemas/Unlink" + } } } - } + ] }, - "RegionListWrapper": { + "Unlink": { + "description": "Unlink a content type group from a content type.", "type": "object", "required": [ - "RegionList" + "_href", + "_method" ], "properties": { - "RegionList": { - "$ref": "#/components/schemas/RegionList" + "_href": { + "type": "string" + }, + "_method": { + "enum": [ + "DELETE" + ], + "type": "string" } } }, - "RegionView": { - "description": "This class represents a region view.", + "User": { "type": "object", - "required": [ - "identifier", - "RegionQuery", - "Result" - ], + "description": "Reference to a registered user account", "properties": { - "identifier": { - "type": "string" - }, - "RegionQuery": { - "type": "object" + "_media-type": { + "type": "string", + "description": "Media type identifier for the user reference" }, - "Result": { - "type": "object" + "_href": { + "type": "string", + "description": "REST API URL reference to the user resource", + "format": "uri" } - } + }, + "required": [ + "_media-type", + "_href" + ], + "additionalProperties": false }, - "RegionViewWrapper": { + "UserWrapper": { "type": "object", "required": [ - "RegionView" + "User" ], "properties": { - "RegionView": { - "$ref": "#/components/schemas/RegionView" + "User": { + "$ref": "#/components/schemas/User" } } }, - "RegionViewInput": { - "description": "This class represents a region view input.", - "xml": { - "name": "ViewInput" - }, + "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": [ - "RegionQuery" + "UserList" ], "properties": { - "RegionQuery": { - "type": "object" + "UserList": { + "$ref": "#/components/schemas/UserList" } } }, - "RegionViewInputWrapper": { + "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": [ - "ViewInput" + "UserRefList" ], "properties": { - "ViewInput": { - "$ref": "#/components/schemas/RegionViewInput" + "UserRefList": { + "$ref": "#/components/schemas/UserRefList" } } }, - "ProductType": { - "description": "This class represents a product type.", + "UserUpdate": { + "description": "This class is used to update a User.", "type": "object", "required": [ - "identifier", - "name", - "AttributeAssignmentList" + "login" ], "properties": { - "identifier": { + "login": { "type": "string" }, - "name": { + "email": { "type": "string" }, - "AttributeAssignmentList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttributeAssignment" - } + "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." } } }, - "ProductTypeWrapper": { + "UserUpdateWrapper": { "type": "object", "required": [ - "ProductType" + "UserUpdate" ], "properties": { - "ProductType": { - "$ref": "#/components/schemas/ProductType" + "UserUpdate": { + "$ref": "#/components/schemas/UserUpdate" } } }, - "ProductTypeCreate": { - "description": "This class is used to create a product type.", + "UserCreate": { + "description": "This class is used to create a User.", "type": "object", "required": [ - "ContentTypeCreateStruct", - "main_language_code", - "assigned_attributes" + "mainLanguageCode", + "remoteId", + "login", + "email", + "password" ], "properties": { - "ContentTypeCreateStruct": { - "type": "object" + "mainLanguageCode": { + "type": "string" }, - "main_language_code": { + "remoteId": { "type": "string" }, - "assigned_attributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductTypeAssignedAttribute" - } + "login": { + "type": "string" + }, + "email": { + "type": "string" + }, + "password": { + "type": "string" + }, + "enabled": { + "type": "boolean" } } }, - "ProductTypeCreateWrapper": { + "UserCreateWrapper": { "type": "object", "required": [ - "ProductTypeCreate" + "UserCreate" ], "properties": { - "ProductTypeCreate": { - "$ref": "#/components/schemas/ProductTypeCreate" + "UserCreate": { + "$ref": "#/components/schemas/UserCreate" } } }, - "ProductTypeUpdate": { - "description": "This class is used to update a product type.", + "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": [ - "ContentTypeUpdateStruct", - "assigned_attributes" + "label", + "value" ], "properties": { - "ContentTypeUpdateStruct": { - "$ref": "#/components/schemas/ContentTypeUpdateStruct" + "label": { + "description": "Label of the attribute.", + "type": "string" }, - "assigned_attributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductTypeAssignedAttribute" - } + "value": { + "description": "Value of the attribute.", + "type": "string" } } }, - "ProductTypeUpdateWrapper": { + "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": [ - "ProductTypeUpdate" + "EventList" ], "properties": { - "ProductTypeUpdate": { - "$ref": "#/components/schemas/ProductTypeUpdate" + "EventList": { + "$ref": "#/components/schemas/EventList" } } }, - "ProductTypeUsage": { + "EventGroup": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class represents a product type usage.", + "description": "Event group.", "type": "object", "required": [ - "is_used" + "_currentPage", + "totalCount", + "events" ], "properties": { - "is_used": { - "type": "boolean" + "_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" + } } } } ] }, - "ProductTypeUsageWrapper": { + "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": [ - "ProductTypeUsage" + "EventGroupList" ], "properties": { - "ProductTypeUsage": { - "$ref": "#/components/schemas/ProductTypeUsage" + "EventGroupList": { + "$ref": "#/components/schemas/EventGroupList" } } }, - "ProductTypeView": { - "description": "This class represents a product type view.", + "RescheduleAction": { + "description": "This class represents events to reschedule", "type": "object", "required": [ - "identifier", - "ProductTypeQuery", - "Result" - ], - "properties": { - "identifier": { - "type": "string" - }, - "ProductTypeQuery": { - "type": "object" + "events", + "dateTime" + ], + "properties": { + "events": { + "description": "list of events", + "type": "array", + "items": { + "type": "string" + } }, - "Result": { - "type": "object" + "dateTime": { + "description": "timestamp to reschedule events to", + "type": "integer" } } }, - "ProductTypeViewWrapper": { + "RescheduleActionWrapper": { "type": "object", "required": [ - "ProductTypeView" + "RescheduleAction" ], "properties": { - "ProductTypeView": { - "$ref": "#/components/schemas/ProductTypeView" + "RescheduleAction": { + "$ref": "#/components/schemas/RescheduleAction" } } }, - "ProductTypeList": { - "description": "This class represents a product type list.", + "UnscheduleAction": { + "description": "This class represents events to unschedule", "type": "object", "required": [ - "ProductType" + "events" ], "properties": { - "ProductType": { + "events": { + "description": "list of events", "type": "array", "items": { - "$ref": "#/components/schemas/ProductType" + "type": "string" } } } }, - "ProductTypeListWrapper": { + "UnscheduleActionWrapper": { "type": "object", "required": [ - "ProductTypeList" + "UnscheduleAction" ], "properties": { - "ProductTypeList": { - "$ref": "#/components/schemas/ProductTypeList" + "UnscheduleAction": { + "$ref": "#/components/schemas/UnscheduleAction" } } }, - "ProductTypeListGet": { - "description": "This class represents a product type list query.", + "AttributeGroup": { + "description": "This class represents an attribute group.", "type": "object", "required": [ - "name_prefix", - "offset", - "limit" + "name", + "identifier", + "position" ], "properties": { - "name_prefix": { + "name": { "type": "string" }, - "offset": { - "type": "integer" + "identifier": { + "type": "string" }, - "limit": { + "position": { "type": "integer" - }, - "languages": { - "type": "array", - "items": { - "type": "string" - } } } }, - "ProductTypeListGetWrapper": { + "AttributeGroupWrapper": { "type": "object", "required": [ - "ProductTypeListGet" + "AttributeGroup" ], "properties": { - "ProductTypeListGet": { - "$ref": "#/components/schemas/ProductTypeListGet" + "AttributeGroup": { + "$ref": "#/components/schemas/AttributeGroup" } } }, - "ProductTypeViewInput": { - "description": "This class represents a product type view input.", - "xml": { - "name": "ViewInput" - }, + "AttributeGroupCreate": { + "description": "This class is used to create an attribute group.", "type": "object", "required": [ - "ProductTypeQuery" + "identifier", + "names", + "position" ], "properties": { - "ProductTypeQuery": { + "identifier": { + "type": "string" + }, + "names": { "type": "object" + }, + "position": { + "type": "integer" } } }, - "ProductTypeViewInputWrapper": { + "AttributeGroupCreateWrapper": { "type": "object", "required": [ - "ViewInput" + "AttributeGroupCreate" ], "properties": { - "ViewInput": { - "$ref": "#/components/schemas/ProductTypeViewInput" + "AttributeGroupCreate": { + "$ref": "#/components/schemas/AttributeGroupCreate" } } }, - "ProductTypeAssignedAttribute": { + "AttributeGroupUpdate": { + "description": "This class is used to update an attribute group.", "type": "object", "required": [ "identifier", - "is_required", - "is_discriminator" + "names", + "position" ], "properties": { "identifier": { "type": "string" }, - "is_required": { - "type": "boolean" + "names": { + "type": "object" }, - "is_discriminator": { - "type": "boolean" + "position": { + "type": "integer" } } }, - "ProductVariant": { - "description": "This class represents a product variant.", + "AttributeGroupUpdateWrapper": { "type": "object", "required": [ - "code", - "name", - "Product", - "DiscriminatorAttributesList" + "AttributeGroupUpdate" ], "properties": { - "code": { - "type": "string" - }, - "name": { - "type": "string" - }, - "Product": { - "$ref": "#/components/schemas/Product" + "AttributeGroupUpdate": { + "$ref": "#/components/schemas/AttributeGroupUpdate" + } + } + }, + "AttributeGroupList": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "DiscriminatorAttributesList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Attribute" + { + "description": "This class represents an attribute group list.", + "type": "object", + "required": [ + "AttributeGroup" + ], + "properties": { + "AttributeGroup": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttributeGroup" + } + } } } - } + ] }, - "ProductVariantWrapper": { + "AttributeGroupListWrapper": { "type": "object", "required": [ - "ProductVariant" + "AttributeGroupList" ], "properties": { - "ProductVariant": { - "$ref": "#/components/schemas/ProductVariant" + "AttributeGroupList": { + "$ref": "#/components/schemas/AttributeGroupList" } } }, - "ProductVariantView": { - "description": "This class represents a product variant view.", + "AttributeGroupListGet": { + "description": "This class represents an attribute group list request.", "type": "object", "required": [ - "identifier", - "ProductVariantQuery", - "Result" + "prefix", + "offset", + "limit" ], "properties": { - "identifier": { + "prefix": { "type": "string" }, - "ProductVariantQuery": { - "type": "object" + "offset": { + "type": "integer" }, - "Result": { - "type": "object" + "limit": { + "type": "integer" } } }, - "ProductVariantViewWrapper": { + "AttributeGroupListGetWrapper": { "type": "object", "required": [ - "ProductVariantView" + "AttributeGroupListGet" ], "properties": { - "ProductVariantView": { - "$ref": "#/components/schemas/ProductVariantView" + "AttributeGroupListGet": { + "$ref": "#/components/schemas/AttributeGroupListGet" } } }, - "ProductVariantViewInput": { - "description": "This class represents a product variant view input.", + "AttributeGroupGet": { + "description": "This class represents an attribute group query.", "type": "object", "required": [ - "ProductVariantQuery" + "languages" ], "properties": { - "ProductVariantQuery": { - "type": "object" + "languages": { + "type": "array", + "items": { + "type": "string" + } } } }, - "ProductVariantViewInputWrapper": { + "AttributeGroupGetWrapper": { "type": "object", "required": [ - "ViewInput" + "AttributeGroupGet" ], "properties": { - "ViewInput": { - "$ref": "#/components/schemas/ProductVariantViewInput" + "AttributeGroupGet": { + "$ref": "#/components/schemas/AttributeGroupGet" } } }, - "ProductVariantCreate": { - "description": "This class is used to create a product variant.", + "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": [ - "code", - "attributes" + "AttributeGroupView" ], "properties": { - "code": { - "type": "string" - }, - "attributes": { - "description": "array<int|string,mixed>", - "type": "object" + "AttributeGroupView": { + "$ref": "#/components/schemas/AttributeGroupView" } } }, - "ProductVariantCreateWrapper": { + "AttributeGroupViewInput": { + "description": "This class represents an attribute group view input.", + "xml": { + "name": "ViewInput" + }, "type": "object", "required": [ - "ProductVariantCreate" + "identifier", + "AttributeGroupQuery" ], "properties": { - "ProductVariantCreate": { - "$ref": "#/components/schemas/ProductVariantCreate" + "identifier": { + "type": "string" + }, + "AttributeGroupQuery": { + "type": "object", + "required": [ + "limit", + "offset", + "name_prefix" + ], + "properties": { + "limit": { + "type": "string" + }, + "offset": { + "type": "string" + }, + "name_prefix": { + "type": "string" + } + } } } }, - "ProductVariantUpdate": { - "description": "This class is used to update a product variant.", + "AttributeGroupViewInputWrapper": { "type": "object", "required": [ - "code", - "attributes" + "ViewInput" ], "properties": { - "code": { - "type": "string" - }, - "attributes": { - "description": "array<int|string,mixed>", - "type": "object" + "ViewInput": { + "$ref": "#/components/schemas/AttributeGroupViewInput" } } }, - "ProductVariantUpdateWrapper": { + "AttributeType": { + "description": "This class represents an attribute type.", "type": "object", "required": [ - "ProductVariantUpdate" + "identifier", + "name" ], "properties": { - "ProductVariantUpdate": { - "$ref": "#/components/schemas/ProductVariantUpdate" + "identifier": { + "type": "string" + }, + "name": { + "type": "string" } } }, - "ProductVariantGenerate": { - "description": "This class is used to generate a product variant.", + "AttributeTypeWrapper": { "type": "object", "required": [ - "attributes" + "AttributeType" ], "properties": { - "attributes": { - "description": "array<int|string,mixed>", - "type": "object" + "AttributeType": { + "$ref": "#/components/schemas/AttributeType" } } }, - "ProductVariantGenerateWrapper": { + "AttributeTypeList": { + "description": "This class represents an attribute type list.", "type": "object", "required": [ - "ProductVariantGenerate" + "attributeTypes" ], "properties": { - "ProductVariantGenerate": { - "$ref": "#/components/schemas/ProductVariantGenerate" + "attributeTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttributeType" + } } } }, - "ProductSortClause": { + "AttributeTypeListWrapper": { "type": "object", "required": [ - "name" + "AttributeTypeList" ], "properties": { - "name": { - "type": "string" + "AttributeTypeList": { + "$ref": "#/components/schemas/AttributeTypeList" } } }, - "ProductSortClauseList": { - "description": "This class represents a product sort clause list.", + "CartList": { + "type": "object" + }, + "Attribute": { + "description": "This class represents an attribute.", "type": "object", "required": [ - "ProductSortClause" + "name", + "identifier", + "description", + "type", + "type_identifier", + "value", + "group", + "position", + "options" ], "properties": { - "ProductSortClause": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSortClause" - } + "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" + ] } } }, - "ProductSortClauseListWrapper": { + "AttributeWrapper": { "type": "object", "required": [ - "ProductSortClauseList" + "Attribute" ], "properties": { - "ProductSortClauseList": { - "$ref": "#/components/schemas/ProductSortClauseList" + "Attribute": { + "$ref": "#/components/schemas/Attribute" } } }, - "Product": { - "description": "This class represents a product.", + "AttributeCreate": { + "description": "This class is used to create an attribute.", "type": "object", "required": [ - "code", - "name", - "ProductType", - "AttributesList" + "identifier", + "type", + "group", + "names", + "descriptions", + "position", + "options" ], "properties": { - "isVariant": { - "type": "boolean" - }, - "isBaseProduct": { - "type": "boolean" - }, - "code": { + "identifier": { "type": "string" }, - "name": { + "type": { "type": "string" }, - "ProductType": { - "$ref": "#/components/schemas/ProductType" - }, - "Content": { - "$ref": "#/components/schemas/Content" + "group": { + "type": "string" }, - "Thumbnail": { - "$ref": "#/components/schemas/Thumbnail" + "names": { + "type": "object" }, - "created_at": { - "type": "integer" + "descriptions": { + "type": "object" }, - "updated_at": { + "position": { "type": "integer" }, - "AttributesList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Attribute" - } + "options": { + "type": [ + "object", + "array" + ] } } }, - "ProductWrapper": { + "AttributeCreateWrapper": { "type": "object", "required": [ - "Product" + "AttributeCreate" ], "properties": { - "Product": { - "$ref": "#/components/schemas/Product" + "AttributeCreate": { + "$ref": "#/components/schemas/AttributeCreate" } } }, - "ProductCreate": { - "description": "This class is used to create a product.", + "AttributeUpdate": { + "description": "This class is used to update an attribute.", "type": "object", "required": [ - "ContentCreate", - "code", - "attributes" + "identifier", + "names", + "descriptions", + "position", + "options" ], "properties": { - "ContentCreate": { - "$ref": "#/components/schemas/ContentCreate" - }, - "code": { + "identifier": { "type": "string" }, - "attributes": { + "names": { + "type": "object" + }, + "descriptions": { + "type": "object" + }, + "position": { + "type": "integer" + }, + "options": { "type": "object" } } }, - "ProductCreateWrapper": { + "AttributeUpdateWrapper": { "type": "object", "required": [ - "ProductCreate" + "AttributeUpdate" ], "properties": { - "ProductCreate": { - "$ref": "#/components/schemas/ProductCreate" + "AttributeUpdate": { + "$ref": "#/components/schemas/AttributeUpdate" } } }, - "ProductUpdate": { - "description": "This class is used to update a product.", + "AttributeListGet": { + "description": "This class represents an attribute list query", "type": "object", - "required": [ - "ContentUpdate", - "code" - ], "properties": { - "ContentUpdate": { - "$ref": "#/components/schemas/ContentUpdate" + "group_name_prefix": { + "type": "string" }, - "code": { + "name_prefix": { "type": "string" }, - "attributes": { - "type": "array", - "items": { - "type": "object" - } + "offset": { + "type": "integer" + }, + "limit": { + "type": "integer" } } }, - "ProductUpdateWrapper": { + "AttributeListGetWrapper": { "type": "object", "required": [ - "ProductUpdate" + "AttributeListGet" ], "properties": { - "ProductUpdate": { - "$ref": "#/components/schemas/ProductUpdate" + "AttributeListGet": { + "$ref": "#/components/schemas/AttributeListGet" } } }, - "ProductContentUpdate": { + "AttributeList": { + "description": "This class represents an attribute list.", "type": "object", "required": [ - "__url", - "fields" + "Attribute" ], "properties": { - "__url": { - "xml": { - "attribute": true, - "name": "url" - }, - "type": "string" - }, - "fields": { - "type": "object", - "required": [ - "field" - ], - "properties": { - "field": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Field" - } - } + "Attribute": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Attribute" } } } }, - "ProductView": { - "description": "This class represents a product view.", + "AttributeListWrapper": { + "type": "object", + "required": [ + "AttributeList" + ], + "properties": { + "AttributeList": { + "$ref": "#/components/schemas/AttributeList" + } + } + }, + "AttributeView": { + "description": "This class represents an attribute view.", "type": "object", "required": [ "identifier", - "ProductQuery", + "AttributeQuery", "Result" ], "properties": { "identifier": { "type": "string" }, - "ProductQuery": { + "AttributeQuery": { "type": "object" }, "Result": { @@ -50119,1448 +37072,1463 @@ } } }, - "ProductViewWrapper": { + "AttributeViewWrapper": { "type": "object", "required": [ - "ProductView" + "AttributeView" ], "properties": { - "ProductView": { - "$ref": "#/components/schemas/ProductView" + "AttributeView": { + "$ref": "#/components/schemas/AttributeView" } } }, - "ProductViewInput": { - "description": "This class represents a product view input.", + "AttributeViewInput": { + "description": "This class represents an attribute view input.", "xml": { "name": "ViewInput" }, "type": "object", "required": [ - "ProductQuery" + "identifier", + "AttributeQuery" ], "properties": { - "ProductQuery": { + "identifier": { + "type": "string" + }, + "AttributeQuery": { "type": "object" } } }, - "ProductViewInputWrapper": { + "AttributeViewInputWrapper": { "type": "object", "required": [ "ViewInput" ], "properties": { "ViewInput": { - "$ref": "#/components/schemas/ProductViewInput" + "$ref": "#/components/schemas/AttributeViewInput" } } }, - "ProductList": { - "description": "This class represents a product list.", + "AttributeAssignment": { "type": "object", "required": [ - "Product" + "is_required", + "is_discriminator", + "Attribute" ], "properties": { - "Product": { + "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/Product" + "$ref": "#/components/schemas/Criterion" } } } }, - "ProductListWrapper": { + "CatalogWrapper": { "type": "object", "required": [ - "ProductList" + "Catalog" ], "properties": { - "ProductList": { - "$ref": "#/components/schemas/ProductList" + "Catalog": { + "$ref": "#/components/schemas/Catalog" } } }, - "ProductListGet": { - "description": "This class represents a product list GET.", + "CatalogCreate": { + "description": "This class is used to create a catalog.", "type": "object", "required": [ - "offset", - "limit", - "languages" + "identifier", + "criteria", + "names", + "status" ], "properties": { - "offset": { - "type": "integer" + "identifier": { + "type": "string" }, - "limit": { - "type": "integer" + "criteria": { + "$ref": "#/components/schemas/Criterion" }, - "languages": { - "type": "array", - "items": { - "type": "string" - } + "names": { + "type": "object" + }, + "descriptions": { + "type": "object" + }, + "status": { + "type": "string" + }, + "creator_id": { + "type": "integer" } } }, - "ProductListGetWrapper": { + "CatalogCreateWrapper": { "type": "object", "required": [ - "ProductListGet" + "CatalogCreate" ], "properties": { - "ProductListGet": { - "$ref": "#/components/schemas/ProductListGet" + "CatalogCreate": { + "$ref": "#/components/schemas/CatalogCreate" } } }, - "ProductGet": { - "description": "This class represents a product GET.", + "CatalogUpdate": { + "description": "This class is used to update a catalog.", "type": "object", "required": [ - "languages" + "identifier", + "transition", + "criteria", + "names", + "descriptions" ], "properties": { - "languages": { - "type": "array", - "items": { - "type": "string" - } + "identifier": { + "type": "string" + }, + "transition": { + "type": "string" + }, + "criteria": { + "$ref": "#/components/schemas/Criterion" + }, + "names": { + "type": "object" + }, + "descriptions": { + "type": "object" } } }, - "ProductGetWrapper": { + "CatalogUpdateWrapper": { "type": "object", "required": [ - "ProductGet" + "CatalogUpdate" ], "properties": { - "ProductGet": { - "$ref": "#/components/schemas/ProductGet" + "CatalogUpdate": { + "$ref": "#/components/schemas/CatalogUpdate" } } }, - "ProductFilter": { + "CatalogCopy": { + "description": "This class is used to copy a catalog.", "type": "object", "required": [ - "name" + "identifier", + "creator_id" ], "properties": { - "name": { + "identifier": { "type": "string" + }, + "creator_id": { + "description": "Optional", + "type": "integer" } } }, - "ProductFilterList": { - "description": "This class represents a product filter list.", + "CatalogCopyWrapper": { "type": "object", "required": [ - "ProductFilter" + "CatalogCopy" ], "properties": { - "ProductFilter": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductFilter" - } + "CatalogCopy": { + "$ref": "#/components/schemas/CatalogCopy" } } }, - "ProductFilterListWrapper": { + "CatalogList": { + "description": "This class represents a catalog list.", "type": "object", "required": [ - "ProductFilterList" + "Catalog" ], "properties": { - "ProductFilterList": { - "$ref": "#/components/schemas/ProductFilterList" + "Catalog": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Catalog" + } } } }, - "Price": { + "CatalogListViewResult": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class represents a price.", "type": "object", "required": [ - "amount", - "Currency" + "CatalogList" ], "properties": { - "amount": { - "type": "string" - }, - "base_amount": { + "CatalogList": { + "$ref": "#/components/schemas/CatalogList" + } + } + } + ] + }, + "CatalogView": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + }, + { + "type": "object", + "required": [ + "identifier", + "CatalogQuery", + "Result" + ], + "properties": { + "identifier": { "type": "string" }, - "Currency": { - "$ref": "#/components/schemas/Currency" - }, - "money": { - "type": "string" + "CatalogQuery": { + "$ref": "#/components/schemas/Ref" }, - "base_money": { - "type": "string" + "Result": { + "$ref": "#/components/schemas/CatalogListViewResult" } } } ] }, - "PriceWrapper": { - "type": "object", - "required": [ - "Price" - ], - "properties": { - "Price": { - "$ref": "#/components/schemas/Price" - } - } - }, - "PriceCreateStruct": { - "description": "This class represents a price creation structure.", + "CatalogViewWrapper": { "type": "object", "required": [ - "amount", - "currency" + "CatalogView" ], "properties": { - "amount": { - "type": "integer" - }, - "currency": { - "type": "string" + "CatalogView": { + "$ref": "#/components/schemas/CatalogView" } } }, - "PriceCreateStructWrapper": { + "CatalogViewInput": { + "description": "This class represents a catalog view input.", + "xml": { + "name": "ViewInput" + }, "type": "object", "required": [ - "PriceCreateStruct" + "CatalogQuery" ], "properties": { - "PriceCreateStruct": { - "$ref": "#/components/schemas/PriceCreateStruct" + "CatalogQuery": { + "type": "object" } } }, - "RestPrice": { + "CatalogViewInputWrapper": { "type": "object", "required": [ - "Price", - "formatted" + "ViewInput" ], "properties": { - "Price": { - "$ref": "#/components/schemas/Price" - }, - "formatted": { - "type": "string" + "ViewInput": { + "$ref": "#/components/schemas/CatalogViewInput" } } }, - "RestPriceWrapper": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - }, - { - "type": "object", - "required": [ - "RestPrice" - ], - "properties": { - "RestPrice": { - "$ref": "#/components/schemas/RestPrice" - } - } - } - ] - }, - "CustomPrice": { + "Currency": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class represents a custom price.", + "description": "This class represents currency.", "type": "object", "required": [ - "amount", - "base_amount", - "Currency", - "money", - "base_money", - "custom_money", - "custom_amount" + "id", + "code", + "subunits", + "enabled" ], "properties": { - "amount": { - "type": "string" - }, - "base_amount": { - "type": "string" - }, - "Currency": { - "$ref": "#/components/schemas/Currency" - }, - "money": { - "type": "string" - }, - "base_money": { - "type": "string" + "id": { + "type": "integer" }, - "custom_money": { + "code": { "type": "string" }, - "custom_amount": { - "type": "string" + "subunits": { + "type": "integer" }, - "custom_rule": { - "type": [ - "string", - "null" - ] + "enabled": { + "type": "boolean" } } } ] }, - "CustomPriceWrapper": { + "CurrencyWrapper": { "type": "object", "required": [ - "CustomPrice" + "Currency" ], "properties": { - "CustomPrice": { - "$ref": "#/components/schemas/CustomPrice" + "Currency": { + "$ref": "#/components/schemas/Currency" } } }, - "CustomPriceCreateStruct": { - "description": "This class represents a custom price creation structure.", + "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": [ - "amount", - "currency", - "customAmount", - "customerGroup" + "identifier", + "CurrencyQuery", + "Result" ], "properties": { - "amount": { - "type": "integer" - }, - "currency": { + "identifier": { "type": "string" }, - "customAmount": { - "type": "integer" + "CurrencyQuery": { + "type": "object" }, - "customerGroup": { - "type": "string" + "Result": { + "type": "object" } } }, - "CustomPriceCreateStructWrapper": { + "CurrencyViewWrapper": { "type": "object", "required": [ - "CustomPriceCreateStruct" + "CurrencyView" ], "properties": { - "CustomPriceCreateStruct": { - "$ref": "#/components/schemas/CustomPriceCreateStruct" + "CurrencyView": { + "$ref": "#/components/schemas/CurrencyView" } } }, - "CustomPriceUpdateStruct": { - "description": "This class represents a custom price updating structure.", + "CurrencyViewInput": { + "description": "This class represents a currency view input.", + "xml": { + "name": "ViewInput" + }, "type": "object", "required": [ - "amount", - "currency", - "customAmount" + "CurrencyQuery" ], "properties": { - "amount": { - "type": "integer" - }, - "currency": { - "type": "string" - }, - "customAmount": { - "type": "integer" + "CurrencyQuery": { + "type": "object" } } }, - "CustomPriceUpdateStructWrapper": { + "CurrencyViewInputWrapper": { "type": "object", "required": [ - "CustomPriceUpdateStruct" + "ViewInput" ], "properties": { - "CustomPriceUpdateStruct": { - "$ref": "#/components/schemas/CustomPriceUpdateStruct" + "ViewInput": { + "$ref": "#/components/schemas/CurrencyViewInput" } } }, - "PriceUpdateStruct": { - "description": "This class represents a price updating structure.", + "CurrencyList": { + "description": "This class represents a currency list.", "type": "object", "required": [ - "amount", - "currency" + "Currency" ], "properties": { - "amount": { - "type": "integer" - }, - "currency": { - "type": "string" + "Currency": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Currency" + } } } }, - "PriceUpdateStructWrapper": { + "CurrencyListWrapper": { "type": "object", "required": [ - "PriceUpdateStruct" + "CurrencyList" ], "properties": { - "PriceUpdateStruct": { - "$ref": "#/components/schemas/PriceUpdateStruct" + "CurrencyList": { + "$ref": "#/components/schemas/CurrencyList" } } }, - "PriceList": { - "description": "This class represents a price list.", + "CustomerGroup": { + "description": "This class represents a customer group.", "type": "object", "required": [ - "prices" + "id", + "name", + "identifier", + "description", + "users", + "global_price_rate" ], "properties": { - "prices": { + "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/Price" + "$ref": "#/components/schemas/User" } + }, + "global_price_rate": { + "description": "A numeric string", + "type": "string" } } }, - "PriceListWrapper": { + "CustomerGroupWrapper": { "type": "object", "required": [ - "PriceList" + "CustomerGroup" ], "properties": { - "PriceList": { - "$ref": "#/components/schemas/PriceList" + "CustomerGroup": { + "$ref": "#/components/schemas/CustomerGroup" } } }, - "Thumbnail": { - "description": "This class represents a thumbnail that can be a target URL or a Base64 data.", + "CustomerGroupCreate": { + "description": "This class is used to create a customer group.", "type": "object", "required": [ - "resource", - "width", - "height", - "mimeType" + "identifier", + "names", + "descriptions", + "global_price_rate" ], "properties": { - "resource": { + "identifier": { "type": "string" }, - "width": { - "type": [ - "integer", - "null" - ] + "names": { + "type": "object" }, - "height": { - "type": [ - "integer", - "null" - ] + "descriptions": { + "type": "object" }, - "mimeType": { + "global_price_rate": { + "description": "numeric-string", "type": "string" } } }, - "VatCategory": { - "description": "This class represents a VAT category.", + "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", - "region", - "vatValue" + "global_price_rate" ], "properties": { + "names": { + "type": "object" + }, "identifier": { "type": "string" }, - "region": { + "global_price_rate": { "type": "string" }, - "vatValue": { - "type": [ - "number", - "null" - ] + "descriptions": { + "type": "array", + "items": { + "type": "string" + } } } }, - "VatCategoryWrapper": { + "CustomerGroupUpdateWrapper": { "type": "object", "required": [ - "VatCategory" + "CustomerGroupUpdate" ], "properties": { - "VatCategory": { - "$ref": "#/components/schemas/VatCategory" + "CustomerGroupUpdate": { + "$ref": "#/components/schemas/CustomerGroupUpdate" } } }, - "VatCategoryList": { - "description": "This class represents a VAT category list.", + "CustomerGroupList": { + "description": "This class represents a customer group list.", "type": "object", "required": [ - "VatCategory" + "CustomerGroup" ], "properties": { - "VatCategory": { + "CustomerGroup": { "type": "array", "items": { - "$ref": "#/components/schemas/VatCategory" + "$ref": "#/components/schemas/CustomerGroup" } } } }, - "VatCategoryListWrapper": { + "CustomerGroupListWrapper": { "type": "object", "required": [ - "VatCategoryList" + "CustomerGroupList" ], "properties": { - "VatCategoryList": { - "$ref": "#/components/schemas/VatCategoryList" + "CustomerGroupList": { + "$ref": "#/components/schemas/CustomerGroupList" } } }, - "VatCategorySummary": { + "CustomerGroupListResult": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class represents a VAT category summary.", "type": "object", "required": [ - "VatCategory", - "RestPrice" + "CustomerGroupList" ], "properties": { - "VatCategory": { - "$ref": "#/components/schemas/VatCategory" - }, - "RestPrice": { - "$ref": "#/components/schemas/RestPrice" + "CustomerGroupList": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + }, + { + "type": "object", + "required": [ + "CustomerGroup" + ], + "properties": { + "CustomerGroup": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerGroup" + } + } + } + } + ] } } } ] }, - "TaxonomyEntry": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "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" }, - { - "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" - } - } + "CustomerGroupQuery": { + "type": "object" + }, + "Result": { + "$ref": "#/components/schemas/CustomerGroupListResult" } - ] + } }, - "TaxonomyEntryWrapper": { + "CustomerGroupViewWrapper": { "type": "object", "required": [ - "TaxonomyEntry" + "CustomerGroupView" ], "properties": { - "TaxonomyEntry": { - "$ref": "#/components/schemas/TaxonomyEntry" + "CustomerGroupView": { + "$ref": "#/components/schemas/CustomerGroupView" } } }, - "TaxonomyEntryBulkRemove": { - "description": "This class is used to bulk remove taxonomy entries.", + "Region": { + "description": "This class represents a region.", "type": "object", "required": [ - "entries" + "identifier" ], "properties": { - "entries": { + "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": { - "type": "integer" + "$ref": "#/components/schemas/Ref" } } } }, - "TaxonomyEntryBulkRemoveWrapper": { + "RegionListWrapper": { "type": "object", "required": [ - "TaxonomyEntryBulkRemove" + "RegionList" ], "properties": { - "TaxonomyEntryBulkRemove": { - "$ref": "#/components/schemas/TaxonomyEntryBulkRemove" + "RegionList": { + "$ref": "#/components/schemas/RegionList" } } }, - "TaxonomyEntryMove": { + "RegionView": { + "description": "This class represents a region view.", "type": "object", "required": [ - "entry", - "sibling", - "position" + "identifier", + "RegionQuery", + "Result" ], "properties": { - "entry": { - "type": "integer" + "identifier": { + "type": "string" }, - "sibling": { - "type": "integer" + "RegionQuery": { + "type": "object" }, - "position": { - "type": "string" + "Result": { + "type": "object" } } }, - "TaxonomyEntryBulkMove": { - "description": "This class is used to bulk move taxonomy entries.", + "RegionViewWrapper": { "type": "object", "required": [ - "entries" + "RegionView" ], "properties": { - "entries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxonomyEntryMove" - } + "RegionView": { + "$ref": "#/components/schemas/RegionView" } } }, - "TaxonomyEntryBulkMoveWrapper": { + "RegionViewInput": { + "description": "This class represents a region view input.", + "xml": { + "name": "ViewInput" + }, "type": "object", "required": [ - "TaxonomyEntryBulkMove" + "RegionQuery" ], "properties": { - "TaxonomyEntryBulkMove": { - "$ref": "#/components/schemas/TaxonomyEntryBulkMove" + "RegionQuery": { + "type": "object" } } }, - "TaxonomyEntryAssignment": { - "description": "This class represents a taxonomy entry assignment.", + "RegionViewInputWrapper": { "type": "object", "required": [ - "id", - "content", - "entry" + "ViewInput" ], "properties": { - "id": { - "type": "integer" + "ViewInput": { + "$ref": "#/components/schemas/RegionViewInput" + } + } + }, + "ProductType": { + "description": "This class represents a product type.", + "type": "object", + "required": [ + "identifier", + "name", + "AttributeAssignmentList" + ], + "properties": { + "identifier": { + "type": "string" }, - "content": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - }, - { - "type": "object", - "required": [ - "Content" - ], - "properties": { - "Content": { - "$ref": "#/components/schemas/Content" - } - } - } - ] + "name": { + "type": "string" }, - "entry": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - }, - { - "type": "object", - "required": [ - "TaxonomyEntry" - ], - "properties": { - "TaxonomyEntry": { - "$ref": "#/components/schemas/TaxonomyEntry" - } - } - } - ] + "AttributeAssignmentList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttributeAssignment" + } } } }, - "TaxonomyEntryAssignmentWrapper": { + "ProductTypeWrapper": { "type": "object", "required": [ - "TaxonomyEntryAssignment" + "ProductType" ], "properties": { - "TaxonomyEntryAssignment": { - "$ref": "#/components/schemas/TaxonomyEntryAssignment" + "ProductType": { + "$ref": "#/components/schemas/ProductType" } } }, - "TaxonomyEntryAssignToContent": { - "description": "This class is used to assign taxonomy entry to content.", + "ProductTypeCreate": { + "description": "This class is used to create a product type.", "type": "object", "required": [ - "content", - "entries" + "ContentTypeCreateStruct", + "main_language_code", + "assigned_attributes" ], "properties": { - "content": { - "type": "integer" + "ContentTypeCreateStruct": { + "type": "object" }, - "entries": { + "main_language_code": { + "type": "string" + }, + "assigned_attributes": { "type": "array", "items": { - "type": "integer" + "$ref": "#/components/schemas/ProductTypeAssignedAttribute" } } } }, - "TaxonomyEntryAssignToContentWrapper": { + "ProductTypeCreateWrapper": { "type": "object", "required": [ - "TaxonomyEntryAssignToContent" + "ProductTypeCreate" ], "properties": { - "TaxonomyEntryAssignToContent": { - "$ref": "#/components/schemas/TaxonomyEntryAssignToContent" + "ProductTypeCreate": { + "$ref": "#/components/schemas/ProductTypeCreate" } } }, - "TaxonomyEntryUnassignFromContent": { - "description": "This class is used to unassign taxonomy entry from content.", + "ProductTypeUpdate": { + "description": "This class is used to update a product type.", "type": "object", "required": [ - "content", - "entries" + "ContentTypeUpdateStruct", + "assigned_attributes" ], "properties": { - "content": { - "type": "integer" + "ContentTypeUpdateStruct": { + "$ref": "#/components/schemas/ContentTypeUpdateStruct" }, - "entries": { + "assigned_attributes": { "type": "array", "items": { - "type": "integer" + "$ref": "#/components/schemas/ProductTypeAssignedAttribute" } } } }, - "TaxonomyEntryUnassignFromContentWrapper": { + "ProductTypeUpdateWrapper": { "type": "object", "required": [ - "TaxonomyEntryUnassignFromContent" + "ProductTypeUpdate" ], "properties": { - "TaxonomyEntryUnassignFromContent": { - "$ref": "#/components/schemas/TaxonomyEntryUnassignFromContent" + "ProductTypeUpdate": { + "$ref": "#/components/schemas/ProductTypeUpdate" } } }, - "EntryAssignmentCollection": { + "ProductTypeUsage": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class represents a taxonomy assignment collection.", + "description": "This class represents a product type usage.", "type": "object", "required": [ - "content", - "assignments" + "is_used" ], "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" - } + "is_used": { + "type": "boolean" } } } ] }, - "EntryAssignmentCollectionWrapper": { + "ProductTypeUsageWrapper": { "type": "object", "required": [ - "EntryAssignmentCollection" + "ProductTypeUsage" ], "properties": { - "EntryAssignmentCollection": { - "$ref": "#/components/schemas/EntryAssignmentCollection" + "ProductTypeUsage": { + "$ref": "#/components/schemas/ProductTypeUsage" } } }, - "Segment": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "ProductTypeView": { + "description": "This class represents a product type view.", + "type": "object", + "required": [ + "identifier", + "ProductTypeQuery", + "Result" + ], + "properties": { + "identifier": { + "type": "string" }, - { - "description": "This class represents a segment.", - "type": "object", - "required": [ - "id", - "identifier", - "name", - "source", - "SegmentGroup" - ], - "properties": { - "id": { - "type": "integer" - }, - "identifier": { - "type": "string" - }, - "name": { - "type": "string" - }, - "source": { - "type": "string" - }, - "lastUpdatedBy": { - "type": "string", - "nullable": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "SegmentGroup": { - "$ref": "#/components/schemas/SegmentGroup" - } - } + "ProductTypeQuery": { + "type": "object" + }, + "Result": { + "type": "object" } - ] + } }, - "SegmentWrapper": { + "ProductTypeViewWrapper": { "type": "object", "required": [ - "Segment" + "ProductTypeView" ], "properties": { - "Segment": { - "$ref": "#/components/schemas/Segment" + "ProductTypeView": { + "$ref": "#/components/schemas/ProductTypeView" } } }, - "SegmentList": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - }, - { - "description": "This class lists segments.", - "type": "object", - "required": [ - "Segment" - ], - "properties": { - "Segment": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Segment" - } - } + "ProductTypeList": { + "description": "This class represents a product type list.", + "type": "object", + "required": [ + "ProductType" + ], + "properties": { + "ProductType": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductType" } } - ] + } }, - "SegmentListWrapper": { + "ProductTypeListWrapper": { "type": "object", "required": [ - "SegmentList" + "ProductTypeList" ], "properties": { - "SegmentList": { - "$ref": "#/components/schemas/SegmentList" + "ProductTypeList": { + "$ref": "#/components/schemas/ProductTypeList" } } }, - "SegmentGroup": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "ProductTypeListGet": { + "description": "This class represents a product type list query.", + "type": "object", + "required": [ + "name_prefix", + "offset", + "limit" + ], + "properties": { + "name_prefix": { + "type": "string" }, - { - "description": "This class represents a segment group.", - "type": "object", - "required": [ - "id", - "identifier", - "name" - ], - "properties": { - "id": { - "type": "integer" - }, - "identifier": { - "type": "string" - }, - "name": { - "type": "string" - } + "offset": { + "type": "integer" + }, + "limit": { + "type": "integer" + }, + "languages": { + "type": "array", + "items": { + "type": "string" } } - ] + } }, - "SegmentGroupWrapper": { + "ProductTypeListGetWrapper": { "type": "object", "required": [ - "SegmentGroup" + "ProductTypeListGet" ], "properties": { - "SegmentGroup": { - "$ref": "#/components/schemas/SegmentGroup" + "ProductTypeListGet": { + "$ref": "#/components/schemas/ProductTypeListGet" } } }, - "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" - } - } - } + "ProductTypeViewInput": { + "description": "This class represents a product type view input.", + "xml": { + "name": "ViewInput" + }, + "type": "object", + "required": [ + "ProductTypeQuery" + ], + "properties": { + "ProductTypeQuery": { + "type": "object" } - ] + } }, - "SegmentGroupListWrapper": { + "ProductTypeViewInputWrapper": { "type": "object", "required": [ - "SegmentGroupList" + "ViewInput" ], "properties": { - "SegmentGroupList": { - "$ref": "#/components/schemas/SegmentGroupList" + "ViewInput": { + "$ref": "#/components/schemas/ProductTypeViewInput" } } }, - "UserSegment": { - "description": "This class represents a segment and a user it's associate to.", + "ProductTypeAssignedAttribute": { "type": "object", + "required": [ + "identifier", + "is_required", + "is_discriminator" + ], "properties": { - "id": { - "type": "integer" - }, "identifier": { "type": "string" }, - "name": { - "type": "string" - }, - "source": { - "type": "string" - }, - "lastUpdatedBy": { - "type": "string", - "nullable": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "SegmentGroup": { - "$ref": "#/components/schemas/Ref" + "is_required": { + "type": "boolean" }, - "User": { - "$ref": "#/components/schemas/Ref" + "is_discriminator": { + "type": "boolean" } } }, - "UserSegmentList": { - "description": "this class lists segments associated to users.", - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "ProductVariant": { + "description": "This class represents a product variant.", + "type": "object", + "required": [ + "code", + "name", + "Product", + "DiscriminatorAttributesList" + ], + "properties": { + "code": { + "type": "string" }, - { - "type": "object", - "properties": { - "UserSegment": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserSegment" - } - } + "name": { + "type": "string" + }, + "Product": { + "$ref": "#/components/schemas/Product" + }, + "DiscriminatorAttributesList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Attribute" } } - ] + } }, - "UserSegmentListWrapper": { + "ProductVariantWrapper": { "type": "object", "required": [ - "UserSegmentList" + "ProductVariant" ], "properties": { - "UserSegmentList": { - "$ref": "#/components/schemas/SegmentList" + "ProductVariant": { + "$ref": "#/components/schemas/ProductVariant" } } }, - "UserSegmentAssignInput": { + "ProductVariantView": { + "description": "This class represents a product variant view.", "type": "object", + "required": [ + "identifier", + "ProductVariantQuery", + "Result" + ], "properties": { - "segments": { - "type": "array", - "items": { - "type": "string" - } + "identifier": { + "type": "string" + }, + "ProductVariantQuery": { + "type": "object" + }, + "Result": { + "type": "object" } } }, - "UserSegmentAssignInputWrapper": { + "ProductVariantViewWrapper": { "type": "object", "required": [ - "UserSegmentAssignInput" + "ProductVariantView" ], "properties": { - "UserSegmentAssignInput": { - "$ref": "#/components/schemas/UserSegmentAssignInput" + "ProductVariantView": { + "$ref": "#/components/schemas/ProductVariantView" } } }, - "CorporateAccountRoot": { - "description": "This class represents Corporate Account Root resource information.", + "ProductVariantViewInput": { + "description": "This class represents a product variant view input.", "type": "object", "required": [ - "links" + "ProductVariantQuery" ], "properties": { - "links": { - "xml": { - "wrapped": false - }, - "type": "array", - "items": { - "$ref": "#/components/schemas/Link" - } + "ProductVariantQuery": { + "type": "object" } } }, - "CorporateAccountRootWrapper": { + "ProductVariantViewInputWrapper": { "type": "object", "required": [ - "CorporateAccountRoot" + "ViewInput" ], "properties": { - "CorporateAccountRoot": { - "$ref": "#/components/schemas/CorporateAccountRoot" + "ViewInput": { + "$ref": "#/components/schemas/ProductVariantViewInput" } } }, - "Link": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "ProductVariantCreate": { + "description": "This class is used to create a product variant.", + "type": "object", + "required": [ + "code", + "attributes" + ], + "properties": { + "code": { + "type": "string" }, - { - "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" - } - } + "attributes": { + "description": "array<int|string,mixed>", + "type": "object" } - ] + } }, - "Company": { - "description": "This class represents a company.", + "ProductVariantCreateWrapper": { "type": "object", "required": [ - "id", - "name", - "Content", - "billingAddress", - "contactId", - "salesRepresentativeId", - "defaultAddressId", - "addressBookId", - "membersId", - "MemberList", - "Location", - "locationPath", - "isActive" + "ProductVariantCreate" ], "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" + "ProductVariantCreate": { + "$ref": "#/components/schemas/ProductVariantCreate" } } }, - "CompanyWrapper": { + "ProductVariantUpdate": { + "description": "This class is used to update a product variant.", "type": "object", "required": [ - "Company" + "code", + "attributes" ], "properties": { - "Company": { - "$ref": "#/components/schemas/Company" + "code": { + "type": "string" + }, + "attributes": { + "description": "array<int|string,mixed>", + "type": "object" } } }, - "CompanyCreate": { - "description": "This class is used to create a company.", + "ProductVariantUpdateWrapper": { "type": "object", "required": [ - "fields" + "ProductVariantUpdate" ], "properties": { - "fields": { - "type": "object", - "required": [ - "field" - ], - "properties": { - "field": { - "description": "Fields of a Company content item.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Field" - } - } - } + "ProductVariantUpdate": { + "$ref": "#/components/schemas/ProductVariantUpdate" } } }, - "CompanyCreateWrapper": { + "ProductVariantGenerate": { + "description": "This class is used to generate a product variant.", "type": "object", "required": [ - "CompanyCreate" + "attributes" ], "properties": { - "CompanyCreate": { - "$ref": "#/components/schemas/CompanyCreate" + "attributes": { + "description": "array<int|string,mixed>", + "type": "object" } } }, - "CompanyUpdate": { - "description": "This class is used to update a Company.", + "ProductVariantGenerateWrapper": { "type": "object", "required": [ - "fields" + "ProductVariantGenerate" ], "properties": { - "fields": { - "type": "object", - "required": [ - "field" - ], - "properties": { - "field": { - "description": "Fields of a Company content item.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Field" - } - } - } + "ProductVariantGenerate": { + "$ref": "#/components/schemas/ProductVariantGenerate" } } }, - "CompanyUpdateWrapper": { + "ProductSortClause": { "type": "object", "required": [ - "CompanyUpdate" + "name" ], "properties": { - "CompanyUpdate": { - "$ref": "#/components/schemas/CompanyUpdate" + "name": { + "type": "string" } } }, - "CompanyList": { - "description": "This class represents a list of companies.", + "ProductSortClauseList": { + "description": "This class represents a product sort clause list.", "type": "object", "required": [ - "companies" + "ProductSortClause" ], "properties": { - "companies": { + "ProductSortClause": { "type": "array", "items": { - "$ref": "#/components/schemas/Company" + "$ref": "#/components/schemas/ProductSortClause" } } } }, - "CompanyListWrapper": { + "ProductSortClauseListWrapper": { "type": "object", "required": [ - "CompanyList" + "ProductSortClauseList" ], "properties": { - "CompanyList": { - "$ref": "#/components/schemas/CompanyList" + "ProductSortClauseList": { + "$ref": "#/components/schemas/ProductSortClauseList" } } }, - "Member": { - "description": "This class represents a company member.", + "Product": { + "description": "This class represents a product.", "type": "object", "required": [ - "id", + "code", "name", - "Company", - "User", - "Role" + "ProductType", + "AttributesList" ], "properties": { - "id": { - "type": "integer" + "isVariant": { + "type": "boolean" + }, + "isBaseProduct": { + "type": "boolean" + }, + "code": { + "type": "string" }, "name": { "type": "string" }, - "Company": { - "$ref": "#/components/schemas/Company" + "ProductType": { + "$ref": "#/components/schemas/ProductType" }, - "User": { - "description": "Underlying User object of a member.", - "$ref": "#/components/schemas/User" + "Content": { + "$ref": "#/components/schemas/Content" }, - "Role": { - "description": "Reference to the member role in a Company resource.", - "$ref": "#/components/schemas/BaseObject" + "Thumbnail": { + "$ref": "#/components/schemas/Thumbnail" + }, + "created_at": { + "type": "integer" + }, + "updated_at": { + "type": "integer" + }, + "AttributesList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Attribute" + } } } }, - "MemberWrapper": { + "ProductWrapper": { "type": "object", "required": [ - "Member" + "Product" ], "properties": { - "Member": { - "$ref": "#/components/schemas/Member" + "Product": { + "$ref": "#/components/schemas/Product" } } }, - "MemberCreate": { - "description": "This class is used to create a member.", + "ProductCreate": { + "description": "This class is used to create a product.", "type": "object", "required": [ - "login", - "email", - "password", - "Role", - "fields" + "ContentCreate", + "code", + "attributes" ], "properties": { - "login": { - "type": "string" + "ContentCreate": { + "$ref": "#/components/schemas/ContentCreate" }, - "email": { + "code": { "type": "string" }, - "password": { - "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" }, - "Role": { - "description": "Reference to a Role resource company member should be given.", - "$ref": "#/components/schemas/BaseObject" + "code": { + "type": "string" }, - "fields": { - "type": "object", - "required": [ - "field" - ], - "properties": { - "field": { - "description": "Fields of a Member content item.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Field" - } - } + "attributes": { + "type": "array", + "items": { + "type": "object" } } } }, - "MemberCreateWrapper": { + "ProductUpdateWrapper": { "type": "object", "required": [ - "MemberCreate" + "ProductUpdate" ], "properties": { - "MemberCreate": { - "$ref": "#/components/schemas/MemberCreate" + "ProductUpdate": { + "$ref": "#/components/schemas/ProductUpdate" } } }, - "MemberUpdate": { - "description": "This class is used to update a member.", + "ProductContentUpdate": { "type": "object", "required": [ - "email", - "password", - "enabled", - "maxLogin", - "Role", + "__url", "fields" ], "properties": { - "email": { - "type": "string" - }, - "password": { + "__url": { + "xml": { + "attribute": true, + "name": "url" + }, "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": [ @@ -51568,7 +38536,6 @@ ], "properties": { "field": { - "description": "Fields of a Member content item.", "type": "array", "items": { "$ref": "#/components/schemas/Field" @@ -51578,1092 +38545,915 @@ } } }, - "MemberUpdateWrapper": { + "ProductView": { + "description": "This class represents a product view.", "type": "object", "required": [ - "MemberUpdate" + "identifier", + "ProductQuery", + "Result" ], "properties": { - "MemberUpdate": { - "$ref": "#/components/schemas/MemberUpdate" + "identifier": { + "type": "string" + }, + "ProductQuery": { + "type": "object" + }, + "Result": { + "type": "object" } } }, - "MemberList": { - "description": "This class represents a list of company members.", + "ProductViewWrapper": { "type": "object", "required": [ - "members" + "ProductView" ], "properties": { - "members": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Member" - } + "ProductView": { + "$ref": "#/components/schemas/ProductView" } } }, - "MemberListWrapper": { + "ProductViewInput": { + "description": "This class represents a product view input.", + "xml": { + "name": "ViewInput" + }, "type": "object", "required": [ - "MemberList" + "ProductQuery" ], "properties": { - "MemberList": { - "$ref": "#/components/schemas/MemberList" + "ProductQuery": { + "type": "object" } } }, - "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": { + "ProductViewInputWrapper": { "type": "object", "required": [ - "SalesRepresentativesList" + "ViewInput" ], "properties": { - "SalesRepresentativesList": { - "$ref": "#/components/schemas/SalesRepresentativesList" + "ViewInput": { + "$ref": "#/components/schemas/ProductViewInput" } } }, - "BillingAddress": { + "ProductList": { + "description": "This class represents a product list.", "type": "object", "required": [ - "name", - "country", - "fields" + "Product" ], "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "country": { - "type": [ - "string", - "null" - ] - }, - "fields": { - "type": [ - "object", - "array" - ] + "Product": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } } } }, - "ActivityLog": { - "description": "This class represents an activity log entry.", - "type": "object" - }, - "ActivityLogGroup": { + "ProductListWrapper": { "type": "object", "required": [ - "user_id", - "logged_at", - "ActivityLogEntries" + "ProductList" ], "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" - } + "ProductList": { + "$ref": "#/components/schemas/ProductList" } } }, - "ActivityLogGroupListInput": { - "description": "This class represents the activity log group search query's criteria and sort clauses.", + "ProductListGet": { + "description": "This class represents a product list GET.", "type": "object", + "required": [ + "offset", + "limit", + "languages" + ], "properties": { "offset": { - "description": "The offset of the first item to return", "type": "integer" }, "limit": { - "description": "The maximum number of items to return - default is set by `activity_log.pagination.activity_logs_limit` which is 25 if not overridden", "type": "integer" }, - "criteria": { - "description": "Search criteria for activity log groups", - "type": "array", - "items": { - "description": "Search criterion for activity log groups", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "description": "The type of the search criterion", - "type": "string", - "enum": [ - "action", - "logged_at", - "object_class", - "user" - ] - }, - "value": { - "description": "The value of the search criterion", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array" - } - ] - }, - "operator": { - "description": "The operator of the search criterion", - "type": "string" - }, - "class": { - "description": "The class of the `object_class` criterion", - "type": "string" - } - } - } - }, - "sort_clause": { - "description": "Sort clauses for activity log groups", + "languages": { "type": "array", "items": { - "description": "Sort clause for activity log groups", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "description": "The type of the sort clause", - "type": "string", - "enum": [ - "logged_at" - ] - }, - "direction": { - "description": "The direction of the sort clause", - "type": "string", - "enum": [ - "ASC", - "DESC" - ] - } - } + "type": "string" } } } }, - "ActivityLogGroupListInputWrapper": { + "ProductListGetWrapper": { "type": "object", "required": [ - "ActivityLogGroupListInput" + "ProductListGet" ], "properties": { - "ActivityLogGroupListInput": { - "$ref": "#/components/schemas/ActivityLogGroupListInput" + "ProductListGet": { + "$ref": "#/components/schemas/ProductListGet" } } }, - "ActivityLogGroupList": { - "description": "This class represents activity log context groups", + "ProductGet": { + "description": "This class represents a product GET.", "type": "object", "required": [ - "ActivityLogGroups" + "languages" ], "properties": { - "ActivityLogGroups": { + "languages": { "type": "array", "items": { - "$ref": "#/components/schemas/ActivityLogGroup" + "type": "string" } } } }, - "ActivityLogGroupListWrapper": { + "ProductGetWrapper": { "type": "object", "required": [ - "ActivityLogGroupList" + "ProductGet" ], "properties": { - "ActivityLogGroupList": { - "$ref": "#/components/schemas/ActivityLogGroupList" + "ProductGet": { + "$ref": "#/components/schemas/ProductGet" } } }, - "Cart": { - "description": "This class represents a Cart", + "ProductFilter": { "type": "object", "required": [ - "id", - "identifier", - "owner", - "Currency", - "entries" + "name" ], "properties": { - "id": { - "description": "Cart ID", - "type": "integer" - }, - "identifier": { - "description": "Cart unique identifier", + "name": { "type": "string" - }, - "owner": { - "description": "User reference", - "$ref": "#/components/schemas/Ref" - }, - "Currency": { - "$ref": "#/components/schemas/Currency" - }, - "entries": { + } + } + }, + "ProductFilterList": { + "description": "This class represents a product filter list.", + "type": "object", + "required": [ + "ProductFilter" + ], + "properties": { + "ProductFilter": { "type": "array", "items": { - "$ref": "#/components/schemas/CartEntry" + "$ref": "#/components/schemas/ProductFilter" } } } }, - "CartWrapper": { + "ProductFilterListWrapper": { "type": "object", "required": [ - "Cart" + "ProductFilterList" ], "properties": { - "Cart": { - "$ref": "#/components/schemas/Cart" + "ProductFilterList": { + "$ref": "#/components/schemas/ProductFilterList" } } }, - "CartCreate": { - "description": "This class represents a new Cart to create", + "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": [ - "name", - "currencyCode" + "Price" ], "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" + "Price": { + "$ref": "#/components/schemas/Price" } } }, - "CartCreateWrapper": { + "PriceCreateStruct": { + "description": "This class represents a price creation structure.", "type": "object", "required": [ - "CartCreate" + "amount", + "currency" ], "properties": { - "CartCreate": { - "$ref": "#/components/schemas/CartCreate" + "amount": { + "type": "integer" + }, + "currency": { + "type": "string" } } }, - "CartProduct": { - "description": "This class represents a cart entry product", + "PriceCreateStructWrapper": { "type": "object", "required": [ - "code" + "PriceCreateStruct" ], "properties": { - "code": { - "description": "product's code", - "type": "string" + "PriceCreateStruct": { + "$ref": "#/components/schemas/PriceCreateStruct" } } }, - "CartView": { - "description": "This class represents a cart view.", + "RestPrice": { "type": "object", "required": [ - "identifier", - "Result" + "Price", + "formatted" ], "properties": { - "identifier": { + "Price": { + "$ref": "#/components/schemas/Price" + }, + "formatted": { "type": "string" + } + } + }, + "RestPriceWrapper": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "Result": { - "$ref": "#/components/schemas/CartListViewResult" + { + "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" + ] + } + } } - } + ] }, - "CartViewWrapper": { + "CustomPriceWrapper": { "type": "object", "required": [ - "CartView" + "CustomPrice" ], "properties": { - "CartView": { - "$ref": "#/components/schemas/CartView" + "CustomPrice": { + "$ref": "#/components/schemas/CustomPrice" } } }, - "CartViewInput": { - "description": "This class represents a cart view input.", + "CustomPriceCreateStruct": { + "description": "This class represents a custom price creation structure.", "type": "object", "required": [ - "identifier", - "CartQuery" + "amount", + "currency", + "customAmount", + "customerGroup" ], "properties": { - "identifier": { + "amount": { + "type": "integer" + }, + "currency": { "type": "string" }, - "CartQuery": { - "$ref": "#/components/schemas/CartViewInput" + "customAmount": { + "type": "integer" + }, + "customerGroup": { + "type": "string" } } }, - "CartViewInputWrapper": { + "CustomPriceCreateStructWrapper": { "type": "object", "required": [ - "CartViewInput" + "CustomPriceCreateStruct" ], "properties": { - "CartViewInput": { - "$ref": "#/components/schemas/CartViewInput" + "CustomPriceCreateStruct": { + "$ref": "#/components/schemas/CustomPriceCreateStruct" } } }, - "CartQuery": { + "CustomPriceUpdateStruct": { + "description": "This class represents a custom price updating structure.", "type": "object", "required": [ - "offset", - "limit", - "ownerId" + "amount", + "currency", + "customAmount" ], "properties": { - "offset": { + "amount": { "type": "integer" }, - "limit": { - "type": "integer" + "currency": { + "type": "string" }, - "ownerId": { + "customAmount": { "type": "integer" } } }, - "CartEntry": { + "CustomPriceUpdateStructWrapper": { "type": "object", "required": [ - "identifier", - "id", - "names", - "quantity", - "Price" + "CustomPriceUpdateStruct" ], "properties": { - "identifier": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "names": { - "type": "array", - "items": { - "type": "object" - } - }, - "quantity": { - "type": "integer" - }, - "Price": { - "$ref": "#/components/schemas/Price" + "CustomPriceUpdateStruct": { + "$ref": "#/components/schemas/CustomPriceUpdateStruct" } } }, - "CartEntryAdd": { - "description": "This class represents a cart entry", + "PriceUpdateStruct": { + "description": "This class represents a price updating structure.", "type": "object", "required": [ - "quantity", - "Product" + "amount", + "currency" ], "properties": { - "quantity": { - "description": "the quantity of entry items", + "amount": { "type": "integer" }, - "Product": { - "description": "product data" - }, - "context": { - "description": "associative array of scalars describing additional, contextual data attached to the cart entry", - "type": "object" + "currency": { + "type": "string" } } }, - "CartEntryAddWrapper": { + "PriceUpdateStructWrapper": { "type": "object", "required": [ - "CartEntryAdd" + "PriceUpdateStruct" ], "properties": { - "CartEntryAdd": { - "$ref": "#/components/schemas/CartEntryAdd" + "PriceUpdateStruct": { + "$ref": "#/components/schemas/PriceUpdateStruct" } } }, - "CartEntryUpdate": { + "PriceList": { + "description": "This class represents a price list.", "type": "object", "required": [ - "quantity" + "prices" ], "properties": { - "quantity": { - "type": "integer" - }, - "context": { - "description": "associative array of scalars describing additional, contextual data attached to the cart entry", - "type": "object" + "prices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } } } }, - "CartEntryUpdateWrapper": { + "PriceListWrapper": { "type": "object", "required": [ - "CartEntryUpdate" + "PriceList" ], "properties": { - "CartEntryUpdate": { - "$ref": "#/components/schemas/CartEntryUpdate" + "PriceList": { + "$ref": "#/components/schemas/PriceList" } } }, - "CartMetadataUpdate": { - "description": "This class represents the update of cart metadata.", + "Thumbnail": { + "description": "This class represents a thumbnail that can be a target URL or a Base64 data.", "type": "object", "required": [ - "identifier", - "defaultLanguageCode", - "names", - "descriptions" + "resource", + "width", + "height", + "mimeType" ], "properties": { - "identifier": { + "resource": { "type": "string" }, - "defaultLanguageCode": { - "type": "string" + "width": { + "type": [ + "integer", + "null" + ] }, - "names": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Value" - } + "height": { + "type": [ + "integer", + "null" + ] }, - "descriptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Value" - } - } - } - }, - "CartMetadataUpdateWrapper": { - "type": "object", - "required": [ - "CartMetadataUpdate" - ], - "properties": { - "CartMetadataUpdate": { - "$ref": "#/components/schemas/CartMetadataUpdate" + "mimeType": { + "type": "string" } } }, - "CartSummary": { - "description": "This class represents a cart summary.", + "VatCategory": { + "description": "This class represents a VAT category.", "type": "object", "required": [ - "id", "identifier", - "name", - "createdAt", - "updatedAt", - "Owner", - "SummaryEntryCollection", - "TotalPrice", - "TotalPriceInclVat", - "vatCategorySummary", - "Currency" + "region", + "vatValue" ], "properties": { - "id": { - "type": "integer" - }, "identifier": { "type": "string" }, - "name": { + "region": { "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" + "vatValue": { + "type": [ + "number", + "null" + ] } } }, - "CartSummaryWrapper": { + "VatCategoryWrapper": { "type": "object", "required": [ - "CartSummary" + "VatCategory" ], "properties": { - "CartSummary": { - "$ref": "#/components/schemas/CartSummary" + "VatCategory": { + "$ref": "#/components/schemas/VatCategory" } } }, - "CartListViewResult": { + "VatCategoryList": { + "description": "This class represents a VAT category list.", "type": "object", "required": [ - "count", - "Result" + "VatCategory" ], "properties": { - "count": { - "type": "integer" - }, - "Result": { - "$ref": "#/components/schemas/CartList" + "VatCategory": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VatCategory" + } } } }, - "SummaryEntryCollection": { - "description": "This class represents a summary entry collection.", + "VatCategoryListWrapper": { "type": "object", "required": [ - "count", - "SummaryEntry" + "VatCategoryList" ], "properties": { - "count": { - "type": "string" + "VatCategoryList": { + "$ref": "#/components/schemas/VatCategoryList" + } + } + }, + "VatCategorySummary": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "SummaryEntry": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SummaryEntry" + { + "description": "This class represents a VAT category summary.", + "type": "object", + "required": [ + "VatCategory", + "RestPrice" + ], + "properties": { + "VatCategory": { + "$ref": "#/components/schemas/VatCategory" + }, + "RestPrice": { + "$ref": "#/components/schemas/RestPrice" + } } } - } + ] }, - "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" - } + "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" } } } - } + ] }, - "ShoppingListEntryIdentifiersWrapper": { + "TaxonomyEntryWrapper": { "type": "object", "required": [ - "ShoppingListEntryIdentifiers" + "TaxonomyEntry" ], "properties": { - "ShoppingListEntryIdentifiers": { - "$ref": "#/components/schemas/ShoppingListEntryIdentifiers" + "TaxonomyEntry": { + "$ref": "#/components/schemas/TaxonomyEntry" } } }, - "CartEntryIdentifiers": { - "description": "This class represents a list of cart entry identifiers", + "TaxonomyEntryBulkRemove": { + "description": "This class is used to bulk remove taxonomy entries.", "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" - } - } + "type": "integer" } } } }, - "CartEntryIdentifiersWrapper": { + "TaxonomyEntryBulkRemoveWrapper": { "type": "object", "required": [ - "CartEntryIdentifiers" + "TaxonomyEntryBulkRemove" ], "properties": { - "CartEntryIdentifiers": { - "$ref": "#/components/schemas/CartEntryIdentifiers" + "TaxonomyEntryBulkRemove": { + "$ref": "#/components/schemas/TaxonomyEntryBulkRemove" } } }, - "TimezoneDate": { + "TaxonomyEntryMove": { "type": "object", "required": [ - "date", - "timezone_type", - "timezone" + "entry", + "sibling", + "position" ], "properties": { - "date": { - "type": "string" - }, - "timezone_type": { + "entry": { "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": { + "sibling": { "type": "integer" }, - "identifier": { - "type": "string" - }, - "created": { - "$ref": "#/components/schemas/TimezoneDate" - }, - "modified": { - "$ref": "#/components/schemas/TimezoneDate" - }, - "status": { - "type": "string" - }, - "source": { + "position": { "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.", + "TaxonomyEntryBulkMove": { + "description": "This class is used to bulk move taxonomy entries.", "type": "object", "required": [ - "Order" + "entries" ], "properties": { - "Order": { + "entries": { "type": "array", "items": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/TaxonomyEntryMove" } } } }, - "OrderListWrapper": { + "TaxonomyEntryBulkMoveWrapper": { "type": "object", "required": [ - "OrderList" + "TaxonomyEntryBulkMove" ], "properties": { - "OrderList": { - "$ref": "#/components/schemas/OrderList" + "TaxonomyEntryBulkMove": { + "$ref": "#/components/schemas/TaxonomyEntryBulkMove" } } }, - "OrderUser": { - "description": "This class represents order user.", + "TaxonomyEntryAssignment": { + "description": "This class represents a taxonomy entry assignment.", "type": "object", "required": [ "id", - "name", - "email" + "content", + "entry" ], "properties": { "id": { - "type": [ - "null", - "integer" - ] + "type": "integer" }, - "name": { - "type": "string" + "content": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + }, + { + "type": "object", + "required": [ + "Content" + ], + "properties": { + "Content": { + "$ref": "#/components/schemas/Content" + } + } + } + ] }, - "email": { - "type": "string" + "entry": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + }, + { + "type": "object", + "required": [ + "TaxonomyEntry" + ], + "properties": { + "TaxonomyEntry": { + "$ref": "#/components/schemas/TaxonomyEntry" + } + } + } + ] } } }, - "OrderCurrency": { - "description": "This class represents order currency.", + "TaxonomyEntryAssignmentWrapper": { "type": "object", "required": [ - "id", - "code" + "TaxonomyEntryAssignment" ], "properties": { - "id": { - "type": "integer" - }, - "code": { - "type": "string" + "TaxonomyEntryAssignment": { + "$ref": "#/components/schemas/TaxonomyEntryAssignment" } } }, - "OrderValue": { - "description": "This class represents order value.", + "TaxonomyEntryAssignToContent": { + "description": "This class is used to assign taxonomy entry to content.", "type": "object", "required": [ - "vat", - "total_gross", - "total_net" + "content", + "entries" ], "properties": { - "vat": { - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/OrderPrice" - } - ] - }, - "total_gross": { - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/OrderPrice" - } - ] + "content": { + "type": "integer" }, - "total_net": { - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/OrderPrice" - } - ] + "entries": { + "type": "array", + "items": { + "type": "integer" + } } } }, - "OrderCompany": { - "description": "This class represents order company.", + "TaxonomyEntryAssignToContentWrapper": { "type": "object", "required": [ - "id", - "name" + "TaxonomyEntryAssignToContent" ], "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" + "TaxonomyEntryAssignToContent": { + "$ref": "#/components/schemas/TaxonomyEntryAssignToContent" } } }, - "OrderPrice": { + "TaxonomyEntryUnassignFromContent": { + "description": "This class is used to unassign taxonomy entry from content.", "type": "object", "required": [ - "amount", - "currency" + "content", + "entries" ], "properties": { - "amount": { - "type": "string" + "content": { + "type": "integer" }, - "currency": { - "type": "string" + "entries": { + "type": "array", + "items": { + "type": "integer" + } } } }, - "OrderCreate": { - "description": "This class is used to create order.", + "TaxonomyEntryUnassignFromContentWrapper": { "type": "object", "required": [ - "source", - "OrderUser", - "OrderCurrency", - "OrderValue", - "OrderCompany", - "items" + "TaxonomyEntryUnassignFromContent" ], "properties": { - "source": { - "type": "string" - }, - "OrderUser": { - "$ref": "#/components/schemas/OrderUser" - }, - "OrderCurrency": { - "$ref": "#/components/schemas/OrderCurrency" - }, - "OrderValue": { - "$ref": "#/components/schemas/OrderValue" - }, - "OrderCompany": { - "$ref": "#/components/schemas/OrderCompany" + "TaxonomyEntryUnassignFromContent": { + "$ref": "#/components/schemas/TaxonomyEntryUnassignFromContent" + } + } + }, + "EntryAssignmentCollection": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderItemWrapper" + { + "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" + } + } } } - } + ] }, - "OrderCreateWrapper": { + "EntryAssignmentCollectionWrapper": { "type": "object", "required": [ - "OrderCreate" + "EntryAssignmentCollection" ], "properties": { - "OrderCreate": { - "$ref": "#/components/schemas/OrderCreate" + "EntryAssignmentCollection": { + "$ref": "#/components/schemas/EntryAssignmentCollection" } } }, - "OrderItem": { - "description": "This class represents order item.", + "BulkTranslationSetupSectionInput": { "type": "object", - "required": [ - "OrderItemValue", - "OrderItemProduct" - ], "properties": { - "OrderItemValue": { - "$ref": "#/components/schemas/OrderItemValue" - }, - "OrderItemProduct": { - "$ref": "#/components/schemas/OrderItemProduct" + "search": { + "type": "string", + "default": "" }, - "quantity": { - "type": "integer" + "contentType": { + "type": "string", + "default": "" }, - "context": { - "type": "object" - } - } - }, - "OrderItemWrapper": { - "type": "object", - "required": [ - "OrderItem" - ], - "properties": { - "OrderItem": { - "$ref": "#/components/schemas/OrderItem" + "page": { + "type": "integer", + "minimum": 1, + "default": 1 } } }, - "OrderItemValue": { - "description": "This class represents order item value.", + "BulkTranslationSetupActionResource": { "type": "object", "required": [ - "unit_price_gross", - "unit_price_net", - "vat_rate", - "subtotal_price_gross", - "subtotal_price_net" + "href", + "method", + "enabled" ], "properties": { - "unit_price_gross": { - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/OrderPrice" - } - ] - }, - "unit_price_net": { - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/OrderPrice" - } - ] - }, - "vat_rate": { + "href": { "type": "string" }, - "subtotal_price_gross": { - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/OrderPrice" - } - ] + "method": { + "type": "string" }, - "subtotal_price_net": { - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/OrderPrice" - } - ] + "enabled": { + "type": "boolean" } } }, - "OrderItemProduct": { - "description": "This class represents order item product.", + "BulkTranslationSetupLanguageChoiceResource": { "type": "object", "required": [ - "id", "code", "name" ], "properties": { - "id": { - "type": "integer" - }, "code": { "type": "string" }, @@ -52672,1261 +39462,1515 @@ } } }, - "OrderUpdate": { - "description": "This class is used to update order.", + "BulkTranslationSetupProviderChoiceResource": { "type": "object", "required": [ - "status", - "transition" + "identifier", + "name" ], "properties": { - "status": { + "identifier": { "type": "string" }, - "transition": { + "name": { "type": "string" } } }, - "OrderUpdateWrapper": { + "BulkTranslationSetupContentTypeChoiceResource": { "type": "object", "required": [ - "OrderUpdate" + "identifier", + "name" ], "properties": { - "OrderUpdate": { - "$ref": "#/components/schemas/OrderUpdate" + "identifier": { + "type": "string" + }, + "name": { + "type": "string" } } }, - "PaymentMethod": { + "BulkTranslationSetupRowResource": { "type": "object", "required": [ "id", - "identifier", - "enabled", "name", - "description" + "contentTypeIdentifier", + "contentTypeName", + "duplicated" ], "properties": { "id": { "type": "integer" }, - "identifier": { + "name": { "type": "string" }, - "enabled": { - "type": "boolean" - }, - "name": { + "contentTypeIdentifier": { "type": "string" }, - "description": { + "contentTypeName": { "type": "string" + }, + "duplicated": { + "type": "boolean" } } }, - "PaymentMethodWrapper": { - "type": "object", - "required": [ - "PaymentMethod" - ], - "properties": { - "PaymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" - } - } - }, - "PaymentMethodCreateStruct": { + "BulkTranslationSetupFiltersResource": { "type": "object", "required": [ - "identifier", - "type", - "names" + "search", + "contentType", + "contentTypeChoices" ], "properties": { - "identifier": { + "search": { "type": "string" }, - "type": { + "contentType": { "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.", + "contentTypeChoices": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/BulkTranslationSetupContentTypeChoiceResource" } - }, - "enabled": { - "type": "boolean" - }, - "options": { - "type": "object" } } }, - "PaymentMethodCreateStructWrapper": { + "BulkTranslationSetupPaginationResource": { "type": "object", "required": [ - "PaymentMethodCreateStruct" + "page", + "pageSize", + "totalPages" ], "properties": { - "PaymentMethodCreateStruct": { - "$ref": "#/components/schemas/PaymentMethodCreateStruct" + "page": { + "type": "integer" + }, + "pageSize": { + "type": "integer" + }, + "totalPages": { + "type": "integer" } } }, - "PaymentMethodUpdateStruct": { + "BulkTranslationSetupSectionResource": { "type": "object", + "required": [ + "count", + "rows", + "filters", + "pagination" + ], "properties": { - "identifier": { - "type": "string" - }, - "names": { - "description": "If set this array of names with languageCode keys replace the complete name collection.", - "type": "object" + "count": { + "type": "integer" }, - "descriptions": { - "description": "An array of descriptions with languageCode keys.", + "rows": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/BulkTranslationSetupRowResource" } }, - "enabled": { - "type": "boolean" + "filters": { + "$ref": "#/components/schemas/BulkTranslationSetupFiltersResource" }, - "options": { - "type": "array", - "items": { - "type": [] - } + "pagination": { + "$ref": "#/components/schemas/BulkTranslationSetupPaginationResource" } } }, - "PaymentMethodUpdateStructWrapper": { + "BulkTranslationSetupSectionsResource": { "type": "object", "required": [ - "PaymentMethodUpdateStructParser" + "duplicates", + "items" ], "properties": { - "PaymentMethodUpdateStructParser": { - "$ref": "#/components/schemas/PaymentMethodUpdateStruct" + "duplicates": { + "$ref": "#/components/schemas/BulkTranslationSetupSectionResource" + }, + "items": { + "$ref": "#/components/schemas/BulkTranslationSetupSectionResource" } } }, - "PaymentMethodView": { + "BulkTranslationSetupConfigurationResource": { "type": "object", "required": [ - "identifier", - "Result" + "sourceLanguage", + "sourceLanguageChoices", + "targetLanguage", + "targetLanguageChoices", + "provider", + "providerChoices" ], "properties": { - "identifier": { + "sourceLanguage": { "type": "string" }, - "Result": { - "$ref": "#/components/schemas/PaymentMethodList" + "sourceLanguageChoices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BulkTranslationSetupLanguageChoiceResource" + } + }, + "targetLanguage": { + "type": "string" + }, + "targetLanguageChoices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BulkTranslationSetupLanguageChoiceResource" + } + }, + "provider": { + "type": "string" + }, + "providerChoices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BulkTranslationSetupProviderChoiceResource" + } } } }, - "PaymentMethodViewWrapper": { + "BulkTranslationSetupSummaryResource": { "type": "object", "required": [ - "PaymentMethodView" + "totalItems", + "duplicates", + "itemsToTranslate" ], "properties": { - "PaymentMethodView": { - "$ref": "#/components/schemas/PaymentMethodView" + "totalItems": { + "type": "integer" + }, + "duplicates": { + "type": "integer" + }, + "itemsToTranslate": { + "type": "integer" } } }, - "PaymentMethodViewInput": { + "BulkTranslationSetupSelectionResource": { "type": "object", "required": [ - "identifier", - "PaymentMethodQuery" + "selectedContentIds" ], "properties": { - "identifier": { - "type": "string" - }, - "PaymentMethodQuery": { - "type": "object" + "selectedContentIds": { + "type": "array", + "items": { + "type": "integer" + } } } }, - "PaymentMethodViewInputWrapper": { + "BulkTranslationSetupActionsResource": { "type": "object", "required": [ - "PaymentMethodViewInput" + "start" ], "properties": { - "PaymentMethodViewInput": { - "$ref": "#/components/schemas/PaymentMethodViewInput" + "start": { + "$ref": "#/components/schemas/BulkTranslationSetupActionResource" } } }, - "PaymentMethodList": { + "BulkTranslationSetupResource": { "type": "object", "required": [ - "count", - "PaymentMethodList" + "configuration", + "summary", + "sections", + "selection", + "actions" ], "properties": { - "count": { - "type": "integer" + "configuration": { + "$ref": "#/components/schemas/BulkTranslationSetupConfigurationResource" }, - "PaymentMethodList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentMethod" - } + "summary": { + "$ref": "#/components/schemas/BulkTranslationSetupSummaryResource" + }, + "sections": { + "$ref": "#/components/schemas/BulkTranslationSetupSectionsResource" + }, + "selection": { + "$ref": "#/components/schemas/BulkTranslationSetupSelectionResource" + }, + "actions": { + "$ref": "#/components/schemas/BulkTranslationSetupActionsResource" } } }, - "Shipment": { - "description": "This class represents a single shipment.", + "MissingTranslationsRowResource": { "type": "object", "required": [ - "id", - "identifier", - "status", - "transitions", - "Order", - "Amount", - "createdAt", - "updatedAt", - "Owner", - "Method" + "contentId", + "name", + "contentTypeIdentifier", + "contentTypeName", + "missingLanguages" ], "properties": { - "id": { + "contentId": { "type": "integer" }, - "identifier": { + "name": { "type": "string" }, - "status": { + "contentTypeIdentifier": { "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" + "contentTypeName": { + "type": "string" }, - "Amount": { - "type": "object", - "required": [ - "value", - "currency" - ], - "properties": { - "value": { - "type": "string" - }, - "currency": { - "type": "string" - } + "missingLanguages": { + "type": "array", + "items": { + "type": "string" } }, - "createdAt": { - "type": "string", - "format": "date-time" - }, - "updatedAt": { - "type": "string", - "format": "date-time" - }, - "Owner": { - "$ref": "#/components/schemas/Ref" - }, - "Method": { - "$ref": "#/components/schemas/Ref" + "mainLocationId": { + "type": "integer", + "nullable": true } } }, - "ShipmentWrapper": { + "MissingTranslationsResource": { "type": "object", "required": [ - "Shipment" + "totalCount", + "page", + "limit", + "rows" ], "properties": { - "Shipment": { - "$ref": "#/components/schemas/Shipment" + "totalCount": { + "type": "integer" + }, + "page": { + "type": "integer" + }, + "limit": { + "type": "integer" + }, + "rows": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MissingTranslationsRowResource" + } } } }, - "ShipmentRefList": { - "description": "This class represents a list of Shipments", + "MissingTranslationIdsResource": { "type": "object", "required": [ - "shipmentRefList" + "ids", + "returnedCount", + "totalCount", + "limited" ], "properties": { - "shipmentRefList": { + "ids": { "type": "array", "items": { - "$ref": "#/components/schemas/Ref" + "type": "integer" } + }, + "returnedCount": { + "type": "integer" + }, + "totalCount": { + "type": "integer" + }, + "limited": { + "type": "boolean" } } }, - "ShipmentRefListWrapper": { + "BulkTranslationContextResource": { "type": "object", "required": [ - "ShipmentRefList" + "jobItemId", + "jobId", + "jobItemStatus", + "jobCreatorId" ], "properties": { - "ShipmentRefList": { - "$ref": "#/components/schemas/ShipmentRefList" + "jobItemId": { + "type": "integer" + }, + "jobId": { + "type": "integer" + }, + "jobItemStatus": { + "type": "string" + }, + "jobTitle": { + "type": "string", + "nullable": true + }, + "jobCreatorId": { + "type": "integer" + }, + "jobCreatorName": { + "type": "string", + "nullable": true, + "description": "Display name of the job creator, or null when that user can no longer be resolved." + }, + "jobCreatorAvatarUrl": { + "type": "string", + "nullable": true, + "description": "URL of the job creator's avatar (their own photo, or a default), or null when that user can no longer be resolved." } } }, - "ShipmentUpdate": { - "description": "This class represents the update of a shipment.", + "ReviewItemRowResource": { "type": "object", "required": [ - "identifier", - "transition", - "Owner", - "Context" + "autoTranslationId", + "contentId", + "versionNo", + "sourceLanguageCode", + "targetLanguageCode", + "providerIdentifier", + "reviewStatus", + "origin" ], "properties": { - "identifier": { + "autoTranslationId": { + "type": "integer" + }, + "contentId": { + "type": "integer" + }, + "contentName": { + "type": "string", + "nullable": true + }, + "contentTypeIdentifier": { + "type": "string", + "nullable": true + }, + "versionNo": { + "type": "integer" + }, + "sourceLanguageCode": { "type": "string" }, - "transition": { + "targetLanguageCode": { "type": "string" }, - "Owner": { - "$ref": "#/components/schemas/Ref" + "providerIdentifier": { + "type": "string" }, - "Context": { - "type": "object" + "reviewStatus": { + "type": "string" + }, + "origin": { + "type": "string", + "enum": [ + "bulk", + "individual" + ] + }, + "bulkContext": { + "nullable": true, + "allOf": [ + { + "$ref": "#/components/schemas/BulkTranslationContextResource" + } + ] } } }, - "ShipmentUpdateWrapper": { + "ForReviewResource": { "type": "object", "required": [ - "ShipmentUpdate" + "totalCount", + "page", + "limit", + "rows" ], "properties": { - "ShipmentUpdate": { - "$ref": "#/components/schemas/ShipmentUpdate" + "totalCount": { + "type": "integer" + }, + "page": { + "type": "integer" + }, + "limit": { + "type": "integer" + }, + "rows": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReviewItemRowResource" + } } } }, - "ShipmentCreate": { - "description": "This class represents the creation of a shipment.", + "TranslatedResource": { "type": "object", "required": [ - "identifier", - "ShippingMethod", - "Owner", - "Context" + "totalCount", + "page", + "limit", + "rows" ], "properties": { - "identifier": { - "type": "string" + "totalCount": { + "type": "integer" }, - "ShippingMethod": { - "$ref": "#/components/schemas/Ref" + "page": { + "type": "integer" }, - "Owner": { - "$ref": "#/components/schemas/Ref" + "limit": { + "type": "integer" }, - "Context": { - "type": "object" + "rows": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReviewItemRowResource" + } } } }, - "ShipmentCreateWrapper": { + "BulkTranslationStartResource": { "type": "object", "required": [ - "ShipmentCreate" + "started", + "totalItems", + "requestedCount", + "acceptedCount", + "skippedCount" ], "properties": { - "ShipmentCreate": { - "$ref": "#/components/schemas/ShipmentCreate" + "started": { + "type": "boolean" + }, + "jobId": { + "type": "integer", + "nullable": true + }, + "totalItems": { + "type": "integer" + }, + "requestedCount": { + "type": "integer" + }, + "acceptedCount": { + "type": "integer" + }, + "skippedCount": { + "type": "integer" } } }, - "ShippingMethod": { - "description": "This class represents a shipping method.", + "HistoryRowResource": { "type": "object", "required": [ - "identifier", - "name", - "names", - "description", - "descriptions", - "enabled", - "options", - "regions", - "type" + "id", + "title", + "createdAt", + "targetLanguageCodes", + "creatorId", + "status", + "totalItems", + "successfulItems", + "reviewItems", + "failedItems" ], "properties": { - "identifier": { - "type": "string" + "id": { + "type": "integer" }, - "name": { - "type": "string" + "title": { + "type": "string", + "description": "The job title, or a \"#<id>\" label when the job was created without one." }, - "names": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MultilingualValue" - } - } + "createdAt": { + "type": "string", + "format": "date-time" + }, + "targetLanguageCodes": { + "type": "array", + "items": { + "type": "string" } }, - "description": { - "type": "string" + "creatorId": { + "type": "integer" }, - "descriptions": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MultilingualValue" - } - } - } + "creatorName": { + "type": "string", + "nullable": true, + "description": "Display name of the job creator, or null when that user can no longer be resolved." }, - "enabled": { - "type": "boolean" + "status": { + "type": "string", + "enum": [ + "pending", + "in_progress", + "completed", + "failed", + "cancelled" + ] }, - "options": { - "type": "object", - "required": [ - "option" - ], - "properties": { - "option": { - "type": "array", - "items": { - "$ref": "#/components/schemas/KeyValue" - } - } - } + "totalItems": { + "type": "integer" }, - "regions": { - "type": "object", - "required": [ - "RegionRefList" - ], - "properties": { - "RegionRefList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Ref" - } - } - } + "successfulItems": { + "type": "integer" }, - "type": { - "$ref": "#/components/schemas/Ref" + "reviewItems": { + "type": "integer" + }, + "failedItems": { + "type": "integer" } } }, - "ShippingMethodWrapper": { + "HistoryCreatorChoiceResource": { "type": "object", "required": [ - "ShippingMethod" + "id", + "name" ], "properties": { - "ShippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "id": { + "type": "integer" + }, + "name": { + "type": "string" } } }, - "ShippingMethodType": { - "description": "This class represents a shipping method type.", + "HistoryResource": { "type": "object", "required": [ - "identifier", - "name" + "totalCount", + "page", + "limit", + "rows", + "creatorChoices" ], "properties": { - "identifier": { - "type": "string" + "totalCount": { + "type": "integer" }, - "name": { + "page": { + "type": "integer" + }, + "limit": { + "type": "integer" + }, + "rows": { + "type": "array", + "items": { + "$ref": "#/components/schemas/HistoryRowResource" + } + }, + "creatorChoices": { + "type": "array", + "description": "Distinct job creators, for the Creator filter dropdown. Unresolved users are omitted.", + "items": { + "$ref": "#/components/schemas/HistoryCreatorChoiceResource" + } + } + } + }, + "PageStructure": { + "description": "Catalogue of the layouts and blocks available for building Pages.", + "type": "object", + "required": [ + "_media-type", + "layouts", + "blocks" + ], + "properties": { + "_media-type": { "type": "string" + }, + "layouts": { + "description": "Page layouts available for building Pages.", + "type": "array", + "items": { + "$ref": "#/components/schemas/PageStructureLayout" + } + }, + "blocks": { + "description": "Page blocks available for placing in the zones of a layout.", + "type": "array", + "items": { + "$ref": "#/components/schemas/PageStructureBlock" + } } } }, - "ShippingMethodTypeWrapper": { + "PageStructureWrapper": { "type": "object", "required": [ - "ShippingMethodType" + "PageStructure" ], "properties": { - "ShippingMethodType": { - "$ref": "#/components/schemas/ShippingMethodType" + "PageStructure": { + "$ref": "#/components/schemas/PageStructure" } } }, - "ShippingMethodTypesList": { - "description": "This class represents a list of shipping method types.", + "PageStructureLayout": { + "description": "Page layout, together with the zones it is divided into.", "type": "object", "required": [ - "ShippingMethodTypes" + "_media-type", + "identifier", + "name", + "description", + "zones" ], "properties": { - "ShippingMethodTypes": { + "_media-type": { + "type": "string" + }, + "identifier": { + "description": "Unique layout identifier, as used in configuration.", + "type": "string" + }, + "name": { + "description": "Human-readable layout name.", + "type": "string" + }, + "description": { + "description": "Human-readable layout description. Empty string when the layout declares no description.", + "type": "string" + }, + "zones": { + "description": "Zones the layout is divided into. Blocks are placed in zones.", "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodType" + "$ref": "#/components/schemas/PageStructureZone" } } } }, - "ShippingMethodTypesListWrapper": { + "PageStructureZone": { + "description": "Zone of a Page layout.", "type": "object", "required": [ - "ShippingMethodTypesList" + "_media-type", + "identifier", + "name", + "description" ], "properties": { - "ShippingMethodTypesList": { - "$ref": "#/components/schemas/ShippingMethodTypesList" + "_media-type": { + "type": "string" + }, + "identifier": { + "description": "Unique zone identifier within its layout.", + "type": "string" + }, + "name": { + "description": "Human-readable zone name.", + "type": "string" + }, + "description": { + "description": "Human-readable zone description. Empty string when the zone declares no description.", + "type": "string" } } }, - "ShippingMethodRefList": { - "description": "This class represents a list of shipping methods", + "PageStructureBlock": { + "description": "Page block, together with its views and attributes.", "type": "object", "required": [ - "ShippingMethodRefs" + "_media-type", + "identifier", + "name", + "description", + "category", + "views", + "attributes" ], "properties": { - "ShippingMethodRefs": { + "_media-type": { + "type": "string" + }, + "identifier": { + "description": "Unique block identifier, as used in configuration.", + "type": "string" + }, + "name": { + "description": "Human-readable block name.", + "type": "string" + }, + "description": { + "description": "Human-readable block description. Empty string when the block declares no description.", + "type": "string" + }, + "category": { + "description": "Identifier of the category the block is grouped under in the editor.", + "type": "string" + }, + "views": { + "description": "Views the block can be rendered with.", "type": "array", "items": { - "$ref": "#/components/schemas/Ref" + "$ref": "#/components/schemas/PageStructureView" + } + }, + "attributes": { + "description": "Attributes the block accepts.", + "type": "array", + "items": { + "$ref": "#/components/schemas/PageStructureAttribute" } } } }, - "ShippingMethodRefListWrapper": { + "PageStructureView": { + "description": "View a Page block can be rendered with.", "type": "object", "required": [ - "ShippingMethodRefList" + "_media-type", + "identifier", + "name", + "description" ], "properties": { - "ShippingMethodRefList": { - "$ref": "#/components/schemas/ShippingMethodRefList" + "_media-type": { + "type": "string" + }, + "identifier": { + "description": "Unique view identifier within its block.", + "type": "string" + }, + "name": { + "description": "Human-readable view name.", + "type": "string" + }, + "description": { + "description": "Human-readable view description. Empty string when the view declares no description.", + "type": "string" } } }, - "ExampleSessionCreate": { + "PageStructureAttribute": { + "description": "Attribute of a Page block.", "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" + "_media-type", + "identifier", + "name", + "type", + "category", + "options" ], - "additionalProperties": false - }, - "ExampleSessionUpdate": { - "type": "object", - "description": "Schema for updating a collaboration session", "properties": { - "ExampleSessionUpdate": { + "_media-type": { + "type": "string" + }, + "identifier": { + "description": "Unique attribute identifier within its block.", + "type": "string" + }, + "name": { + "description": "Human-readable attribute name.", + "type": "string" + }, + "type": { + "description": "Identifier of the attribute type, which determines how the value is edited and stored.", + "type": "string" + }, + "category": { + "description": "Identifier of the category the attribute is grouped under in the block edit form.", + "type": "string" + }, + "options": { + "description": "Attribute type specific configuration, passed through from the block definition as-is. Always serialized as a JSON object, empty when the attribute declares no options.\n", "type": "object", - "properties": { - "hasPublicLink": { - "type": "boolean", - "description": "Whether the session should have a public access link enabled" - } - }, - "required": [ - "hasPublicLink" - ] + "additionalProperties": true } - }, - "required": [ - "ExampleSessionUpdate" - ], - "additionalProperties": false + } }, - "InternalParticipantUpdate": { - "type": "object", - "description": "Schema for updating an internal participant", - "properties": { - "InternalParticipantUpdate": { + "Segment": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + }, + { + "description": "This class represents a segment.", "type": "object", + "required": [ + "id", + "identifier", + "name", + "source", + "SegmentGroup" + ], "properties": { - "scope": { + "id": { + "type": "integer" + }, + "identifier": { + "type": "string" + }, + "name": { + "type": "string" + }, + "source": { + "type": "string" + }, + "lastUpdatedBy": { "type": "string", - "description": "Permission scope for the participant", - "enum": [ - "view", - "edit", - "admin" - ] + "nullable": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "SegmentGroup": { + "$ref": "#/components/schemas/SegmentGroup" } - }, - "required": [ - "scope" - ] + } } - }, - "required": [ - "InternalParticipantUpdate" - ], - "additionalProperties": false + ] }, - "ExternalParticipantUpdate": { + "SegmentWrapper": { "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" + "Segment" ], - "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" - ] + "Segment": { + "$ref": "#/components/schemas/Segment" } - }, - "required": [ - "InvitationCreate" - ], - "additionalProperties": false + } }, - "ParticipantListCreate": { - "type": "object", - "description": "Schema for creating a list of participants", - "properties": { - "ParticipantListCreate": { + "SegmentList": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + }, + { + "description": "This class lists segments.", "type": "object", + "required": [ + "Segment" + ], "properties": { - "ParticipantCreate": { + "Segment": { "type": "array", - "description": "Array of participants to create", "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/InternalParticipantCreate" - }, - { - "$ref": "#/components/schemas/ExternalParticipantCreate" - } - ] - }, - "minItems": 1 + "$ref": "#/components/schemas/Segment" + } } - }, - "required": [ - "ParticipantCreate" - ] + } } - }, - "required": [ - "ParticipantListCreate" - ], - "additionalProperties": false + ] }, - "InternalParticipantCreate": { + "SegmentListWrapper": { "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" + "SegmentList" ], - "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" - ] + "SegmentList": { + "$ref": "#/components/schemas/SegmentList" } - }, - "required": [ - "_media-type", - "email", - "scope" - ], - "additionalProperties": false + } }, - "UserReference": { + "SegmentViewPermissions": { + "description": "Actions the current user is allowed to perform on segment groups in general. Reflects the role policies of the current user.\n", "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" + "createGroup" ], - "additionalProperties": false - }, - "ExampleSessionWrapper": { - "type": "object", - "description": "Wrapper object containing a collaboration session", "properties": { - "CollaborationSession": { - "$ref": "#/components/schemas/CollaborationSession", - "description": "The collaboration session object" + "createGroup": { + "description": "Whether the current user is allowed to create segment groups.", + "type": "boolean" } - }, - "required": [ - "CollaborationSession" - ], - "additionalProperties": false + } }, - "CollaborationSession": { + "SegmentViewGroupPermissions": { + "description": "Actions the current user is allowed to perform on a segment group. Reflects the role policies of the current user and the protected segment groups configuration: a protected segment group cannot be updated or removed and no segments can be created in it.\n", "type": "object", - "description": "A collaboration session representing a shared workspace for participants", + "required": [ + "update", + "delete", + "createSegment" + ], "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" + "update": { + "description": "Whether the current user is allowed to update the segment group.", + "type": "boolean" }, - "isActive": { - "type": "boolean", - "description": "Whether the collaboration session is currently active" + "delete": { + "description": "Whether the current user is allowed to remove the segment group.", + "type": "boolean" }, - "hasPublicLink": { - "type": "boolean", - "description": "Whether the session has a public access link enabled" + "createSegment": { + "description": "Whether the current user is allowed to create segments in the segment group.", + "type": "boolean" } - }, - "required": [ - "_media-type", - "id", - "token", - "ParticipantList", - "Owner", - "createdAt", - "updatedAt", - "subject" - ], - "additionalProperties": false + } }, - "Owner": { + "SegmentViewSegmentPermissions": { + "description": "Actions the current user is allowed to perform on a segment. Reflects the role policies of the current user and the protected segment groups configuration: segments of a protected segment group cannot be updated or removed.\n", "type": "object", - "description": "Owner of a collaboration session", + "required": [ + "update", + "delete" + ], "properties": { - "_media-type": { - "type": "string", - "description": "Media type identifier for the owner" + "update": { + "description": "Whether the current user is allowed to update the segment.", + "type": "boolean" }, - "_href": { - "type": "string", - "description": "REST API URL reference to the owner resource", - "format": "uri" + "delete": { + "description": "Whether the current user is allowed to remove the segment.", + "type": "boolean" } - }, + } + }, + "SegmentViewGroupInfo": { + "description": "This class represents a segment group within the segment view.", + "type": "object", "required": [ - "_media-type", - "_href" + "id", + "identifier", + "name", + "permissions" ], - "additionalProperties": false + "properties": { + "id": { + "type": "integer" + }, + "identifier": { + "type": "string" + }, + "name": { + "type": "string" + }, + "permissions": { + "$ref": "#/components/schemas/SegmentViewGroupPermissions" + } + } }, - "ExternalParticipantWrapper": { + "SegmentViewSegment": { + "description": "This class represents a segment within the segment view, together with the number of targeting blocks using it and its metadata.", "type": "object", - "description": "Wrapper object containing an external participant", - "properties": { - "Participant": { - "$ref": "#/components/schemas/ExternalParticipant", - "description": "The external participant object" - } - }, "required": [ - "Participant" + "id", + "identifier", + "name", + "source", + "blocksCount", + "permissions" ], - "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" + "type": "integer" + }, + "identifier": { + "type": "string" }, "name": { - "type": "string", - "description": "Display name of the external participant" + "type": "string" }, - "scope": { - "type": "string", - "description": "Permission scope for the participant (e.g., 'read', 'write', 'admin')" + "source": { + "type": "string" }, - "email": { + "link": { + "description": "Absolute URL of the page where the segment is managed at its source, for example the segment group list in the Back Office or the audience editor of an integration. Omitted when no link is available for the segment source.\n", "type": "string", - "description": "Email address of the external participant", - "format": "email" + "nullable": true }, - "createdAt": { + "lastUpdatedBy": { "type": "string", - "description": "ISO 8601 timestamp when the participant was added", - "format": "date-time" + "nullable": true }, "updatedAt": { "type": "string", - "description": "ISO 8601 timestamp when the participant was last updated", - "format": "date-time" + "format": "date-time", + "nullable": true + }, + "lastUpdatedByLabel": { + "type": "string", + "nullable": true + }, + "blocksCount": { + "description": "Number of published targeting blocks using the segment.", + "type": "integer" + }, + "metadata": { + "description": "Additional metadata attached to the segment by its producer, for example an integration. Keys are metadata identifiers, values are always lists of strings, even for single-valued identifiers. Empty when no metadata is stored.\n", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "permissions": { + "$ref": "#/components/schemas/SegmentViewSegmentPermissions" } - }, - "required": [ - "_media-type", - "id", - "name", - "scope", - "email", - "createdAt", - "updatedAt" - ], - "additionalProperties": false + } }, - "InternalParticipantWrapper": { + "SegmentViewGroupSegments": { + "description": "This class represents a segment group together with its segments.", "type": "object", - "description": "Wrapper object containing an internal participant", - "properties": { - "Participant": { - "$ref": "#/components/schemas/InternalParticipant", - "description": "The internal participant object" - } - }, "required": [ - "Participant" + "group", + "segments" ], - "additionalProperties": false + "properties": { + "group": { + "$ref": "#/components/schemas/SegmentViewGroupInfo" + }, + "segments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SegmentViewSegment" + } + } + } }, - "InternalParticipant": { + "SegmentViewGroupFilterOption": { + "description": "This class represents a segment group filter value with its segment count.", "type": "object", - "description": "An internal participant in a collaboration session (registered user)", + "required": [ + "id", + "identifier", + "name", + "count" + ], "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')" + "type": "integer" }, - "User": { - "$ref": "#/components/schemas/User", - "description": "Reference to the associated user account" + "identifier": { + "type": "string" }, - "createdAt": { - "type": "string", - "description": "ISO 8601 timestamp when the participant was added", - "format": "date-time" + "name": { + "type": "string" }, - "updatedAt": { - "type": "string", - "description": "ISO 8601 timestamp when the participant was last updated", - "format": "date-time" + "count": { + "type": "integer" } - }, + } + }, + "SegmentViewSourceFilterOption": { + "description": "This class represents a segment source filter value with its segment count.", + "type": "object", "required": [ - "_media-type", - "id", - "name", - "scope", - "User", - "createdAt", - "updatedAt" + "value", + "count" ], - "additionalProperties": false + "properties": { + "value": { + "type": "string" + }, + "count": { + "type": "integer" + } + } }, - "ParticipantListWrapper": { + "SegmentViewMetadataFilterOption": { + "description": "This class represents a segment metadata value with its segment count.", "type": "object", - "description": "Wrapper object containing a list of participants", + "required": [ + "value", + "count" + ], "properties": { - "ParticipantList": { - "$ref": "#/components/schemas/ParticipantListObject", - "description": "The participant list object" + "value": { + "type": "string" + }, + "count": { + "type": "integer" } - }, + } + }, + "SegmentViewFilters": { + "description": "This class represents the available filter options of the segment view.", + "type": "object", "required": [ - "ParticipantList" + "groups", + "source", + "metadata" ], - "additionalProperties": false + "properties": { + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SegmentViewGroupFilterOption" + } + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SegmentViewSourceFilterOption" + } + }, + "metadata": { + "description": "Metadata values segments can be filtered by, keyed by metadata identifier. Contains only the identifiers declared as filterable by their producer, counted against the remaining filters. Empty when none are declared.\n", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SegmentViewMetadataFilterOption" + } + } + } + } }, - "ParticipantListObject": { + "SegmentView": { + "description": "This class lists segments grouped by their segment groups, with available filter values.", "type": "object", - "description": "A list of participants in a collaboration session", + "required": [ + "totalCount", + "permissions", + "filters", + "groups" + ], "properties": { - "_media-type": { - "type": "string", - "description": "Media type identifier for the participant list" + "totalCount": { + "type": "integer" }, - "Participants": { + "permissions": { + "$ref": "#/components/schemas/SegmentViewPermissions" + }, + "filters": { + "$ref": "#/components/schemas/SegmentViewFilters" + }, + "groups": { "type": "array", - "description": "Array of participants in the collaboration session", "items": { - "$ref": "#/components/schemas/ParticipantItem" + "$ref": "#/components/schemas/SegmentViewGroupSegments" } } - }, + } + }, + "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": [ - "_media-type", - "Participants" + "SegmentGroup" ], - "additionalProperties": false + "properties": { + "SegmentGroup": { + "$ref": "#/components/schemas/SegmentGroup" + } + } }, - "ParticipantItem": { + "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", - "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" + "type": "integer" }, - "scope": { - "type": "string", - "description": "Permission scope for the participant (e.g., 'read', 'write', 'admin')" + "identifier": { + "type": "string" }, - "User": { - "$ref": "#/components/schemas/User", - "description": "Reference to the associated user account (for internal participants only)" + "name": { + "type": "string" }, - "email": { - "type": "string", - "description": "Email address of the participant (for external participants only)", - "format": "email" + "source": { + "type": "string" }, - "createdAt": { + "lastUpdatedBy": { "type": "string", - "description": "ISO 8601 timestamp when the participant was added", - "format": "date-time" + "nullable": true }, "updatedAt": { "type": "string", - "description": "ISO 8601 timestamp when the participant was last updated", - "format": "date-time" + "format": "date-time", + "nullable": true + }, + "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": [ - "_media-type", - "id", - "name", - "scope", - "createdAt", - "updatedAt" + "UserSegmentList" ], - "additionalProperties": false + "properties": { + "UserSegmentList": { + "$ref": "#/components/schemas/SegmentList" + } + } }, - "InvitationWrapper": { + "UserSegmentAssignInput": { "type": "object", - "description": "Wrapper object containing an invitation", "properties": { - "Invitation": { - "$ref": "#/components/schemas/Invitation", - "description": "The invitation object" + "segments": { + "type": "array", + "items": { + "type": "string" + } } - }, + } + }, + "UserSegmentAssignInputWrapper": { + "type": "object", "required": [ - "Invitation" + "UserSegmentAssignInput" ], - "additionalProperties": false + "properties": { + "UserSegmentAssignInput": { + "$ref": "#/components/schemas/UserSegmentAssignInput" + } + } }, - "Invitation": { + "ActivityLog": { + "description": "This class represents an activity log entry.", + "type": "object" + }, + "ActivityLogGroup": { "type": "object", - "description": "An invitation to join a collaboration session", + "required": [ + "user_id", + "logged_at", + "ActivityLogEntries" + ], "properties": { - "_media-type": { - "type": "string", - "description": "Media type identifier for the invitation" + "user_id": { + "description": "The ID of the user performing the logged actions", + "type": "integer" }, - "id": { - "type": "integer", - "description": "Unique identifier of the invitation" + "logged_at": { + "description": "Timestamp representing when the group has been logged", + "type": "integer" }, - "status": { - "type": "string", - "description": "Current status of the invitation (e.g., 'pending', 'accepted', 'declined')", - "enum": [ - "pending", - "accepted", - "declined", - "expired" - ] + "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", + "properties": { + "offset": { + "description": "The offset of the first item to return", + "type": "integer" }, - "createdAt": { - "type": "string", - "description": "ISO 8601 timestamp when the invitation was created", - "format": "date-time" + "limit": { + "description": "The maximum number of items to return - default is set by `activity_log.pagination.activity_logs_limit` which is 25 if not overridden", + "type": "integer" }, - "updatedAt": { - "type": "string", - "description": "ISO 8601 timestamp when the invitation was last updated", - "format": "date-time" + "criteria": { + "description": "Search criteria for activity log groups", + "type": "array", + "items": { + "description": "Search criterion for activity log groups", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "The type of the search criterion", + "type": "string", + "enum": [ + "action", + "logged_at", + "object_class", + "user" + ] + }, + "value": { + "description": "The value of the search criterion", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array" + } + ] + }, + "operator": { + "description": "The operator of the search criterion", + "type": "string" + }, + "class": { + "description": "The class of the `object_class` criterion", + "type": "string" + } + } + } }, - "context": { - "oneOf": [ - { - "type": "array", - "description": "Additional context data as an array" - }, - { - "type": "object", - "description": "Additional context data as an object" + "sort_clause": { + "description": "Sort clauses for activity log groups", + "type": "array", + "items": { + "description": "Sort clause for activity log groups", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "The type of the sort clause", + "type": "string", + "enum": [ + "logged_at" + ] + }, + "direction": { + "description": "The direction of the sort clause", + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + } } - ], - "description": "Additional context information for the invitation" - }, - "Sender": { - "$ref": "#/components/schemas/Sender", - "description": "Reference to the user who sent the invitation" + } } - }, + } + }, + "ActivityLogGroupListInputWrapper": { + "type": "object", "required": [ - "_media-type", - "id", - "status", - "createdAt", - "updatedAt", - "context", - "Sender" + "ActivityLogGroupListInput" ], - "additionalProperties": false + "properties": { + "ActivityLogGroupListInput": { + "$ref": "#/components/schemas/ActivityLogGroupListInput" + } + } }, - "Sender": { + "ActivityLogGroupList": { + "description": "This class represents activity log context groups", "type": "object", - "description": "Reference to the sender of an invitation", + "required": [ + "ActivityLogGroups" + ], "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" + "ActivityLogGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ActivityLogGroup" + } } - }, + } + }, + "ActivityLogGroupListWrapper": { + "type": "object", "required": [ - "_media-type", - "_href" + "ActivityLogGroupList" ], - "additionalProperties": false + "properties": { + "ActivityLogGroupList": { + "$ref": "#/components/schemas/ActivityLogGroupList" + } + } }, "ActionType": { "type": "object", @@ -54230,755 +41274,684 @@ } } }, - "DiscountList": { + "ExampleSessionCreate": { "type": "object", - "required": [ - "_media-type", - "Discount" - ], + "description": "Schema for creating a new collaboration session", "properties": { - "_media-type": { - "type": "string", - "enum": [ - "application/vnd.ibexa.api.DiscountList+json" + "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" ] - }, - "Discount": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/Discount" - } - ] - } } - } + }, + "required": [ + "ExampleSessionCreate" + ], + "additionalProperties": false }, - "Discount": { + "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": [ - "id", - "identifier", - "name", - "type", - "priority", - "isEnabled", - "createdAt", - "updatedAt", - "startDate", - "DiscountRule", - "DiscountExpressionAware", - "DiscountConditions", - "DiscountTranslations" + "ExampleSessionUpdate" ], + "additionalProperties": false + }, + "InternalParticipantUpdate": { + "type": "object", + "description": "Schema for updating an internal participant", "properties": { - "_media-type": { - "type": "string", - "enum": [ - "application/vnd.ibexa.api.Discount+json" + "InternalParticipantUpdate": { + "type": "object", + "properties": { + "scope": { + "type": "string", + "description": "Permission scope for the participant", + "enum": [ + "view", + "edit", + "admin" + ] + } + }, + "required": [ + "scope" ] - }, - "id": { - "type": "integer" - }, - "identifier": { - "type": "string" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "label": { - "type": "string" - }, - "labelDescription": { - "type": "string" - }, - "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" - } } - } + }, + "required": [ + "InternalParticipantUpdate" + ], + "additionalProperties": false }, - "DiscountRule": { + "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": [ - "_media-type", - "type", - "expressionValues" + "ExternalParticipantUpdate" ], + "additionalProperties": false + }, + "InvitationCreate": { + "type": "object", + "description": "Schema for creating a new invitation", "properties": { - "_media-type": { - "type": "string" - }, - "type": { - "type": "string" - }, - "expressionValues": { + "InvitationCreate": { "type": "object", - "additionalProperties": true + "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 }, - "DiscountExpressionAware": { + "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": [ - "_media-type", - "expressionValues" + "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.DiscountExpressionAware+json" + "application/vnd.ibexa.api.InternalParticipantCreate+json" ] }, - "expressionValues": { - "type": "object", - "additionalProperties": true + "User": { + "$ref": "#/components/schemas/UserReference", + "description": "Reference to the user account" + }, + "scope": { + "type": "string", + "description": "Permission scope for the participant", + "enum": [ + "view", + "edit", + "admin" + ] } - } - }, - "DiscountCondition": { - "type": "object", + }, "required": [ "_media-type", - "identifier", - "expressionValues" + "User", + "scope" ], + "additionalProperties": false + }, + "ExternalParticipantCreate": { + "type": "object", + "description": "Schema for creating an external participant", "properties": { "_media-type": { - "type": "string" + "type": "string", + "description": "Media type identifier for external participant creation", + "enum": [ + "application/vnd.ibexa.api.ExternalParticipantCreate+json" + ] }, - "identifier": { - "type": "string" + "email": { + "type": "string", + "description": "Email address of the external participant", + "format": "email" }, - "expressionValues": { - "type": "object", - "additionalProperties": true + "scope": { + "type": "string", + "description": "Permission scope for the participant", + "enum": [ + "view", + "edit", + "admin" + ] } - } - }, - "DiscountTranslation": { - "type": "object", + }, "required": [ "_media-type", - "languageCode", - "name" + "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.DiscountTranslation+json" + "application/vnd.ibexa.api.User+json" ] }, - "languageCode": { - "$ref": "#/components/schemas/Language" - }, - "name": { - "type": "string" - }, - "description": { - "type": "object" - }, - "label": { - "type": "string" - }, - "labelDescription": { - "type": "string" + "_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 }, - "DiscountCreate": { + "ExampleSessionWrapper": { "type": "object", + "description": "Wrapper object containing a collaboration session", + "properties": { + "CollaborationSession": { + "$ref": "#/components/schemas/CollaborationSession", + "description": "The collaboration session object" + } + }, "required": [ - "identifier", - "type", - "priority", - "isEnabled", - "userId", - "rule", - "translations" + "CollaborationSession" ], + "additionalProperties": false + }, + "CollaborationSession": { + "type": "object", + "description": "A collaboration session representing a shared workspace for participants", "properties": { - "identifier": { - "type": "string", - "minLength": 1 - }, - "type": { + "_media-type": { "type": "string", - "enum": [ - "cart", - "catalog" - ] + "description": "Media type identifier for the collaboration session" }, - "priority": { + "id": { "type": "integer", - "minimum": 1, - "maximum": 10 - }, - "isEnabled": { - "type": "boolean" + "description": "Unique identifier of the collaboration session" }, - "userId": { - "type": "integer" + "token": { + "type": "string", + "description": "Session access token for authentication and authorization" }, - "rule": { - "type": "object", - "required": [ - "type", - "amount" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "fixed_amount", - "percentage" - ] - }, - "amount": { - "type": "string" - } - } + "ParticipantList": { + "$ref": "#/components/schemas/ParticipantListObject", + "description": "List of participants in the collaboration session" }, - "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": [] - } - } - } + "Owner": { + "$ref": "#/components/schemas/Owner", + "description": "Owner of the collaboration session" }, - "startDate": { + "createdAt": { "type": "string", + "description": "ISO 8601 timestamp when the session was created", "format": "date-time" }, - "endDate": { + "updatedAt": { "type": "string", + "description": "ISO 8601 timestamp when the session was last updated", "format": "date-time" }, - "createdAt": { + "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", - "format": "date-time" + "description": "Media type identifier for the owner" }, - "updatedAt": { + "_href": { "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 + "description": "REST API URL reference to the owner resource", + "format": "uri" } - } + }, + "required": [ + "_media-type", + "_href" + ], + "additionalProperties": false }, - "DiscountUpdate": { + "ExternalParticipantWrapper": { "type": "object", + "description": "Wrapper object containing an external participant", + "properties": { + "Participant": { + "$ref": "#/components/schemas/ExternalParticipant", + "description": "The external participant object" + } + }, "required": [ - "identifier" + "Participant" ], + "additionalProperties": false + }, + "ExternalParticipant": { + "type": "object", + "description": "An external participant in a collaboration session (not a registered user)", "properties": { - "identifier": { + "_media-type": { "type": "string", - "minLength": 1 + "description": "Media type identifier for the external participant" }, - "priority": { + "id": { "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" - } - } + "description": "Unique identifier of the participant" }, - "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": [] - } - } - } + "name": { + "type": "string", + "description": "Display name of the external participant" }, - "startDate": { + "scope": { "type": "string", - "format": "date-time" + "description": "Permission scope for the participant (e.g., 'read', 'write', 'admin')" }, - "endDate": { + "email": { "type": "string", - "format": "date-time" + "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" - }, - "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" + "_media-type", + "id", + "name", + "scope", + "email", + "createdAt", + "updatedAt" ], - "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" - } - } - } - } + "additionalProperties": false }, - "DiscountCodeWrapper": { + "InternalParticipantWrapper": { "type": "object", - "required": [ - "DiscountCode" - ], + "description": "Wrapper object containing an internal participant", "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" - }, - "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" - } - } + "Participant": { + "$ref": "#/components/schemas/InternalParticipant", + "description": "The internal participant object" } - ] - }, - "ShoppingListWrapper": { - "type": "object", + }, "required": [ - "ShoppingList" + "Participant" ], - "properties": { - "ShoppingList": { - "$ref": "#/components/schemas/ShoppingList" - } - } + "additionalProperties": false }, - "ShoppingListEntry": { - "description": "This class represents an entry in a shopping list.", + "InternalParticipant": { "type": "object", - "required": [ - "identifier", - "product", - "addedAt" - ], + "description": "An internal participant in a collaboration session (registered user)", "properties": { - "identifier": { - "description": "The unique identifier (UUID) of the entry.", + "_media-type": { "type": "string", - "format": "uuid" + "description": "Media type identifier for the internal participant" }, - "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" - } - } + "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" }, - "addedAt": { - "description": "The date and time when the entry was added.", + "updatedAt": { "type": "string", + "description": "ISO 8601 timestamp when the participant was last updated", "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" + "_media-type", + "id", + "name", + "scope", + "User", + "createdAt", + "updatedAt" ], - "properties": { - "ShoppingListCreate": { - "$ref": "#/components/schemas/ShoppingListCreate" - } - } + "additionalProperties": false }, - "ShoppingListUpdate": { - "description": "Updates an existing shopping list.", + "ParticipantListWrapper": { "type": "object", - "required": [ - "name" - ], + "description": "Wrapper object containing a list of participants", "properties": { - "name": { - "description": "The name of the shopping list (required).", - "type": "string" + "ParticipantList": { + "$ref": "#/components/schemas/ParticipantListObject", + "description": "The participant list object" } - } - }, - "ShoppingListUpdateWrapper": { - "type": "object", + }, "required": [ - "ShoppingListUpdate" + "ParticipantList" ], - "properties": { - "ShoppingListUpdate": { - "$ref": "#/components/schemas/ShoppingListUpdate" - } - } + "additionalProperties": false }, - "ShoppingListEntriesAdd": { - "description": "Adds one or more product entries to an existing shopping list.", + "ParticipantListObject": { "type": "object", - "required": [ - "entries" - ], + "description": "A list of participants in a collaboration session", "properties": { - "entries": { - "description": "Array of entries to add (required, min 1).", + "_media-type": { + "type": "string", + "description": "Media type identifier for the participant list" + }, + "Participants": { "type": "array", - "minItems": 1, + "description": "Array of participants in the collaboration session", "items": { - "$ref": "#/components/schemas/ShoppingListEntryAdd" + "$ref": "#/components/schemas/ParticipantItem" } } - } - }, - "ShoppingListEntriesAddWrapper": { - "type": "object", + }, "required": [ - "ShoppingListEntriesAdd" + "_media-type", + "Participants" ], - "properties": { - "ShoppingListEntriesAdd": { - "$ref": "#/components/schemas/ShoppingListEntriesAdd" - } - } + "additionalProperties": false }, - "ShoppingListEntriesRemove": { - "description": "Removes one or more entries from a shopping list by their identifiers.", + "ParticipantItem": { "type": "object", - "required": [ - "identifiers" - ], + "description": "A participant item that can be either internal or external", "properties": { - "identifiers": { - "description": "Array of entry identifiers (UUIDs) to remove (required, min 1).", - "type": "array", - "minItems": 1, - "items": { - "type": "string", - "format": "uuid" - } + "_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" } - } - }, - "ShoppingListEntriesRemoveWrapper": { - "type": "object", + }, "required": [ - "ShoppingListEntriesRemove" + "_media-type", + "id", + "name", + "scope", + "createdAt", + "updatedAt" ], - "properties": { - "ShoppingListEntriesRemove": { - "$ref": "#/components/schemas/ShoppingListEntriesRemove" - } - } + "additionalProperties": false }, - "ShoppingListEntryAdd": { - "description": "Represents a single entry to add to a shopping list.", + "InvitationWrapper": { "type": "object", - "required": [ - "productCode" - ], + "description": "Wrapper object containing an invitation", "properties": { - "productCode": { - "description": "Product code (required).", - "type": "string" + "Invitation": { + "$ref": "#/components/schemas/Invitation", + "description": "The invitation object" } - } - }, - "ShoppingListCollection": { - "description": "This class represents a collection of shopping lists.", - "type": "object", + }, "required": [ - "totalCount", - "count", - "ShoppingList" + "Invitation" ], + "additionalProperties": false + }, + "Invitation": { + "type": "object", + "description": "An invitation to join a collaboration session", "properties": { - "totalCount": { - "description": "Total number of shopping lists.", - "type": "integer" + "_media-type": { + "type": "string", + "description": "Media type identifier for the invitation" }, - "count": { - "description": "Number of shopping lists in this response.", - "type": "integer" + "id": { + "type": "integer", + "description": "Unique identifier of the invitation" }, - "ShoppingList": { - "description": "Array of shopping lists.", - "type": "array", - "items": { - "$ref": "#/components/schemas/ShoppingList" - } + "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" } - } - }, - "ShoppingListCollectionWrapper": { - "type": "object", + }, "required": [ - "ShoppingListCollection" + "_media-type", + "id", + "status", + "createdAt", + "updatedAt", + "context", + "Sender" ], + "additionalProperties": false + }, + "Sender": { + "type": "object", + "description": "Reference to the sender of an invitation", "properties": { - "ShoppingListCollection": { - "$ref": "#/components/schemas/ShoppingListCollection" + "_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 } }, "responses": [], @@ -54991,132 +41964,149 @@ "security": [], "tags": [ { - "name": "Section" + "name": "Section", + "description": "Resource 'Section' operations." }, { - "name": "Objects" + "name": "Objects", + "description": "Resource 'Objects' operations." }, { - "name": "Type Groups" + "name": "Type Groups", + "description": "Resource 'Type Groups' operations." }, { - "name": "Type" + "name": "Type", + "description": "Resource 'Type' operations." }, { - "name": "User" + "name": "User", + "description": "Resource 'User' operations." }, { - "name": "User Group" + "name": "User Group", + "description": "Resource 'User Group' operations." }, { - "name": "User Role" + "name": "User Role", + "description": "Resource 'User Role' operations." }, { - "name": "User Policy" + "name": "User Policy", + "description": "Resource 'User Policy' operations." }, { - "name": "Language" + "name": "Language", + "description": "Resource 'Language' operations." }, { - "name": "Location" + "name": "Location", + "description": "Resource 'Location' operations." }, { - "name": "Object State Groups" + "name": "Object State Groups", + "description": "Resource 'Object State Groups' operations." }, { - "name": "Trash" + "name": "Trash", + "description": "Resource 'Trash' operations." }, { - "name": "Url Wildcard" + "name": "Url Wildcard", + "description": "Resource 'Url Wildcard' operations." }, { - "name": "Url Alias" + "name": "Url Alias", + "description": "Resource 'Url Alias' operations." }, { "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": "User Session", + "description": "Resource 'User Session' operations." }, { - "name": "Product Catalog" + "name": "Bookmark", + "description": "Resource 'Bookmark' operations." }, { - "name": "Product Currency" + "name": "User Token", + "description": "Resource 'User Token' operations." }, { - "name": "Product Customer Group" + "name": "Calendar", + "description": "Resource 'Calendar' operations." }, { - "name": "Product" + "name": "Product Attribute", + "description": "Resource 'Product Attribute' operations." }, { - "name": "Product Type" + "name": "Product Attribute Type", + "description": "Resource 'Product Attribute Type' operations." }, { - "name": "Product Variant" + "name": "Product Attribute Group", + "description": "Resource 'Product Attribute Group' operations." }, { - "name": "Product Region" + "name": "Product Catalog", + "description": "Resource 'Product Catalog' operations." }, { - "name": "Product Vat" + "name": "Product Currency", + "description": "Resource 'Product Currency' operations." }, { - "name": "Taxonomy" + "name": "Product Customer Group", + "description": "Resource 'Product Customer Group' operations." }, { - "name": "Segmentation" + "name": "Product", + "description": "Resource 'Product' operations." }, { - "name": "Corporate Account" + "name": "Product Type", + "description": "Resource 'Product Type' operations." }, { - "name": "Activity Log" + "name": "Product Variant", + "description": "Resource 'Product Variant' operations." }, { - "name": "Cart" + "name": "Product Region", + "description": "Resource 'Product Region' operations." }, { - "name": "Shopping List" + "name": "Product Vat", + "description": "Resource 'Product Vat' operations." }, { - "name": "Orders" + "name": "Taxonomy", + "description": "Resource 'Taxonomy' operations." }, { - "name": "Payments" + "name": "Page", + "description": "Resource 'Page' operations." }, { - "name": "Shipping" + "name": "Segmentation", + "description": "Resource 'Segmentation' operations." }, { - "name": "Collaboration Sessions" + "name": "Activity Log", + "description": "Resource 'Activity Log' operations." }, { - "name": "Connector AI" + "name": "Connector AI", + "description": "Resource 'Connector AI' operations." }, { - "name": "Discounts" + "name": "Collaboration Sessions", + "description": "Resource 'Collaboration Sessions' operations." } ], "webhooks": [] -} +} \ No newline at end of file diff --git a/docs/api/rest_api/rest_api_reference/openapi.yaml b/docs/api/rest_api/rest_api_reference/openapi.yaml index 8531109d95..7de1ee8af4 100644 --- a/docs/api/rest_api/rest_api_reference/openapi.yaml +++ b/docs/api/rest_api/rest_api_reference/openapi.yaml @@ -2,10 +2,10 @@ openapi: 3.1.0 info: x-logo: - url: https://doc.ibexa.co/en/latest/images/ibexa-dxp-logo.png - title: Ibexa DXP REST API + url: https://doc.ibexa.co/en/saas/images/cohesivo-logo.png + title: Cohesivo SaaS REST API description: "" - version: 6.0.0 + version: "" servers: - url: /api/ibexa/v2 description: Current server @@ -99,13 +99,6 @@ paths: summary: List of activity log groups description: Lists last activity log groups and their entries. parameters: [] - deprecated: false - x-badges: - - name: Experience - color: '#D3822B' - - name: Commerce - color: '#A32768' - position: after post: operationId: ibexa.activity_log.rest.activity_log_group.list.post tags: @@ -199,12 +192,10 @@ paths: description: The CSRF Token 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 query to filter activity log groups. content: @@ -252,13 +243,6 @@ paths: </sortClauses> </ActivityLogListInput> required: false - deprecated: false - x-badges: - - name: Experience - color: '#D3822B' - - name: Commerce - color: '#A32768' - position: after /bookmark: get: operationId: ibexa.rest.load_bookmarks @@ -604,7 +588,6 @@ paths: summary: List of bookmarks description: Lists bookmarked Locations for the current user. parameters: [] - deprecated: false /bookmark/{locationId}: get: operationId: ibexa.rest.is_bookmarked.get @@ -617,21 +600,20 @@ paths: description: Error - the user is not authorized for the given Location. 404: description: Error - the given Location is not bookmarked or does not exist. + 204: + description: BookmarkIsBookmarkedController resource summary: Check if Location is bookmarked description: Checks if the given Location is bookmarked by the current user. parameters: - name: locationId in: path - description: "" + description: BookmarkIsBookmarkedController identifier required: true deprecated: false - allowEmptyValue: false schema: type: integer style: simple explode: false - allowReserved: false - deprecated: false post: operationId: ibexa.rest.create_bookmark tags: @@ -653,28 +635,23 @@ paths: description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: locationId in: path - description: "" + description: BookmarkCreateController identifier 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 delete: operationId: ibexa.rest.delete_bookmark tags: @@ -694,24 +671,19 @@ paths: description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: locationId in: path - description: "" + description: BookmarkDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false head: operationId: ibexa.rest.is_bookmarked.head tags: @@ -728,16 +700,13 @@ paths: parameters: - name: locationId in: path - description: "" + description: BookmarkIsBookmarkedController identifier required: true deprecated: false - allowEmptyValue: false schema: type: integer style: simple explode: false - allowReserved: false - deprecated: false /calendar/event: get: operationId: ibexa.calendar.rest.event.list @@ -776,47 +745,39 @@ paths: description: timestamp (seconds since the Unix Epoch). required: true deprecated: false - allowEmptyValue: false schema: $ref: '#/components/schemas/UnixTimestamp' style: form explode: false - allowReserved: false - name: end in: query description: timestamp. required: true deprecated: false - allowEmptyValue: false schema: $ref: '#/components/schemas/UnixTimestamp' style: form explode: false - allowReserved: false - name: count in: query description: Maximum number of events returned (10 by default). required: false deprecated: false - allowEmptyValue: false schema: type: integer style: form explode: false - allowReserved: false - name: types in: query description: Comma-separated list of type identifiers. required: false deprecated: false - allowEmptyValue: false schema: type: array items: type: string style: form explode: false - allowReserved: false example: - future_publication - future_hide @@ -827,14 +788,12 @@ paths: description: comma-separated list of language codes. required: false deprecated: false - allowEmptyValue: false schema: type: array items: type: string style: form explode: false - allowReserved: false example: - eng-GB - fre-FR @@ -847,14 +806,11 @@ paths: is the ID) encoded as "MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy" required: false deprecated: false - allowEmptyValue: false schema: type: string style: form explode: false - allowReserved: false example: MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy - deprecated: false /calendar/event/grouped-by-day: get: operationId: ibexa.calendar.rest.event.list.group_by_day @@ -1175,47 +1131,39 @@ paths: description: timestamp (seconds since the Unix Epoch). required: true deprecated: false - allowEmptyValue: false schema: $ref: '#/components/schemas/UnixTimestamp' style: form explode: false - allowReserved: false - name: end in: query description: timestamp. required: true deprecated: false - allowEmptyValue: false schema: $ref: '#/components/schemas/UnixTimestamp' style: form explode: false - allowReserved: false - name: count in: query description: Maximum number of events returned (10 by default). required: false deprecated: false - allowEmptyValue: false schema: type: integer style: form explode: false - allowReserved: false - name: types in: query description: Comma-separated list of type identifiers. required: false deprecated: false - allowEmptyValue: false schema: type: array items: type: string style: form explode: false - allowReserved: false example: - future_publication - future_hide @@ -1226,14 +1174,12 @@ paths: description: comma-separated list of language codes. required: false deprecated: false - allowEmptyValue: false schema: type: array items: type: string style: form explode: false - allowReserved: false example: - eng-GB - fre-FR @@ -1246,14 +1192,11 @@ paths: is the ID) encoded as "MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy" required: false deprecated: false - allowEmptyValue: false schema: type: string style: form explode: false - allowReserved: false example: MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy - deprecated: false /calendar/event/{eventType}: post: operationId: ibexa.calendar.rest.event.action @@ -1271,7 +1214,6 @@ paths: description: The type of event to execute an action on. required: true deprecated: false - allowEmptyValue: false schema: type: string enum: @@ -1279,7 +1221,6 @@ paths: - future_hide style: simple explode: false - allowReserved: false requestBody: description: Data for the calendar action to execute content: @@ -1305,5966 +1246,3290 @@ paths: events: - future_publication:2 required: true - deprecated: false - /cart: + /collaboration/sessions: post: - operationId: ibexa.rest.cart.create + operationId: api_collaborationsessions_post tags: - - Cart + - Collaboration Sessions responses: - 200: - description: If set, the created Cart is returned in XML or JSON format. + 201: + description: Session created content: - application/vnd.ibexa.api.Cart+json: + application/vnd.ibexa.api.ExampleSession+json: schema: - $ref: '#/components/schemas/CartWrapper' + $ref: '#/components/schemas/ExampleSessionWrapper' 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: + 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 - Currency: - _media-type: application/vnd.ibexa.api.Currency+json - id: 2 - code: EUR - subunits: 2 - enabled: true - entries: [] - application/vnd.ibexa.api.Cart+xml: + subject: Project Collaboration Session + isActive: true + hasPublicLink: false + application/vnd.ibexa.api.ExampleSession+xml: schema: - $ref: '#/components/schemas/Cart' + $ref: '#/components/schemas/ExampleSessionWrapper' + example: |+ + <?xml version="1.0"?> + <CollaborationSession media-type="application/vnd.ibexa.api.ExampleSession+xml"> + <id>123</id> + <token>abc123def456ghi789</token> + <createdAt>2023-11-15T10:30:00+00:00</createdAt> + <updatedAt>2023-11-15T14:45:00+00:00</updatedAt> + <ParticipantList media-type="application/vnd.ibexa.api.ParticipantList+xml"> + <Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml"> + <id>1</id> + <name>John Doe</name> + <scope>edit</scope> + <User href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> + <createdAt>2023-11-15T10:30:00+00:00</createdAt> + <updatedAt>2023-11-15T10:30:00+00:00</updatedAt> + </Participant> + <Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml"> + <id>2</id> + <name>guest@example.com</name> + <scope>view</scope> + <email>guest@example.com</email> + <createdAt>2023-11-15T11:00:00+00:00</createdAt> + <updatedAt>2023-11-15T11:00:00+00:00</updatedAt> + </Participant> + </ParticipantList> + <Owner href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> + <subject>Project Collaboration Session</subject> + <isActive>true</isActive> + <hasPublicLink>false</hasPublicLink> + </CollaborationSession> + 400: - description: Error - The input does not match the input schema definition. - summary: Create Cart - description: Creates Cart from payload. - parameters: - - name: X-CSRF-Token - in: header - description: The CSRF token. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The CartCreate schema encoded in XML or JSON format. - 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: ibexa.rest.cart.cart.view - 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: X-CSRF-Token - in: header - description: The CSRF token. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false + 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: The CartViewInput schema is posted in XML or JSON format. + description: Session creation payload content: - application/vnd.ibexa.api.CartViewInput+json: + application/vnd.ibexa.api.ExampleSessionCreate+json: schema: - $ref: '#/components/schemas/CartViewInputWrapper' + $ref: '#/components/schemas/ExampleSessionCreate' example: - CartViewInput: - identifier: loadUserCarts - CartQuery: - offset: 0 - limit: 10 - ownerId: 123 - application/vnd.ibexa.api.CartViewInput+xml: + 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/CartViewInput' + $ref: '#/components/schemas/ExampleSessionCreate' + example: |+ + <?xml version="1.0" encoding="UTF-8"?> + <ExampleSessionCreate> + <Owner media-type="application/vnd.ibexa.api.User+xml" + href="/api/ibexa/v2/user/users/14" + > + </Owner> + <ParticipantListCreate media-type="application/vnd.ibexa.api.ParticipantListCreate+xml"> + <ParticipantCreate media-type="application/vnd.ibexa.api.InternalParticipantCreate+xml"> + <scope>view</scope> + <User media-type="application/vnd.ibexa.api.User+xml" + href="/api/ibexa/v2/user/users/14" + > + </User> + </ParticipantCreate> + <ParticipantCreate media-type="application/vnd.ibexa.api.ExternalParticipantCreate+xml"> + <email>user@link.invalid</email> + <scope>view</scope> + </ParticipantCreate> + </ParticipantListCreate> + <subject>example</subject> + </ExampleSessionCreate> + required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /cart/{identifier}: + /collaboration/sessions/{sessionToken}: get: - operationId: ibexa.rest.cart.get + operationId: api_collaborationsessions_sessionToken_get tags: - - Cart + - Collaboration Sessions responses: 200: - description: OK - return the cart + description: Session content: - application/vnd.ibexa.api.Cart+json: + application/vnd.ibexa.api.ExampleSession+json: schema: - $ref: '#/components/schemas/CartWrapper' - application/vnd.ibexa.api.Cart+xml: + $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/Cart' - 401: - description: Error - the user is not authorized to get this cart. + $ref: '#/components/schemas/ExampleSessionWrapper' + example: |+ + <?xml version="1.0"?> + <CollaborationSession media-type="application/vnd.ibexa.api.ExampleSession+xml"> + <id>123</id> + <token>abc123def456ghi789</token> + <createdAt>2023-11-15T10:30:00+00:00</createdAt> + <updatedAt>2023-11-15T14:45:00+00:00</updatedAt> + <ParticipantList media-type="application/vnd.ibexa.api.ParticipantList+xml"> + <Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml"> + <id>1</id> + <name>John Doe</name> + <scope>edit</scope> + <User href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> + <createdAt>2023-11-15T10:30:00+00:00</createdAt> + <updatedAt>2023-11-15T10:30:00+00:00</updatedAt> + </Participant> + <Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml"> + <id>2</id> + <name>guest@example.com</name> + <scope>view</scope> + <email>guest@example.com</email> + <createdAt>2023-11-15T11:00:00+00:00</createdAt> + <updatedAt>2023-11-15T11:00:00+00:00</updatedAt> + </Participant> + </ParticipantList> + <Owner href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> + <subject>Project Collaboration Session</subject> + <isActive>true</isActive> + <hasPublicLink>false</hasPublicLink> + </CollaborationSession> + 404: - description: Error - The identifier do not match any Cart. - summary: Get Cart - description: Gets Cart by its identifier. + 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: identifier + - name: sessionToken in: path - description: "" + description: The session token to retrieve. 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: ibexa.rest.cart.delete + operationId: api_collaborationsessions_sessionToken_delete tags: - - Cart + - Collaboration Sessions responses: 204: - description: CartDeleteController resource deleted - summary: Delete Cart - description: Deletes Cart by its identifier. + 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: identifier + - name: sessionToken in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: X-CSRF-Token - in: header - description: The CSRF token. + description: The session token to delete. 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: ibexa.rest.cart.update + operationId: api_collaborationsessions_sessionToken_patch tags: - - Cart + - Collaboration Sessions responses: 200: - description: OK - return the updated cart + description: Updated session content: - application/vnd.ibexa.api.Cart+json: + application/vnd.ibexa.api.ExampleSession+json: schema: - $ref: '#/components/schemas/CartWrapper' - application/vnd.ibexa.api.Cart+xml: + $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/Cart' + $ref: '#/components/schemas/ExampleSessionWrapper' + example: |+ + <?xml version="1.0"?> + <CollaborationSession media-type="application/vnd.ibexa.api.ExampleSession+xml"> + <id>123</id> + <token>abc123def456ghi789</token> + <createdAt>2023-11-15T10:30:00+00:00</createdAt> + <updatedAt>2023-11-15T14:45:00+00:00</updatedAt> + <ParticipantList media-type="application/vnd.ibexa.api.ParticipantList+xml"> + <Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml"> + <id>1</id> + <name>John Doe</name> + <scope>edit</scope> + <User href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> + <createdAt>2023-11-15T10:30:00+00:00</createdAt> + <updatedAt>2023-11-15T10:30:00+00:00</updatedAt> + </Participant> + <Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml"> + <id>2</id> + <name>guest@example.com</name> + <scope>view</scope> + <email>guest@example.com</email> + <createdAt>2023-11-15T11:00:00+00:00</createdAt> + <updatedAt>2023-11-15T11:00:00+00:00</updatedAt> + </Participant> + </ParticipantList> + <Owner href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> + <subject>Project Collaboration Session</subject> + <isActive>true</isActive> + <hasPublicLink>false</hasPublicLink> + </CollaborationSession> + 400: - description: Error - The input does not match the input schema definition. - 401: - description: Error - the user is not authorized to update this cart. + description: Error - the input does not match the input schema definition. 404: - description: Error - The identifier do not match any cart. - summary: Update Cart's metadata - description: Updates identified Cart's metadata from payload. + 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: identifier + - name: sessionToken in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: X-CSRF-Token - in: header - description: The CSRF token. + description: The session token to update. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The CartMetadataUpdate schema encoded in XML or JSON format. + description: Session update payload content: - application/vnd.ibexa.api.CartMetadataUpdate+json: + application/vnd.ibexa.api.ExampleSessionUpdate+json: schema: - $ref: '#/components/schemas/CartMetadataUpdateWrapper' - application/vnd.ibexa.api.CartMetadataUpdate+xml: + $ref: '#/components/schemas/ExampleSessionUpdate' + example: + ExampleSessionUpdate: + hasPublicLink: true + application/vnd.ibexa.api.ExampleSessionUpdate+xml: schema: - $ref: '#/components/schemas/CartMetadataUpdate' - required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /cart/{identifier}/empty: - post: - operationId: ibexa.rest.cart.empty - 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 - - name: X-CSRF-Token - in: header - description: The CSRF token. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: No payload required - content: [] + $ref: '#/components/schemas/ExampleSessionUpdate' + example: |+ + <?xml version="1.0" encoding="UTF-8"?> + <ExampleSessionUpdate> + <hasPublicLink>true</hasPublicLink> + </ExampleSessionUpdate> + required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /cart/{identifier}/entry: + /collaboration/sessions/{sessionToken}/invitations: post: - operationId: ibexa.cart.rest.cart.entry.add + operationId: api_collaborationsessions_sessionTokeninvitations_post tags: - - Cart + - Collaboration Sessions responses: - 200: - description: OK - return the updated cart + 201: + description: Invitation created content: - application/vnd.ibexa.api.Cart+json: + application/vnd.ibexa.api.Invitation+json: schema: - $ref: '#/components/schemas/CartWrapper' - application/vnd.ibexa.api.Cart+xml: + $ref: '#/components/schemas/InvitationWrapper' + application/vnd.ibexa.api.Invitation+xml: schema: - $ref: '#/components/schemas/Cart' + $ref: '#/components/schemas/InvitationWrapper' 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. + description: Error - the input does not match the input schema definition. 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 + 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: identifier + - name: sessionToken in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: X-CSRF-Token - in: header - description: The CSRF token. + description: The session token. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The CartEntryAdd schema encoded in XML or JSON format. + description: Invitation creation payload content: - application/vnd.ibexa.api.CartEntryAdd+json: + application/vnd.ibexa.api.InvitationCreate+json: schema: - $ref: '#/components/schemas/CartEntryAddWrapper' + $ref: '#/components/schemas/InvitationCreate' example: - CartEntryAdd: - quantity: 1 - Product: - code: test + InvitationCreate: + email: external.user@example.com + Sender: + _media-type: application/vnd.ibexa.api.User+json + _href: /api/ibexa/v2/user/users/14 context: - foo: bar - application/vnd.ibexa.api.CartEntryAdd+xml: + 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/CartEntryAdd' + $ref: '#/components/schemas/InvitationCreate' + example: |+ + <?xml version="1.0" encoding="UTF-8"?> + <InvitationCreate> + <Sender media-type="application/vnd.ibexa.api.User+xml" + href="/api/ibexa/v2/user/users/14" + > + </Sender> + <email>anonymous@link.invalid</email> + <context> + <simple_array> + <element>test</element> + <element>value1</element> + <element>value2</element> + <element>value3</element> + <element>value4</element> + <element>value5</element> + </simple_array> + <single_value>value</single_value> + <extended_array> + <bar>bar_value</bar> + <baz>baz_value</baz> + <foo>foo_value</foo> + </extended_array> + </context> + </InvitationCreate> + required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /cart/{identifier}/entry/{entryId}: - delete: - operationId: ibexa.rest.cart.entry.remove + /collaboration/sessions/{sessionToken}/participants: + get: + operationId: api_collaborationsessions_sessionTokenparticipants_get tags: - - Cart + - Collaboration Sessions responses: 200: - description: OK - return the updated cart + description: Participants list content: - application/vnd.ibexa.api.Cart+json: - schema: - $ref: '#/components/schemas/CartWrapper' - application/vnd.ibexa.api.Cart+xml: + application/vnd.ibexa.api.ParticipantList+json: 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 + $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: |+ + <?xml version="1.0"?> + <ParticipantList media-type="application/vnd.ibexa.api.ParticipantList+xml"> + <Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml"> + <id>1</id> + <name>John Doe</name> + <scope>edit</scope> + <User href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> + <createdAt>2023-11-15T10:30:00+00:00</createdAt> + <updatedAt>2023-11-15T10:30:00+00:00</updatedAt> + </Participant> + <Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml"> + <id>2</id> + <name>guest@example.com</name> + <scope>view</scope> + <email>guest@example.com</email> + <createdAt>2023-11-15T11:00:00+00:00</createdAt> + <updatedAt>2023-11-15T11:00:00+00:00</updatedAt> + </Participant> + </ParticipantList> + + 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: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: X-CSRF-Token - in: header - description: The CSRF token. + description: The session token. 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: ibexa.rest.cart.cart.entry.update + post: + operationId: api_collaborationsessions_sessionTokenparticipants_post tags: - - Cart + - Collaboration Sessions responses: 200: - description: OK - return the updated cart + description: Participants list content: - application/vnd.ibexa.api.Cart+json: + application/vnd.ibexa.api.ParticipantList+json: schema: - $ref: '#/components/schemas/CartWrapper' - application/vnd.ibexa.api.Cart+xml: + $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/Cart' + $ref: '#/components/schemas/ParticipantListWrapper' + example: |+ + <?xml version="1.0"?> + <ParticipantList media-type="application/vnd.ibexa.api.ParticipantList+xml"> + <Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml"> + <id>1</id> + <name>John Doe</name> + <scope>edit</scope> + <User href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> + <createdAt>2023-11-15T10:30:00+00:00</createdAt> + <updatedAt>2023-11-15T10:30:00+00:00</updatedAt> + </Participant> + <Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml"> + <id>2</id> + <name>guest@example.com</name> + <scope>view</scope> + <email>guest@example.com</email> + <createdAt>2023-11-15T11:00:00+00:00</createdAt> + <updatedAt>2023-11-15T11:00:00+00:00</updatedAt> + </Participant> + </ParticipantList> + 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. + description: Error - the input does not match the input schema definition. 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. + 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: identifier - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: entryId + - name: sessionToken in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: X-CSRF-Token - in: header - description: The CSRF token. + description: The session token. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The CartEntryUpdate schema encoded in XML or JSON format. + description: Participant list creation payload content: - application/vnd.ibexa.api.CartEntryUpdate+json: + application/vnd.ibexa.api.ParticipantListCreate+json: schema: - $ref: '#/components/schemas/CartEntryUpdateWrapper' - application/vnd.ibexa.api.CartEntryUpdate+xml: + $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/CartEntryUpdate' + $ref: '#/components/schemas/ParticipantListCreate' + example: |+ + <?xml version="1.0" encoding="UTF-8"?> + <ParticipantListCreate> + <ParticipantCreate media-type="application/vnd.ibexa.api.InternalParticipantCreate+xml"> + <scope>view</scope> + <User media-type="application/vnd.ibexa.api.User+xml" + href="/api/ibexa/v2/user/users/14" + > + </User> + </ParticipantCreate> + <ParticipantCreate media-type="application/vnd.ibexa.api.ExternalParticipantCreate+xml"> + <email>user@link.invalid</email> + <scope>view</scope> + </ParticipantCreate> + </ParticipantListCreate> + required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /cart/{identifier}/move-entries-to-shopping-list: - post: - operationId: ibexa.rest.cart.move_cart_entries_to_shopping_list + /collaboration/sessions/{sessionToken}/participants/{participantId}: + delete: + operationId: api_collaborationsessions_sessionTokenparticipants_participantId_delete tags: - - Cart + - Collaboration Sessions 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. + 204: + description: Participant removed 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. + 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: identifier + - name: sessionToken in: path - description: The Cart identifier + description: The session token. 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. + - name: participantId + in: path + description: The participant ID to remove. required: true deprecated: false - allowEmptyValue: false schema: - type: string + type: integer style: simple explode: false - allowReserved: false - requestBody: - description: The CartEntryIdentifiers schema encoded in XML or JSON format. - content: - application/vnd.ibexa.api.CartEntryIdentifiers+json: - schema: - $ref: '#/components/schemas/CartEntryIdentifiersWrapper' - example: - CartEntryIdentifiers: - entries: - - identifier: entry-002 - - identifier: entry-004 - application/vnd.ibexa.api.CartEntryIdentifiers+xml: - schema: - $ref: '#/components/schemas/CartEntryIdentifiers' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <CartEntryIdentifiers> - <entries> - <identifier>entry-002</identifier> - </entries> - <entries> - <identifier>entry-004</identifier> - </entries> - </CartEntryIdentifiers> - required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /cart/{identifier}/move-entries-to-shopping-list/{shoppingListIdentifier}: - post: - operationId: ibexa.rest.cart.move_cart_entries_to_shopping_list.shopping_list_identifier + patch: + operationId: api_collaborationsessions_sessionTokenparticipants_participantId_patch tags: - - Cart + - Collaboration Sessions responses: 200: - description: OK - returns the shopping list with added cart entries + description: Updated participant content: - application/vnd.ibexa.api.ShoppingList+json: + 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/ShoppingListWrapper' - application/vnd.ibexa.api.ShoppingList+xml: + $ref: '#/components/schemas/InternalParticipantWrapper' + application/vnd.ibexa.api.InternalParticipant+xml: schema: - $ref: '#/components/schemas/ShoppingList' + $ref: '#/components/schemas/InternalParticipantWrapper' 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. + description: Error - the input does not match the input schema definition. 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. + 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: identifier + - name: sessionToken in: path - description: The Cart identifier + description: The session token. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: shoppingListIdentifier + - name: participantId 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. + description: The participant ID to update. required: true deprecated: false - allowEmptyValue: false schema: - type: string + type: integer style: simple explode: false - allowReserved: false requestBody: - description: The CartEntryIdentifiers schema encoded in XML or JSON format. + description: Participant update payload content: - application/vnd.ibexa.api.CartEntryIdentifiers+json: + 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: |+ + <?xml version="1.0" encoding="UTF-8"?> + <ExternalParticipantUpdate> + <scope>view</scope> + </ExternalParticipantUpdate> + + application/vnd.ibexa.api.InternalParticipantUpdate+json: schema: - $ref: '#/components/schemas/CartEntryIdentifiersWrapper' - application/vnd.ibexa.api.CartEntryIdentifiers+xml: + $ref: '#/components/schemas/InternalParticipantUpdate' + example: + InternalParticipantUpdate: + scope: view + application/vnd.ibexa.api.InternalParticipantUpdate+xml: schema: - $ref: '#/components/schemas/CartEntryIdentifiers' + $ref: '#/components/schemas/InternalParticipantUpdate' + example: |+ + <?xml version="1.0" encoding="UTF-8"?> + <InternalParticipantUpdate> + <scope>view</scope> + </InternalParticipantUpdate> + required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /cart/{identifier}/move-to-shopping-list: - post: - operationId: ibexa.rest.cart.move_cart_to_shopping_list + /ai/action-types: + get: + operationId: ibexa.rest.ai.action_type.list tags: - - Cart + - Connector AI responses: 200: - description: OK - returns the shopping list with added cart entries + description: Action type list content: - application/vnd.ibexa.api.ShoppingList+json: + application/vnd.ibexa.api.ai.ActionTypeList+json: schema: - $ref: '#/components/schemas/ShoppingListWrapper' - application/vnd.ibexa.api.ShoppingList+xml: + $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/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: ibexa.rest.cart.move_cart_to_shopping_list.shopping_list_identifier + $ref: '#/components/schemas/ActionTypeList' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <ActionTypeList media-type="application/vnd.ibexa.api.ai.ActionTypeList+xml" href="/api/ibexa/v2/ai/action-types"> + <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> + <identifier>generate_alt_text</identifier> + <name>Generate alternative text</name> + <inputIdentifier>image</inputIdentifier> + <outputIdentifier>text</outputIdentifier> + <options> + <width>512</width> + <height>512</height> + <image_quality>85</image_quality> + </options> + </ActionType> + <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> + <identifier>refine_text</identifier> + <name>Refine text</name> + <inputIdentifier>text</inputIdentifier> + <outputIdentifier>text</outputIdentifier> + <options/> + </ActionType> + </ActionTypeList> + summary: Get action types list. + description: Returns action types list. + parameters: [] + /ai/action-types/{identifier}: + get: + operationId: ibexa.rest.ai.action_type tags: - - Cart + - Connector AI responses: 200: - description: OK - returns the shopping list with added cart entries + description: Action type content: - application/vnd.ibexa.api.ShoppingList+json: + application/vnd.ibexa.api.ai.ActionType+json: schema: - $ref: '#/components/schemas/ShoppingListWrapper' - application/vnd.ibexa.api.ShoppingList+xml: + $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/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. + $ref: '#/components/schemas/ActionType' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> + <identifier>generate_alt_text</identifier> + <name>Generate alternative text</name> + <inputIdentifier>image</inputIdentifier> + <outputIdentifier>text</outputIdentifier> + <options> + <width>512</width> + <height>512</height> + <image_quality>85</image_quality> + </options> + </ActionType> + 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: 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. + description: ActionTypeLoadByIdentifierController identifier 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: + example: generate_alt_text + /ai/actions: get: - operationId: ibexa.rest.cart.summary + operationId: ibexa.rest.ai.action.list.get tags: - - Cart + - Connector AI responses: 200: - description: If set, the Cart Summary is returned in XML or JSON format. + description: Action configuration list is returned in JSON or XML content: - application/vnd.ibexa.api.CartSummary+json: + application/vnd.ibexa.api.ai.ActionConfigurationList+json: schema: - $ref: '#/components/schemas/CartSummaryWrapper' + $ref: '#/components/schemas/ActionConfigurationList' 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: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - id: 303 - fieldDefinitionIdentifier: image - languageCode: eng-GB - fieldTypeIdentifier: ibexa_image_asset - fieldValue: - destinationContentId: ~ - alternativeText: ~ - source: ~ - - 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: ~ - height: ~ - 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: ~ - height: ~ - 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 + 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 - application/vnd.ibexa.api.CartSummary+xml: + 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/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: 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: + $ref: '#/components/schemas/ActionConfigurationList' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <ActionConfigurationList media-type="application/vnd.ibexa.api.ai.ActionConfigurationList+xml" href="/api/ibexa/v2/ai/actions"> + <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> + <identifier>rewrite_with_friendly_tone</identifier> + <name>Rewrite in friendly tone</name> + <description></description> + <enabled>1</enabled> + <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> + <identifier>refine_text</identifier> + <name>Refine text</name> + <inputIdentifier>text</inputIdentifier> + <outputIdentifier>text</outputIdentifier> + <options/> + </ActionType> + <actionTypeOptions/> + <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier> + <actionHandlerOptions> + <max_tokens>4000</max_tokens> + <temperature>1</temperature> + <prompt>Rewrite text in friendly tone. Preserve meaning and crucial information.</prompt> + <model>gpt-4-turbo</model> + </actionHandlerOptions> + <createdAt>2025-08-07T13:16:47+02:00</createdAt> + <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> + </ActionConfiguration> + <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> + <identifier>rewrite_with_professional_tone</identifier> + <name>Rewrite in professional tone</name> + <description></description> + <enabled>1</enabled> + <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> + <identifier>refine_text</identifier> + <name>Refine text</name> + <inputIdentifier>text</inputIdentifier> + <outputIdentifier>text</outputIdentifier> + <options/> + </ActionType> + <actionTypeOptions/> + <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier> + <actionHandlerOptions> + <max_tokens>4000</max_tokens> + <temperature>1</temperature> + <prompt>Rewrite text in professional tone. Preserve meaning and crucial information.</prompt> + <model>gpt-4-turbo</model> + </actionHandlerOptions> + <createdAt>2025-08-07T13:16:47+02:00</createdAt> + <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> + </ActionConfiguration> + <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> + <identifier>summarize_text</identifier> + <name>Summarize</name> + <description></description> + <enabled>1</enabled> + <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> + <identifier>refine_text</identifier> + <name>Refine text</name> + <inputIdentifier>text</inputIdentifier> + <outputIdentifier>text</outputIdentifier> + <options/> + </ActionType> + <actionTypeOptions/> + <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier> + <actionHandlerOptions> + <max_tokens>4000</max_tokens> + <temperature>1</temperature> + <prompt>Summarize text into one sentence. Preserve meaning and crucial information.</prompt> + <model>gpt-4-turbo</model> + </actionHandlerOptions> + <createdAt>2025-08-07T13:16:47+02:00</createdAt> + <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> + </ActionConfiguration> + <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> + <identifier>expand_text</identifier> + <name>Expand text</name> + <description></description> + <enabled>1</enabled> + <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> + <identifier>refine_text</identifier> + <name>Refine text</name> + <inputIdentifier>text</inputIdentifier> + <outputIdentifier>text</outputIdentifier> + <options/> + </ActionType> + <actionTypeOptions/> + <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier> + <actionHandlerOptions> + <max_tokens>4000</max_tokens> + <temperature>1</temperature> + <prompt>Expand the given text by 25%. Preserve meaning and crucial information.</prompt> + <model>gpt-4-turbo</model> + </actionHandlerOptions> + <createdAt>2025-08-07T13:16:47+02:00</createdAt> + <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> + </ActionConfiguration> + <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> + <identifier>shorten_text</identifier> + <name>Shorten text</name> + <description></description> + <enabled>1</enabled> + <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> + <identifier>refine_text</identifier> + <name>Refine text</name> + <inputIdentifier>text</inputIdentifier> + <outputIdentifier>text</outputIdentifier> + <options/> + </ActionType> + <actionTypeOptions/> + <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier> + <actionHandlerOptions> + <max_tokens>4000</max_tokens> + <temperature>1</temperature> + <prompt>Shorten the given text by 25%. Preserve meaning and crucial information.</prompt> + <model>gpt-4-turbo</model> + </actionHandlerOptions> + <createdAt>2025-08-07T13:16:47+02:00</createdAt> + <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> + </ActionConfiguration> + <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> + <identifier>proofread</identifier> + <name>Proofread</name> + <description></description> + <enabled>1</enabled> + <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> + <identifier>refine_text</identifier> + <name>Refine text</name> + <inputIdentifier>text</inputIdentifier> + <outputIdentifier>text</outputIdentifier> + <options/> + </ActionType> + <actionTypeOptions/> + <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier> + <actionHandlerOptions> + <max_tokens>4000</max_tokens> + <temperature>1</temperature> + <prompt>Rewrite given text to identify and fix grammatical and punctuation errors. Preserve meaning and crucial information.</prompt> + <model>gpt-4-turbo</model> + </actionHandlerOptions> + <createdAt>2025-08-07T13:16:47+02:00</createdAt> + <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> + </ActionConfiguration> + <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> + <identifier>improve_readability</identifier> + <name>Improve readability</name> + <description></description> + <enabled>1</enabled> + <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> + <identifier>refine_text</identifier> + <name>Refine text</name> + <inputIdentifier>text</inputIdentifier> + <outputIdentifier>text</outputIdentifier> + <options/> + </ActionType> + <actionTypeOptions/> + <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier> + <actionHandlerOptions> + <max_tokens>4000</max_tokens> + <temperature>1</temperature> + <prompt>Rewrite this content to improve readability. Preserve meaning and crucial information.</prompt> + <model>gpt-4-turbo</model> + </actionHandlerOptions> + <createdAt>2025-08-07T13:16:47+02:00</createdAt> + <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> + </ActionConfiguration> + <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> + <identifier>gen_alt_text</identifier> + <name>Generate alternative text</name> + <description></description> + <enabled>1</enabled> + <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> + <identifier>generate_alt_text</identifier> + <name>Generate alternative text</name> + <inputIdentifier>image</inputIdentifier> + <outputIdentifier>text</outputIdentifier> + <options> + <width>512</width> + <height>512</height> + <image_quality>85</image_quality> + </options> + </ActionType> + <actionTypeOptions> + <max_length>140</max_length> + </actionTypeOptions> + <actionHandlerIdentifier>openai-image-to-text</actionHandlerIdentifier> + <actionHandlerOptions> + <max_tokens>4000</max_tokens> + <temperature>1</temperature> + <prompt></prompt> + <model>gpt-4-turbo</model> + </actionHandlerOptions> + <createdAt>2025-08-07T13:16:47+02:00</createdAt> + <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> + </ActionConfiguration> + </ActionConfigurationList> + summary: Get action configuration list. + description: Returns action configuration list. + parameters: [] post: - operationId: api_collaborationsessions_post + operationId: ibexa.rest.ai.action.list.post tags: - - Collaboration Sessions + - Connector AI responses: - 201: - description: Session created + 200: + description: Action configuration list is returned in JSON or XML content: - application/vnd.ibexa.api.ExampleSession+json: + application/vnd.ibexa.api.ai.ActionConfigurationList+json: schema: - $ref: '#/components/schemas/ExampleSessionWrapper' + $ref: '#/components/schemas/ActionConfigurationList' 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: |+ - <?xml version="1.0"?> - <CollaborationSession media-type="application/vnd.ibexa.api.ExampleSession+xml"> - <id>123</id> - <token>abc123def456ghi789</token> - <createdAt>2023-11-15T10:30:00+00:00</createdAt> - <updatedAt>2023-11-15T14:45:00+00:00</updatedAt> - <ParticipantList media-type="application/vnd.ibexa.api.ParticipantList+xml"> - <Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml"> - <id>1</id> - <name>John Doe</name> - <scope>edit</scope> - <User href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> - <createdAt>2023-11-15T10:30:00+00:00</createdAt> - <updatedAt>2023-11-15T10:30:00+00:00</updatedAt> - </Participant> - <Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml"> - <id>2</id> - <name>guest@example.com</name> - <scope>view</scope> - <email>guest@example.com</email> - <createdAt>2023-11-15T11:00:00+00:00</createdAt> - <updatedAt>2023-11-15T11:00:00+00:00</updatedAt> - </Participant> - </ParticipantList> - <Owner href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> - <subject>Project Collaboration Session</subject> - <isActive>true</isActive> - <hasPublicLink>false</hasPublicLink> - </CollaborationSession> - - 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: [] + 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: | + <?xml version="1.0" encoding="UTF-8"?> + <ActionConfigurationList media-type="application/vnd.ibexa.api.ai.ActionConfigurationList+xml" href="/api/ibexa/v2/ai/actions"> + <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> + <identifier>rewrite_with_professional_tone</identifier> + <name>Rewrite in professional tone</name> + <description></description> + <enabled>1</enabled> + <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> + <identifier>refine_text</identifier> + <name>Refine text</name> + <inputIdentifier>text</inputIdentifier> + <outputIdentifier>text</outputIdentifier> + <options/> + </ActionType> + <actionTypeOptions/> + <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier> + <actionHandlerOptions> + <max_tokens>4000</max_tokens> + <temperature>1</temperature> + <prompt>Rewrite text in professional tone. Preserve meaning and crucial information.</prompt> + <model>gpt-4-turbo</model> + </actionHandlerOptions> + <createdAt>2025-08-07T13:16:47+02:00</createdAt> + <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> + </ActionConfiguration> + <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> + <identifier>rewrite_with_friendly_tone</identifier> + <name>Rewrite in friendly tone</name> + <description></description> + <enabled>1</enabled> + <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> + <identifier>refine_text</identifier> + <name>Refine text</name> + <inputIdentifier>text</inputIdentifier> + <outputIdentifier>text</outputIdentifier> + <options/> + </ActionType> + <actionTypeOptions/> + <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier> + <actionHandlerOptions> + <max_tokens>4000</max_tokens> + <temperature>1</temperature> + <prompt>Rewrite text in friendly tone. Preserve meaning and crucial information.</prompt> + <model>gpt-4-turbo</model> + </actionHandlerOptions> + <createdAt>2025-08-07T13:16:47+02:00</createdAt> + <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> + </ActionConfiguration> + </ActionConfigurationList> + 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 + schema: + type: string + style: simple + explode: false requestBody: - description: Session creation payload + description: Query action configuration search criteria content: - application/vnd.ibexa.api.ExampleSessionCreate+json: + application/vnd.ibexa.api.ai.ActionConfigurationListInput+json: schema: - $ref: '#/components/schemas/ExampleSessionCreate' + $ref: '#/components/schemas/ActionConfigurationListInput' 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: + 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/ExampleSessionCreate' - example: |+ + $ref: '#/components/schemas/ActionConfigurationListInput' + example: | <?xml version="1.0" encoding="UTF-8"?> - <ExampleSessionCreate> - <Owner media-type="application/vnd.ibexa.api.User+xml" - href="/api/ibexa/v2/user/users/14" - > - </Owner> - <ParticipantListCreate media-type="application/vnd.ibexa.api.ParticipantListCreate+xml"> - <ParticipantCreate media-type="application/vnd.ibexa.api.InternalParticipantCreate+xml"> - <scope>view</scope> - <User media-type="application/vnd.ibexa.api.User+xml" - href="/api/ibexa/v2/user/users/14" - > - </User> - </ParticipantCreate> - <ParticipantCreate media-type="application/vnd.ibexa.api.ExternalParticipantCreate+xml"> - <email>user@link.invalid</email> - <scope>view</scope> - </ParticipantCreate> - </ParticipantListCreate> - <subject>example</subject> - </ExampleSessionCreate> - + <ActionConfigurationListInput> + <query>Rewrite</query> + <action_type_identifier>refine_text</action_type_identifier> + <enabled>1</enabled> + <limit>25</limit> + <page>1</page> + </ActionConfigurationListInput> required: false - deprecated: false - /collaboration/sessions/{sessionToken}: - get: - operationId: api_collaborationsessions_sessionToken_get + /ai/actions/{actionConfigurationIdentifier}/execute: + post: + operationId: ibexa.rest.ai.actions.execute tags: - - Collaboration Sessions + - Connector AI responses: 200: - description: Session + description: Reworked text or generated alternative text content: - application/vnd.ibexa.api.ExampleSession+json: + application/vnd.ibexa.api.ai.AltText+json: schema: - $ref: '#/components/schemas/ExampleSessionWrapper' + $ref: '#/components/schemas/AltText' 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: + 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/ExampleSessionWrapper' - example: |+ - <?xml version="1.0"?> - <CollaborationSession media-type="application/vnd.ibexa.api.ExampleSession+xml"> - <id>123</id> - <token>abc123def456ghi789</token> - <createdAt>2023-11-15T10:30:00+00:00</createdAt> - <updatedAt>2023-11-15T14:45:00+00:00</updatedAt> - <ParticipantList media-type="application/vnd.ibexa.api.ParticipantList+xml"> - <Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml"> - <id>1</id> - <name>John Doe</name> - <scope>edit</scope> - <User href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> - <createdAt>2023-11-15T10:30:00+00:00</createdAt> - <updatedAt>2023-11-15T10:30:00+00:00</updatedAt> - </Participant> - <Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml"> - <id>2</id> - <name>guest@example.com</name> - <scope>view</scope> - <email>guest@example.com</email> - <createdAt>2023-11-15T11:00:00+00:00</createdAt> - <updatedAt>2023-11-15T11:00:00+00:00</updatedAt> - </Participant> - </ParticipantList> - <Owner href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> - <subject>Project Collaboration Session</subject> - <isActive>true</isActive> - <hasPublicLink>false</hasPublicLink> - </CollaborationSession> - - 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. + $ref: '#/components/schemas/AltText' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <AltText media-type="application/vnd.ibexa.api.ai.AltText+xml"> + <Text media-type="application/vnd.ibexa.api.ai.Text+xml"> + <text>Sunlit home office with an open laptop, papers, and a blurred background.</text> + </Text> + </AltText> + 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: | + <?xml version="1.0" encoding="UTF-8"?> + <Text media-type="application/vnd.ibexa.api.ai.Text+xml"> + <text>Hello, I hope you are well. How have you been spending your day?</text> + </Text> + 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: sessionToken + - name: actionConfigurationIdentifier in: path - description: The session token to retrieve. + 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 - deprecated: false - delete: - operationId: api_collaborationsessions_sessionToken_delete + 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 + schema: + type: string + style: simple + explode: 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: | + <?xml version="1.0" encoding="UTF-8"?> + <GenerateAltText xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> + <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</base64> + </Image> + <RuntimeContext /> + </GenerateAltText> + 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: | + <?xml version="1.0" encoding="UTF-8"?> + <RefineText xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> + <Text> + <text>Hey, wassup. What you've been doing the whole day?</text> + </Text> + <RuntimeContext /> + </RefineText> + required: false + /ai/actions/{identifier}: + get: + operationId: ibexa.rest.ai.action tags: - - Collaboration Sessions + - Connector AI responses: - 204: - description: Session deleted + 200: + description: Action configuration in JSON or XML + 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: | + <?xml version="1.0" encoding="UTF-8"?> + <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> + <identifier>rewrite_with_friendly_tone</identifier> + <name>Rewrite in friendly tone</name> + <description></description> + <enabled>1</enabled> + <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> + <identifier>refine_text</identifier> + <name>Refine text</name> + <inputIdentifier>text</inputIdentifier> + <outputIdentifier>text</outputIdentifier> + <options/> + </ActionType> + <actionTypeOptions/> + <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier> + <actionHandlerOptions> + <max_tokens>4000</max_tokens> + <temperature>1</temperature> + <prompt>Rewrite text in friendly tone. Preserve meaning and crucial information.</prompt> + <model>gpt-4-turbo</model> + </actionHandlerOptions> + <createdAt>2025-08-07T13:16:47+02:00</createdAt> + <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> + </ActionConfiguration> 404: - description: Error - the session does not exist. + description: Error - an action configuration of the given unique identifier + is not found. 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. + 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: sessionToken + - name: identifier in: path - description: The session token to delete. + description: ActionConfigurationLoadByIdentifierController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - patch: - operationId: api_collaborationsessions_sessionToken_patch + example: rewrite_with_friendly_tone + /languages: + get: + operationId: ibexa.rest.languages.list tags: - - Collaboration Sessions + - Language responses: 200: - description: Updated session + description: If set, the list is returned in XML or JSON format. content: - application/vnd.ibexa.api.ExampleSession+json: + application/vnd.ibexa.api.LanguageList+json: schema: - $ref: '#/components/schemas/ExampleSessionWrapper' + $ref: '#/components/schemas/LanguageListWrapper' 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: + 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/ExampleSessionWrapper' - example: |+ - <?xml version="1.0"?> - <CollaborationSession media-type="application/vnd.ibexa.api.ExampleSession+xml"> - <id>123</id> - <token>abc123def456ghi789</token> - <createdAt>2023-11-15T10:30:00+00:00</createdAt> - <updatedAt>2023-11-15T14:45:00+00:00</updatedAt> - <ParticipantList media-type="application/vnd.ibexa.api.ParticipantList+xml"> - <Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml"> - <id>1</id> - <name>John Doe</name> - <scope>edit</scope> - <User href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> - <createdAt>2023-11-15T10:30:00+00:00</createdAt> - <updatedAt>2023-11-15T10:30:00+00:00</updatedAt> - </Participant> - <Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml"> - <id>2</id> - <name>guest@example.com</name> - <scope>view</scope> - <email>guest@example.com</email> - <createdAt>2023-11-15T11:00:00+00:00</createdAt> - <updatedAt>2023-11-15T11:00:00+00:00</updatedAt> - </Participant> - </ParticipantList> - <Owner href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> - <subject>Project Collaboration Session</subject> - <isActive>true</isActive> - <hasPublicLink>false</hasPublicLink> - </CollaborationSession> - - 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: |+ - <?xml version="1.0" encoding="UTF-8"?> - <ExampleSessionUpdate> - <hasPublicLink>true</hasPublicLink> - </ExampleSessionUpdate> - - required: false - deprecated: false - /collaboration/sessions/{sessionToken}/invitations: - post: - operationId: api_collaborationsessions_sessionTokeninvitations_post + $ref: '#/components/schemas/LanguageList' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <LanguageList media-type="application/vnd.ibexa.api.LanguageList+xml" href="/api/ibexa/v2/languages"> + <Language media-type="application/vnd.ibexa.api.Language+xml" href="/api/ibexa/v2/languages/eng-GB"> + <languageId>2</languageId> + <languageCode>eng-GB</languageCode> + <name>English (United Kingdom)</name> + </Language> + <Language href="/api/ibexa/v2/languages/pol-PL" media-type="application/vnd.ibexa.api.Language+xml"> + <languageId>4</languageId> + <languageCode>pol-PL</languageCode> + <name>Polish (polski)</name> + </Language> + </LanguageList> + summary: Language list + description: Lists languages + parameters: [] + /languages/{code}: + get: + operationId: ibexa.rest.languages.view tags: - - Collaboration Sessions + - Language responses: - 201: - description: Invitation created + 200: + description: If set, the language is returned in XML or JSON format. content: - application/vnd.ibexa.api.Invitation+json: + application/vnd.ibexa.api.Language+json: schema: - $ref: '#/components/schemas/InvitationWrapper' - application/vnd.ibexa.api.Invitation+xml: + $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/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. + $ref: '#/components/schemas/Language' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <Language media-type="application/vnd.ibexa.api.Language+xml" href="/api/ibexa/v2/languages/eng-GB"> + <languageId>2</languageId> + <languageCode>eng-GB</languageCode> + <name>English (United Kingdom)</name> + </Language> + summary: Get language + description: Retrieves a LanguageLoadByIdController resource. parameters: - - name: sessionToken + - name: code in: path - description: The session token. + description: LanguageLoadByIdController identifier 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: |+ - <?xml version="1.0" encoding="UTF-8"?> - <InvitationCreate> - <Sender media-type="application/vnd.ibexa.api.User+xml" - href="/api/ibexa/v2/user/users/14" - > - </Sender> - <email>anonymous@link.invalid</email> - <context> - <simple_array> - <element>test</element> - <element>value1</element> - <element>value2</element> - <element>value3</element> - <element>value4</element> - <element>value5</element> - </simple_array> - <single_value>value</single_value> - <extended_array> - <bar>bar_value</bar> - <baz>baz_value</baz> - <foo>foo_value</foo> - </extended_array> - </context> - </InvitationCreate> - - required: false - deprecated: false - /collaboration/sessions/{sessionToken}/participants: + /content/locations: get: - operationId: api_collaborationsessions_sessionTokenparticipants_get + operationId: ibexa.rest.redirect_location tags: - - Collaboration Sessions + - Location responses: 200: - description: Participants list + description: OK - returns the LocationList in XML or JSON format. content: - application/vnd.ibexa.api.ParticipantList+json: + application/vnd.ibexa.api.LocationList+json: schema: - $ref: '#/components/schemas/ParticipantListWrapper' + $ref: '#/components/schemas/LocationWrapper' 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: + Location: + _media-type: application/vnd.ibexa.api.Location+json + _href: /api/ibexa/v2/content/locations/1/2/58 + id: 58 + priority: 0 + hidden: false + invisible: false + explicitlyHidden: false + ParentLocation: + _media-type: application/vnd.ibexa.api.Location+json + _href: /api/ibexa/v2/content/locations/1/2 + pathString: /1/2/58/ + depth: 2 + childCount: 3 + remoteId: 0cfe62f27753448d79aaa8acd8d01699 + Children: + _media-type: application/vnd.ibexa.api.LocationList+json + _href: /api/ibexa/v2/content/locations/1/2/58/children + Content: + _media-type: application/vnd.ibexa.api.Content+json + _href: /api/ibexa/v2/content/objects/57 + sortField: PATH + sortOrder: ASC + UrlAliases: + _media-type: application/vnd.ibexa.api.UrlAliasRefList+json + _href: /api/ibexa/v2/content/locations/1/2/58/urlaliases + ContentInfo: + _media-type: application/vnd.ibexa.api.ContentInfo+json + _href: /api/ibexa/v2/content/objects/57 + Content: + _media-type: application/vnd.ibexa.api.ContentInfo+json + _href: /api/ibexa/v2/content/objects/57 + _remoteId: 782f5afa9d6587804daa911e88ff5bb9 + _id: 57 + ContentType: + _media-type: application/vnd.ibexa.api.ContentType+json + _href: /api/ibexa/v2/content/types/1 + Name: All Tips + TranslatedName: All Tips + Versions: + _media-type: application/vnd.ibexa.api.VersionList+json + _href: /api/ibexa/v2/content/objects/57/versions + CurrentVersion: + _media-type: application/vnd.ibexa.api.Version+json + _href: /api/ibexa/v2/content/objects/57/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/57/locations + Owner: + _media-type: application/vnd.ibexa.api.User+json + _href: /api/ibexa/v2/user/users/14 + lastModificationDate: "2021-06-28T11:22:52+00:00" + publishedDate: "2021-06-28T11:22:52+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/57/objectstates + application/vnd.ibexa.api.LocationList+xml: schema: - $ref: '#/components/schemas/ParticipantListWrapper' - example: |+ - <?xml version="1.0"?> - <ParticipantList media-type="application/vnd.ibexa.api.ParticipantList+xml"> - <Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml"> - <id>1</id> - <name>John Doe</name> - <scope>edit</scope> - <User href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> - <createdAt>2023-11-15T10:30:00+00:00</createdAt> - <updatedAt>2023-11-15T10:30:00+00:00</updatedAt> - </Participant> - <Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml"> - <id>2</id> - <name>guest@example.com</name> - <scope>view</scope> - <email>guest@example.com</email> - <createdAt>2023-11-15T11:00:00+00:00</createdAt> - <updatedAt>2023-11-15T11:00:00+00:00</updatedAt> - </Participant> - </ParticipantList> - + $ref: '#/components/schemas/Location' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/58"> + <id>58</id> + <priority>0</priority> + <hidden>false</hidden> + <invisible>false</invisible> + <explicitlyHidden>false</explicitlyHidden> + <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2"/> + <pathString>/1/2/58/</pathString> + <depth>2</depth> + <childCount>3</childCount> + <remoteId>0cfe62f27753448d79aaa8acd8d01699</remoteId> + <Children media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/2/58/children"/> + <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/57"/> + <sortField>PATH</sortField> + <sortOrder>ASC</sortOrder> + <UrlAliases media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/58/urlaliases"/> + <ContentInfo media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/57"> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/57" remoteId="782f5afa9d6587804daa911e88ff5bb9" id="57"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"/> + <Name>All Tips</Name> + <TranslatedName>All Tips</TranslatedName> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/57/versions"/> + <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/57/currentversion"/> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/57/locations"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <lastModificationDate>2021-06-28T11:22:52+00:00</lastModificationDate> + <publishedDate>2021-06-28T11:22:52+00:00</publishedDate> + <mainLanguageCode>eng-GB</mainLanguageCode> + <currentVersionNo>1</currentVersionNo> + <alwaysAvailable>true</alwaysAvailable> + <isHidden>false</isHidden> + <status>PUBLISHED</status> + <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/57/objectstates"/> + </Content> + </ContentInfo> + </Location> + 307: + description: Temporary redirect to the main resource URL. 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 + 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: [] + /content/locations/{path}: + get: + operationId: ibexa.rest.load_location tags: - - Collaboration Sessions + - Location responses: 200: - description: Participants list + description: If set, the new Location is returned in XML or JSON format. content: - application/vnd.ibexa.api.ParticipantList+json: + application/vnd.ibexa.api.Location+json: schema: - $ref: '#/components/schemas/ParticipantListWrapper' + $ref: '#/components/schemas/LocationWrapper' 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: + Location: + _media-type: application/vnd.ibexa.api.Location+json + _href: /api/ibexa/v2/content/locations/1/2/58 + id: 58 + priority: 0 + hidden: false + invisible: false + explicitlyHidden: false + ParentLocation: + _media-type: application/vnd.ibexa.api.Location+json + _href: /api/ibexa/v2/content/locations/1/2 + pathString: /1/2/58/ + depth: 2 + childCount: 3 + remoteId: 0cfe62f27753448d79aaa8acd8d01699 + Children: + _media-type: application/vnd.ibexa.api.LocationList+json + _href: /api/ibexa/v2/content/locations/1/2/58/children + Content: + _media-type: application/vnd.ibexa.api.Content+json + _href: /api/ibexa/v2/content/objects/57 + sortField: PATH + sortOrder: ASC + UrlAliases: + _media-type: application/vnd.ibexa.api.UrlAliasRefList+json + _href: /api/ibexa/v2/content/locations/1/2/58/urlaliases + ContentInfo: + _media-type: application/vnd.ibexa.api.ContentInfo+json + _href: /api/ibexa/v2/content/objects/57 + Content: + _media-type: application/vnd.ibexa.api.ContentInfo+json + _href: /api/ibexa/v2/content/objects/57 + _remoteId: 782f5afa9d6587804daa911e88ff5bb9 + _id: 57 + ContentType: + _media-type: application/vnd.ibexa.api.ContentType+json + _href: /api/ibexa/v2/content/types/1 + Name: All Tips + TranslatedName: All Tips + Versions: + _media-type: application/vnd.ibexa.api.VersionList+json + _href: /api/ibexa/v2/content/objects/57/versions + CurrentVersion: + _media-type: application/vnd.ibexa.api.Version+json + _href: /api/ibexa/v2/content/objects/57/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/57/locations + Owner: + _media-type: application/vnd.ibexa.api.User+json + _href: /api/ibexa/v2/user/users/14 + lastModificationDate: "2021-06-28T11:22:52+00:00" + publishedDate: "2021-06-28T11:22:52+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/57/objectstates + application/vnd.ibexa.api.Location+xml: schema: - $ref: '#/components/schemas/ParticipantListWrapper' - example: |+ - <?xml version="1.0"?> - <ParticipantList media-type="application/vnd.ibexa.api.ParticipantList+xml"> - <Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml"> - <id>1</id> - <name>John Doe</name> - <scope>edit</scope> - <User href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> - <createdAt>2023-11-15T10:30:00+00:00</createdAt> - <updatedAt>2023-11-15T10:30:00+00:00</updatedAt> - </Participant> - <Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml"> - <id>2</id> - <name>guest@example.com</name> - <scope>view</scope> - <email>guest@example.com</email> - <createdAt>2023-11-15T11:00:00+00:00</createdAt> - <updatedAt>2023-11-15T11:00:00+00:00</updatedAt> - </Participant> - </ParticipantList> - - 400: - description: Error - the input does not match the input schema definition. - 404: - description: Error - the session does not exist. + $ref: '#/components/schemas/Location' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/61"> + <id>61</id> + <priority>0</priority> + <hidden>false</hidden> + <invisible>false</invisible> + <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2"/> + <pathString>/1/2/61/</pathString> + <depth>2</depth> + <childCount>0</childCount> + <remoteId>2cfa66027e3806b113d994c9c26d3a66</remoteId> + <Children media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/2/61/children"/> + <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/60"/> + <sortField>NAME</sortField> + <sortOrder>ASC</sortOrder> + <UrlAliases media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/61/urlaliases"/> + <ContentInfo media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/60"> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/60" remoteId="f9198276543bfe5e1dfc01a9a8d0c7ee" id="60"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"/> + <Name>666</Name> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/60/versions"/> + <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/60/currentversion"/> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/60/locations"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <lastModificationDate>2018-11-09T14:49:52+01:00</lastModificationDate> + <publishedDate>2018-11-09T14:49:52+01:00</publishedDate> + <mainLanguageCode>eng-GB</mainLanguageCode> + <currentVersionNo>1</currentVersionNo> + <alwaysAvailable>false</alwaysAvailable> + <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/60/objectstates"/> + </Content> + </ContentInfo> + </Location> 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. + 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: sessionToken + - name: If-None-Match + in: header + description: ETag + required: false + deprecated: false + schema: + type: string + style: simple + explode: false + - name: path in: path - description: The session token. + description: LocationLoadByPathController identifier 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: |+ - <?xml version="1.0" encoding="UTF-8"?> - <ParticipantListCreate> - <ParticipantCreate media-type="application/vnd.ibexa.api.InternalParticipantCreate+xml"> - <scope>view</scope> - <User media-type="application/vnd.ibexa.api.User+xml" - href="/api/ibexa/v2/user/users/14" - > - </User> - </ParticipantCreate> - <ParticipantCreate media-type="application/vnd.ibexa.api.ExternalParticipantCreate+xml"> - <email>user@link.invalid</email> - <scope>view</scope> - </ParticipantCreate> - </ParticipantListCreate> - - required: false - deprecated: false - /collaboration/sessions/{sessionToken}/participants/{participantId}: delete: - operationId: api_collaborationsessions_sessionTokenparticipants_participantId_delete + operationId: ibexa.rest.delete_subtree tags: - - Collaboration Sessions + - Location responses: 204: - description: Participant removed - 404: - description: Error - the session or participant does not exist. + description: No Content - deleted. 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. + 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: sessionToken - in: path - description: The session token. + - name: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: participantId + - name: path in: path - description: The participant ID to remove. + description: LocationSubtreeDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: - type: integer + type: string style: simple explode: false - allowReserved: false - deprecated: false patch: - operationId: api_collaborationsessions_sessionTokenparticipants_participantId_patch + operationId: ibexa.rest.update_location tags: - - Collaboration Sessions + - Location responses: 200: - description: Updated participant + description: If set, the Location is returned in XML or JSON format. 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: + application/vnd.ibexa.api.Location+json: schema: - $ref: '#/components/schemas/InternalParticipantWrapper' - application/vnd.ibexa.api.InternalParticipant+xml: + $ref: '#/components/schemas/LocationWrapper' + example: + Location: + _media-type: application/vnd.ibexa.api.Location+json + _href: /api/ibexa/v2/content/locations/1/2/59 + id: 59 + priority: 3 + hidden: true + invisible: true + explicitlyHidden: true + ParentLocation: + _media-type: application/vnd.ibexa.api.Location+json + _href: /api/ibexa/v2/content/locations/1/2 + pathString: /1/2/59/ + depth: 2 + childCount: 5 + remoteId: remoteId-qwert999 + Children: + _media-type: application/vnd.ibexa.api.LocationList+json + _href: /api/ibexa/v2/content/locations/1/2/59/children + Content: + _media-type: application/vnd.ibexa.api.Content+json + _href: /api/ibexa/v2/content/objects/58 + sortField: NAME + sortOrder: DESC + UrlAliases: + _media-type: 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.Location+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. + $ref: '#/components/schemas/Location' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/58"> + <id>58</id> + <priority>0</priority> + <hidden>false</hidden> + <invisible>false</invisible> + <explicitlyHidden>false</explicitlyHidden> + <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2"/> + <pathString>/1/2/58/</pathString> + <depth>2</depth> + <childCount>3</childCount> + <remoteId>0cfe62f27753448d79aaa8acd8d01699</remoteId> + <Children media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/2/58/children"/> + <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/57"/> + <sortField>PATH</sortField> + <sortOrder>ASC</sortOrder> + <UrlAliases media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/58/urlaliases"/> + <ContentInfo media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/57"> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/57" remoteId="782f5afa9d6587804daa911e88ff5bb9" id="57"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"/> + <Name>All Tips</Name> + <TranslatedName>All Tips</TranslatedName> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/57/versions"/> + <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/57/currentversion"/> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/57/locations"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <lastModificationDate>2021-06-28T11:22:52+00:00</lastModificationDate> + <publishedDate>2021-06-28T11:22:52+00:00</publishedDate> + <mainLanguageCode>eng-GB</mainLanguageCode> + <currentVersionNo>1</currentVersionNo> + <alwaysAvailable>true</alwaysAvailable> + <isHidden>false</isHidden> + <status>PUBLISHED</status> + <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/57/objectstates"/> + </Content> + </ContentInfo> + </Location> 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. + 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: sessionToken - in: path - description: The session token. + - name: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: participantId + - name: If-Match + in: header + description: ETag + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: path in: path - description: The participant ID to update. + description: LocationUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: - type: integer + type: string style: simple explode: false - allowReserved: false requestBody: - description: Participant update payload + description: The LocationUpdate schema encoded in XML or JSON format. 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: |+ - <?xml version="1.0" encoding="UTF-8"?> - <ExternalParticipantUpdate> - <scope>view</scope> - </ExternalParticipantUpdate> - - application/vnd.ibexa.api.InternalParticipantUpdate+json: + application/vnd.ibexa.api.LocationUpdate+json: schema: - $ref: '#/components/schemas/InternalParticipantUpdate' + $ref: '#/components/schemas/LocationUpdateStructWrapper' example: - InternalParticipantUpdate: - scope: view - application/vnd.ibexa.api.InternalParticipantUpdate+xml: + LocationUpdate: + priority: "3" + hidden: true + remoteId: remoteId-qwert999 + sortField: NAME + sortOrder: DESC + application/vnd.ibexa.api.LocationUpdate+xml: schema: - $ref: '#/components/schemas/InternalParticipantUpdate' - example: |+ + $ref: '#/components/schemas/LocationUpdateStruct' + example: | <?xml version="1.0" encoding="UTF-8"?> - <InternalParticipantUpdate> - <scope>view</scope> - </InternalParticipantUpdate> - + <LocationUpdate> + <priority>3</priority> + <hidden>true</hidden> + <remoteId>remoteId-qwert999</remoteId> + <sortField>CLASS</sortField> + <sortOrder>DESC</sortOrder> + </LocationUpdate> required: false - deprecated: false - /ai/action-types: + /content/locations/{path}/children: get: - operationId: ibexa.rest.ai.action_type.list + operationId: ibexa.rest.load_location_children tags: - - Connector AI + - Location responses: 200: - description: Action type list + description: If set, the new Location list is returned in XML or JSON format. content: - application/vnd.ibexa.api.ai.ActionTypeList+json: + application/vnd.ibexa.api.LocationList+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: + $ref: '#/components/schemas/LocationListWrapper' + application/vnd.ibexa.api.LocationList+xml: schema: - $ref: '#/components/schemas/ActionTypeList' + $ref: '#/components/schemas/LocationList' example: | <?xml version="1.0" encoding="UTF-8"?> - <ActionTypeList media-type="application/vnd.ibexa.api.ai.ActionTypeList+xml" href="/api/ibexa/v2/ai/action-types"> - <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> - <identifier>generate_alt_text</identifier> - <name>Generate alternative text</name> - <inputIdentifier>image</inputIdentifier> - <outputIdentifier>text</outputIdentifier> - <options> - <width>512</width> - <height>512</height> - <image_quality>85</image_quality> - </options> - </ActionType> - <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> - <identifier>refine_text</identifier> - <name>Refine text</name> - <inputIdentifier>text</inputIdentifier> - <outputIdentifier>text</outputIdentifier> - <options/> - </ActionType> - </ActionTypeList> - summary: Get action types list. - description: Returns action types list. - parameters: [] - deprecated: false - /ai/action-types/{identifier}: + <LocationList media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/63/children"> + <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/63/60"/> + <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/63/61"/> + <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/63/62"/> + <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/63/67"/> + </LocationList> + 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: path + in: path + description: LocationChildrenListController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + /content/locations/{path}/urlaliases: get: - operationId: ibexa.rest.ai.action_type + operationId: ibexa.rest.list_location_url_aliases tags: - - Connector AI + - Location responses: 200: - description: Action type + description: OK - returns the list of URL aliases. content: - application/vnd.ibexa.api.ai.ActionType+json: + application/vnd.ibexa.api.UrlAliasRefList+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: + $ref: '#/components/schemas/UrlAliasRefListWrapper' + application/vnd.ibexa.api.UrlAliasRefList+xml: schema: - $ref: '#/components/schemas/ActionType' + $ref: '#/components/schemas/UrlAliasRefList' example: | <?xml version="1.0" encoding="UTF-8"?> - <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> - <identifier>generate_alt_text</identifier> - <name>Generate alternative text</name> - <inputIdentifier>image</inputIdentifier> - <outputIdentifier>text</outputIdentifier> - <options> - <width>512</width> - <height>512</height> - <image_quality>85</image_quality> - </options> - </ActionType> - 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. + <UrlAliasRefList media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/59/urlaliases"> + <UrlAlias media-type="application/vnd.ibexa.api.UrlAlias+xml" href="/api/ibexa/v2/content/urlaliases/0-deca3dadca45c3dff7861274b8e67ed7"/> + <UrlAlias media-type="application/vnd.ibexa.api.UrlAlias+xml" href="/api/ibexa/v2/content/urlaliases/0-e1511fd04f57162341c2950fa1375867"/> + </UrlAliasRefList> + 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: identifier + - name: path in: path - description: "" + description: URLAliasListLocationController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - example: generate_alt_text - deprecated: false - /ai/actions: + /content/objectstategroups: get: - operationId: ibexa.rest.ai.action.list.get + operationId: ibexa.rest.load_object_state_groups tags: - - Connector AI + - Object State Groups responses: 200: - description: Action configuration list is returned in JSON or XML + description: OK - returns a list of Object state groups. content: - application/vnd.ibexa.api.ai.ActionConfigurationList+json: + application/vnd.ibexa.api.ObjectStateGroupList+json: schema: - $ref: '#/components/schemas/ActionConfigurationList' + $ref: '#/components/schemas/ObjectStateGroupListWrapper' 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: + 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/ActionConfigurationList' + $ref: '#/components/schemas/ObjectStateGroupList' example: | <?xml version="1.0" encoding="UTF-8"?> - <ActionConfigurationList media-type="application/vnd.ibexa.api.ai.ActionConfigurationList+xml" href="/api/ibexa/v2/ai/actions"> - <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> - <identifier>rewrite_with_friendly_tone</identifier> - <name>Rewrite in friendly tone</name> - <description></description> - <enabled>1</enabled> - <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> - <identifier>refine_text</identifier> - <name>Refine text</name> - <inputIdentifier>text</inputIdentifier> - <outputIdentifier>text</outputIdentifier> - <options/> - </ActionType> - <actionTypeOptions/> - <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier> - <actionHandlerOptions> - <max_tokens>4000</max_tokens> - <temperature>1</temperature> - <prompt>Rewrite text in friendly tone. Preserve meaning and crucial information.</prompt> - <model>gpt-4-turbo</model> - </actionHandlerOptions> - <createdAt>2025-08-07T13:16:47+02:00</createdAt> - <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> - </ActionConfiguration> - <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> - <identifier>rewrite_with_professional_tone</identifier> - <name>Rewrite in professional tone</name> - <description></description> - <enabled>1</enabled> - <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> - <identifier>refine_text</identifier> - <name>Refine text</name> - <inputIdentifier>text</inputIdentifier> - <outputIdentifier>text</outputIdentifier> - <options/> - </ActionType> - <actionTypeOptions/> - <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier> - <actionHandlerOptions> - <max_tokens>4000</max_tokens> - <temperature>1</temperature> - <prompt>Rewrite text in professional tone. Preserve meaning and crucial information.</prompt> - <model>gpt-4-turbo</model> - </actionHandlerOptions> - <createdAt>2025-08-07T13:16:47+02:00</createdAt> - <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> - </ActionConfiguration> - <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> - <identifier>summarize_text</identifier> - <name>Summarize</name> - <description></description> - <enabled>1</enabled> - <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> - <identifier>refine_text</identifier> - <name>Refine text</name> - <inputIdentifier>text</inputIdentifier> - <outputIdentifier>text</outputIdentifier> - <options/> - </ActionType> - <actionTypeOptions/> - <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier> - <actionHandlerOptions> - <max_tokens>4000</max_tokens> - <temperature>1</temperature> - <prompt>Summarize text into one sentence. Preserve meaning and crucial information.</prompt> - <model>gpt-4-turbo</model> - </actionHandlerOptions> - <createdAt>2025-08-07T13:16:47+02:00</createdAt> - <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> - </ActionConfiguration> - <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> - <identifier>expand_text</identifier> - <name>Expand text</name> - <description></description> - <enabled>1</enabled> - <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> - <identifier>refine_text</identifier> - <name>Refine text</name> - <inputIdentifier>text</inputIdentifier> - <outputIdentifier>text</outputIdentifier> - <options/> - </ActionType> - <actionTypeOptions/> - <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier> - <actionHandlerOptions> - <max_tokens>4000</max_tokens> - <temperature>1</temperature> - <prompt>Expand the given text by 25%. Preserve meaning and crucial information.</prompt> - <model>gpt-4-turbo</model> - </actionHandlerOptions> - <createdAt>2025-08-07T13:16:47+02:00</createdAt> - <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> - </ActionConfiguration> - <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> - <identifier>shorten_text</identifier> - <name>Shorten text</name> - <description></description> - <enabled>1</enabled> - <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> - <identifier>refine_text</identifier> - <name>Refine text</name> - <inputIdentifier>text</inputIdentifier> - <outputIdentifier>text</outputIdentifier> - <options/> - </ActionType> - <actionTypeOptions/> - <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier> - <actionHandlerOptions> - <max_tokens>4000</max_tokens> - <temperature>1</temperature> - <prompt>Shorten the given text by 25%. Preserve meaning and crucial information.</prompt> - <model>gpt-4-turbo</model> - </actionHandlerOptions> - <createdAt>2025-08-07T13:16:47+02:00</createdAt> - <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> - </ActionConfiguration> - <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> - <identifier>proofread</identifier> - <name>Proofread</name> - <description></description> - <enabled>1</enabled> - <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> - <identifier>refine_text</identifier> - <name>Refine text</name> - <inputIdentifier>text</inputIdentifier> - <outputIdentifier>text</outputIdentifier> - <options/> - </ActionType> - <actionTypeOptions/> - <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier> - <actionHandlerOptions> - <max_tokens>4000</max_tokens> - <temperature>1</temperature> - <prompt>Rewrite given text to identify and fix grammatical and punctuation errors. Preserve meaning and crucial information.</prompt> - <model>gpt-4-turbo</model> - </actionHandlerOptions> - <createdAt>2025-08-07T13:16:47+02:00</createdAt> - <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> - </ActionConfiguration> - <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> - <identifier>improve_readability</identifier> - <name>Improve readability</name> - <description></description> - <enabled>1</enabled> - <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> - <identifier>refine_text</identifier> - <name>Refine text</name> - <inputIdentifier>text</inputIdentifier> - <outputIdentifier>text</outputIdentifier> - <options/> - </ActionType> - <actionTypeOptions/> - <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier> - <actionHandlerOptions> - <max_tokens>4000</max_tokens> - <temperature>1</temperature> - <prompt>Rewrite this content to improve readability. Preserve meaning and crucial information.</prompt> - <model>gpt-4-turbo</model> - </actionHandlerOptions> - <createdAt>2025-08-07T13:16:47+02:00</createdAt> - <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> - </ActionConfiguration> - <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> - <identifier>gen_alt_text</identifier> - <name>Generate alternative text</name> - <description></description> - <enabled>1</enabled> - <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> - <identifier>generate_alt_text</identifier> - <name>Generate alternative text</name> - <inputIdentifier>image</inputIdentifier> - <outputIdentifier>text</outputIdentifier> - <options> - <width>512</width> - <height>512</height> - <image_quality>85</image_quality> - </options> - </ActionType> - <actionTypeOptions> - <max_length>140</max_length> - </actionTypeOptions> - <actionHandlerIdentifier>openai-image-to-text</actionHandlerIdentifier> - <actionHandlerOptions> - <max_tokens>4000</max_tokens> - <temperature>1</temperature> - <prompt></prompt> - <model>gpt-4-turbo</model> - </actionHandlerOptions> - <createdAt>2025-08-07T13:16:47+02:00</createdAt> - <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> - </ActionConfiguration> - </ActionConfigurationList> - summary: Get action configuration list. - description: Returns action configuration list. - parameters: [] - deprecated: false + <ObjectStateGroupList media-type="application/vnd.ibexa.api.ObjectStateGroupList+xml" href="/api/ibexa/v2/content/objectstategroups"> + <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/2"> + <id>2</id> + <identifier>ibexa_lock</identifier> + <defaultLanguageCode>eng-GB</defaultLanguageCode> + <languageCodes>eng-GB</languageCodes> + <ObjectStates media-type="application/vnd.ibexa.api.ObjectStateList+xml" href="/api/ibexa/v2/content/objectstategroups/2/objectstates"/> + <names> + <value languageCode="eng-GB">Lock</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + </ObjectStateGroup> + <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/3"> + <id>3</id> + <identifier>accessibility</identifier> + <defaultLanguageCode>eng-GB</defaultLanguageCode> + <languageCodes>eng-GB</languageCodes> + <ObjectStates media-type="application/vnd.ibexa.api.ObjectStateList+xml" href="/api/ibexa/v2/content/objectstategroups/3/objectstates"/> + <names> + <value languageCode="eng-GB">Accessibility</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + </ObjectStateGroup> + <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/6"> + <id>6</id> + <identifier>custom-states</identifier> + <defaultLanguageCode>eng-GB</defaultLanguageCode> + <languageCodes>eng-GB</languageCodes> + <ObjectStates media-type="application/vnd.ibexa.api.ObjectStateList+xml" href="/api/ibexa/v2/content/objectstategroups/6/objectstates"/> + <names> + <value languageCode="eng-GB">Custom State</value> + </names> + <descriptions> + <value languageCode="eng-GB">Custom Object state</value> + </descriptions> + </ObjectStateGroup> + </ObjectStateGroupList> + 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: If-None-Match + in: header + description: ETag + required: false + deprecated: false + schema: + type: string + style: simple + explode: false post: - operationId: ibexa.rest.ai.action.list.post + operationId: ibexa.rest.create_object_state_group tags: - - Connector AI + - Object State Groups responses: - 200: - description: Action configuration list is returned in JSON or XML + 201: + description: Object state group created. content: - application/vnd.ibexa.api.ai.ActionConfigurationList+json: + application/vnd.ibexa.api.ObjectStateGroup+json: schema: - $ref: '#/components/schemas/ActionConfigurationList' + $ref: '#/components/schemas/ObjectStateGroupWrapper' 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: + ObjectStateGroup: + _media-type: application/vnd.ibexa.api.ObjectStateGroup+json + _href: /api/ibexa/v2/content/objectstategroups/7 + id: 7 + identifier: custom-states + defaultLanguageCode: eng-GB + languageCodes: eng-GB + ObjectStates: + _media-type: application/vnd.ibexa.api.ObjectStateList+json + _href: /api/ibexa/v2/content/objectstategroups/7/objectstates + names: + value: + - _languageCode: eng-GB + '#text': Custom State + descriptions: + value: + - _languageCode: eng-GB + '#text': Custom Object state + application/vnd.ibexa.api.ObjectStateGroup+xml: schema: - $ref: '#/components/schemas/ActionConfigurationList' + $ref: '#/components/schemas/ObjectStateGroup' example: | <?xml version="1.0" encoding="UTF-8"?> - <ActionConfigurationList media-type="application/vnd.ibexa.api.ai.ActionConfigurationList+xml" href="/api/ibexa/v2/ai/actions"> - <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> - <identifier>rewrite_with_professional_tone</identifier> - <name>Rewrite in professional tone</name> - <description></description> - <enabled>1</enabled> - <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> - <identifier>refine_text</identifier> - <name>Refine text</name> - <inputIdentifier>text</inputIdentifier> - <outputIdentifier>text</outputIdentifier> - <options/> - </ActionType> - <actionTypeOptions/> - <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier> - <actionHandlerOptions> - <max_tokens>4000</max_tokens> - <temperature>1</temperature> - <prompt>Rewrite text in professional tone. Preserve meaning and crucial information.</prompt> - <model>gpt-4-turbo</model> - </actionHandlerOptions> - <createdAt>2025-08-07T13:16:47+02:00</createdAt> - <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> - </ActionConfiguration> - <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> - <identifier>rewrite_with_friendly_tone</identifier> - <name>Rewrite in friendly tone</name> - <description></description> - <enabled>1</enabled> - <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> - <identifier>refine_text</identifier> - <name>Refine text</name> - <inputIdentifier>text</inputIdentifier> - <outputIdentifier>text</outputIdentifier> - <options/> - </ActionType> - <actionTypeOptions/> - <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier> - <actionHandlerOptions> - <max_tokens>4000</max_tokens> - <temperature>1</temperature> - <prompt>Rewrite text in friendly tone. Preserve meaning and crucial information.</prompt> - <model>gpt-4-turbo</model> - </actionHandlerOptions> - <createdAt>2025-08-07T13:16:47+02:00</createdAt> - <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> - </ActionConfiguration> - </ActionConfigurationList> - summary: Query action configuration list. - description: Returns action configuration list based on the given query. + <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/5"> + <id>5</id> + <identifier>custom-states</identifier> + <defaultLanguageCode>eng-GB</defaultLanguageCode> + <languageCodes>eng-GB</languageCodes> + <ObjectStates media-type="application/vnd.ibexa.api.ObjectStateList+xml" href="/api/ibexa/v2/content/objectstategroups/5/objectstates"/> + <names> + <value languageCode="eng-GB">Custom State</value> + </names> + <descriptions> + <value languageCode="eng-GB">Custom Object state</value> + </descriptions> + </ObjectStateGroup> + 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: X-CSRF-Token in: header - description: CSRF token obtained during the authentication. + description: The CSRF Token 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: Query action configuration search criteria + description: The Object state group input schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.ai.ActionConfigurationListInput+json: + application/vnd.ibexa.api.ObjectStateGroupCreate+json: schema: - $ref: '#/components/schemas/ActionConfigurationListInput' + $ref: '#/components/schemas/ObjectStateGroupCreateWrapper' example: - ActionConfigurationListInput: - query: Rewrite - action_type_identifier: refine_text - enabled: true - limit: 25 - page: 1 - application/vnd.ibexa.api.ai.ActionConfigurationListInput+xml: + 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/ActionConfigurationListInput' - example: | + $ref: '#/components/schemas/ObjectStateGroupCreate' + example: |- <?xml version="1.0" encoding="UTF-8"?> - <ActionConfigurationListInput> - <query>Rewrite</query> - <action_type_identifier>refine_text</action_type_identifier> - <enabled>1</enabled> - <limit>25</limit> - <page>1</page> - </ActionConfigurationListInput> + <ObjectStateGroupCreate> + <identifier>custom</identifier> + <defaultLanguageCode>eng-GB</defaultLanguageCode> + <names> + <value languageCode="eng-GB">Custom State</value> + </names> + <descriptions> + <value languageCode="eng-GB">Custom Object state</value> + </descriptions> + </ObjectStateGroupCreate> required: false - deprecated: false - /ai/actions/{actionConfigurationIdentifier}/execute: - post: - operationId: ibexa.rest.ai.actions.execute + /content/objectstategroups/{objectStateGroupId}: + get: + operationId: ibexa.rest.load_object_state_group tags: - - Connector AI + - Object State Groups responses: 200: - description: Reworked text or generated alternative text + description: OK - returns the Object state group. 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: | - <?xml version="1.0" encoding="UTF-8"?> - <AltText media-type="application/vnd.ibexa.api.ai.AltText+xml"> - <Text media-type="application/vnd.ibexa.api.ai.Text+xml"> - <text>Sunlit home office with an open laptop, papers, and a blurred background.</text> - </Text> - </AltText> - application/vnd.ibexa.api.ai.Text+json: + application/vnd.ibexa.api.ObjectStateGroup+json: schema: - $ref: '#/components/schemas/Text' + $ref: '#/components/schemas/ObjectStateGroupWrapper' 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: + ObjectStateGroup: + _media-type: application/vnd.ibexa.api.ObjectStateGroup+json + _href: /api/ibexa/v2/content/objectstategroups/7 + id: 7 + identifier: custom-states + defaultLanguageCode: eng-GB + languageCodes: eng-GB + ObjectStates: + _media-type: application/vnd.ibexa.api.ObjectStateList+json + _href: /api/ibexa/v2/content/objectstategroups/7/objectstates + names: + value: + - _languageCode: eng-GB + '#text': Custom State + descriptions: + value: + - _languageCode: eng-GB + '#text': Custom Object state + application/vnd.ibexa.api.ObjectStateGroup+xml: schema: - $ref: '#/components/schemas/Text' + $ref: '#/components/schemas/ObjectStateGroup' example: | <?xml version="1.0" encoding="UTF-8"?> - <Text media-type="application/vnd.ibexa.api.ai.Text+xml"> - <text>Hello, I hope you are well. How have you been spending your day?</text> - </Text> - 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. + <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/7"> + <id>7</id> + <identifier>custom-states</identifier> + <defaultLanguageCode>eng-GB</defaultLanguageCode> + <languageCodes>eng-GB</languageCodes> + <ObjectStates media-type="application/vnd.ibexa.api.ObjectStateList+xml" href="/api/ibexa/v2/content/objectstategroups/7/objectstates"/> + <names> + <value languageCode="eng-GB">Custom State</value> + </names> + <descriptions> + <value languageCode="eng-GB">Custom Object state</value> + </descriptions> + </ObjectStateGroup> + 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: actionConfigurationIdentifier + - name: If-None-Match + in: header + description: ETag + required: false + deprecated: false + schema: + type: string + style: simple + explode: false + - name: objectStateGroupId in: path - description: Configured action name (obtain by listing the configured actions - via GET `/api/ibexa/v2/ai/actions` endpoint). + description: ObjectStateGroupLoadByIdController identifier 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 + delete: + operationId: ibexa.rest.delete_object_state_group + 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: X-CSRF-Token in: header - description: CSRF token obtained during the authentication. + description: The CSRF Token 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: 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: | - <?xml version="1.0" encoding="UTF-8"?> - <GenerateAltText xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> - <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</base64> - </Image> - <RuntimeContext /> - </GenerateAltText> - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <RefineText xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> - <Text> - <text>Hey, wassup. What you've been doing the whole day?</text> - </Text> - <RuntimeContext /> - </RefineText> - required: false - deprecated: false - /ai/actions/{identifier}: - get: - operationId: ibexa.rest.ai.action + - name: objectStateGroupId + in: path + description: ObjectStateGroupDeleteController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + patch: + operationId: ibexa.rest.update_object_state_group tags: - - Connector AI + - Object State Groups responses: 200: - description: Action configuration in JSON or XML + description: OK - Object stated group updated. content: - application/vnd.ibexa.api.ai.ActionConfiguration+json: + application/vnd.ibexa.api.ObjectStateGroup+json: schema: - $ref: '#/components/schemas/ActionConfiguration' + $ref: '#/components/schemas/ObjectStateGroupWrapper' 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: + 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/ActionConfiguration' + $ref: '#/components/schemas/ObjectStateGroup' example: | <?xml version="1.0" encoding="UTF-8"?> - <ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml"> - <identifier>rewrite_with_friendly_tone</identifier> - <name>Rewrite in friendly tone</name> - <description></description> - <enabled>1</enabled> - <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml"> - <identifier>refine_text</identifier> - <name>Refine text</name> - <inputIdentifier>text</inputIdentifier> - <outputIdentifier>text</outputIdentifier> - <options/> - </ActionType> - <actionTypeOptions/> - <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier> - <actionHandlerOptions> - <max_tokens>4000</max_tokens> - <temperature>1</temperature> - <prompt>Rewrite text in friendly tone. Preserve meaning and crucial information.</prompt> - <model>gpt-4-turbo</model> - </actionHandlerOptions> - <createdAt>2025-08-07T13:16:47+02:00</createdAt> - <updatedAt>2025-08-07T13:16:47+02:00</updatedAt> - </ActionConfiguration> - 404: - description: Error - an action configuration of the given unique identifier - is not found. + <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/7"> + <id>7</id> + <identifier>custom-states</identifier> + <defaultLanguageCode>eng-GB</defaultLanguageCode> + <languageCodes>eng-GB</languageCodes> + <ObjectStates media-type="application/vnd.ibexa.api.ObjectStateList+xml" href="/api/ibexa/v2/content/objectstategroups/7/objectstates"/> + <names> + <value languageCode="eng-GB">New Custom State name</value> + </names> + <descriptions> + <value languageCode="eng-GB">Custom Object state</value> + </descriptions> + </ObjectStateGroup> + 400: + description: Error - The input does not match the input schema definition. 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. + 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: identifier + - name: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: If-Match + in: header + description: ETag + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: objectStateGroupId in: path - description: "" + description: ObjectStateGroupUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - example: rewrite_with_friendly_tone - deprecated: false - /corporate: + requestBody: + description: The Object state group input schema encoded in XML or JSON format. + 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: | + <?xml version="1.0" encoding="UTF-8"?> + <ObjectStateGroupUpdate> + <names> + <value languageCode="eng-GB">New Custom State name</value> + </names> + </ObjectStateGroupUpdate> + required: false + /content/objectstategroups/{objectStateGroupId}/objectstates: get: - operationId: ibexa.rest.corporate_account.root + operationId: ibexa.rest.load_object_states tags: - - Corporate Account + - Object State Groups responses: 200: - description: List of Link objects to specific Corporate Account REST resources + description: OK - returns a list of Object states. content: - application/vnd.ibexa.api.CorporateAccountRoot+json: + application/vnd.ibexa.api.ObjectStateList+json: schema: - $ref: '#/components/schemas/CorporateAccountRootWrapper' + $ref: '#/components/schemas/ObjectStateListWrapper' 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: | - <?xml version="1.0" encoding="UTF-8"?> - <CorporateAccountRoot media-type="application/vnd.ibexa.api.CorporateAccountRoot+xml"> - <link media-type="application/vnd.ibexa.api.CompaniesList+xml" rel="ca-companies" href="/api/ibexa/v2/corporate/companies"/> - <link media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" rel="ca-types" href="/api/ibexa/v2/content/typegroups?identifier=corporate_account"/> - <link media-type="application/vnd.ibexa.api.ContentType+xml" rel="ca-types-company" href="/api/ibexa/v2/content/types/48"/> - <link media-type="application/vnd.ibexa.api.ContentType+xml" rel="ca-types-member" href="/api/ibexa/v2/content/types/47"/> - <link media-type="application/vnd.ibexa.api.ContentType+xml" rel="ca-types-address" href="/api/ibexa/v2/content/types/49"/> - <link media-type="application/vnd.ibexa.api.SalesRepresentativesList+xml" rel="ca-sales-representatives" href="/api/ibexa/v2/corporate/sales-representatives"/> - <link media-type="application/vnd.ibexa.api.Role+xml" rel="ca-role-admin" href="/api/ibexa/v2/user/roles/14"/> - <link media-type="application/vnd.ibexa.api.Role+xml" rel="ca-role-buyer" href="/api/ibexa/v2/user/roles/15"/> - </CorporateAccountRoot> - summary: Root Resource - description: Provides basic information about Corporate Account endpoints and - configuration. - parameters: [] - deprecated: false - x-badges: - - name: Experience - color: '#D3822B' - - name: Commerce - color: '#A32768' - position: after - /corporate/companies: - get: - operationId: ibexa.rest.corporate_account.companies.list - 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: ~ - height: ~ - 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: ~ - - id: 348 - fieldDefinitionIdentifier: default_address - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: ~ - - id: 349 - fieldDefinitionIdentifier: billing_address - languageCode: eng-GB - fieldTypeIdentifier: ibexa_address - fieldValue: - name: ~ - country: ~ - 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: ~ - height: ~ - 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: ~ - country: ~ - fields: [] - contactId: ~ - salesRepresentativeId: 14 - defaultAddressId: ~ - 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: + 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/CompanyList' + $ref: '#/components/schemas/ObjectStateList' example: | <?xml version="1.0" encoding="UTF-8"?> - <CompanyList media-type="application/vnd.ibexa.api.CompanyList+xml"> - <Company media-type="application/vnd.ibexa.api.Company+xml"> - <id>66</id> - <name>Ibexa AS</name> - <Content media-type="application/vnd.ibexa.api.Content+xml" - href="/api/ibexa/v2/content/objects/66" remoteId="9f20fb03d0ab0a6aef9930f7e6720377" - id="66"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" - href="/api/ibexa/v2/content/types/48"/> - <Name>Ibexa AS</Name> - <TranslatedName>Ibexa AS</TranslatedName> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" - href="/api/ibexa/v2/content/objects/66/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" - href="/api/ibexa/v2/content/objects/66/currentversion"> - <Version media-type="application/vnd.ibexa.api.Version+xml" - href="/api/ibexa/v2/content/objects/66/versions/1"> - <VersionInfo> - <id>593</id> - <versionNo>1</versionNo> - <status>PUBLISHED</status> - <modificationDate>2023-04-03T13:09:40+02:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" - href="/api/ibexa/v2/user/users/14"/> - <creationDate>2023-04-03T13:09:40+02:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo - media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Ibexa AS</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" - href="/api/ibexa/v2/content/objects/66"/> - </VersionInfo> - <Fields> - <field> - <id>295</id> - <fieldDefinitionIdentifier>active</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_boolean</fieldTypeIdentifier> - <fieldValue>true</fieldValue> - </field> - <field> - <id>296</id> - <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Ibexa AS</fieldValue> - </field> - <field> - <id>297</id> - <fieldDefinitionIdentifier>vat</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>123 456 789</fieldValue> - </field> - <field> - <id>298</id> - <fieldDefinitionIdentifier>website</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>https://ibexa.co</fieldValue> - </field> - <field> - <id>299</id> - <fieldDefinitionIdentifier>customer_group</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_customer_group</fieldTypeIdentifier> - <fieldValue> - <value key="customer_group_id">1</value> - </fieldValue> - </field> - <field> - <id>300</id> - <fieldDefinitionIdentifier>sales_rep</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">14</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/14</value> - </fieldValue> - </field> - <field> - <id>301</id> - <fieldDefinitionIdentifier>contact</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">74</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/74</value> - </fieldValue> - </field> - <field> - <id>302</id> - <fieldDefinitionIdentifier>default_address</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">69</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/69</value> - </fieldValue> - </field> - <field> - <id>303</id> - <fieldDefinitionIdentifier>billing_address</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_address</fieldTypeIdentifier> - <fieldValue> - <value key="name">HQ</value> - <value key="country">PL</value> - <value key="fields"> - <value key="region">Silesia</value> - <value key="locality">Katowice</value> - <value key="street">Gliwicka 6/5</value> - <value key="postal_code">40-079</value> - <value key="email">company@email.invalid</value> - <value key="phone_number">+48 000 000 000</value> - </value> - </fieldValue> - </field> - <field> - <id>305</id> - <fieldDefinitionIdentifier>members</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">67</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/67</value> - </fieldValue> - </field> - <field> - <id>304</id> - <fieldDefinitionIdentifier>address_book</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">68</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/68</value> - </fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" - href="/api/ibexa/v2/content/objects/66/versions/1/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/placeholder</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - </CurrentVersion> - <Section media-type="application/vnd.ibexa.api.Section+xml" - href="/api/ibexa/v2/content/sections/10"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" - href="/api/ibexa/v2/content/locations/1/65/67"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" - href="/api/ibexa/v2/content/objects/66/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <lastModificationDate>2023-04-03T13:09:40+02:00</lastModificationDate> - <publishedDate>2023-03-31T14:33:36+02:00</publishedDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>1</currentVersionNo> - <alwaysAvailable>true</alwaysAvailable> - <isHidden>false</isHidden> - <status>PUBLISHED</status> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" - href="/api/ibexa/v2/content/objects/66/objectstates"/> - </Content> - <billingAddress>HQ, Poland</billingAddress> - <contactId>74</contactId> - <salesRepresentativeId>14</salesRepresentativeId> - <defaultAddressId>69</defaultAddressId> - <addressBookId>68</addressBookId> - <membersId>67</membersId> - <MemberList media-type="application/vnd.ibexa.api.MemberList+xml" - href="/api/ibexa/v2/corporate/companies/66/members"/> - <Location media-type="application/vnd.ibexa.api.Location+xml" - href="/api/ibexa/v2/content/locations/1/65/67"/> - <locationPath>/1/65/67/</locationPath> - <isActive>1</isActive> - </Company> - <Company media-type="application/vnd.ibexa.api.Company+xml"> - <id>75</id> - <name>QNTM Group AB</name> - <Content media-type="application/vnd.ibexa.api.Content+xml" - href="/api/ibexa/v2/content/objects/75" remoteId="1d7eaec5b4371f7a35f253d15ecd5258" - id="75"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" - href="/api/ibexa/v2/content/types/48"/> - <Name>QNTM Group AB</Name> - <TranslatedName>QNTM Group AB</TranslatedName> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" - href="/api/ibexa/v2/content/objects/75/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" - href="/api/ibexa/v2/content/objects/75/currentversion"> - <Version media-type="application/vnd.ibexa.api.Version+xml" - href="/api/ibexa/v2/content/objects/75/versions/3"> - <VersionInfo> - <id>546</id> - <versionNo>3</versionNo> - <status>PUBLISHED</status> - <modificationDate>2023-03-31T15:24:49+02:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" - href="/api/ibexa/v2/user/users/14"/> - <creationDate>2023-03-31T15:24:49+02:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo - media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">QNTM Group AB</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" - href="/api/ibexa/v2/content/objects/75"/> - </VersionInfo> - <Fields> - <field> - <id>341</id> - <fieldDefinitionIdentifier>active</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_boolean</fieldTypeIdentifier> - <fieldValue>true</fieldValue> - </field> - <field> - <id>342</id> - <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>QNTM Group AB</fieldValue> - </field> - <field> - <id>343</id> - <fieldDefinitionIdentifier>vat</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>123 456 789</fieldValue> - </field> - <field> - <id>344</id> - <fieldDefinitionIdentifier>website</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>https://ibexa.co</fieldValue> - </field> - <field> - <id>345</id> - <fieldDefinitionIdentifier>customer_group</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_customer_group</fieldTypeIdentifier> - <fieldValue> - <value key="customer_group_id">1</value> - </fieldValue> - </field> - <field> - <id>346</id> - <fieldDefinitionIdentifier>sales_rep</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">14</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/14</value> - </fieldValue> - </field> - <field> - <id>347</id> - <fieldDefinitionIdentifier>contact</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId"/> - </fieldValue> - </field> - <field> - <id>348</id> - <fieldDefinitionIdentifier>default_address</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId"/> - </fieldValue> - </field> - <field> - <id>349</id> - <fieldDefinitionIdentifier>billing_address</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_address</fieldTypeIdentifier> - <fieldValue> - <value key="name"/> - <value key="country"/> - <value key="fields"/> - </fieldValue> - </field> - <field> - <id>351</id> - <fieldDefinitionIdentifier>members</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">76</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/76</value> - </fieldValue> - </field> - <field> - <id>350</id> - <fieldDefinitionIdentifier>address_book</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">77</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/77</value> - </fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" - href="/api/ibexa/v2/content/objects/75/versions/3/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/placeholder</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - </CurrentVersion> - <Section media-type="application/vnd.ibexa.api.Section+xml" - href="/api/ibexa/v2/content/sections/10"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" - href="/api/ibexa/v2/content/locations/1/65/76"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" - href="/api/ibexa/v2/content/objects/75/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <lastModificationDate>2023-03-31T15:24:49+02:00</lastModificationDate> - <publishedDate>2023-03-31T15:24:48+02:00</publishedDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>3</currentVersionNo> - <alwaysAvailable>true</alwaysAvailable> - <isHidden>false</isHidden> - <status>PUBLISHED</status> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" - href="/api/ibexa/v2/content/objects/75/objectstates"/> - </Content> - <billingAddress></billingAddress> - <contactId></contactId> - <salesRepresentativeId>14</salesRepresentativeId> - <defaultAddressId></defaultAddressId> - <addressBookId>77</addressBookId> - <membersId>76</membersId> - <MemberList media-type="application/vnd.ibexa.api.MemberList+xml" - href="/api/ibexa/v2/corporate/companies/75/members"/> - <Location media-type="application/vnd.ibexa.api.Location+xml" - href="/api/ibexa/v2/content/locations/1/65/76"/> - <locationPath>/1/65/76/</locationPath> - <isActive>1</isActive> - </Company> - </CompanyList> - 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: [] - deprecated: false - x-badges: - - name: Experience - color: '#D3822B' - - name: Commerce - color: '#A32768' - position: after + <ObjectStateList media-type="application/vnd.ibexa.api.ObjectStateList+xml" href="/api/ibexa/v2/content/objectstategroups/2/objectstates"> + <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/2/objectstates/1"> + <id>1</id> + <identifier>not_locked</identifier> + <priority>0</priority> + <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/2"/> + <defaultLanguageCode>eng-GB</defaultLanguageCode> + <languageCodes>eng-GB</languageCodes> + <names> + <value languageCode="eng-GB">Not locked</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + </ObjectState> + <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/2/objectstates/2"> + <id>2</id> + <identifier>locked</identifier> + <priority>1</priority> + <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/2"/> + <defaultLanguageCode>eng-GB</defaultLanguageCode> + <languageCodes>eng-GB</languageCodes> + <names> + <value languageCode="eng-GB">Locked</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + </ObjectState> + </ObjectStateList> + 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: If-None-Match + in: header + description: ETag + required: false + deprecated: false + schema: + type: string + style: simple + explode: false + - name: objectStateGroupId + in: path + description: ObjectStateListController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false post: - operationId: ibexa.rest.corporate_account.companies.create + operationId: ibexa.rest.create_object_state tags: - - Corporate Account + - Object State Groups responses: 201: - description: If set, the new company is returned in XML or JSON format. + description: Object state created. content: - application/vnd.ibexa.api.Company+json: + application/vnd.ibexa.api.ObjectState+json: schema: - $ref: '#/components/schemas/CompanyWrapper' + $ref: '#/components/schemas/ObjectStateWrapper' 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: ~ - height: ~ - 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: + ObjectState: + _media-type: application/vnd.ibexa.api.ObjectState+json + _href: /api/ibexa/v2/content/objectstategroups/7/objectstates/7 + id: 7 + identifier: new-state + priority: 0 + ObjectStateGroup: + _media-type: application/vnd.ibexa.api.ObjectStateGroup+json + _href: /api/ibexa/v2/content/objectstategroups/7 + defaultLanguageCode: eng-GB + languageCodes: eng-GB + names: + value: + - _languageCode: eng-GB + '#text': New State + descriptions: + value: + - _languageCode: eng-GB + '#text': New Object State + application/vnd.ibexa.api.ObjectState+xml: schema: - $ref: '#/components/schemas/Company' + $ref: '#/components/schemas/ObjectState' example: | <?xml version="1.0" encoding="UTF-8"?> - <Company media-type="application/vnd.ibexa.api.Company+xml"> - <id>66</id> - <name>Ibexa AS</name> - <Content media-type="application/vnd.ibexa.api.Content+xml" - href="/api/ibexa/v2/content/objects/66" remoteId="9f20fb03d0ab0a6aef9930f7e6720377" - id="66"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" - href="/api/ibexa/v2/content/types/48"/> - <Name>Ibexa AS</Name> - <TranslatedName>Ibexa AS</TranslatedName> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" - href="/api/ibexa/v2/content/objects/66/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" - href="/api/ibexa/v2/content/objects/66/currentversion"> - <Version media-type="application/vnd.ibexa.api.Version+xml" - href="/api/ibexa/v2/content/objects/66/versions/1"> - <VersionInfo> - <id>593</id> - <versionNo>1</versionNo> - <status>PUBLISHED</status> - <modificationDate>2023-04-03T13:09:40+02:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" - href="/api/ibexa/v2/user/users/14"/> - <creationDate>2023-04-03T13:09:40+02:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Ibexa AS</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" - href="/api/ibexa/v2/content/objects/66"/> - </VersionInfo> - <Fields> - <field> - <id>295</id> - <fieldDefinitionIdentifier>active</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_boolean</fieldTypeIdentifier> - <fieldValue>true</fieldValue> - </field> - <field> - <id>296</id> - <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Ibexa AS</fieldValue> - </field> - <field> - <id>297</id> - <fieldDefinitionIdentifier>vat</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>123 456 789</fieldValue> - </field> - <field> - <id>298</id> - <fieldDefinitionIdentifier>website</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>https://ibexa.co</fieldValue> - </field> - <field> - <id>299</id> - <fieldDefinitionIdentifier>customer_group</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_customer_group</fieldTypeIdentifier> - <fieldValue> - <value key="customer_group_id">1</value> - </fieldValue> - </field> - <field> - <id>300</id> - <fieldDefinitionIdentifier>sales_rep</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">14</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/14</value> - </fieldValue> - </field> - <field> - <id>301</id> - <fieldDefinitionIdentifier>contact</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">74</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/74</value> - </fieldValue> - </field> - <field> - <id>302</id> - <fieldDefinitionIdentifier>default_address</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">69</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/69</value> - </fieldValue> - </field> - <field> - <id>303</id> - <fieldDefinitionIdentifier>billing_address</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_address</fieldTypeIdentifier> - <fieldValue> - <value key="name">HQ</value> - <value key="country">PL</value> - <value key="fields"> - <value key="region">Silesia</value> - <value key="locality">Katowice</value> - <value key="street">Gliwicka 6/5</value> - <value key="postal_code">40-079</value> - <value key="email">company@email.invalid</value> - <value key="phone_number">+48 000 000 000</value> - </value> - </fieldValue> - </field> - <field> - <id>305</id> - <fieldDefinitionIdentifier>members</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">67</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/67</value> - </fieldValue> - </field> - <field> - <id>304</id> - <fieldDefinitionIdentifier>address_book</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">68</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/68</value> - </fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" - href="/api/ibexa/v2/content/objects/66/versions/1/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/placeholder</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - </CurrentVersion> - <Section media-type="application/vnd.ibexa.api.Section+xml" - href="/api/ibexa/v2/content/sections/10"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" - href="/api/ibexa/v2/content/locations/1/65/67"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" - href="/api/ibexa/v2/content/objects/66/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <lastModificationDate>2023-04-03T13:09:40+02:00</lastModificationDate> - <publishedDate>2023-03-31T14:33:36+02:00</publishedDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>1</currentVersionNo> - <alwaysAvailable>true</alwaysAvailable> - <isHidden>false</isHidden> - <status>PUBLISHED</status> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" - href="/api/ibexa/v2/content/objects/66/objectstates"/> - </Content> - <billingAddress>HQ, Poland</billingAddress> - <contactId>74</contactId> - <salesRepresentativeId>80</salesRepresentativeId> - <defaultAddressId>69</defaultAddressId> - <addressBookId>68</addressBookId> - <membersId>67</membersId> - <MemberList media-type="application/vnd.ibexa.api.MemberList+xml" - href="/api/ibexa/v2/corporate/companies/66/members"/> - <Location media-type="application/vnd.ibexa.api.Location+xml" - href="/api/ibexa/v2/content/locations/1/65/67"/> - <locationPath>/1/65/67/</locationPath> - <isActive>1</isActive> - </Company> + <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/7/objectstates/5"> + <id>5</id> + <identifier>new-state</identifier> + <priority>0</priority> + <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/7"/> + <defaultLanguageCode>eng-GB</defaultLanguageCode> + <languageCodes>eng-GB</languageCodes> + <names> + <value languageCode="eng-GB">New State</value> + </names> + <descriptions> + <value languageCode="eng-GB">New Object State</value> + </descriptions> + </ObjectState> 400: - description: Error - the input does not match the input schema definition. + 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. + 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: X-CSRF-Token in: header - description: Only needed for session's checking. The {csrfToken} needed on - all unsafe HTTP methods with session. + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: objectStateGroupId + in: path + description: ObjectStateCreateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The CompanyCreate schema encoded in XML or JSON format. + description: The Object state input schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.CompanyCreate+json: + application/vnd.ibexa.api.ObjectStateCreate+json: schema: - $ref: '#/components/schemas/CompanyCreateWrapper' + $ref: '#/components/schemas/ObjectStateCreateWrapper' 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: + 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/CompanyCreate' + $ref: '#/components/schemas/ObjectStateCreate' example: | <?xml version="1.0" encoding="UTF-8"?> - <CompanyCreate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> - <User/> - <fields> - <field> - <fieldDefinitionIdentifier>active</fieldDefinitionIdentifier> - <fieldValue>true</fieldValue> - </field> - <field> - <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> - <fieldValue>Ibexa Sp. z o. o.</fieldValue> - </field> - <field> - <fieldDefinitionIdentifier>vat</fieldDefinitionIdentifier> - <fieldValue>123 456 789</fieldValue> - </field> - <field> - <fieldDefinitionIdentifier>website</fieldDefinitionIdentifier> - <fieldValue>https://ibexa.co</fieldValue> - </field> - <field> - <fieldDefinitionIdentifier>customer_group</fieldDefinitionIdentifier> - <fieldValue> - <value key="customer_group_id">1</value> - </fieldValue> - </field> - <field> - <fieldDefinitionIdentifier>sales_rep</fieldDefinitionIdentifier> - <fieldValue> - <value key="destinationContentId">14</value> - </fieldValue> - </field> - <field> - <fieldDefinitionIdentifier>billing_address</fieldDefinitionIdentifier> - <fieldValue> - <value key="name">HQ</value> - <value key="country">PL</value> - <value key="fields"> - <value key="region">Silesia</value> - <value key="locality">Katowice</value> - <value key="street">Gliwicka 6/5</value> - <value key="postal_code">40-079</value> - <value key="email">company@email.invalid</value> - <value key="phone_number">+48 000 000 000</value> - </value> - </fieldValue> - </field> - </fields> - </CompanyCreate> + <ObjectStateCreate> + <identifier>new-state</identifier> + <priority>1</priority> + <defaultLanguageCode>eng-GB</defaultLanguageCode> + <names> + <value languageCode="eng-GB">New State</value> + </names> + <descriptions> + <value languageCode="eng-GB">New Object State</value> + </descriptions> + </ObjectStateCreate> required: false - deprecated: false - x-badges: - - name: Experience - color: '#D3822B' - - name: Commerce - color: '#A32768' - position: after - /corporate/companies/{companyId}: + /content/objectstategroups/{objectStateGroupId}/objectstates/{objectStateId}: get: - operationId: ibexa.rest.corporate_account.companies.get + operationId: ibexa.rest.load_object_state tags: - - Corporate Account + - Object State Groups responses: 200: - description: If set, the company is returned in XML or JSON format. + description: OK - returns the Object state. content: - application/vnd.ibexa.api.Company+json: + application/vnd.ibexa.api.ObjectState+json: schema: - $ref: '#/components/schemas/CompanyWrapper' + $ref: '#/components/schemas/ObjectStateWrapper' 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: ~ - height: ~ - 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: + ObjectState: + _media-type: application/vnd.ibexa.api.ObjectState+json + _href: /api/ibexa/v2/content/objectstategroups/2/objectstates/2 + id: 2 + identifier: locked + priority: 1 + ObjectStateGroup: + _media-type: application/vnd.ibexa.api.ObjectStateGroup+json + _href: /api/ibexa/v2/content/objectstategroups/2 + defaultLanguageCode: eng-GB + languageCodes: eng-GB + names: + value: + - _languageCode: eng-GB + '#text': Locked + descriptions: + value: + - _languageCode: eng-GB + '#text': "" + application/vnd.ibexa.api.ObjectState+xml: schema: - $ref: '#/components/schemas/Company' + $ref: '#/components/schemas/ObjectState' example: | <?xml version="1.0" encoding="UTF-8"?> - <Company media-type="application/vnd.ibexa.api.Company+xml"> - <id>66</id> - <name>Ibexa AS</name> - <Content media-type="application/vnd.ibexa.api.Content+xml" - href="/api/ibexa/v2/content/objects/66" remoteId="9f20fb03d0ab0a6aef9930f7e6720377" - id="66"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" - href="/api/ibexa/v2/content/types/48"/> - <Name>Ibexa AS</Name> - <TranslatedName>Ibexa AS</TranslatedName> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" - href="/api/ibexa/v2/content/objects/66/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" - href="/api/ibexa/v2/content/objects/66/currentversion"> - <Version media-type="application/vnd.ibexa.api.Version+xml" - href="/api/ibexa/v2/content/objects/66/versions/1"> - <VersionInfo> - <id>593</id> - <versionNo>1</versionNo> - <status>PUBLISHED</status> - <modificationDate>2023-04-03T13:09:40+02:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" - href="/api/ibexa/v2/user/users/14"/> - <creationDate>2023-04-03T13:09:40+02:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Ibexa AS</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" - href="/api/ibexa/v2/content/objects/66"/> - </VersionInfo> - <Fields> - <field> - <id>295</id> - <fieldDefinitionIdentifier>active</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_boolean</fieldTypeIdentifier> - <fieldValue>true</fieldValue> - </field> - <field> - <id>296</id> - <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Ibexa AS</fieldValue> - </field> - <field> - <id>297</id> - <fieldDefinitionIdentifier>vat</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>123 456 789</fieldValue> - </field> - <field> - <id>298</id> - <fieldDefinitionIdentifier>website</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>https://ibexa.co</fieldValue> - </field> - <field> - <id>299</id> - <fieldDefinitionIdentifier>customer_group</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_customer_group</fieldTypeIdentifier> - <fieldValue> - <value key="customer_group_id">1</value> - </fieldValue> - </field> - <field> - <id>300</id> - <fieldDefinitionIdentifier>sales_rep</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">14</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/14</value> - </fieldValue> - </field> - <field> - <id>301</id> - <fieldDefinitionIdentifier>contact</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">74</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/74</value> - </fieldValue> - </field> - <field> - <id>302</id> - <fieldDefinitionIdentifier>default_address</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">69</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/69</value> - </fieldValue> - </field> - <field> - <id>303</id> - <fieldDefinitionIdentifier>billing_address</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_address</fieldTypeIdentifier> - <fieldValue> - <value key="name">HQ</value> - <value key="country">PL</value> - <value key="fields"> - <value key="region">Silesia</value> - <value key="locality">Katowice</value> - <value key="street">Gliwicka 6/5</value> - <value key="postal_code">40-079</value> - <value key="email">company@email.invalid</value> - <value key="phone_number">+48 000 000 000</value> - </value> - </fieldValue> - </field> - <field> - <id>305</id> - <fieldDefinitionIdentifier>members</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">67</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/67</value> - </fieldValue> - </field> - <field> - <id>304</id> - <fieldDefinitionIdentifier>address_book</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">68</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/68</value> - </fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" - href="/api/ibexa/v2/content/objects/66/versions/1/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/placeholder</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - </CurrentVersion> - <Section media-type="application/vnd.ibexa.api.Section+xml" - href="/api/ibexa/v2/content/sections/10"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" - href="/api/ibexa/v2/content/locations/1/65/67"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" - href="/api/ibexa/v2/content/objects/66/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <lastModificationDate>2023-04-03T13:09:40+02:00</lastModificationDate> - <publishedDate>2023-03-31T14:33:36+02:00</publishedDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>1</currentVersionNo> - <alwaysAvailable>true</alwaysAvailable> - <isHidden>false</isHidden> - <status>PUBLISHED</status> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" - href="/api/ibexa/v2/content/objects/66/objectstates"/> - </Content> - <billingAddress>HQ, Poland</billingAddress> - <contactId>74</contactId> - <salesRepresentativeId>80</salesRepresentativeId> - <defaultAddressId>69</defaultAddressId> - <addressBookId>68</addressBookId> - <membersId>67</membersId> - <MemberList media-type="application/vnd.ibexa.api.MemberList+xml" - href="/api/ibexa/v2/corporate/companies/66/members"/> - <Location media-type="application/vnd.ibexa.api.Location+xml" - href="/api/ibexa/v2/content/locations/1/65/67"/> - <locationPath>/1/65/67/</locationPath> - <isActive>1</isActive> - </Company> + <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/6/objectstates/2"> + <id>2</id> + <identifier>locked</identifier> + <priority>1</priority> + <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/2"/> + <defaultLanguageCode>eng-GB</defaultLanguageCode> + <languageCodes>eng-GB</languageCodes> + <names> + <value languageCode="eng-GB">Locked</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + </ObjectState> 401: - description: Error - The user is not authorized to read this company. + description: Error - The user is not authorized to read this Object state. 404: - description: Error - The company does not exist. - summary: Get company - description: Returns the company by given company ID. + description: Error - The Object state does not exist. + summary: Get Object state + description: Returns the Object state. parameters: - - name: If-None-match + - name: If-None-Match in: header description: ETag required: false deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: companyId + - name: objectStateGroupId in: path - description: "" + description: ObjectStateLoadByIdController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: objectStateId + in: path + description: ObjectStateLoadByIdController identifier 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: ibexa.rest.corporate_account.companies.delete + operationId: ibexa.rest.delete_object_state tags: - - Corporate Account + - Object State Groups responses: 204: - description: No Content - given company is deleted. + description: No Content - Object state deleted. 401: - description: Error - the user is not authorized to delete this company. + description: Error - The user is not authorized to delete an Object state. 404: - description: Error - the company does not exist. - summary: Delete company - description: The given company is deleted. + description: Error - The Object state does not exist. + summary: Delete Object state + description: Deletes provided Object state. parameters: - name: X-CSRF-Token in: header - description: Only needed for session's checking. The {csrfToken} needed on - all unsafe HTTP methods with session. + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: objectStateGroupId + in: path + description: ObjectStateDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: companyId + - name: objectStateId in: path - description: "" + description: ObjectStateDeleteController identifier 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: ibexa.rest.corporate_account.companies.update + operationId: ibexa.rest.update_object_state tags: - - Corporate Account + - Object State Groups responses: 200: - description: OK - company updated. + description: OK - Object State updated content: - application/vnd.ibexa.api.Company+json: + application/vnd.ibexa.api.ObjectState+json: schema: - $ref: '#/components/schemas/CompanyWrapper' + $ref: '#/components/schemas/ObjectStateWrapper' 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: ~ - height: ~ - 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: + 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/Company' + $ref: '#/components/schemas/ObjectState' example: | <?xml version="1.0" encoding="UTF-8"?> - <Company media-type="application/vnd.ibexa.api.Company+xml"> - <id>66</id> - <name>Ibexa AS</name> - <Content media-type="application/vnd.ibexa.api.Content+xml" - href="/api/ibexa/v2/content/objects/66" remoteId="9f20fb03d0ab0a6aef9930f7e6720377" - id="66"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" - href="/api/ibexa/v2/content/types/48"/> - <Name>Ibexa AS</Name> - <TranslatedName>Ibexa AS</TranslatedName> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" - href="/api/ibexa/v2/content/objects/66/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" - href="/api/ibexa/v2/content/objects/66/currentversion"> - <Version media-type="application/vnd.ibexa.api.Version+xml" - href="/api/ibexa/v2/content/objects/66/versions/1"> - <VersionInfo> - <id>593</id> - <versionNo>1</versionNo> - <status>PUBLISHED</status> - <modificationDate>2023-04-03T13:09:40+02:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" - href="/api/ibexa/v2/user/users/14"/> - <creationDate>2023-04-03T13:09:40+02:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Ibexa AS</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" - href="/api/ibexa/v2/content/objects/66"/> - </VersionInfo> - <Fields> - <field> - <id>295</id> - <fieldDefinitionIdentifier>active</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_boolean</fieldTypeIdentifier> - <fieldValue>true</fieldValue> - </field> - <field> - <id>296</id> - <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Ibexa AS</fieldValue> - </field> - <field> - <id>297</id> - <fieldDefinitionIdentifier>vat</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>123 456 789</fieldValue> - </field> - <field> - <id>298</id> - <fieldDefinitionIdentifier>website</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>https://ibexa.co</fieldValue> - </field> - <field> - <id>299</id> - <fieldDefinitionIdentifier>customer_group</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_customer_group</fieldTypeIdentifier> - <fieldValue> - <value key="customer_group_id">1</value> - </fieldValue> - </field> - <field> - <id>300</id> - <fieldDefinitionIdentifier>sales_rep</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">14</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/14</value> - </fieldValue> - </field> - <field> - <id>301</id> - <fieldDefinitionIdentifier>contact</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">74</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/74</value> - </fieldValue> - </field> - <field> - <id>302</id> - <fieldDefinitionIdentifier>default_address</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">69</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/69</value> - </fieldValue> - </field> - <field> - <id>303</id> - <fieldDefinitionIdentifier>billing_address</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_address</fieldTypeIdentifier> - <fieldValue> - <value key="name">HQ</value> - <value key="country">PL</value> - <value key="fields"> - <value key="region">Silesia</value> - <value key="locality">Katowice</value> - <value key="street">Gliwicka 6/5</value> - <value key="postal_code">40-079</value> - <value key="email">company@email.invalid</value> - <value key="phone_number">+48 000 000 000</value> - </value> - </fieldValue> - </field> - <field> - <id>305</id> - <fieldDefinitionIdentifier>members</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">67</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/67</value> - </fieldValue> - </field> - <field> - <id>304</id> - <fieldDefinitionIdentifier>address_book</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">68</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/68</value> - </fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" - href="/api/ibexa/v2/content/objects/66/versions/1/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/placeholder</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - </CurrentVersion> - <Section media-type="application/vnd.ibexa.api.Section+xml" - href="/api/ibexa/v2/content/sections/10"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" - href="/api/ibexa/v2/content/locations/1/65/67"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" - href="/api/ibexa/v2/content/objects/66/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <lastModificationDate>2023-04-03T13:09:40+02:00</lastModificationDate> - <publishedDate>2023-03-31T14:33:36+02:00</publishedDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>1</currentVersionNo> - <alwaysAvailable>true</alwaysAvailable> - <isHidden>false</isHidden> - <status>PUBLISHED</status> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" - href="/api/ibexa/v2/content/objects/66/objectstates"/> - </Content> - <billingAddress>HQ, Poland</billingAddress> - <contactId>74</contactId> - <salesRepresentativeId>80</salesRepresentativeId> - <defaultAddressId>69</defaultAddressId> - <addressBookId>68</addressBookId> - <membersId>67</membersId> - <MemberList media-type="application/vnd.ibexa.api.MemberList+xml" - href="/api/ibexa/v2/corporate/companies/66/members"/> - <Location media-type="application/vnd.ibexa.api.Location+xml" - href="/api/ibexa/v2/content/locations/1/65/67"/> - <locationPath>/1/65/67/</locationPath> - <isActive>1</isActive> - </Company> + <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/2/objectstates/2"> + <id>2</id> + <identifier>locked</identifier> + <priority>1</priority> + <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/2"/> + <defaultLanguageCode>eng-GB</defaultLanguageCode> + <languageCodes>eng-GB</languageCodes> + <names> + <value languageCode="eng-GB">New Object State name</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + </ObjectState> 400: - description: Error - the input does not match the input schema definition. + 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 + 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: X-CSRF-Token in: header - description: Only needed for session's checking. The {csrfToken} needed on - all unsafe HTTP methods with session. + description: The CSRF Token needed on all unsafe HTTP methods with session. 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 + - name: objectStateGroupId in: path - description: "" + description: ObjectStateUpdateController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: objectStateId + in: path + description: ObjectStateUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The company input schema encoded in XML or JSON. + description: The Object state input schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.CompanyUpdate+json: + application/vnd.ibexa.api.ObjectStateUpdate+json: schema: - $ref: '#/components/schemas/CompanyUpdateWrapper' + $ref: '#/components/schemas/ObjectStateUpdateWrapper' example: - CompanyUpdate: - fields: - field: - - fieldDefinitionIdentifier: contact - fieldValue: - destinationContentId: 144 - application/vnd.ibexa.api.CompanyUpdate+xml: + ObjectStateUpdate: + names: + value: + - _languageCode: eng-GB + '#text': New Object State name + application/vnd.ibexa.api.ObjectStateUpdate+xml: schema: - $ref: '#/components/schemas/CompanyUpdate' + $ref: '#/components/schemas/ObjectStateUpdate' example: | <?xml version="1.0" encoding="UTF-8"?> - <CompanyUpdate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> - <fields> - <field> - <fieldDefinitionIdentifier>contact</fieldDefinitionIdentifier> - <fieldValue> - <value key="destinationContentId">144</value> - </fieldValue> - </field> - </fields> - </CompanyUpdate> + <ObjectStateUpdate> + <priority>3</priority> + <defaultLanguageCode>eng-GB</defaultLanguageCode> + <names> + <value languageCode="eng-GB">New Object State name</value> + </names> + </ObjectStateUpdate> required: false - deprecated: false - x-badges: - - name: Experience - color: '#D3822B' - - name: Commerce - color: '#A32768' - position: after - /corporate/companies/{companyId}/members: + /content/objects: get: - operationId: ibexa.rest.corporate_account.members.list + operationId: ibexa.rest.redirect_content tags: - - Corporate Account + - Objects responses: - 200: - description: If set, helps to determine response format. - content: - application/vnd.ibexa.api.MemberList+json: + 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: - $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: ~ - height: ~ - 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: ~ - 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: ~ - height: ~ - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <MemberList media-type="application/vnd.ibexa.api.MemberList+xml" href="/api/ibexa/v2/corporate/companies/139/members"> - <Member media-type="application/vnd.ibexa.api.Member+xml" href="/api/ibexa/v2/corporate/companies/139/members/144"> - <id>144</id> - <name>Jay Kowalski</name> - <Company media-type="application/vnd.ibexa.api.Company+xml"> - <id>139</id> - <name>Ibexa Sp. z o. o.</name> - <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/139" remoteId="b16d06d4c5ba7c37b26fa167b551dfc2" id="139"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/48"/> - <Name>Ibexa Sp. z o. o.</Name> - <TranslatedName>Ibexa Sp. z o. o.</TranslatedName> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/139/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/139/currentversion"> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/139/versions/6"> - <VersionInfo> - <id>677</id> - <versionNo>6</versionNo> - <status>PUBLISHED</status> - <modificationDate>2023-04-28T16:10:13+02:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <creationDate>2023-04-28T16:10:13+02:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Ibexa Sp. z o. o.</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/139"/> - </VersionInfo> - <Fields> - <field> - <id>673</id> - <fieldDefinitionIdentifier>active</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_boolean</fieldTypeIdentifier> - <fieldValue>true</fieldValue> - </field> - <field> - <id>674</id> - <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Ibexa Sp. z o. o.</fieldValue> - </field> - <field> - <id>675</id> - <fieldDefinitionIdentifier>vat</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>123 456 789</fieldValue> - </field> - <field> - <id>676</id> - <fieldDefinitionIdentifier>website</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>https://ibexa.co</fieldValue> - </field> - <field> - <id>677</id> - <fieldDefinitionIdentifier>customer_group</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_customer_group</fieldTypeIdentifier> - <fieldValue> - <value key="customer_group_id">1</value> - </fieldValue> - </field> - <field> - <id>678</id> - <fieldDefinitionIdentifier>sales_rep</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">14</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/14</value> - </fieldValue> - </field> - <field> - <id>679</id> - <fieldDefinitionIdentifier>contact</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">144</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/144</value> - </fieldValue> - </field> - <field> - <id>680</id> - <fieldDefinitionIdentifier>default_address</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">142</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/142</value> - </fieldValue> - </field> - <field> - <id>681</id> - <fieldDefinitionIdentifier>billing_address</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_address</fieldTypeIdentifier> - <fieldValue> - <value key="name">HQ</value> - <value key="country">PL</value> - <value key="fields"> - <value key="region">Silesia</value> - <value key="locality">Katowice</value> - <value key="street">Gliwicka 6/5</value> - <value key="postal_code">40-079</value> - <value key="email">company@email.invalid</value> - <value key="phone_number">+48 000 000 000</value> - </value> - </fieldValue> - </field> - <field> - <id>683</id> - <fieldDefinitionIdentifier>members</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">140</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/140</value> - </fieldValue> - </field> - <field> - <id>682</id> - <fieldDefinitionIdentifier>address_book</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">141</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/141</value> - </fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/139/versions/6/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/placeholder</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - </CurrentVersion> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/10"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/65/140"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/139/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <lastModificationDate>2023-04-28T16:10:13+02:00</lastModificationDate> - <publishedDate>2023-04-28T15:44:55+02:00</publishedDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>6</currentVersionNo> - <alwaysAvailable>true</alwaysAvailable> - <isHidden>false</isHidden> - <status>PUBLISHED</status> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/139/objectstates"/> - </Content> - <billingAddress>HQ, Poland</billingAddress> - <contactId>144</contactId> - <salesRepresentativeId>14</salesRepresentativeId> - <defaultAddressId>142</defaultAddressId> - <addressBookId>141</addressBookId> - <membersId>140</membersId> - <MemberList media-type="application/vnd.ibexa.api.MemberList+xml" href="/api/ibexa/v2/corporate/companies/139/members"/> - <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/65/140"/> - <locationPath>/1/65/140/</locationPath> - <isActive>1</isActive> - </Company> - <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/144" id="144" remoteId="1b3938c16adfa29996f3afff0b4a0032"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/47"/> - <name>Jay Kowalski</name> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/144/versions"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/10"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/65/140/141/145"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/144/locations"/> - <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/144/groups"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <publishDate>2023-04-28T16:10:03+02:00</publishDate> - <lastModificationDate>2023-04-28T16:17:07+02:00</lastModificationDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <alwaysAvailable>true</alwaysAvailable> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/144/versions/6"> - <VersionInfo> - <id>683</id> - <versionNo>6</versionNo> - <status>PUBLISHED</status> - <modificationDate>2023-04-28T16:17:07+02:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <creationDate>2023-04-28T16:17:06+02:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Jay Kowalski</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/144"/> - </VersionInfo> - <Fields> - <field> - <id>698</id> - <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Jay</fieldValue> - </field> - <field> - <id>699</id> - <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Kowalski</fieldValue> - </field> - <field> - <id>700</id> - <fieldDefinitionIdentifier>phone_number</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>+48 123 123 456</fieldValue> - </field> - <field> - <id>701</id> - <fieldDefinitionIdentifier>user</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> - <fieldValue> - <value key="hasStoredLogin">true</value> - <value key="contentId">144</value> - <value key="login">jay.kowalski</value> - <value key="email">jay.kowalski@email.invalid</value> - <value key="passwordUpdatedAt">1682691427</value> - <value key="enabled">false</value> - <value key="maxLogin">5</value> - <value key="plainPassword"/> - </fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/144/versions/6/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/user/default_profile_image/initials.svg?initials=JK#profile_image</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - <login>jay.kowalski</login> - <email>jay.kowalski@email.invalid</email> - <enabled>false</enabled> - <UserGroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/users/144/groups"/> - <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/144/roles"/> - </User> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/15"> - <identifier>Company Buyer</identifier> - <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/15/policies"/> - </Role> - </Member> - </MemberList> + type: string 400: - description: Returned when invalid Criterion or Sort clause is used. - content: - application/vnd.ibexa.api.ErrorMessage: - schema: - $ref: '#/components/schemas/ErrorMessage' + description: Error - the required `remoteId` query parameter is missing. 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. + 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: 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] + - name: remoteId in: query - description: "" - required: false + description: Remote ID of the content item. + required: true 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: ibexa.rest.corporate_account.members.create + operationId: ibexa.rest.create_content tags: - - Corporate Account + - Objects responses: 201: - description: OK - company member created and returned. + 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. content: - application/vnd.ibexa.api.Member+json: + application/vnd.ibexa.api.Content+json: schema: - $ref: '#/components/schemas/MemberWrapper' + $ref: '#/components/schemas/ContentWrapper' 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: ~ - height: ~ - 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 + Content: + _media-type: application/vnd.ibexa.api.Content+json + _href: /api/ibexa/v2/content/objects/109 + _remoteId: 8716f007ba15f6f35139acb55e39b811 + _id: 109 + ContentType: + _media-type: application/vnd.ibexa.api.ContentType+json + _href: /api/ibexa/v2/content/types/2 + Name: draft article + TranslatedName: draft article + Versions: + _media-type: application/vnd.ibexa.api.VersionList+json + _href: /api/ibexa/v2/content/objects/109/versions + CurrentVersion: + _media-type: application/vnd.ibexa.api.Version+json + _href: /api/ibexa/v2/content/objects/109/currentversion Version: _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/144/versions/6 + _href: /api/ibexa/v2/content/objects/109/versions/1 VersionInfo: - id: 683 - versionNo: 6 - status: PUBLISHED - modificationDate: "2023-04-28T16:17:07+02:00" + id: 587 + versionNo: 1 + status: DRAFT + modificationDate: "2023-05-24T06:27:54+00: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" + creationDate: "2023-05-24T06:27:54+00:00" initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: @@ -7274,688 +4539,410 @@ paths: names: value: - _languageCode: eng-GB - '#text': Jay Kowalski + '#text': draft article Content: _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/144 + _href: /api/ibexa/v2/content/objects/109 Fields: field: - - id: 698 - fieldDefinitionIdentifier: first_name + - id: 488 + fieldDefinitionIdentifier: title languageCode: eng-GB fieldTypeIdentifier: ibexa_string - fieldValue: Jay - - id: 699 - fieldDefinitionIdentifier: last_name + fieldValue: draft article + - id: 489 + fieldDefinitionIdentifier: short_title languageCode: eng-GB fieldTypeIdentifier: ibexa_string - fieldValue: Kowalski - - id: 700 - fieldDefinitionIdentifier: phone_number + fieldValue: ~ + - id: 490 + fieldDefinitionIdentifier: author languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: +48 123 123 456 - - id: 701 - fieldDefinitionIdentifier: user + fieldTypeIdentifier: ibexa_author + fieldValue: [] + - id: 491 + fieldDefinitionIdentifier: intro languageCode: eng-GB - fieldTypeIdentifier: ibexa_user + fieldTypeIdentifier: ibexa_richtext fieldValue: - hasStoredLogin: true - contentId: 144 - login: jay.kowalski - email: jay.kowalski@email.invalid - passwordUpdatedAt: 1682691427 - enabled: false - maxLogin: 5 - plainPassword: ~ + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>draft draft</para></section> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft</p></section> + - id: 492 + fieldDefinitionIdentifier: body + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>draft draft draft</para></section> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft draft</p></section> + - id: 493 + fieldDefinitionIdentifier: enable_comments + languageCode: eng-GB + fieldTypeIdentifier: ibexa_boolean + fieldValue: false + - id: 494 + fieldDefinitionIdentifier: image + languageCode: eng-GB + fieldTypeIdentifier: ibexa_object_relation + fieldValue: + destinationContentId: ~ Relations: _media-type: application/vnd.ibexa.api.RelationList+json - _href: /api/ibexa/v2/content/objects/144/versions/6/relations + _href: /api/ibexa/v2/content/objects/109/versions/1/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json - resource: /user/default_profile_image/initials.svg?initials=JK#profile_image + resource: /placeholder width: ~ height: ~ 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: + 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/109/locations + Owner: + _media-type: application/vnd.ibexa.api.User+json + _href: /api/ibexa/v2/user/users/14 + mainLanguageCode: eng-GB + currentVersionNo: 1 + alwaysAvailable: true + isHidden: false + status: DRAFT + ObjectStates: + _media-type: application/vnd.ibexa.api.ContentObjectStates+json + _href: /api/ibexa/v2/content/objects/109/objectstates + application/vnd.ibexa.api.Content+xml: schema: - $ref: '#/components/schemas/Member' + $ref: '#/components/schemas/Content' example: | <?xml version="1.0" encoding="UTF-8"?> - <Member media-type="application/vnd.ibexa.api.Member+xml" - href="/api/ibexa/v2/corporate/companies/139/members/144"> - <id>144</id> - <name>Jay Kowalski</name> - <Company media-type="application/vnd.ibexa.api.Company+xml"> - <id>139</id> - <name>Ibexa Sp. z o. o.</name> - <Content media-type="application/vnd.ibexa.api.Content+xml" - href="/api/ibexa/v2/content/objects/139" remoteId="b16d06d4c5ba7c37b26fa167b551dfc2" - id="139"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" - href="/api/ibexa/v2/content/types/48"/> - <Name>Ibexa Sp. z o. o.</Name> - <TranslatedName>Ibexa Sp. z o. o.</TranslatedName> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" - href="/api/ibexa/v2/content/objects/139/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" - href="/api/ibexa/v2/content/objects/139/currentversion"> - <Version media-type="application/vnd.ibexa.api.Version+xml" - href="/api/ibexa/v2/content/objects/139/versions/6"> - <VersionInfo> - <id>677</id> - <versionNo>6</versionNo> - <status>PUBLISHED</status> - <modificationDate>2023-04-28T16:10:13+02:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" - href="/api/ibexa/v2/user/users/14"/> - <creationDate>2023-04-28T16:10:13+02:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo - media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Ibexa Sp. z o. o.</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" - href="/api/ibexa/v2/content/objects/139"/> - </VersionInfo> - <Fields> - <field> - <id>673</id> - <fieldDefinitionIdentifier>active</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_boolean</fieldTypeIdentifier> - <fieldValue>true</fieldValue> - </field> - <field> - <id>674</id> - <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Ibexa Sp. z o. o.</fieldValue> - </field> - <field> - <id>675</id> - <fieldDefinitionIdentifier>vat</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>123 456 789</fieldValue> - </field> - <field> - <id>676</id> - <fieldDefinitionIdentifier>website</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>https://ibexa.co</fieldValue> - </field> - <field> - <id>677</id> - <fieldDefinitionIdentifier>customer_group</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_customer_group</fieldTypeIdentifier> - <fieldValue> - <value key="customer_group_id">1</value> - </fieldValue> - </field> - <field> - <id>678</id> - <fieldDefinitionIdentifier>sales_rep</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">14</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/14</value> - </fieldValue> - </field> - <field> - <id>679</id> - <fieldDefinitionIdentifier>contact</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">144</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/144</value> - </fieldValue> - </field> - <field> - <id>680</id> - <fieldDefinitionIdentifier>default_address</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">142</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/142</value> - </fieldValue> - </field> - <field> - <id>681</id> - <fieldDefinitionIdentifier>billing_address</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_address</fieldTypeIdentifier> - <fieldValue> - <value key="name">HQ</value> - <value key="country">PL</value> - <value key="fields"> - <value key="region">Silesia</value> - <value key="locality">Katowice</value> - <value key="street">Gliwicka 6/5</value> - <value key="postal_code">40-079</value> - <value key="email">company@email.invalid</value> - <value key="phone_number">+48 000 000 000</value> - </value> - </fieldValue> - </field> - <field> - <id>683</id> - <fieldDefinitionIdentifier>members</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">140</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/140</value> - </fieldValue> - </field> - <field> - <id>682</id> - <fieldDefinitionIdentifier>address_book</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">141</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/141</value> - </fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" - href="/api/ibexa/v2/content/objects/139/versions/6/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/placeholder</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - </CurrentVersion> - <Section media-type="application/vnd.ibexa.api.Section+xml" - href="/api/ibexa/v2/content/sections/10"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" - href="/api/ibexa/v2/content/locations/1/65/140"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" - href="/api/ibexa/v2/content/objects/139/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <lastModificationDate>2023-04-28T16:10:13+02:00</lastModificationDate> - <publishedDate>2023-04-28T15:44:55+02:00</publishedDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>6</currentVersionNo> - <alwaysAvailable>true</alwaysAvailable> - <isHidden>false</isHidden> - <status>PUBLISHED</status> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" - href="/api/ibexa/v2/content/objects/139/objectstates"/> - </Content> - <billingAddress>HQ, Poland</billingAddress> - <contactId>144</contactId> - <salesRepresentativeId>14</salesRepresentativeId> - <defaultAddressId>142</defaultAddressId> - <addressBookId>141</addressBookId> - <membersId>140</membersId> - <MemberList media-type="application/vnd.ibexa.api.MemberList+xml" - href="/api/ibexa/v2/corporate/companies/139/members"/> - <Location media-type="application/vnd.ibexa.api.Location+xml" - href="/api/ibexa/v2/content/locations/1/65/140"/> - <locationPath>/1/65/140/</locationPath> - <isActive>1</isActive> - </Company> - <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/144" id="144" - remoteId="1b3938c16adfa29996f3afff0b4a0032"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" - href="/api/ibexa/v2/content/types/47"/> - <name>Jay Kowalski</name> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" - href="/api/ibexa/v2/content/objects/144/versions"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" - href="/api/ibexa/v2/content/sections/10"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" - href="/api/ibexa/v2/content/locations/1/65/140/141/145"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" - href="/api/ibexa/v2/content/objects/144/locations"/> - <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" - href="/api/ibexa/v2/user/users/144/groups"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <publishDate>2023-04-28T16:10:03+02:00</publishDate> - <lastModificationDate>2023-04-28T16:10:03+02:00</lastModificationDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <alwaysAvailable>true</alwaysAvailable> - <Version media-type="application/vnd.ibexa.api.Version+xml" - href="/api/ibexa/v2/content/objects/144/versions/1"> - <VersionInfo> - <id>676</id> - <versionNo>1</versionNo> - <status>PUBLISHED</status> - <modificationDate>2023-04-28T16:10:03+02:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" - href="/api/ibexa/v2/user/users/14"/> - <creationDate>2023-04-28T16:10:03+02:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Jay Kowalski</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" - href="/api/ibexa/v2/content/objects/144"/> - </VersionInfo> - <Fields> - <field> - <id>698</id> - <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Jay</fieldValue> - </field> - <field> - <id>699</id> - <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Kowalski</fieldValue> - </field> - <field> - <id>700</id> - <fieldDefinitionIdentifier>phone_number</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>+48 123 123 456</fieldValue> - </field> - <field> - <id>701</id> - <fieldDefinitionIdentifier>user</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> - <fieldValue> - <value key="hasStoredLogin">true</value> - <value key="contentId">144</value> - <value key="login">jay.kowalski</value> - <value key="email">jay.kowalski@email.invalid</value> - <value key="passwordUpdatedAt">1682691003</value> - <value key="enabled">true</value> - <value key="maxLogin">0</value> - <value key="plainPassword"/> - </fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" - href="/api/ibexa/v2/content/objects/144/versions/1/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/user/default_profile_image/initials.svg?initials=JK#profile_image</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - <login>jay.kowalski</login> - <email>jay.kowalski@email.invalid</email> - <enabled>true</enabled> - <UserGroups media-type="application/vnd.ibexa.api.UserGroupList+xml" - href="/api/ibexa/v2/user/users/144/groups"/> - <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" - href="/api/ibexa/v2/user/users/144/roles"/> - </User> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/14"> - <identifier>Company Admin</identifier> - <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" - href="/api/ibexa/v2/user/roles/14/policies"/> - </Role> - </Member> - 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: 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 - requestBody: - description: The MemberCreate schema encoded in XML or JSON format. - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <MemberCreate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> - <login>jay.kowalski</login> - <email>jay.kowalski@email.invalid</email> - <password>Ibexa123#</password> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/14"/> - <fields> - <field> - <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> - <fieldValue>Jay</fieldValue> - </field> - <field> - <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> - <fieldValue>Kowalski</fieldValue> - </field> - <field> - <fieldDefinitionIdentifier>phone_number</fieldDefinitionIdentifier> - <fieldValue>+48 123 123 456</fieldValue> - </field> - </fields> - </MemberCreate> - required: false - deprecated: false - x-badges: - - name: Experience - color: '#D3822B' - - name: Commerce - color: '#A32768' - position: after - /corporate/companies/{companyId}/members/{memberId}: - get: - operationId: ibexa.rest.corporate_account.members.get - tags: - - Corporate Account - responses: - 200: - description: If set, the company member is returned in XML or JSON format. - 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: ~ - height: ~ - 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: + <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/108" remoteId="25c5c35ab9d18e88bd2ee77991b730e2" id="108"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"/> + <Name>draft article</Name> + <TranslatedName>draft article</TranslatedName> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/108/versions"/> + <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/108/currentversion"> + <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/108/versions/1"> + <VersionInfo> + <id>586</id> + <versionNo>1</versionNo> + <status>DRAFT</status> + <modificationDate>2023-05-24T06:24:46+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <creationDate>2023-05-24T06:24:46+00:00</creationDate> + <initialLanguageCode>eng-GB</initialLanguageCode> + <languageCodes>eng-GB</languageCodes> + <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> + <Language> + <languageCode>eng-GB</languageCode> + </Language> + </VersionTranslationInfo> + <names> + <value languageCode="eng-GB">draft article</value> + </names> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/108"/> + </VersionInfo> + <Fields> + <field> + <id>481</id> + <fieldDefinitionIdentifier>title</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue>draft article</fieldValue> + </field> + <field> + <id>482</id> + <fieldDefinitionIdentifier>short_title</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue/> + </field> + <field> + <id>483</id> + <fieldDefinitionIdentifier>author</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_author</fieldTypeIdentifier> + <fieldValue/> + </field> + <field> + <id>484</id> + <fieldDefinitionIdentifier>intro</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> + <fieldValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>draft draft</para></section> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft</p></section> + </value> + </fieldValue> + </field> + <field> + <id>485</id> + <fieldDefinitionIdentifier>body</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> + <fieldValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>draft draft draft</para></section> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft draft</p></section> + </value> + </fieldValue> + </field> + <field> + <id>486</id> + <fieldDefinitionIdentifier>enable_comments</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_boolean</fieldTypeIdentifier> + <fieldValue>false</fieldValue> + </field> + <field> + <id>487</id> + <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> + <fieldValue> + <value key="destinationContentId"/> + </fieldValue> + </field> + </Fields> + <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/108/versions/1/relations"/> + <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> + <resource>/placeholder</resource> + <width></width> + <height></height> + <mimeType>image/svg+xml</mimeType> + </Thumbnail> + </Version> + </CurrentVersion> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/108/locations"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <mainLanguageCode>eng-GB</mainLanguageCode> + <currentVersionNo>1</currentVersionNo> + <alwaysAvailable>true</alwaysAvailable> + <isHidden>false</isHidden> + <status>DRAFT</status> + <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/108/objectstates"/> + </Content> + application/vnd.ibexa.api.ContentInfo+json: + schema: + $ref: '#/components/schemas/ContentInfoWrapper' + example: + Content: + _media-type: application/vnd.ibexa.api.ContentInfo+json + _href: /api/ibexa/v2/content/objects/77 + _remoteId: 89e9b86c673b1c1de6781bb94488b18c + _id: 77 + ContentType: + _media-type: application/vnd.ibexa.api.ContentType+json + _href: /api/ibexa/v2/content/types/2 + Name: draft article + TranslatedName: draft article + Versions: + _media-type: application/vnd.ibexa.api.VersionList+json + _href: /api/ibexa/v2/content/objects/77/versions + CurrentVersion: + _media-type: application/vnd.ibexa.api.Version+json + _href: /api/ibexa/v2/content/objects/77/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/77/locations + Owner: _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 + _href: /api/ibexa/v2/user/users/14 + mainLanguageCode: eng-GB + currentVersionNo: 1 + alwaysAvailable: true + isHidden: false + status: DRAFT + ObjectStates: + _media-type: application/vnd.ibexa.api.ContentObjectStates+json + _href: /api/ibexa/v2/content/objects/77/objectstates + application/vnd.ibexa.api.ContentInfo+xml: + schema: + $ref: '#/components/schemas/ContentInfo' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/110" remoteId="59258c7a8c545db8a641742138d11d82" id="110"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"/> + <Name>draft article</Name> + <TranslatedName>draft article</TranslatedName> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/110/versions"/> + <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/110/currentversion"/> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/110/locations"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <mainLanguageCode>eng-GB</mainLanguageCode> + <currentVersionNo>1</currentVersionNo> + <alwaysAvailable>true</alwaysAvailable> + <isHidden>false</isHidden> + <status>DRAFT</status> + <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/110/objectstates"/> + </Content> + 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: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + requestBody: + description: The ContentCreate schema encoded in XML or JSON format. + 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: <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft + draft</p></section> + - fieldDefinitionIdentifier: body + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft + draft draft </p></section> + application/vnd.ibexa.api.ContentCreate+xml: + schema: + $ref: '#/components/schemas/ContentCreate' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <ContentCreate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> + <ContentType href="/api/ibexa/v2/content/types/2"/> + <mainLanguageCode>eng-GB</mainLanguageCode> + <LocationCreate> + <ParentLocation href="/api/ibexa/v2/content/locations/1/2"/> + <priority>0</priority> + <hidden>false</hidden> + <sortField>PATH</sortField> + <sortOrder>ASC</sortOrder> + </LocationCreate> + <Section href="/api/ibexa/v2/content/sections/1"/> + <alwaysAvailable>true</alwaysAvailable> + <remoteId></remoteId> + <fields> + <field> + <fieldDefinitionIdentifier>title</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldValue>draft article</fieldValue> + </field> + <field> + <fieldDefinitionIdentifier>intro</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldValue> + <value key="xml"><![CDATA[<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft</p></section>]]></value> + </fieldValue> + </field> + <field> + <fieldDefinitionIdentifier>body</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldValue> + <value key="xml"><![CDATA[<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft draft</p></section>]]></value> + </fieldValue> + </field> + </fields> + </ContentCreate> + required: false + /content/objects/{contentId}: + get: + operationId: ibexa.rest.load_content + tags: + - Objects + responses: + 200: + description: OK - returns the Content or ContentInfo in XML or JSON format. + 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/144/versions/6 + _href: /api/ibexa/v2/content/objects/54/versions/1 VersionInfo: - id: 683 - versionNo: 6 + id: 514 + versionNo: 1 status: PUBLISHED - modificationDate: "2023-04-28T16:17:07+02:00" + 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: "2023-04-28T16:17:06+02:00" + creationDate: "2018-09-17T06:48:13+00:00" initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: @@ -7965,8386 +4952,5588 @@ paths: names: value: - _languageCode: eng-GB - '#text': Jay Kowalski + '#text': Forms Content: _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/144 + _href: /api/ibexa/v2/content/objects/54 Fields: field: - - id: 698 - fieldDefinitionIdentifier: first_name + - id: 249 + fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string - fieldValue: Jay - - id: 699 - fieldDefinitionIdentifier: last_name + fieldValue: Forms + - id: 250 + fieldDefinitionIdentifier: short_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string - fieldValue: Kowalski - - id: 700 - fieldDefinitionIdentifier: phone_number + fieldValue: ~ + - id: 251 + fieldDefinitionIdentifier: short_description languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: +48 123 123 456 - - id: 701 - fieldDefinitionIdentifier: user + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + - id: 252 + fieldDefinitionIdentifier: description languageCode: eng-GB - fieldTypeIdentifier: ibexa_user + fieldTypeIdentifier: ibexa_richtext fieldValue: - hasStoredLogin: true - contentId: 144 - login: jay.kowalski - email: jay.kowalski@email.invalid - passwordUpdatedAt: 1682691427 - enabled: false - maxLogin: 5 - plainPassword: ~ + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> Relations: _media-type: application/vnd.ibexa.api.RelationList+json - _href: /api/ibexa/v2/content/objects/144/versions/6/relations + _href: /api/ibexa/v2/content/objects/54/versions/1/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json - resource: /user/default_profile_image/initials.svg?initials=JK#profile_image + resource: /bundles/ezplatformadminui/img/ez-icons.svg#folder width: ~ height: ~ 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: + 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/Member' + $ref: '#/components/schemas/Content' example: | <?xml version="1.0" encoding="UTF-8"?> - <Member media-type="application/vnd.ibexa.api.Member+xml" - href="/api/ibexa/v2/corporate/companies/139/members/144"> - <id>144</id> - <name>Jay Kowalski</name> - <Company media-type="application/vnd.ibexa.api.Company+xml"> - <id>139</id> - <name>Ibexa Sp. z o. o.</name> - <Content media-type="application/vnd.ibexa.api.Content+xml" - href="/api/ibexa/v2/content/objects/139" remoteId="b16d06d4c5ba7c37b26fa167b551dfc2" - id="139"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" - href="/api/ibexa/v2/content/types/48"/> - <Name>Ibexa Sp. z o. o.</Name> - <TranslatedName>Ibexa Sp. z o. o.</TranslatedName> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" - href="/api/ibexa/v2/content/objects/139/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" - href="/api/ibexa/v2/content/objects/139/currentversion"> - <Version media-type="application/vnd.ibexa.api.Version+xml" - href="/api/ibexa/v2/content/objects/139/versions/6"> - <VersionInfo> - <id>677</id> - <versionNo>6</versionNo> - <status>PUBLISHED</status> - <modificationDate>2023-04-28T16:10:13+02:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" - href="/api/ibexa/v2/user/users/14"/> - <creationDate>2023-04-28T16:10:13+02:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo - media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Ibexa Sp. z o. o.</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" - href="/api/ibexa/v2/content/objects/139"/> - </VersionInfo> - <Fields> - <field> - <id>673</id> - <fieldDefinitionIdentifier>active</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_boolean</fieldTypeIdentifier> - <fieldValue>true</fieldValue> - </field> - <field> - <id>674</id> - <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Ibexa Sp. z o. o.</fieldValue> - </field> - <field> - <id>675</id> - <fieldDefinitionIdentifier>vat</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>123 456 789</fieldValue> - </field> - <field> - <id>676</id> - <fieldDefinitionIdentifier>website</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>https://ibexa.co</fieldValue> - </field> - <field> - <id>677</id> - <fieldDefinitionIdentifier>customer_group</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_customer_group</fieldTypeIdentifier> - <fieldValue> - <value key="customer_group_id">1</value> - </fieldValue> - </field> - <field> - <id>678</id> - <fieldDefinitionIdentifier>sales_rep</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">14</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/14</value> - </fieldValue> - </field> - <field> - <id>679</id> - <fieldDefinitionIdentifier>contact</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">144</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/144</value> - </fieldValue> - </field> - <field> - <id>680</id> - <fieldDefinitionIdentifier>default_address</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">142</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/142</value> - </fieldValue> - </field> - <field> - <id>681</id> - <fieldDefinitionIdentifier>billing_address</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_address</fieldTypeIdentifier> - <fieldValue> - <value key="name">HQ</value> - <value key="country">PL</value> - <value key="fields"> - <value key="region">Silesia</value> - <value key="locality">Katowice</value> - <value key="street">Gliwicka 6/5</value> - <value key="postal_code">40-079</value> - <value key="email">company@email.invalid</value> - <value key="phone_number">+48 000 000 000</value> - </value> - </fieldValue> - </field> - <field> - <id>683</id> - <fieldDefinitionIdentifier>members</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">140</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/140</value> - </fieldValue> - </field> - <field> - <id>682</id> - <fieldDefinitionIdentifier>address_book</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">141</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/141</value> - </fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" - href="/api/ibexa/v2/content/objects/139/versions/6/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/placeholder</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - </CurrentVersion> - <Section media-type="application/vnd.ibexa.api.Section+xml" - href="/api/ibexa/v2/content/sections/10"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" - href="/api/ibexa/v2/content/locations/1/65/140"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" - href="/api/ibexa/v2/content/objects/139/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <lastModificationDate>2023-04-28T16:10:13+02:00</lastModificationDate> - <publishedDate>2023-04-28T15:44:55+02:00</publishedDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>6</currentVersionNo> - <alwaysAvailable>true</alwaysAvailable> - <isHidden>false</isHidden> - <status>PUBLISHED</status> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" - href="/api/ibexa/v2/content/objects/139/objectstates"/> - </Content> - <billingAddress>HQ, Poland</billingAddress> - <contactId>144</contactId> - <salesRepresentativeId>14</salesRepresentativeId> - <defaultAddressId>142</defaultAddressId> - <addressBookId>141</addressBookId> - <membersId>140</membersId> - <MemberList media-type="application/vnd.ibexa.api.MemberList+xml" - href="/api/ibexa/v2/corporate/companies/139/members"/> - <Location media-type="application/vnd.ibexa.api.Location+xml" - href="/api/ibexa/v2/content/locations/1/65/140"/> - <locationPath>/1/65/140/</locationPath> - <isActive>1</isActive> - </Company> - <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/144" id="144" - remoteId="1b3938c16adfa29996f3afff0b4a0032"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" - href="/api/ibexa/v2/content/types/47"/> - <name>Jay Kowalski</name> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" - href="/api/ibexa/v2/content/objects/144/versions"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" - href="/api/ibexa/v2/content/sections/10"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" - href="/api/ibexa/v2/content/locations/1/65/140/141/145"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" - href="/api/ibexa/v2/content/objects/144/locations"/> - <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" - href="/api/ibexa/v2/user/users/144/groups"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <publishDate>2023-04-28T16:10:03+02:00</publishDate> - <lastModificationDate>2023-04-28T16:10:03+02:00</lastModificationDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <alwaysAvailable>true</alwaysAvailable> - <Version media-type="application/vnd.ibexa.api.Version+xml" - href="/api/ibexa/v2/content/objects/144/versions/1"> - <VersionInfo> - <id>676</id> - <versionNo>1</versionNo> - <status>PUBLISHED</status> - <modificationDate>2023-04-28T16:10:03+02:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" - href="/api/ibexa/v2/user/users/14"/> - <creationDate>2023-04-28T16:10:03+02:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Jay Kowalski</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" - href="/api/ibexa/v2/content/objects/144"/> - </VersionInfo> - <Fields> - <field> - <id>698</id> - <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Jay</fieldValue> - </field> - <field> - <id>699</id> - <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Kowalski</fieldValue> - </field> - <field> - <id>700</id> - <fieldDefinitionIdentifier>phone_number</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>+48 123 123 456</fieldValue> - </field> - <field> - <id>701</id> - <fieldDefinitionIdentifier>user</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> - <fieldValue> - <value key="hasStoredLogin">true</value> - <value key="contentId">144</value> - <value key="login">jay.kowalski</value> - <value key="email">jay.kowalski@email.invalid</value> - <value key="passwordUpdatedAt">1682691003</value> - <value key="enabled">true</value> - <value key="maxLogin">0</value> - <value key="plainPassword"/> - </fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" - href="/api/ibexa/v2/content/objects/144/versions/1/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/user/default_profile_image/initials.svg?initials=JK#profile_image</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - <login>jay.kowalski</login> - <email>jay.kowalski@email.invalid</email> - <enabled>true</enabled> - <UserGroups media-type="application/vnd.ibexa.api.UserGroupList+xml" - href="/api/ibexa/v2/user/users/144/groups"/> - <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" - href="/api/ibexa/v2/user/users/144/roles"/> - </User> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/14"> - <identifier>Company Admin</identifier> - <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" - href="/api/ibexa/v2/user/roles/14/policies"/> - </Role> - </Member> + <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/54" remoteId="9e863fbb0fb835ce050032b4f00de61d" id="54"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"/> + <Name>Forms</Name> + <TranslatedName>Forms</TranslatedName> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/54/versions"/> + <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/54/currentversion"> + <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/54/versions/1"> + <VersionInfo> + <id>514</id> + <versionNo>1</versionNo> + <status>PUBLISHED</status> + <modificationDate>2018-09-17T06:48:13+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <creationDate>2018-09-17T06:48:13+00:00</creationDate> + <initialLanguageCode>eng-GB</initialLanguageCode> + <languageCodes>eng-GB</languageCodes> + <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> + <Language> + <languageCode>eng-GB</languageCode> + </Language> + </VersionTranslationInfo> + <names> + <value languageCode="eng-GB">Forms</value> + </names> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/54"/> + </VersionInfo> + <Fields> + <field> + <id>249</id> + <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue>Forms</fieldValue> + </field> + <field> + <id>250</id> + <fieldDefinitionIdentifier>short_name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue/> + </field> + <field> + <id>251</id> + <fieldDefinitionIdentifier>short_description</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> + <fieldValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </fieldValue> + </field> + <field> + <id>252</id> + <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> + <fieldValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </fieldValue> + </field> + </Fields> + <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/54/versions/1/relations"/> + <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> + <resource>/bundles/ezplatformadminui/img/ez-icons.svg#folder</resource> + <width></width> + <height></height> + <mimeType>image/svg+xml</mimeType> + </Thumbnail> + </Version> + </CurrentVersion> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/6"/> + <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/55"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/54/locations"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <lastModificationDate>2018-09-17T06:48:13+00:00</lastModificationDate> + <publishedDate>2018-09-17T06:48:13+00:00</publishedDate> + <mainLanguageCode>eng-GB</mainLanguageCode> + <currentVersionNo>1</currentVersionNo> + <alwaysAvailable>false</alwaysAvailable> + <isHidden>false</isHidden> + <status>PUBLISHED</status> + <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/54/objectstates"/> + </Content> + application/vnd.ibexa.api.ContentInfo+json: + schema: + $ref: '#/components/schemas/ContentInfoWrapper' + application/vnd.ibexa.api.ContentInfo+xml: + schema: + $ref: '#/components/schemas/ContentInfo' 401: - description: Error - The user is not authorized to read this company. + 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 company does not exist. - summary: Get company member - description: Returns the company member by given member ID. + 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).\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." parameters: - - name: companyId - in: path - description: "" - required: true + - 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: memberId + - name: contentId in: path - description: "" + description: ContentLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: - type: string + type: integer style: simple explode: false - allowReserved: false - deprecated: false - x-badges: - - name: Experience - color: '#D3822B' - - name: Commerce - color: '#A32768' - position: after delete: - operationId: ibexa.rest.corporate_account.members.delete + operationId: ibexa.rest.delete_content tags: - - Corporate Account + - Objects responses: 204: - description: No Content - given company member is deleted. - 401: - description: Error - the user is not authorized to delete this company member. + description: The content item is deleted. 404: - description: Error - the company member does not exist. - summary: Delete company member - description: The given company member is deleted. + 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: 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: "" + description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: memberId + - name: contentId in: path - description: "" + description: ContentDeleteController identifier 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: ibexa.rest.corporate_account.members.patch + operationId: ibexa.rest.update_content_metadata tags: - - Corporate Account + - Objects responses: 200: - description: OK - company member updated. + description: If set, all information for the content item (excluding the + current version) is returned in XML or JSON format. content: - application/vnd.ibexa.api.Member+json: + application/vnd.ibexa.api.ContentInfo+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: ~ - height: ~ - 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: ~ - 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: ~ - height: ~ - 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: + $ref: '#/components/schemas/ContentInfoWrapper' + application/vnd.ibexa.api.ContentInfo+xml: schema: - $ref: '#/components/schemas/Member' + $ref: '#/components/schemas/ContentInfo' example: | <?xml version="1.0" encoding="UTF-8"?> - <Member media-type="application/vnd.ibexa.api.Member+xml" - href="/api/ibexa/v2/corporate/companies/139/members/144"> - <id>144</id> - <name>Jay Kowalski</name> - <Company media-type="application/vnd.ibexa.api.Company+xml"> - <id>139</id> - <name>Ibexa Sp. z o. o.</name> - <Content media-type="application/vnd.ibexa.api.Content+xml" - href="/api/ibexa/v2/content/objects/139" remoteId="b16d06d4c5ba7c37b26fa167b551dfc2" - id="139"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" - href="/api/ibexa/v2/content/types/48"/> - <Name>Ibexa Sp. z o. o.</Name> - <TranslatedName>Ibexa Sp. z o. o.</TranslatedName> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" - href="/api/ibexa/v2/content/objects/139/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" - href="/api/ibexa/v2/content/objects/139/currentversion"> - <Version media-type="application/vnd.ibexa.api.Version+xml" - href="/api/ibexa/v2/content/objects/139/versions/6"> - <VersionInfo> - <id>677</id> - <versionNo>6</versionNo> - <status>PUBLISHED</status> - <modificationDate>2023-04-28T16:10:13+02:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" - href="/api/ibexa/v2/user/users/14"/> - <creationDate>2023-04-28T16:10:13+02:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo - media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Ibexa Sp. z o. o.</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" - href="/api/ibexa/v2/content/objects/139"/> - </VersionInfo> - <Fields> - <field> - <id>673</id> - <fieldDefinitionIdentifier>active</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_boolean</fieldTypeIdentifier> - <fieldValue>true</fieldValue> - </field> - <field> - <id>674</id> - <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Ibexa Sp. z o. o.</fieldValue> - </field> - <field> - <id>675</id> - <fieldDefinitionIdentifier>vat</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>123 456 789</fieldValue> - </field> - <field> - <id>676</id> - <fieldDefinitionIdentifier>website</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>https://ibexa.co</fieldValue> - </field> - <field> - <id>677</id> - <fieldDefinitionIdentifier>customer_group</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_customer_group</fieldTypeIdentifier> - <fieldValue> - <value key="customer_group_id">1</value> - </fieldValue> - </field> - <field> - <id>678</id> - <fieldDefinitionIdentifier>sales_rep</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">14</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/14</value> - </fieldValue> - </field> - <field> - <id>679</id> - <fieldDefinitionIdentifier>contact</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">144</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/144</value> - </fieldValue> - </field> - <field> - <id>680</id> - <fieldDefinitionIdentifier>default_address</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">142</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/142</value> - </fieldValue> - </field> - <field> - <id>681</id> - <fieldDefinitionIdentifier>billing_address</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_address</fieldTypeIdentifier> - <fieldValue> - <value key="name">HQ</value> - <value key="country">PL</value> - <value key="fields"> - <value key="region">Silesia</value> - <value key="locality">Katowice</value> - <value key="street">Gliwicka 6/5</value> - <value key="postal_code">40-079</value> - <value key="email">company@email.invalid</value> - <value key="phone_number">+48 000 000 000</value> - </value> - </fieldValue> - </field> - <field> - <id>683</id> - <fieldDefinitionIdentifier>members</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">140</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/140</value> - </fieldValue> - </field> - <field> - <id>682</id> - <fieldDefinitionIdentifier>address_book</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId">141</value> - <value key="destinationContentHref">/api/ibexa/v2/content/objects/141</value> - </fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" - href="/api/ibexa/v2/content/objects/139/versions/6/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/placeholder</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - </CurrentVersion> - <Section media-type="application/vnd.ibexa.api.Section+xml" - href="/api/ibexa/v2/content/sections/10"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" - href="/api/ibexa/v2/content/locations/1/65/140"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" - href="/api/ibexa/v2/content/objects/139/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <lastModificationDate>2023-04-28T16:10:13+02:00</lastModificationDate> - <publishedDate>2023-04-28T15:44:55+02:00</publishedDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>6</currentVersionNo> - <alwaysAvailable>true</alwaysAvailable> - <isHidden>false</isHidden> - <status>PUBLISHED</status> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" - href="/api/ibexa/v2/content/objects/139/objectstates"/> - </Content> - <billingAddress>HQ, Poland</billingAddress> - <contactId>144</contactId> - <salesRepresentativeId>14</salesRepresentativeId> - <defaultAddressId>142</defaultAddressId> - <addressBookId>141</addressBookId> - <membersId>140</membersId> - <MemberList media-type="application/vnd.ibexa.api.MemberList+xml" - href="/api/ibexa/v2/corporate/companies/139/members"/> - <Location media-type="application/vnd.ibexa.api.Location+xml" - href="/api/ibexa/v2/content/locations/1/65/140"/> - <locationPath>/1/65/140/</locationPath> - <isActive>1</isActive> - </Company> - <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/144" id="144" - remoteId="1b3938c16adfa29996f3afff0b4a0032"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" - href="/api/ibexa/v2/content/types/47"/> - <name>Jay Kowalski</name> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" - href="/api/ibexa/v2/content/objects/144/versions"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" - href="/api/ibexa/v2/content/sections/10"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" - href="/api/ibexa/v2/content/locations/1/65/140/141/145"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" - href="/api/ibexa/v2/content/objects/144/locations"/> - <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" - href="/api/ibexa/v2/user/users/144/groups"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <publishDate>2023-04-28T16:10:03+02:00</publishDate> - <lastModificationDate>2023-04-28T16:10:03+02:00</lastModificationDate> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/80" remoteId="69848aeb86164c35e5c98202eebe9e05" id="80"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"/> + <Name>article1</Name> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/80/versions"/> + <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/80/currentversion"/> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> + <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/63/66"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/80/locations"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/11"/> + <lastModificationDate>2019-02-19T15:00:34+01:00</lastModificationDate> + <publishedDate>2019-02-19T15:00:34+01:00</publishedDate> <mainLanguageCode>eng-GB</mainLanguageCode> - <alwaysAvailable>true</alwaysAvailable> - <Version media-type="application/vnd.ibexa.api.Version+xml" - href="/api/ibexa/v2/content/objects/144/versions/1"> - <VersionInfo> - <id>676</id> - <versionNo>1</versionNo> - <status>PUBLISHED</status> - <modificationDate>2023-04-28T16:10:03+02:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" - href="/api/ibexa/v2/user/users/14"/> - <creationDate>2023-04-28T16:10:03+02:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Jay Kowalski</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" - href="/api/ibexa/v2/content/objects/144"/> - </VersionInfo> - <Fields> - <field> - <id>698</id> - <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Jay</fieldValue> - </field> - <field> - <id>699</id> - <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Kowalski</fieldValue> - </field> - <field> - <id>700</id> - <fieldDefinitionIdentifier>phone_number</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>+48 123 123 456</fieldValue> - </field> - <field> - <id>701</id> - <fieldDefinitionIdentifier>user</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> - <fieldValue> - <value key="hasStoredLogin">true</value> - <value key="contentId">144</value> - <value key="login">jay.kowalski</value> - <value key="email">jay.kowalski@email.invalid</value> - <value key="passwordUpdatedAt">1682691003</value> - <value key="enabled">true</value> - <value key="maxLogin">0</value> - <value key="plainPassword"/> - </fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" - href="/api/ibexa/v2/content/objects/144/versions/1/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/user/default_profile_image/initials.svg?initials=JK#profile_image</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - <login>jay.kowalski</login> - <email>jay.kowalski@email.invalid</email> - <enabled>true</enabled> - <UserGroups media-type="application/vnd.ibexa.api.UserGroupList+xml" - href="/api/ibexa/v2/user/users/144/groups"/> - <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" - href="/api/ibexa/v2/user/users/144/roles"/> - </User> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/14"> - <identifier>Company Admin</identifier> - <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" - href="/api/ibexa/v2/user/roles/14/policies"/> - </Role> - </Member> + <currentVersionNo>1</currentVersionNo> + <alwaysAvailable>false</alwaysAvailable> + <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/80/objectstates"/> + </Content> 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. + 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: X-CSRF-Token in: header - description: Only needed for session's checking. The {csrfToken} needed on - all unsafe HTTP methods with session. + description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: If-Match + - 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: "" + 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: memberId + - name: contentId in: path - description: "" + description: ContentMetadataUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The company input schema encoded in XML or JSON. + description: The ContentUpdate schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.MemberUpdate+json: + application/vnd.ibexa.api.ContentUpdate+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: + $ref: '#/components/schemas/ContentInfoWrapper' + application/vnd.ibexa.api.ContentUpdate+xml: schema: - $ref: '#/components/schemas/MemberUpdate' + $ref: '#/components/schemas/ContentInfo' example: | <?xml version="1.0" encoding="UTF-8"?> - <MemberUpdate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> - <email>jay.kowalski@updated.email</email> - <password>Publish123#</password> - <enabled>false</enabled> - <maxLogin>5</maxLogin> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/15"/> - <fields> - <field> - <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> - <fieldValue>Jay</fieldValue> - </field> - <field> - <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> - <fieldValue>Kowalski</fieldValue> - </field> - <field> - <fieldDefinitionIdentifier>phone_number</fieldDefinitionIdentifier> - <fieldValue>+48 123 123 456</fieldValue> - </field> - </fields> - </MemberUpdate> + <ContentUpdate> + <mainLanguageCode>eng-GB</mainLanguageCode> + <Section href="/api/ibexa/v2/content/sections/1"/> + <MainLocation href="/api/ibexa/v2/content/locations/2/63/66"/> + <Owner href="/api/ibexa/v2/user/users/11"/> + <alwaysAvailable>false</alwaysAvailable> + <remoteId>69848aeb86164c35e5c98202eebe9e05</remoteId> + </ContentUpdate> required: false - deprecated: false - x-badges: - - name: Experience - color: '#D3822B' - - name: Commerce - color: '#A32768' - position: after - /corporate/sales-representatives: + /content/objects/{contentId}/currentversion: get: - operationId: ibexa.rest.corporate_account.sales_representatives.get + operationId: ibexa.rest.redirect_current_version tags: - - Corporate Account + - Objects responses: 200: - description: Sales representatives list containing Company objects. + description: OK - returns the Version in XML or JSON format. content: - application/vnd.ibexa.api.SalesRepresentativesList+json: + application/vnd.ibexa.api.Version+json: schema: - $ref: '#/components/schemas/SalesRepresentativesListWrapper' + $ref: '#/components/schemas/VersionWrapper' 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: + Version: + _media-type: application/vnd.ibexa.api.Version+json + _href: /api/ibexa/v2/content/objects/107/versions/2 + VersionInfo: + id: 578 + versionNo: 2 + status: PUBLISHED + modificationDate: "2023-05-24T05:59:09+00:00" + Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 - 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: ~ - - id: 342 - fieldDefinitionIdentifier: signature - languageCode: eng-GB - fieldTypeIdentifier: ibexa_text - fieldValue: ~ - - id: 343 - fieldDefinitionIdentifier: image - languageCode: eng-GB - fieldTypeIdentifier: ibexa_image - fieldValue: ~ - 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: ~ - height: ~ - 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: + creationDate: "2023-05-24T05:59:02+00:00" + initialLanguageCode: eng-GB + languageCodes: eng-GB + VersionTranslationInfo: + _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json + Language: + - languageCode: eng-GB + names: + value: + - _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: ~ + - id: 479 + fieldDefinitionIdentifier: short_description + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + - id: 480 + fieldDefinitionIdentifier: description + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + Relations: + _media-type: application/vnd.ibexa.api.RelationList+json + _href: /api/ibexa/v2/content/objects/107/versions/2/relations + Relation: [] + Thumbnail: + _media-type: application/vnd.ibexa.api.Thumbnail+json + resource: /placeholder + width: ~ + height: ~ + mimeType: image/svg+xml + application/vnd.ibexa.api.Version+xml: schema: - $ref: '#/components/schemas/SalesRepresentativesList' + $ref: '#/components/schemas/Version' example: | <?xml version="1.0" encoding="UTF-8"?> - <SalesRepresentativesList media-type="application/vnd.ibexa.api.SalesRepresentativesList+xml"> - <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/75" id="75" remoteId="f262e2fa12ae105b78a1b654e87a0874"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/> - <name>John Black</name> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/75/versions"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/10"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/64/76"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/75/locations"/> - <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/75/groups"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <publishDate>2023-06-20T07:33:17+00:00</publishDate> - <lastModificationDate>2023-06-20T07:33:17+00:00</lastModificationDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <alwaysAvailable>true</alwaysAvailable> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/75/versions/1"> - <VersionInfo> - <id>536</id> - <versionNo>1</versionNo> - <status>PUBLISHED</status> - <modificationDate>2023-06-20T07:33:17+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <creationDate>2023-06-20T07:33:17+00:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">John Black</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/75"/> - </VersionInfo> - <Fields> - <field> - <id>339</id> - <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>John</fieldValue> - </field> - <field> - <id>340</id> - <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Black</fieldValue> - </field> - <field> - <id>341</id> - <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> - <fieldValue> - <value key="hasStoredLogin">true</value> - <value key="contentId">75</value> - <value key="login">John Black</value> - <value key="email">j.black@ibexa.co</value> - <value key="passwordUpdatedAt">1687246397</value> - <value key="enabled">true</value> - <value key="maxLogin">0</value> - <value key="plainPassword"/> - </fieldValue> - </field> - <field> - <id>342</id> - <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier> - <fieldValue/> - </field> - <field> - <id>343</id> - <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier> - <fieldValue/> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/75/versions/1/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/user/default_profile_image/initials.svg?initials=JB#profile_image</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - <login>John Black</login> - <email>j.black@ibexa.co</email> - <enabled>true</enabled> - <UserGroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/users/75/groups"/> - <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/75/roles"/> - </User> - </SalesRepresentativesList> - 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: [] - deprecated: false - x-badges: - - name: Experience - color: '#D3822B' - - name: Commerce - color: '#A32768' - position: after - /discounts: - get: - operationId: ibexa.discounts.rest.list - tags: - - Discounts - responses: - 200: - description: A discount list is returned. - 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 + <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/107/versions/2"> + <VersionInfo> + <id>578</id> + <versionNo>2</versionNo> + <status>PUBLISHED</status> + <modificationDate>2023-05-24T05:59:09+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <creationDate>2023-05-24T05:59:02+00:00</creationDate> + <initialLanguageCode>eng-GB</initialLanguageCode> + <languageCodes>eng-GB</languageCodes> + <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> + <Language> + <languageCode>eng-GB</languageCode> + </Language> + </VersionTranslationInfo> + <names> + <value languageCode="eng-GB">Features</value> + </names> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/107"/> + </VersionInfo> + <Fields> + <field> + <id>477</id> + <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue>Features</fieldValue> + </field> + <field> + <id>478</id> + <fieldDefinitionIdentifier>short_name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue/> + </field> + <field> + <id>479</id> + <fieldDefinitionIdentifier>short_description</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> + <fieldValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </fieldValue> + </field> + <field> + <id>480</id> + <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> + <fieldValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </fieldValue> + </field> + </Fields> + <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/107/versions/2/relations"/> + <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> + <resource>/placeholder</resource> + <width></width> + <height></height> + <mimeType>image/svg+xml</mimeType> + </Thumbnail> + </Version> + 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: 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 + - name: contentId + in: path + description: ContentCurrentVersionRedirectController identifier + required: true deprecated: false - allowEmptyValue: false schema: - type: integer - style: form + type: string + style: simple explode: false - allowReserved: false - example: 25 - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after post: - operationId: ibexa.discounts.rest.create + operationId: ibexa.rest.content.create_draft_from_current_version tags: - - Discounts + - Objects responses: - 200: - description: The created discount is returned. + 201: + description: Created content: - application/vnd.ibexa.api.Discount+json: + application/vnd.ibexa.api.Version+json: schema: - $ref: '#/components/schemas/Discount' + $ref: '#/components/schemas/VersionWrapper' 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 + 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: ~ + - id: 479 + fieldDefinitionIdentifier: short_description + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + - id: 480 + fieldDefinitionIdentifier: description + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + 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: ~ + height: ~ + mimeType: image/svg+xml + application/vnd.ibexa.api.Version+xml: + schema: + $ref: '#/components/schemas/Version' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/107/versions/5"> + <VersionInfo> + <id>581</id> + <versionNo>5</versionNo> + <status>ARCHIVED</status> + <modificationDate>2023-05-24T06:11:50+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <creationDate>2023-05-24T06:09:49+00:00</creationDate> + <initialLanguageCode>eng-GB</initialLanguageCode> + <languageCodes>eng-GB</languageCodes> + <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> + <Language> + <languageCode>eng-GB</languageCode> + </Language> + </VersionTranslationInfo> + <names> + <value languageCode="eng-GB">Features</value> + </names> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/107"/> + </VersionInfo> + <Fields> + <field> + <id>477</id> + <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue>Features</fieldValue> + </field> + <field> + <id>478</id> + <fieldDefinitionIdentifier>short_name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue/> + </field> + <field> + <id>479</id> + <fieldDefinitionIdentifier>short_description</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> + <fieldValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </fieldValue> + </field> + <field> + <id>480</id> + <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> + <fieldValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </fieldValue> + </field> + </Fields> + <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/107/versions/5/relations"/> + <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> + <resource>/placeholder</resource> + <width></width> + <height></height> + <mimeType>image/svg+xml</mimeType> + </Thumbnail> + </Version> 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 + 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: X-CSRF-Token in: header - description: CSRF token obtained during the authentication. + description: The CSRF Token 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 DiscountCreate schema - 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: ibexa.discounts.rest.identifier - tags: - - Discounts - responses: - 200: - description: The discount is returned. - 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 + - name: contentId in: path - description: "" + description: ContentDraftCreateFromCurrentVersionController identifier 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: ibexa.discounts.rest.delete + requestBody: + description: No payload required + content: [] + required: false + /content/objects/{contentId}/hide: + post: + operationId: ibexa.rest.hide_content tags: - - Discounts + - Objects responses: 204: - description: The discount is deleted. - 404: - description: Error - a discount of the given unique identifier is not found. + description: OK - Object item is hidden. 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 + 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: identifier - in: path - description: "" + - name: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. 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. + - name: contentId + in: path + description: ContentHideController identifier 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: ibexa.discounts.rest.update + requestBody: + description: No payload required + content: [] + required: false + /content/objects/{contentId}/locations: + get: + operationId: ibexa.rest.load_locations_for_content tags: - - Discounts + - Objects responses: 200: - description: The updated discount is returned. + description: If set, the Location list is returned in XML or JSON format. content: - application/vnd.ibexa.api.Discount+json: + application/vnd.ibexa.api.LocationList+json: schema: - $ref: '#/components/schemas/Discount' + $ref: '#/components/schemas/LocationListWrapper' 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. + 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: | + <?xml version="1.0" encoding="UTF-8"?> + <LocationList media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/63/locations"> + <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/57/65"/> + </LocationList> 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 + 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: identifier + - name: If-None-Match + in: header + description: ETag + required: false + deprecated: false + schema: + type: string + style: simple + explode: false + - name: contentId in: path - description: "" + description: LocationForContentListController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - example: my_discount_identifier + post: + operationId: ibexa.rest.create_location + tags: + - Objects + responses: + 201: + description: If set, the new Location is returned in XML or JSON format. + 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: | + <?xml version="1.0" encoding="UTF-8"?> + <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/42/96"> + <id>96</id> + <priority>0</priority> + <hidden>false</hidden> + <invisible>true</invisible> + <explicitlyHidden>false</explicitlyHidden> + <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/42"/> + <pathString>/1/2/42/96/</pathString> + <depth>3</depth> + <childCount>0</childCount> + <remoteId>58133c8c75230e5debe362a28b92d27a</remoteId> + <Children media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/2/42/96/children"/> + <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/63"/> + <sortField>PATH</sortField> + <sortOrder>ASC</sortOrder> + <UrlAliases media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/42/96/urlaliases"/> + <ContentInfo media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/63"> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/63" remoteId="211e99934c8fef5900e4813b96ec5c87" id="63"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"/> + <Name>Art3</Name> + <TranslatedName>Art3</TranslatedName> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/63/versions"/> + <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/63/currentversion"/> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/63/locations"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <lastModificationDate>2021-06-28T11:34:17+00:00</lastModificationDate> + <publishedDate>2021-06-28T11:34:17+00:00</publishedDate> + <mainLanguageCode>eng-GB</mainLanguageCode> + <currentVersionNo>1</currentVersionNo> + <alwaysAvailable>false</alwaysAvailable> + <isHidden>false</isHidden> + <status>PUBLISHED</status> + <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/63/objectstates"/> + </Content> + </ContentInfo> + </Location> + 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: X-CSRF-Token in: header - description: CSRF token obtained during the authentication. + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: contentId + in: path + description: LocationCreateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The DiscountUpdate schema + description: The LocationCreate schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.DiscountUpdate+json: + application/vnd.ibexa.api.LocationCreate+json: schema: - $ref: '#/components/schemas/DiscountUpdate' + $ref: '#/components/schemas/LocationCreateWrapper' 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 + 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: | + <?xml version="1.0" encoding="UTF-8"?> + <LocationCreate> + <ParentLocation href="/api/ibexa/v2/content/locations/1/42" /> + <priority>0</priority> + <hidden>false</hidden> + <sortField>PATH</sortField> + <sortOrder>ASC</sortOrder> + </LocationCreate> required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /discounts/{identifier}/disable: - post: - operationId: ibexa.discounts.rest.disable + /content/objects/{contentId}/objectstates: + get: + operationId: ibexa.rest.get_object_states_for_content tags: - - Discounts + - Objects responses: - 204: - description: The discount is disabled. + 200: + description: OK - returns the Object state. + content: + application/vnd.ibexa.api.ContentObjectStates+json: + schema: + $ref: '#/components/schemas/ContentObjectStates' + 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: | + <?xml version="1.0" encoding="UTF-8"?> + <ContentObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml"> + <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/2/objectstates/1"/> + <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/3/objectstates/3"/> + <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/7/objectstates/7"/> + <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/8/objectstates/8"/> + </ContentObjectStates> 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 + 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: identifier - in: path - description: "" - required: true + - name: If-None-Match + in: header + description: ETag + required: false 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. + - name: contentId + in: path + description: ObjectStatesForContentListController identifier 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 - /discounts/{identifier}/enable: - post: - operationId: ibexa.discounts.rest.enable + patch: + operationId: ibexa.rest.set_object_states_for_content tags: - - Discounts + - Objects responses: 204: - description: The discount is enabled. - 404: - description: Error - a discount of the given unique identifier is not found. + 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/2 + application/vnd.ibexa.api.ContentObjectStates+xml: + schema: + $ref: '#/components/schemas/ContentObjectStates' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <ContentObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml"> + <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/2/objectstates/2"/> + </ContentObjectStates> + 400: + description: Error - The input does not match the input schema definition. 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 + 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: identifier - in: path - description: "" + - name: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - example: my_discount_identifier - - name: X-CSRF-Token + - name: If-Match in: header - description: CSRF token obtained during the authentication. + description: ETag + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: contentId + in: path + description: ObjectStatesForContentUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: No payload required - content: [] + description: The content item Object states input schema encoded in XML or + JSON format. + content: + application/vnd.ibexa.api.ContentObjectStates+json: + schema: + $ref: '#/components/schemas/ContentObjectStatesWrapper' + example: + ContentObjectStates: + ObjectState: + - _href: /api/ibexa/v2/content/objectstategroups/2/objectstates/2 + application/vnd.ibexa.api.ContentObjectStates+xml: + schema: + $ref: '#/components/schemas/ContentObjectStates' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <ContentObjectStates> + <ObjectState href="/api/ibexa/v2/content/objectstategroups/2/objectstates/2" /> + </ContentObjectStates> required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /discounts/{id}: + /content/objects/{contentId}/relations: get: - operationId: ibexa.discounts.rest.id + operationId: ibexa.rest.redirect_current_version_relations tags: - - Discounts + - Objects responses: - 200: - description: The discount is returned. - 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. + 307: + description: Temporary redirect. 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. + 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: id + - name: contentId in: path - description: "" + description: ContentCurrentVersionRelationsRedirectController identifier required: true deprecated: false - allowEmptyValue: false schema: - type: integer + type: string style: simple explode: false - allowReserved: false - example: 1 - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /discounts_codes/{cartIdentifier}/apply: + /content/objects/{contentId}/reveal: post: - operationId: ibexa.rest.discounts_codes.apply + operationId: ibexa.rest.reveal_content tags: - - Discounts + - Objects 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 + 204: + description: OK - Object item is revealed. + 401: + description: Error - The user has no permission to change Object item visibility. 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. + description: Error - The content item was not found. + summary: Reveal content item + description: Makes or keep the content item visible parameters: - name: X-CSRF-Token in: header - description: "" + description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: cartIdentifier + - name: contentId in: path - description: "" + description: ContentRevealController identifier 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 + description: No payload required + content: [] required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /discounts_codes/{cartIdentifier}/drop: - post: - operationId: ibexa.rest.discounts_codes.drop + /content/objects/{contentId}/translations/{languageCode}: + delete: + operationId: ibexa.rest.delete_content_translation tags: - - Discounts + - Objects responses: 204: - description: No Content - the discount code has been dropped. + description: No Content + 401: + description: Error - the user is not authorized to delete content item (content/remove + policy). 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. + 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: X-CSRF-Token in: header - description: "" + description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: cartIdentifier + - name: contentId in: path - description: "" + description: ContentTranslationDeleteController identifier 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: ibexa.rest.languages.list - tags: - - Language - responses: - 200: - description: If set, the list is returned in XML or JSON format. - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <LanguageList media-type="application/vnd.ibexa.api.LanguageList+xml" href="/api/ibexa/v2/languages"> - <Language media-type="application/vnd.ibexa.api.Language+xml" href="/api/ibexa/v2/languages/eng-GB"> - <languageId>2</languageId> - <languageCode>eng-GB</languageCode> - <name>English (United Kingdom)</name> - </Language> - <Language href="/api/ibexa/v2/languages/pol-PL" media-type="application/vnd.ibexa.api.Language+xml"> - <languageId>4</languageId> - <languageCode>pol-PL</languageCode> - <name>Polish (polski)</name> - </Language> - </LanguageList> - summary: Language list - description: Lists languages - parameters: [] - deprecated: false - /languages/{code}: - get: - operationId: ibexa.rest.languages.view - tags: - - Language - responses: - 200: - description: If set, the language is returned in XML or JSON format. - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <Language media-type="application/vnd.ibexa.api.Language+xml" href="/api/ibexa/v2/languages/eng-GB"> - <languageId>2</languageId> - <languageCode>eng-GB</languageCode> - <name>English (United Kingdom)</name> - </Language> - summary: Get language - description: Retrieves a LanguageLoadByIdController resource. - parameters: - - name: code + - name: languageCode in: path - description: "" + description: ContentTranslationDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - /content/locations: + /content/objects/{contentId}/versions: get: - operationId: ibexa.rest.redirect_location + operationId: ibexa.rest.load_content_versions tags: - - Location + - Objects responses: 200: - description: OK - returns the LocationList in XML or JSON format. + description: If set, the version list is returned in XML or JSON format. content: - application/vnd.ibexa.api.LocationList+json: + application/vnd.ibexa.api.VersionList+json: schema: - $ref: '#/components/schemas/LocationWrapper' + $ref: '#/components/schemas/VersionListWrapper' example: - Location: - _media-type: application/vnd.ibexa.api.Location+json - _href: /api/ibexa/v2/content/locations/1/2/58 - id: 58 - priority: 0 - hidden: false - invisible: false - explicitlyHidden: false - ParentLocation: - _media-type: application/vnd.ibexa.api.Location+json - _href: /api/ibexa/v2/content/locations/1/2 - pathString: /1/2/58/ - depth: 2 - childCount: 3 - remoteId: 0cfe62f27753448d79aaa8acd8d01699 - Children: - _media-type: application/vnd.ibexa.api.LocationList+json - _href: /api/ibexa/v2/content/locations/1/2/58/children - Content: - _media-type: application/vnd.ibexa.api.Content+json - _href: /api/ibexa/v2/content/objects/57 - sortField: PATH - sortOrder: ASC - UrlAliases: - _media-type: application/vnd.ibexa.api.UrlAliasRefList+json - _href: /api/ibexa/v2/content/locations/1/2/58/urlaliases - ContentInfo: - _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/57 - Content: - _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/57 - _remoteId: 782f5afa9d6587804daa911e88ff5bb9 - _id: 57 - ContentType: - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/1 - Name: All Tips - TranslatedName: All Tips - Versions: - _media-type: application/vnd.ibexa.api.VersionList+json - _href: /api/ibexa/v2/content/objects/57/versions - CurrentVersion: - _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/57/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/57/locations - Owner: + 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 - lastModificationDate: "2021-06-28T11:22:52+00:00" - publishedDate: "2021-06-28T11:22:52+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/57/objectstates - application/vnd.ibexa.api.LocationList+xml: + 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/Location' + $ref: '#/components/schemas/VersionList' example: | <?xml version="1.0" encoding="UTF-8"?> - <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/58"> - <id>58</id> - <priority>0</priority> - <hidden>false</hidden> - <invisible>false</invisible> - <explicitlyHidden>false</explicitlyHidden> - <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2"/> - <pathString>/1/2/58/</pathString> - <depth>2</depth> - <childCount>3</childCount> - <remoteId>0cfe62f27753448d79aaa8acd8d01699</remoteId> - <Children media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/2/58/children"/> - <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/57"/> - <sortField>PATH</sortField> - <sortOrder>ASC</sortOrder> - <UrlAliases media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/58/urlaliases"/> - <ContentInfo media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/57"> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/57" remoteId="782f5afa9d6587804daa911e88ff5bb9" id="57"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"/> - <Name>All Tips</Name> - <TranslatedName>All Tips</TranslatedName> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/57/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/57/currentversion"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/57/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <lastModificationDate>2021-06-28T11:22:52+00:00</lastModificationDate> - <publishedDate>2021-06-28T11:22:52+00:00</publishedDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>1</currentVersionNo> - <alwaysAvailable>true</alwaysAvailable> - <isHidden>false</isHidden> + <VersionList media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/61/versions"> + <VersionItem> + <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/61/versions/1"/> + <VersionInfo> + <id>521</id> + <versionNo>1</versionNo> <status>PUBLISHED</status> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/57/objectstates"/> - </Content> - </ContentInfo> - </Location> - 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: [] - deprecated: false - /content/locations/{path}: + <modificationDate>2021-06-28T11:33:49+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <creationDate>2021-06-28T11:33:31+00:00</creationDate> + <initialLanguageCode>eng-GB</initialLanguageCode> + <languageCodes>eng-GB</languageCodes> + <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> + <Language> + <languageCode>eng-GB</languageCode> + </Language> + </VersionTranslationInfo> + <names> + <value languageCode="eng-GB">Art1</value> + </names> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/61"/> + </VersionInfo> + </VersionItem> + <VersionItem> + <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/61/versions/2"/> + <VersionInfo> + <id>580</id> + <versionNo>2</versionNo> + <status>DRAFT</status> + <modificationDate>2021-07-26T08:10:02+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <creationDate>2021-07-26T08:10:02+00:00</creationDate> + <initialLanguageCode>eng-GB</initialLanguageCode> + <languageCodes>eng-GB</languageCodes> + <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> + <Language> + <languageCode>eng-GB</languageCode> + </Language> + </VersionTranslationInfo> + <names> + <value languageCode="eng-GB">Art1</value> + </names> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/61"/> + </VersionInfo> + </VersionItem> + <VersionItem> + <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/61/versions/3"/> + <VersionInfo> + <id>581</id> + <versionNo>3</versionNo> + <status>DRAFT</status> + <modificationDate>2021-07-26T08:16:50+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <creationDate>2021-07-26T08:16:50+00:00</creationDate> + <initialLanguageCode>eng-GB</initialLanguageCode> + <languageCodes>eng-GB</languageCodes> + <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> + <Language> + <languageCode>eng-GB</languageCode> + </Language> + </VersionTranslationInfo> + <names> + <value languageCode="eng-GB">Art1</value> + </names> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/61"/> + </VersionInfo> + </VersionItem> + </VersionList> + 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: contentId + in: path + description: ContentVersionsListController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + /content/objects/{contentId}/versions/{versionNo}: get: - operationId: ibexa.rest.load_location + operationId: ibexa.rest.load_content_in_version tags: - - Location + - Objects responses: 200: - description: If set, the new Location is returned in XML or JSON format. + description: If set, the version list is returned in XML or JSON format. content: - application/vnd.ibexa.api.Location+json: + application/vnd.ibexa.api.Version+json: schema: - $ref: '#/components/schemas/LocationWrapper' + $ref: '#/components/schemas/VersionWrapper' example: - Location: - _media-type: application/vnd.ibexa.api.Location+json - _href: /api/ibexa/v2/content/locations/1/2/58 - id: 58 - priority: 0 - hidden: false - invisible: false - explicitlyHidden: false - ParentLocation: - _media-type: application/vnd.ibexa.api.Location+json - _href: /api/ibexa/v2/content/locations/1/2 - pathString: /1/2/58/ - depth: 2 - childCount: 3 - remoteId: 0cfe62f27753448d79aaa8acd8d01699 - Children: - _media-type: application/vnd.ibexa.api.LocationList+json - _href: /api/ibexa/v2/content/locations/1/2/58/children - Content: - _media-type: application/vnd.ibexa.api.Content+json - _href: /api/ibexa/v2/content/objects/57 - sortField: PATH - sortOrder: ASC - UrlAliases: - _media-type: application/vnd.ibexa.api.UrlAliasRefList+json - _href: /api/ibexa/v2/content/locations/1/2/58/urlaliases - ContentInfo: - _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/57 + 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/57 - _remoteId: 782f5afa9d6587804daa911e88ff5bb9 - _id: 57 - ContentType: - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/1 - Name: All Tips - TranslatedName: All Tips - Versions: - _media-type: application/vnd.ibexa.api.VersionList+json - _href: /api/ibexa/v2/content/objects/57/versions - CurrentVersion: - _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/57/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/57/locations - Owner: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - lastModificationDate: "2021-06-28T11:22:52+00:00" - publishedDate: "2021-06-28T11:22:52+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/57/objectstates - application/vnd.ibexa.api.Location+xml: + _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: ~ + - id: 479 + fieldDefinitionIdentifier: short_description + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + - id: 480 + fieldDefinitionIdentifier: description + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + 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: ~ + height: ~ + mimeType: image/svg+xml + application/vnd.ibexa.api.Version+xml: schema: - $ref: '#/components/schemas/Location' + $ref: '#/components/schemas/Version' example: | <?xml version="1.0" encoding="UTF-8"?> - <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/61"> - <id>61</id> - <priority>0</priority> - <hidden>false</hidden> - <invisible>false</invisible> - <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2"/> - <pathString>/1/2/61/</pathString> - <depth>2</depth> - <childCount>0</childCount> - <remoteId>2cfa66027e3806b113d994c9c26d3a66</remoteId> - <Children media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/2/61/children"/> - <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/60"/> - <sortField>NAME</sortField> - <sortOrder>ASC</sortOrder> - <UrlAliases media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/61/urlaliases"/> - <ContentInfo media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/60"> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/60" remoteId="f9198276543bfe5e1dfc01a9a8d0c7ee" id="60"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"/> - <Name>666</Name> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/60/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/60/currentversion"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/60/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <lastModificationDate>2018-11-09T14:49:52+01:00</lastModificationDate> - <publishedDate>2018-11-09T14:49:52+01:00</publishedDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>1</currentVersionNo> - <alwaysAvailable>false</alwaysAvailable> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/60/objectstates"/> - </Content> - </ContentInfo> - </Location> + <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/107/versions/5"> + <VersionInfo> + <id>581</id> + <versionNo>5</versionNo> + <status>ARCHIVED</status> + <modificationDate>2023-05-24T06:11:50+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <creationDate>2023-05-24T06:09:49+00:00</creationDate> + <initialLanguageCode>eng-GB</initialLanguageCode> + <languageCodes>eng-GB</languageCodes> + <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> + <Language> + <languageCode>eng-GB</languageCode> + </Language> + </VersionTranslationInfo> + <names> + <value languageCode="eng-GB">Features</value> + </names> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/107"/> + </VersionInfo> + <Fields> + <field> + <id>477</id> + <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue>Features</fieldValue> + </field> + <field> + <id>478</id> + <fieldDefinitionIdentifier>short_name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue/> + </field> + <field> + <id>479</id> + <fieldDefinitionIdentifier>short_description</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> + <fieldValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </fieldValue> + </field> + <field> + <id>480</id> + <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> + <fieldValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </fieldValue> + </field> + </Fields> + <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/107/versions/5/relations"/> + <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> + <resource>/placeholder</resource> + <width></width> + <height></height> + <mimeType>image/svg+xml</mimeType> + </Thumbnail> + </Version> + 304: + description: Not Modified - the ETag matches the current one. 401: - description: Error - the user is not authorized to read this Location. + description: Error - the user is not authorized to read this content item. 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'. + 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: ETag + description: Only return the version if the given ETag is the not current + one, otherwise a 304 is returned. required: false deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: path + - name: contentId in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false - delete: - operationId: ibexa.rest.delete_subtree - 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + description: ContentInVersionLoadController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: path + - name: versionNo in: path - description: "" + description: ContentInVersionLoadController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - patch: - operationId: ibexa.rest.update_location + post: + operationId: ibexa.rest.content.create_draft_from_version tags: - - Location + - Objects responses: - 200: - description: If set, the Location is returned in XML or JSON format. + 201: + description: Created. content: - application/vnd.ibexa.api.Location+json: + application/vnd.ibexa.api.Version+json: schema: - $ref: '#/components/schemas/LocationWrapper' + $ref: '#/components/schemas/VersionWrapper' example: - Location: - _media-type: application/vnd.ibexa.api.Location+json - _href: /api/ibexa/v2/content/locations/1/2/59 - id: 59 - priority: 3 - hidden: true - invisible: true - explicitlyHidden: true - ParentLocation: - _media-type: application/vnd.ibexa.api.Location+json - _href: /api/ibexa/v2/content/locations/1/2 - pathString: /1/2/59/ - depth: 2 - childCount: 5 - remoteId: remoteId-qwert999 - Children: - _media-type: application/vnd.ibexa.api.LocationList+json - _href: /api/ibexa/v2/content/locations/1/2/59/children - Content: - _media-type: application/vnd.ibexa.api.Content+json - _href: /api/ibexa/v2/content/objects/58 - sortField: NAME - sortOrder: DESC - UrlAliases: - _media-type: 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 + 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/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.Location+xml: + _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: ~ + - id: 479 + fieldDefinitionIdentifier: short_description + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + - id: 480 + fieldDefinitionIdentifier: description + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + 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: ~ + height: ~ + mimeType: image/svg+xml + application/vnd.ibexa.api.Version+xml: schema: - $ref: '#/components/schemas/Location' + $ref: '#/components/schemas/Version' example: | <?xml version="1.0" encoding="UTF-8"?> - <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/58"> - <id>58</id> - <priority>0</priority> - <hidden>false</hidden> - <invisible>false</invisible> - <explicitlyHidden>false</explicitlyHidden> - <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2"/> - <pathString>/1/2/58/</pathString> - <depth>2</depth> - <childCount>3</childCount> - <remoteId>0cfe62f27753448d79aaa8acd8d01699</remoteId> - <Children media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/2/58/children"/> - <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/57"/> - <sortField>PATH</sortField> - <sortOrder>ASC</sortOrder> - <UrlAliases media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/58/urlaliases"/> - <ContentInfo media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/57"> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/57" remoteId="782f5afa9d6587804daa911e88ff5bb9" id="57"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"/> - <Name>All Tips</Name> - <TranslatedName>All Tips</TranslatedName> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/57/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/57/currentversion"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/57/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <lastModificationDate>2021-06-28T11:22:52+00:00</lastModificationDate> - <publishedDate>2021-06-28T11:22:52+00:00</publishedDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>1</currentVersionNo> - <alwaysAvailable>true</alwaysAvailable> - <isHidden>false</isHidden> - <status>PUBLISHED</status> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/57/objectstates"/> - </Content> - </ContentInfo> - </Location> + <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/107/versions/5"> + <VersionInfo> + <id>581</id> + <versionNo>5</versionNo> + <status>ARCHIVED</status> + <modificationDate>2023-05-24T06:11:50+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <creationDate>2023-05-24T06:09:49+00:00</creationDate> + <initialLanguageCode>eng-GB</initialLanguageCode> + <languageCodes>eng-GB</languageCodes> + <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> + <Language> + <languageCode>eng-GB</languageCode> + </Language> + </VersionTranslationInfo> + <names> + <value languageCode="eng-GB">Features</value> + </names> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/107"/> + </VersionInfo> + <Fields> + <field> + <id>477</id> + <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue>Features</fieldValue> + </field> + <field> + <id>478</id> + <fieldDefinitionIdentifier>short_name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue/> + </field> + <field> + <id>479</id> + <fieldDefinitionIdentifier>short_description</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> + <fieldValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </fieldValue> + </field> + <field> + <id>480</id> + <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> + <fieldValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </fieldValue> + </field> + </Fields> + <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/107/versions/5/relations"/> + <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> + <resource>/placeholder</resource> + <width></width> + <height></height> + <mimeType>image/svg+xml</mimeType> + </Thumbnail> + </Version> 401: - description: Error - the user is not authorized to update this Location. + description: Error - the user is not authorized to update this content item. 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. + 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: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: If-Match - in: header - description: ETag + - name: contentId + in: path + description: ContentDraftCreateFromVersionController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: path + - name: versionNo in: path - description: "" + description: ContentDraftCreateFromVersionController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The LocationUpdate schema encoded in XML or JSON format. - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <LocationUpdate> - <priority>3</priority> - <hidden>true</hidden> - <remoteId>remoteId-qwert999</remoteId> - <sortField>CLASS</sortField> - <sortOrder>DESC</sortOrder> - </LocationUpdate> + description: No payload required + content: [] required: false - deprecated: false - /content/locations/{path}/children: - get: - operationId: ibexa.rest.load_location_children + delete: + operationId: ibexa.rest.delete_content_version tags: - - Location + - Objects responses: - 200: - description: If set, the new Location list is returned in XML or JSON format. - content: - application/vnd.ibexa.api.LocationList+json: - schema: - $ref: '#/components/schemas/LocationListWrapper' - application/vnd.ibexa.api.LocationList+xml: - schema: - $ref: '#/components/schemas/LocationList' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <LocationList media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/63/children"> - <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/63/60"/> - <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/63/61"/> - <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/63/62"/> - <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/63/67"/> - </LocationList> - 401: - description: Error - the user is not authorized to read this content item. + 204: + description: No Content - the version is deleted. 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. + 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: path + - name: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: contentId in: path - description: "" + description: ContentVersionDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - /content/locations/{path}/urlaliases: - get: - operationId: ibexa.rest.list_location_url_aliases - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <UrlAliasRefList media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/59/urlaliases"> - <UrlAlias media-type="application/vnd.ibexa.api.UrlAlias+xml" href="/api/ibexa/v2/content/urlaliases/0-deca3dadca45c3dff7861274b8e67ed7"/> - <UrlAlias media-type="application/vnd.ibexa.api.UrlAlias+xml" href="/api/ibexa/v2/content/urlaliases/0-e1511fd04f57162341c2950fa1375867"/> - </UrlAliasRefList> - 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: path + - name: versionNo in: path - description: "" + description: ContentVersionDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - /content/objectstategroups: - get: - operationId: ibexa.rest.load_object_state_groups + patch: + operationId: ibexa.rest.update_version tags: - - Object State Groups + - Objects responses: 200: - description: OK - returns a list of Object state groups. + description: If set, the updated version is returned in XML or JSON format. content: - application/vnd.ibexa.api.ObjectStateGroupList+json: + application/vnd.ibexa.api.Version+json: schema: - $ref: '#/components/schemas/ObjectStateGroupListWrapper' + $ref: '#/components/schemas/VersionWrapper' 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 + 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 - ObjectStates: - _media-type: application/vnd.ibexa.api.ObjectStateList+json - _href: /api/ibexa/v2/content/objectstategroups/6/objectstates + VersionTranslationInfo: + _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json + Language: + - languageCode: eng-GB 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ObjectStateGroupList media-type="application/vnd.ibexa.api.ObjectStateGroupList+xml" href="/api/ibexa/v2/content/objectstategroups"> - <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/2"> - <id>2</id> - <identifier>ibexa_lock</identifier> - <defaultLanguageCode>eng-GB</defaultLanguageCode> - <languageCodes>eng-GB</languageCodes> - <ObjectStates media-type="application/vnd.ibexa.api.ObjectStateList+xml" href="/api/ibexa/v2/content/objectstategroups/2/objectstates"/> - <names> - <value languageCode="eng-GB">Lock</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - </ObjectStateGroup> - <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/3"> - <id>3</id> - <identifier>accessibility</identifier> - <defaultLanguageCode>eng-GB</defaultLanguageCode> - <languageCodes>eng-GB</languageCodes> - <ObjectStates media-type="application/vnd.ibexa.api.ObjectStateList+xml" href="/api/ibexa/v2/content/objectstategroups/3/objectstates"/> - <names> - <value languageCode="eng-GB">Accessibility</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - </ObjectStateGroup> - <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/6"> - <id>6</id> - <identifier>custom-states</identifier> - <defaultLanguageCode>eng-GB</defaultLanguageCode> - <languageCodes>eng-GB</languageCodes> - <ObjectStates media-type="application/vnd.ibexa.api.ObjectStateList+xml" href="/api/ibexa/v2/content/objectstategroups/6/objectstates"/> - <names> - <value languageCode="eng-GB">Custom State</value> - </names> - <descriptions> - <value languageCode="eng-GB">Custom Object state</value> - </descriptions> - </ObjectStateGroup> - </ObjectStateGroupList> - 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: If-None-Match - in: header - description: ETag - required: false - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false - post: - operationId: ibexa.rest.create_object_state_group - 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': Custom State - descriptions: - value: - - _languageCode: eng-GB - '#text': Custom Object state - application/vnd.ibexa.api.ObjectStateGroup+xml: + '#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: ~ + - id: 479 + fieldDefinitionIdentifier: short_description + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + - id: 480 + fieldDefinitionIdentifier: description + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + 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: ~ + height: ~ + mimeType: image/svg+xml + application/vnd.ibexa.api.Version+xml: schema: - $ref: '#/components/schemas/ObjectStateGroup' + $ref: '#/components/schemas/Version' example: | <?xml version="1.0" encoding="UTF-8"?> - <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/5"> - <id>5</id> - <identifier>custom-states</identifier> - <defaultLanguageCode>eng-GB</defaultLanguageCode> - <languageCodes>eng-GB</languageCodes> - <ObjectStates media-type="application/vnd.ibexa.api.ObjectStateList+xml" href="/api/ibexa/v2/content/objectstategroups/5/objectstates"/> + <Version href="/content/objects/23/versions/4" media-type="application/vnd.ibexa.api.Version+xml"> + <VersionInfo> + <id>45</id> + <versionNo>4</versionNo> + <status>DRAFT</status> + <modificationDate>2012-02-20T12:00:00</modificationDate> + <Creator href="/user/users/44" media-type="application/vnd.ibexa.api.User+xml" /> + <creationDate>22012-02-20T12:00:00</creationDate> + <initialLanguageCode>ger-DE</initialLanguageCode> <names> - <value languageCode="eng-GB">Custom State</value> + <value languageCode="ger-DE">Neuer Titel</value> </names> - <descriptions> - <value languageCode="eng-GB">Custom Object state</value> - </descriptions> - </ObjectStateGroup> + <Content href="/content/objects/23" media-type="application/vnd.ibexa.api.ContentInfo+xml" /> + </VersionInfo> + <Fields> + <field> + <id>1234</id> + <fieldDefinitionIdentifier>title</fieldDefinitionIdentifier> + <languageCode>ger-DE</languageCode> + <fieldValue>Neuer Titel</fieldValue> + </field> + <field> + <id>1235</id> + <fieldDefinitionIdentifier>summary</fieldDefinitionIdentifier> + <languageCode>ger-DE</languageCode> + <fieldValue>Dies ist eine neuse Zusammenfassungy</fieldValue> + </field> + <field> + <fieldDefinitionIdentifier>authors</fieldDefinitionIdentifier> + <languageCode>ger-DE</languageCode> + <fieldValue> + <authors> + <author name="Klaus Mustermann" email="klaus.mustermann@example.net" /> + </authors> + </fieldValue> + </field> + </Fields> + <Relations> + <Relation href="/content/object/32/versions/2/relations/43" media-type="application/vnd.ibexa.api.Relation+xml"> + <SourceContent href="/content/objects/23" + media-type="application/vnd.ibexa.api.ContentInfo+xml" /> + <DestinationContent href="/content/objects/45" + media-type="application/vnd.ibexa.api.ContentInfo+xml" /> + <RelationType>COMMON</RelationType> + </Relation> + </Relations> + </Version> 400: - description: Error - The input does not match the input schema definition. + 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. + description: Error - the user is not authorized to update this version. 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. + 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: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. 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 + schema: + type: string + style: simple + explode: false + - name: contentId + in: path + description: ContentVersionUpdateController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: versionNo + in: path + description: ContentVersionUpdateController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false requestBody: - description: The Object state group input schema encoded in XML or JSON format. + description: The VersionUpdate schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.ObjectStateGroupCreate+json: + application/vnd.ibexa.api.VersionUpdate+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: + $ref: '#/components/schemas/VersionUpdateWrapper' + application/vnd.ibexa.api.VersionUpdate+xml: schema: - $ref: '#/components/schemas/ObjectStateGroupCreate' - example: |- + $ref: '#/components/schemas/VersionUpdate' + example: | <?xml version="1.0" encoding="UTF-8"?> - <ObjectStateGroupCreate> - <identifier>custom</identifier> - <defaultLanguageCode>eng-GB</defaultLanguageCode> - <names> - <value languageCode="eng-GB">Custom State</value> - </names> - <descriptions> - <value languageCode="eng-GB">Custom Object state</value> - </descriptions> - </ObjectStateGroupCreate> + <VersionUpdate xmlns:p="http://ibexa.co/API/Values" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://ibexa.co/API/Values ../VersionUpdate.xsd "> + <modificationDate>2012-02-20T12:00:00</modificationDate> + <initialLanguageCode>ger-DE</initialLanguageCode> + <fields> + <field> + <id>1234</id> + <fieldDefinitionIdentifier>title</fieldDefinitionIdentifier> + <languageCode>ger-DE</languageCode> + <fieldValue>Neuer Titel</fieldValue> + </field> + <field> + <id>1235</id> + <fieldDefinitionIdentifier>summary</fieldDefinitionIdentifier> + <languageCode>ger-DE</languageCode> + <fieldValue>Dies ist eine neuse Zusammenfassungy</fieldValue> + </field> + </fields> + </VersionUpdate> required: false - deprecated: false - /content/objectstategroups/{objectStateGroupId}: + /content/objects/{contentId}/versions/{versionNo}/relations: get: - operationId: ibexa.rest.load_object_state_group + operationId: ibexa.rest.load_version_relations tags: - - Object State Groups + - Objects responses: 200: - description: OK - returns the Object state group. + description: If set, the Relation is returned in XML or JSON format. content: - application/vnd.ibexa.api.ObjectStateGroup+json: + application/vnd.ibexa.api.RelationList+json: schema: - $ref: '#/components/schemas/ObjectStateGroupWrapper' + $ref: '#/components/schemas/RelationListWrapper' 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': Custom State - descriptions: - value: - - _languageCode: eng-GB - '#text': Custom Object state - application/vnd.ibexa.api.ObjectStateGroup+xml: + 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/ObjectStateGroup' + $ref: '#/components/schemas/RelationList' example: | <?xml version="1.0" encoding="UTF-8"?> - <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/7"> - <id>7</id> - <identifier>custom-states</identifier> - <defaultLanguageCode>eng-GB</defaultLanguageCode> - <languageCodes>eng-GB</languageCodes> - <ObjectStates media-type="application/vnd.ibexa.api.ObjectStateList+xml" href="/api/ibexa/v2/content/objectstategroups/7/objectstates"/> - <names> - <value languageCode="eng-GB">Custom State</value> - </names> - <descriptions> - <value languageCode="eng-GB">Custom Object state</value> - </descriptions> - </ObjectStateGroup> + <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/107/versions/9/relations"> + <Relation media-type="application/vnd.ibexa.api.Relation+xml" href="/api/ibexa/v2/content/objects/107/versions/9/relations/7"> + <SourceContent media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/107"/> + <DestinationContent media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/52"/> + <RelationType>LINK</RelationType> + </Relation> + </Relations> 401: - description: Error - The user is not authorized to read this Object state - group. + description: Error - the user is not authorized to read this content item. 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. + 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: If-None-Match - in: header - description: ETag - required: false + - name: contentId + in: path + description: ContentVersionsRelationsListController identifier + required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: objectStateGroupId + - name: versionNo in: path - description: "" + description: ContentVersionsRelationsListController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - delete: - operationId: ibexa.rest.delete_object_state_group + post: + operationId: ibexa.rest.create_relation tags: - - Object State Groups + - Objects 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. + 201: + description: If set, the updated version is returned in XML or JSON format. + 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: | + <?xml version="1.0" encoding="UTF-8"?> + <Relation media-type="application/vnd.ibexa.api.Relation+xml" href="/api/ibexa/v2/content/objects/59/versions/2/relations/40"> + <SourceContent media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/59"/> + <DestinationContent media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/59"/> + <RelationType>COMMON</RelationType> + </Relation> + summary: Create new Relation + description: Creates a new Relation of type COMMON for the given draft. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: objectStateGroupId + - name: contentId in: path - description: "" + description: ContentRelationCreateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - patch: - operationId: ibexa.rest.update_object_state_group + - name: versionNo + in: path + description: ContentRelationCreateController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + requestBody: + description: The RelationCreate schema encoded in XML or JSON format. + 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: | + <?xml version="1.0" encoding="UTF-8"?> + <RelationCreate> + <Destination href="/api/ibexa/v2/content/objects/59"/> + </RelationCreate> + required: false + /content/objects/{contentId}/versions/{versionNo}/relations/{relationId}: + get: + operationId: ibexa.rest.load_version_relation tags: - - Object State Groups + - Objects responses: 200: - description: OK - Object stated group updated. + description: OK - loads a Relation for the given content item. content: - application/vnd.ibexa.api.ObjectStateGroup+json: + application/vnd.ibexa.api.Relation+json: schema: - $ref: '#/components/schemas/ObjectStateGroupWrapper' + $ref: '#/components/schemas/RelationWrapper' 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: + 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/ObjectStateGroup' + $ref: '#/components/schemas/Relation' example: | <?xml version="1.0" encoding="UTF-8"?> - <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/7"> - <id>7</id> - <identifier>custom-states</identifier> - <defaultLanguageCode>eng-GB</defaultLanguageCode> - <languageCodes>eng-GB</languageCodes> - <ObjectStates media-type="application/vnd.ibexa.api.ObjectStateList+xml" href="/api/ibexa/v2/content/objectstategroups/7/objectstates"/> - <names> - <value languageCode="eng-GB">New Custom State name</value> - </names> - <descriptions> - <value languageCode="eng-GB">Custom Object state</value> - </descriptions> - </ObjectStateGroup> - 400: - description: Error - The input does not match the input schema definition. + <Relation media-type="application/vnd.ibexa.api.Relation+xml" href="/api/ibexa/v2/content/objects/86/versions/1/relations/1"> + <SourceContent media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/86"/> + <DestinationContent media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/86"/> + <RelationType>COMMON</RelationType> + </Relation> 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. + 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + - name: contentId + in: path + description: ContentVersionRelationLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: If-Match - in: header - description: ETag + - name: versionNo + in: path + description: ContentVersionRelationLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: objectStateGroupId + - name: relationId in: path - description: "" + description: ContentVersionRelationLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - requestBody: - description: The Object state group input schema encoded in XML or JSON format. - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ObjectStateGroupUpdate> - <names> - <value languageCode="eng-GB">New Custom State name</value> - </names> - </ObjectStateGroupUpdate> - required: false - deprecated: false - /content/objectstategroups/{objectStateGroupId}/objectstates: - get: - operationId: ibexa.rest.load_object_states - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ObjectStateList media-type="application/vnd.ibexa.api.ObjectStateList+xml" href="/api/ibexa/v2/content/objectstategroups/2/objectstates"> - <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/2/objectstates/1"> - <id>1</id> - <identifier>not_locked</identifier> - <priority>0</priority> - <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/2"/> - <defaultLanguageCode>eng-GB</defaultLanguageCode> - <languageCodes>eng-GB</languageCodes> - <names> - <value languageCode="eng-GB">Not locked</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - </ObjectState> - <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/2/objectstates/2"> - <id>2</id> - <identifier>locked</identifier> - <priority>1</priority> - <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/2"/> - <defaultLanguageCode>eng-GB</defaultLanguageCode> - <languageCodes>eng-GB</languageCodes> - <names> - <value languageCode="eng-GB">Locked</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - </ObjectState> - </ObjectStateList> - 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: If-None-Match - in: header - description: ETag - required: false - 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: ibexa.rest.create_object_state + delete: + operationId: ibexa.rest.remove_relation tags: - - Object State Groups + - Objects 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/7/objectstates/7 - id: 7 - identifier: new-state - priority: 0 - ObjectStateGroup: - _media-type: application/vnd.ibexa.api.ObjectStateGroup+json - _href: /api/ibexa/v2/content/objectstategroups/7 - defaultLanguageCode: eng-GB - languageCodes: eng-GB - names: - value: - - _languageCode: eng-GB - '#text': New State - descriptions: - value: - - _languageCode: eng-GB - '#text': New Object State - application/vnd.ibexa.api.ObjectState+xml: - schema: - $ref: '#/components/schemas/ObjectState' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/7/objectstates/5"> - <id>5</id> - <identifier>new-state</identifier> - <priority>0</priority> - <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/7"/> - <defaultLanguageCode>eng-GB</defaultLanguageCode> - <languageCodes>eng-GB</languageCodes> - <names> - <value languageCode="eng-GB">New State</value> - </names> - <descriptions> - <value languageCode="eng-GB">New Object State</value> - </descriptions> - </ObjectState> - 400: - description: Error - The input does not match the input schema definition. + 204: + description: No Content - deleted a Relation of the given draft. 401: - description: Error - The user is not authorized to create an Object state. + description: Error - the user is not authorized to delete this Relation. 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. + 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: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: objectStateGroupId + - name: contentId in: path - description: "" + description: ContentVersionRelationDeleteController identifier required: true deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The Object state input schema encoded in XML or JSON format. - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ObjectStateCreate> - <identifier>new-state</identifier> - <priority>1</priority> - <defaultLanguageCode>eng-GB</defaultLanguageCode> - <names> - <value languageCode="eng-GB">New State</value> - </names> - <descriptions> - <value languageCode="eng-GB">New Object State</value> - </descriptions> - </ObjectStateCreate> - required: false - deprecated: false - /content/objectstategroups/{objectStateGroupId}/objectstates/{objectStateId}: - get: - operationId: ibexa.rest.load_object_state - 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/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.ObjectState+xml: - schema: - $ref: '#/components/schemas/ObjectState' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/6/objectstates/2"> - <id>2</id> - <identifier>locked</identifier> - <priority>1</priority> - <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/2"/> - <defaultLanguageCode>eng-GB</defaultLanguageCode> - <languageCodes>eng-GB</languageCodes> - <names> - <value languageCode="eng-GB">Locked</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - </ObjectState> - 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: If-None-Match - in: header - description: ETag - required: false - deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: objectStateGroupId + - name: versionNo in: path - description: "" + description: ContentVersionRelationDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: objectStateId + - name: relationId in: path - description: "" + description: ContentVersionRelationDeleteController identifier 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: ibexa.rest.delete_object_state + operationId: ibexa.rest.delete_translation_from_draft tags: - - Object State Groups + - Objects responses: 204: - description: No Content - Object state deleted. + description: No Content - removes a translation from a version draft. 401: - description: Error - The user is not authorized to delete an Object state. + 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 Object state does not exist. - summary: Delete Object state - description: Deletes provided Object state. + 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: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. 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 + - name: contentId in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false - patch: - operationId: ibexa.rest.update_object_state - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/2/objectstates/2"> - <id>2</id> - <identifier>locked</identifier> - <priority>1</priority> - <ObjectStateGroup media-type="application/vnd.ibexa.api.ObjectStateGroup+xml" href="/api/ibexa/v2/content/objectstategroups/2"/> - <defaultLanguageCode>eng-GB</defaultLanguageCode> - <languageCodes>eng-GB</languageCodes> - <names> - <value languageCode="eng-GB">New Object State name</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - </ObjectState> - 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: If-Match - in: header - description: ETag + description: ContentDraftTranslationDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: objectStateGroupId + - name: versionNo in: path - description: "" + description: ContentDraftTranslationDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: objectStateId + - name: languageCode in: path - description: "" + description: ContentDraftTranslationDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - requestBody: - description: The Object state input schema encoded in XML or JSON format. - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ObjectStateUpdate> - <priority>3</priority> - <defaultLanguageCode>eng-GB</defaultLanguageCode> - <names> - <value languageCode="eng-GB">New Object State name</value> - </names> - </ObjectStateUpdate> - required: false - deprecated: false - /content/objects: + /page/structure: get: - operationId: ibexa.rest.redirect_content + operationId: ibexa.page_builder.rest.page_structure tags: - - Objects + - Page 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. + 200: + description: The Page structure is returned in XML or JSON format. + content: + application/vnd.ibexa.api.PageStructure+json: schema: - type: string + $ref: '#/components/schemas/PageStructureWrapper' + example: + PageStructure: + _media-type: application/vnd.ibexa.api.PageStructure+json + layouts: + - _media-type: application/vnd.ibexa.api.PageStructureLayout+json + identifier: default + name: default + description: Default layout for Landing Page + zones: + - _media-type: application/vnd.ibexa.api.PageStructureZone+json + identifier: default_id + name: default + description: "" + blocks: + - _media-type: application/vnd.ibexa.api.PageStructureBlock+json + identifier: richtext + name: Text + description: Holds formatted rich text authored in the editor. + category: default + views: + - _media-type: application/vnd.ibexa.api.PageStructureView+json + identifier: default + name: Default view + description: "" + attributes: + - _media-type: application/vnd.ibexa.api.PageStructureAttribute+json + identifier: content + name: Content + type: richtext + category: default + options: [] + - _media-type: application/vnd.ibexa.api.PageStructureBlock+json + identifier: collection + name: Collection + description: Shows a hand-picked, ordered collection of content + items. + category: default + views: + - _media-type: application/vnd.ibexa.api.PageStructureView+json + identifier: default + name: Default block layout + description: "" + attributes: + - _media-type: application/vnd.ibexa.api.PageStructureAttribute+json + identifier: locationlist + name: Location list + type: locationlist + category: default + options: + match: + default: [] + application/vnd.ibexa.api.PageStructure+xml: + schema: + $ref: '#/components/schemas/PageStructure' 400: - description: Error - the required `remoteId` query parameter is missing. + description: Error - the content type given in `contentTypeIdentifier` exists, + but cannot hold a Page, because it has no field of the `ibexa_landing_page` + field type. 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. + description: Error - the identifier given in `contentTypeIdentifier` names + no existing content type. + summary: Page structure + description: Lists the layouts and blocks available for building Pages, with + the zones of every layout and the views and attributes of every block. parameters: - - name: remoteId + - name: contentTypeIdentifier in: query - description: Remote ID of the content item. - required: true + description: Identifier of a content type holding a Page. When given, only + the layouts and blocks allowed for that content type are returned. When + omitted or empty, the whole catalogue is returned. + required: false deprecated: false - allowEmptyValue: false schema: type: string style: form explode: false - allowReserved: false - deprecated: false - post: - operationId: ibexa.rest.create_content + example: landing_page + /product/catalog/products: + get: + operationId: ibexa.product_catalog.rest.products tags: - - Objects + - Product responses: - 201: - 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. + 200: + description: If set, the products are returned in XML or JSON format. content: - application/vnd.ibexa.api.Content+json: + application/vnd.ibexa.api.ProductList+json: schema: - $ref: '#/components/schemas/ContentWrapper' + $ref: '#/components/schemas/ProductListWrapper' example: - Content: - _media-type: application/vnd.ibexa.api.Content+json - _href: /api/ibexa/v2/content/objects/109 - _remoteId: 8716f007ba15f6f35139acb55e39b811 - _id: 109 - ContentType: - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/2 - Name: draft article - TranslatedName: draft article - Versions: - _media-type: application/vnd.ibexa.api.VersionList+json - _href: /api/ibexa/v2/content/objects/109/versions - CurrentVersion: - _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/109/currentversion - Version: - _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/109/versions/1 - VersionInfo: - id: 587 - versionNo: 1 - status: DRAFT - modificationDate: "2023-05-24T06:27:54+00:00" - Creator: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - creationDate: "2023-05-24T06:27:54+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': draft article - Content: - _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/109 - Fields: - field: - - id: 488 - fieldDefinitionIdentifier: title - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: draft article - - id: 489 - fieldDefinitionIdentifier: short_title - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: ~ - - id: 490 - fieldDefinitionIdentifier: author - languageCode: eng-GB - fieldTypeIdentifier: ibexa_author - fieldValue: [] - - id: 491 - fieldDefinitionIdentifier: intro - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>draft draft</para></section> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft</p></section> - - id: 492 - fieldDefinitionIdentifier: body - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>draft draft draft</para></section> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft draft</p></section> - - id: 493 - fieldDefinitionIdentifier: enable_comments - languageCode: eng-GB - fieldTypeIdentifier: ibexa_boolean - fieldValue: false - - id: 494 - fieldDefinitionIdentifier: image - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: ~ - Relations: - _media-type: application/vnd.ibexa.api.RelationList+json - _href: /api/ibexa/v2/content/objects/109/versions/1/relations - Relation: [] - Thumbnail: - _media-type: application/vnd.ibexa.api.Thumbnail+json - resource: /placeholder - width: ~ - height: ~ - 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/109/locations - Owner: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - mainLanguageCode: eng-GB - currentVersionNo: 1 - alwaysAvailable: true - isHidden: false - status: DRAFT - ObjectStates: - _media-type: application/vnd.ibexa.api.ContentObjectStates+json - _href: /api/ibexa/v2/content/objects/109/objectstates - application/vnd.ibexa.api.Content+xml: - schema: - $ref: '#/components/schemas/Content' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/108" remoteId="25c5c35ab9d18e88bd2ee77991b730e2" id="108"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"/> - <Name>draft article</Name> - <TranslatedName>draft article</TranslatedName> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/108/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/108/currentversion"> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/108/versions/1"> - <VersionInfo> - <id>586</id> - <versionNo>1</versionNo> - <status>DRAFT</status> - <modificationDate>2023-05-24T06:24:46+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <creationDate>2023-05-24T06:24:46+00:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">draft article</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/108"/> - </VersionInfo> - <Fields> - <field> - <id>481</id> - <fieldDefinitionIdentifier>title</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>draft article</fieldValue> - </field> - <field> - <id>482</id> - <fieldDefinitionIdentifier>short_title</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue/> - </field> - <field> - <id>483</id> - <fieldDefinitionIdentifier>author</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_author</fieldTypeIdentifier> - <fieldValue/> - </field> - <field> - <id>484</id> - <fieldDefinitionIdentifier>intro</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> - <fieldValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>draft draft</para></section> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft</p></section> - </value> - </fieldValue> - </field> - <field> - <id>485</id> - <fieldDefinitionIdentifier>body</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> - <fieldValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>draft draft draft</para></section> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft draft</p></section> - </value> - </fieldValue> - </field> - <field> - <id>486</id> - <fieldDefinitionIdentifier>enable_comments</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_boolean</fieldTypeIdentifier> - <fieldValue>false</fieldValue> - </field> - <field> - <id>487</id> - <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_object_relation</fieldTypeIdentifier> - <fieldValue> - <value key="destinationContentId"/> - </fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/108/versions/1/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/placeholder</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - </CurrentVersion> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/108/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>1</currentVersionNo> - <alwaysAvailable>true</alwaysAvailable> - <isHidden>false</isHidden> - <status>DRAFT</status> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/108/objectstates"/> - </Content> - application/vnd.ibexa.api.ContentInfo+json: - schema: - $ref: '#/components/schemas/ContentInfoWrapper' - example: - Content: - _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/77 - _remoteId: 89e9b86c673b1c1de6781bb94488b18c - _id: 77 - ContentType: - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/2 - Name: draft article - TranslatedName: draft article - Versions: - _media-type: application/vnd.ibexa.api.VersionList+json - _href: /api/ibexa/v2/content/objects/77/versions - CurrentVersion: - _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/77/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/77/locations - Owner: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - mainLanguageCode: eng-GB - currentVersionNo: 1 - alwaysAvailable: true - isHidden: false - status: DRAFT - ObjectStates: - _media-type: application/vnd.ibexa.api.ContentObjectStates+json - _href: /api/ibexa/v2/content/objects/77/objectstates - application/vnd.ibexa.api.ContentInfo+xml: - schema: - $ref: '#/components/schemas/ContentInfo' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/110" remoteId="59258c7a8c545db8a641742138d11d82" id="110"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"/> - <Name>draft article</Name> - <TranslatedName>draft article</TranslatedName> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/110/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/110/currentversion"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/110/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>1</currentVersionNo> - <alwaysAvailable>true</alwaysAvailable> - <isHidden>false</isHidden> - <status>DRAFT</status> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/110/objectstates"/> - </Content> - 400: - description: Error - the input does not match the input schema definition - or the validation on a field fails. + 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: ~ + height: ~ + 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: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + - id: 615 + fieldDefinitionIdentifier: image + languageCode: eng-GB + fieldTypeIdentifier: ibexa_image_asset + fieldValue: + destinationContentId: ~ + alternativeText: ~ + source: ~ + 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: ~ + height: ~ + 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: ~ + height: ~ + mimeType: image/svg+xml + created_at: 1645787893 + updated_at: 1645787893 + AttributesList: [] 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false + 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: [] requestBody: - description: The ContentCreate schema encoded in XML or JSON format. + description: The product list schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.ContentCreate+json: + application/vnd.ibexa.api.ProductListGet+json: schema: - $ref: '#/components/schemas/ContentCreateWrapper' + $ref: '#/components/schemas/ProductListGetWrapper' 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: <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft - draft</p></section> - - fieldDefinitionIdentifier: body - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft - draft draft </p></section> - application/vnd.ibexa.api.ContentCreate+xml: - schema: - $ref: '#/components/schemas/ContentCreate' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <ContentCreate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> - <ContentType href="/api/ibexa/v2/content/types/2"/> - <mainLanguageCode>eng-GB</mainLanguageCode> - <LocationCreate> - <ParentLocation href="/api/ibexa/v2/content/locations/1/2"/> - <priority>0</priority> - <hidden>false</hidden> - <sortField>PATH</sortField> - <sortOrder>ASC</sortOrder> - </LocationCreate> - <Section href="/api/ibexa/v2/content/sections/1"/> - <alwaysAvailable>true</alwaysAvailable> - <remoteId></remoteId> - <fields> - <field> - <fieldDefinitionIdentifier>title</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldValue>draft article</fieldValue> - </field> - <field> - <fieldDefinitionIdentifier>intro</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldValue> - <value key="xml"><![CDATA[<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft</p></section>]]></value> - </fieldValue> - </field> - <field> - <fieldDefinitionIdentifier>body</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldValue> - <value key="xml"><![CDATA[<section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft draft</p></section>]]></value> - </fieldValue> - </field> - </fields> - </ContentCreate> + ProductListGet: + offset: 0 + limit: 10 + languages: + - eng-GB required: false - deprecated: false - /content/objects/{contentId}: - get: - operationId: ibexa.rest.load_content + /product/catalog/products/view: + post: + operationId: ibexa.product_catalog.rest.products.view tags: - - Objects + - Product responses: 200: - description: OK - returns the Content or ContentInfo in XML or JSON format. + description: The view in XML or JSON format. content: - application/vnd.ibexa.api.Content+json: + application/vnd.ibexa.api.ProductView+json: schema: - $ref: '#/components/schemas/ContentWrapper' + $ref: '#/components/schemas/ProductViewWrapper' 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 + 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: ~ + - _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: ~ + value: ~ 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: ~ - - id: 251 - fieldDefinitionIdentifier: short_description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - id: 252 - fieldDefinitionIdentifier: description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - 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: ~ - height: ~ - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/54" remoteId="9e863fbb0fb835ce050032b4f00de61d" id="54"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"/> - <Name>Forms</Name> - <TranslatedName>Forms</TranslatedName> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/54/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/54/currentversion"> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/54/versions/1"> - <VersionInfo> - <id>514</id> - <versionNo>1</versionNo> - <status>PUBLISHED</status> - <modificationDate>2018-09-17T06:48:13+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <creationDate>2018-09-17T06:48:13+00:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Forms</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/54"/> - </VersionInfo> - <Fields> - <field> - <id>249</id> - <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Forms</fieldValue> - </field> - <field> - <id>250</id> - <fieldDefinitionIdentifier>short_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue/> - </field> - <field> - <id>251</id> - <fieldDefinitionIdentifier>short_description</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> - <fieldValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </fieldValue> - </field> - <field> - <id>252</id> - <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> - <fieldValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/54/versions/1/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/bundles/ezplatformadminui/img/ez-icons.svg#folder</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - </CurrentVersion> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/6"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/55"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/54/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <lastModificationDate>2018-09-17T06:48:13+00:00</lastModificationDate> - <publishedDate>2018-09-17T06:48:13+00:00</publishedDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>1</currentVersionNo> - <alwaysAvailable>false</alwaysAvailable> - <isHidden>false</isHidden> - <status>PUBLISHED</status> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/54/objectstates"/> - </Content> - application/vnd.ibexa.api.ContentInfo+json: - schema: - $ref: '#/components/schemas/ContentInfoWrapper' - 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).\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." - parameters: - - 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: ibexa.rest.delete_content - 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - 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: ibexa.rest.update_content_metadata - tags: - - Objects - responses: - 200: - description: If set, all information for the content item (excluding the - current version) is returned in XML or JSON format. - content: - application/vnd.ibexa.api.ContentInfo+json: - schema: - $ref: '#/components/schemas/ContentInfoWrapper' - application/vnd.ibexa.api.ContentInfo+xml: - schema: - $ref: '#/components/schemas/ContentInfo' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/80" remoteId="69848aeb86164c35e5c98202eebe9e05" id="80"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"/> - <Name>article1</Name> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/80/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/80/currentversion"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/63/66"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/80/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/11"/> - <lastModificationDate>2019-02-19T15:00:34+01:00</lastModificationDate> - <publishedDate>2019-02-19T15:00:34+01:00</publishedDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>1</currentVersionNo> - <alwaysAvailable>false</alwaysAvailable> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/80/objectstates"/> - </Content> - 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - 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: contentId - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The ContentUpdate schema encoded in XML or JSON format. - content: - application/vnd.ibexa.api.ContentUpdate+json: - schema: - $ref: '#/components/schemas/ContentInfoWrapper' - application/vnd.ibexa.api.ContentUpdate+xml: - schema: - $ref: '#/components/schemas/ContentInfo' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <ContentUpdate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <Section href="/api/ibexa/v2/content/sections/1"/> - <MainLocation href="/api/ibexa/v2/content/locations/2/63/66"/> - <Owner href="/api/ibexa/v2/user/users/11"/> - <alwaysAvailable>false</alwaysAvailable> - <remoteId>69848aeb86164c35e5c98202eebe9e05</remoteId> - </ContentUpdate> - required: false - deprecated: false - /content/objects/{contentId}/currentversion: - get: - operationId: ibexa.rest.redirect_current_version - tags: - - Objects - responses: - 200: - description: OK - returns the Version in XML or JSON format. - 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/2 - VersionInfo: - id: 578 - versionNo: 2 - status: PUBLISHED - modificationDate: "2023-05-24T05:59:09+00:00" - Creator: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - creationDate: "2023-05-24T05:59:02+00:00" - initialLanguageCode: eng-GB - languageCodes: eng-GB - VersionTranslationInfo: - _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json - Language: - - languageCode: eng-GB - names: - value: - - _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: ~ - - id: 479 - fieldDefinitionIdentifier: short_description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - id: 480 - fieldDefinitionIdentifier: description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - Relations: - _media-type: application/vnd.ibexa.api.RelationList+json - _href: /api/ibexa/v2/content/objects/107/versions/2/relations - Relation: [] - Thumbnail: - _media-type: application/vnd.ibexa.api.Thumbnail+json - resource: /placeholder - width: ~ - height: ~ - mimeType: image/svg+xml - application/vnd.ibexa.api.Version+xml: + _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: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + - id: 304 + fieldDefinitionIdentifier: image + languageCode: eng-GB + fieldTypeIdentifier: ibexa_image_asset + fieldValue: + destinationContentId: ~ + alternativeText: ~ + source: ~ + - 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: ~ + height: ~ + 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: ~ + height: ~ + 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: ~ + value: ~ + 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: ~ + - _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: ~ + value: ~ + 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: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + - id: 298 + fieldDefinitionIdentifier: image + languageCode: eng-GB + fieldTypeIdentifier: ibexa_image_asset + fieldValue: + destinationContentId: ~ + alternativeText: ~ + source: ~ + - 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: ~ + height: ~ + 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: ~ + height: ~ + 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: ~ + value: ~ + 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/Version' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/107/versions/2"> - <VersionInfo> - <id>578</id> - <versionNo>2</versionNo> - <status>PUBLISHED</status> - <modificationDate>2023-05-24T05:59:09+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <creationDate>2023-05-24T05:59:02+00:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Features</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/107"/> - </VersionInfo> - <Fields> - <field> - <id>477</id> - <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Features</fieldValue> - </field> - <field> - <id>478</id> - <fieldDefinitionIdentifier>short_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue/> - </field> - <field> - <id>479</id> - <fieldDefinitionIdentifier>short_description</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> - <fieldValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </fieldValue> - </field> - <field> - <id>480</id> - <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> - <fieldValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/107/versions/2/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/placeholder</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - 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. + $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: contentId - in: path - description: "" + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - post: - operationId: ibexa.rest.content.create_draft_from_current_version + requestBody: + description: The view input in XML or JSON format. + 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: ~ + application/vnd.ibexa.api.ProductViewInput+xml: + schema: + $ref: '#/components/schemas/ProductViewInput' + required: false + /product/catalog/products/{code}: + get: + operationId: ibexa.product_catalog.rest.product tags: - - Objects + - Product responses: - 201: - description: Created + 200: + description: If set, the products are returned in XML or JSON format. content: - application/vnd.ibexa.api.Version+json: + application/vnd.ibexa.api.Product+json: schema: - $ref: '#/components/schemas/VersionWrapper' + $ref: '#/components/schemas/ProductWrapper' 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: + Product: + _media-type: application/vnd.ibexa.api.Product+json + code: DRESUN + name: Yellow sundress + ProductType: + _media-type: application/vnd.ibexa.api.ProductType+json + identifier: dress + name: Dress + AttributeAssignmentList: + - _media-type: application/vnd.ibexa.api.AttributeAssignment+json + is_required: false + is_discriminator: false + Attribute: + _media-type: application/vnd.ibexa.api.Attribute+json + identifier: size + name: Size + description: "" + type: Integer + type_identifier: integer + value: 5 + group: Hat + position: 0 + options: [] + 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: Yellow sundress + TranslatedName: Yellow sundress + 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': Yellow sundress + 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: Yellow sundress + - id: 613 + fieldDefinitionIdentifier: product_specification + languageCode: eng-GB + fieldTypeIdentifier: ibexa_product_specification + fieldValue: + id: 25 + code: DRESUN + attributes: + - 10 + - id: 614 + fieldDefinitionIdentifier: description + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + - id: 615 + fieldDefinitionIdentifier: image + languageCode: eng-GB + fieldTypeIdentifier: ibexa_image_asset + fieldValue: + destinationContentId: ~ + alternativeText: ~ + source: ~ + 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: ~ + height: ~ + 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 - 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: ~ - - id: 479 - fieldDefinitionIdentifier: short_description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - id: 480 - fieldDefinitionIdentifier: description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - Relations: - _media-type: application/vnd.ibexa.api.RelationList+json - _href: /api/ibexa/v2/content/objects/107/versions/5/relations - Relation: [] + 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: /placeholder + resource: /bundles/ibexaadminui/img/ibexa-icons.svg#file width: ~ height: ~ mimeType: image/svg+xml - application/vnd.ibexa.api.Version+xml: - schema: - $ref: '#/components/schemas/Version' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/107/versions/5"> - <VersionInfo> - <id>581</id> - <versionNo>5</versionNo> - <status>ARCHIVED</status> - <modificationDate>2023-05-24T06:11:50+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <creationDate>2023-05-24T06:09:49+00:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Features</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/107"/> - </VersionInfo> - <Fields> - <field> - <id>477</id> - <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Features</fieldValue> - </field> - <field> - <id>478</id> - <fieldDefinitionIdentifier>short_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue/> - </field> - <field> - <id>479</id> - <fieldDefinitionIdentifier>short_description</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> - <fieldValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </fieldValue> - </field> - <field> - <id>480</id> - <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> - <fieldValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/107/versions/5/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/placeholder</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - 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: No payload required - content: [] - required: false - deprecated: false - /content/objects/{contentId}/hide: - post: - operationId: ibexa.rest.hide_content - tags: - - Objects - responses: - 204: - description: OK - Object item is hidden. + created_at: 1647006758 + updated_at: 1647006758 + AttributesList: + - _media-type: application/vnd.ibexa.api.Attribute+json + identifier: size + name: Size + description: "" + type: Integer + type_identifier: integer + value: 5 + group: Clothes + position: 0 + options: [] 401: - description: Error - The user has no permission to change Object item visibility. + description: Error - the user is not authorized to view this product. 404: - description: Error - The content item was not found. - summary: Hide content item - description: Makes or keep the content item invisible + description: Error - no product with the given code exists. + summary: Load the given product + description: Loads the given product. parameters: - - name: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: contentId + - name: code in: path - description: "" + description: ProductLoadByCodeController identifier 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 - /content/objects/{contentId}/locations: - get: - operationId: ibexa.rest.load_locations_for_content - tags: - - Objects - responses: - 200: - description: If set, the Location list is returned in XML or JSON format. - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <LocationList media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/63/locations"> - <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/57/65"/> - </LocationList> - 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: If-None-Match - in: header - description: ETag + description: An optional product schema encoded in XML or JSON format. + content: + application/vnd.ibexa.api.ProductGet+json: + schema: + $ref: '#/components/schemas/ProductGetWrapper' + example: + ProductGet: + languages: + - eng-GB 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: string - style: simple - explode: false - allowReserved: false - deprecated: false - post: - operationId: ibexa.rest.create_location + patch: + operationId: ibexa.product_catalog.rest.products.update tags: - - Objects + - Product responses: 201: - description: If set, the new Location is returned in XML or JSON format. + description: If set, the updated product is returned in XML or JSON format. content: - application/vnd.ibexa.api.Location+json: + application/vnd.ibexa.api.Product+json: schema: - $ref: '#/components/schemas/LocationWrapper' + $ref: '#/components/schemas/ProductWrapper' 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: + Product: + _media-type: application/vnd.ibexa.api.Product+json + code: bbbb + name: fgh + ProductType: + _media-type: application/vnd.ibexa.api.ProductType+json + identifier: test_pt321 + name: New Product Type + AttributeAssignmentList: + - _media-type: application/vnd.ibexa.api.AttributeAssignment+json + is_required: false + is_discriminator: true + Attribute: + _media-type: application/vnd.ibexa.api.Attribute+json + identifier: testAttr + name: testAttr + description: "" + type: Checkbox + type_identifier: checkbox + value: true + group: Test Attribute group + position: 0 + options: [] + 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: fgh + TranslatedName: fgh + 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/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: | - <?xml version="1.0" encoding="UTF-8"?> - <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/42/96"> - <id>96</id> - <priority>0</priority> - <hidden>false</hidden> - <invisible>true</invisible> - <explicitlyHidden>false</explicitlyHidden> - <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/42"/> - <pathString>/1/2/42/96/</pathString> - <depth>3</depth> - <childCount>0</childCount> - <remoteId>58133c8c75230e5debe362a28b92d27a</remoteId> - <Children media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/2/42/96/children"/> - <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/63"/> - <sortField>PATH</sortField> - <sortOrder>ASC</sortOrder> - <UrlAliases media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/42/96/urlaliases"/> - <ContentInfo media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/63"> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/63" remoteId="211e99934c8fef5900e4813b96ec5c87" id="63"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"/> - <Name>Art3</Name> - <TranslatedName>Art3</TranslatedName> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/63/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/63/currentversion"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/63/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <lastModificationDate>2021-06-28T11:34:17+00:00</lastModificationDate> - <publishedDate>2021-06-28T11:34:17+00:00</publishedDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>1</currentVersionNo> - <alwaysAvailable>false</alwaysAvailable> - <isHidden>false</isHidden> - <status>PUBLISHED</status> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/63/objectstates"/> - </Content> - </ContentInfo> - </Location> + _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': fgh + 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: fgh + - id: 613 + fieldDefinitionIdentifier: product_specification + languageCode: eng-GB + fieldTypeIdentifier: ibexa_product_specification + fieldValue: + id: 25 + code: bbbb + attributes: + - 10 + - id: 614 + fieldDefinitionIdentifier: description + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + - id: 615 + fieldDefinitionIdentifier: image + languageCode: eng-GB + fieldTypeIdentifier: ibexa_image_asset + fieldValue: + destinationContentId: ~ + alternativeText: ~ + source: ~ + 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: ~ + height: ~ + 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: ~ + height: ~ + mimeType: image/svg+xml + created_at: 1646398748 + updated_at: 1646398748 + AttributesList: + - _media-type: application/vnd.ibexa.api.Attribute+json + identifier: testAttr + name: testAttr + description: "" + type: Checkbox + type_identifier: checkbox + value: true + group: Test Attribute group + position: 0 + options: [] + - _media-type: application/vnd.ibexa.api.Attribute+json + identifier: nnnn + name: nnnn + description: "" + type: Checkbox + type_identifier: checkbox + value: true + group: Test 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 Location. + description: Error - the user is not authorized to update this product. 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. + 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + - name: code + in: path + description: ProductUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: contentId - in: path - description: "" + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The LocationCreate schema encoded in XML or JSON format. + description: If set, the updated product is returned in XML or JSON format. content: - application/vnd.ibexa.api.LocationCreate+json: + application/vnd.ibexa.api.ProductUpdate+json: schema: - $ref: '#/components/schemas/LocationCreateWrapper' + $ref: '#/components/schemas/ProductUpdateWrapper' 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: | - <?xml version="1.0" encoding="UTF-8"?> - <LocationCreate> - <ParentLocation href="/api/ibexa/v2/content/locations/1/42" /> - <priority>0</priority> - <hidden>false</hidden> - <sortField>PATH</sortField> - <sortOrder>ASC</sortOrder> - </LocationCreate> + 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 - /content/objects/{contentId}/objectstates: + /product/catalog/products/{code}/prices: get: - operationId: ibexa.rest.get_object_states_for_content + operationId: ibexa.product_catalog.rest.prices.list tags: - - Objects + - Product responses: 200: - description: OK - returns the Object state. + description: OK - loads the list of product prices. content: - application/vnd.ibexa.api.ContentObjectStates+json: + application/vnd.ibexa.api.PriceList+json: schema: - $ref: '#/components/schemas/ContentObjectStates' + $ref: '#/components/schemas/PriceListWrapper' 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ContentObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml"> - <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/2/objectstates/1"/> - <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/3/objectstates/3"/> - <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/7/objectstates/7"/> - <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/8/objectstates/8"/> - </ContentObjectStates> - 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 + 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: If-None-Match - in: header - description: ETag - required: false - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: contentId + - name: code in: path - description: "" + description: PriceLoadAllController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - patch: - operationId: ibexa.rest.set_object_states_for_content + post: + operationId: ibexa.product_catalog.rest.prices.create tags: - - Objects + - Product responses: - 204: - description: OK - Object state updated. + 200: + description: OK - creates product price. content: - application/vnd.ibexa.api.ContentObjectStates+json: + application/vnd.ibexa.api.CustomPrice+json: schema: - $ref: '#/components/schemas/ContentObjectStatesWrapper' + $ref: '#/components/schemas/CustomPriceWrapper' 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/2 - application/vnd.ibexa.api.ContentObjectStates+xml: + CustomPrice: + _media-type: application/vnd.ibexa.api.CustomPrice+json + id: 5 + amount: "15.00" + base_amount: "25.00" + Currency: + _media-type: application/vnd.ibexa.api.Currency+json + id: 2 + code: EUR + subunits: 2 + enabled: true + money: "1500" + base_money: "2500" + custom_money: "1500" + custom_amount: "15.00" + application/vnd.ibexa.api.Price+json: schema: - $ref: '#/components/schemas/ContentObjectStates' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <ContentObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml"> - <ObjectState media-type="application/vnd.ibexa.api.ObjectState+xml" href="/api/ibexa/v2/content/objectstategroups/2/objectstates/2"/> - </ContentObjectStates> + $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. + 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. + 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + - name: code + in: path + description: PriceCreateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: If-Match + - name: X-CSRF-Token in: header - description: ETag - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: contentId - in: path - description: "" + description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The content item Object states input schema encoded in XML or - JSON format. + description: The product price schema encoded in JSON format. content: - application/vnd.ibexa.api.ContentObjectStates+json: + application/vnd.ibexa.api.CustomPriceCreateStruct+json: schema: - $ref: '#/components/schemas/ContentObjectStatesWrapper' + $ref: '#/components/schemas/CustomPriceCreateStructWrapper' example: - ContentObjectStates: - ObjectState: - - _href: /api/ibexa/v2/content/objectstategroups/2/objectstates/2 - application/vnd.ibexa.api.ContentObjectStates+xml: + CustomPriceCreateStruct: + customerGroup: test + amount: 2500 + customAmount: 1500 + currency: EUR + application/vnd.ibexa.api.PriceCreateStruct+json: schema: - $ref: '#/components/schemas/ContentObjectStates' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <ContentObjectStates> - <ObjectState href="/api/ibexa/v2/content/objectstategroups/2/objectstates/2" /> - </ContentObjectStates> + $ref: '#/components/schemas/PriceCreateStructWrapper' + example: + PriceCreateStruct: + amount: 9 + currency: CHF required: false - deprecated: false - /content/objects/{contentId}/relations: + /product/catalog/products/{code}/prices/{currencyCode}: get: - operationId: ibexa.rest.redirect_current_version_relations + operationId: ibexa.product_catalog.rest.prices.get.base_price tags: - - Objects + - Product 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: ibexa.rest.reveal_content - tags: - - Objects - responses: - 204: - description: OK - Object item is revealed. + 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: 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" 401: - description: Error - The user has no permission to change Object item visibility. + description: Error - the user has no permission to read prices. 404: - description: Error - The content item was not found. - summary: Reveal content item - description: Makes or keep the content item visible + description: Error - the price does not exist. + summary: Get price in given currency + description: Get price in given currency. parameters: - - name: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + - name: code + in: path + description: PriceLoadByProductCodeController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: contentId + - name: currencyCode in: path - description: "" + description: PriceLoadByProductCodeController identifier 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 - /content/objects/{contentId}/translations/{languageCode}: - delete: - operationId: ibexa.rest.delete_content_translation + /product/catalog/products/{code}/prices/{currencyCode}/customer-group/{customerGroupIdentifier}: + get: + operationId: ibexa.product_catalog.rest.prices.get.custom_price tags: - - Objects + - Product responses: - 204: - description: No Content + 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: "11.50" + base_amount: "10.00" + Currency: + _media-type: application/vnd.ibexa.api.Currency+json + id: 5 + code: USD + subunits: 2 + enabled: true + money: "1150" + base_money: "1000" + custom_money: "1150" + custom_amount: "11.50" + custom_rule: "15.00" 401: - description: Error - the user is not authorized to delete content item (content/remove - policy). + description: Error - the user has no permission to read prices. 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. + 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + - name: code + in: path + description: PriceLoadByProductCodeController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: contentId + - name: currencyCode in: path - description: "" + description: PriceLoadByProductCodeController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: languageCode + - name: customerGroupIdentifier in: path - description: "" + description: PriceLoadByProductCodeController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - /content/objects/{contentId}/versions: - get: - operationId: ibexa.rest.load_content_versions + /product/catalog/products/{code}/prices/{id}: + delete: + operationId: ibexa.product_catalog.rest.prices.delete tags: - - Objects + - Product responses: 200: - description: If set, the version list is returned in XML or JSON format. - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <VersionList media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/61/versions"> - <VersionItem> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/61/versions/1"/> - <VersionInfo> - <id>521</id> - <versionNo>1</versionNo> - <status>PUBLISHED</status> - <modificationDate>2021-06-28T11:33:49+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <creationDate>2021-06-28T11:33:31+00:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Art1</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/61"/> - </VersionInfo> - </VersionItem> - <VersionItem> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/61/versions/2"/> - <VersionInfo> - <id>580</id> - <versionNo>2</versionNo> - <status>DRAFT</status> - <modificationDate>2021-07-26T08:10:02+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <creationDate>2021-07-26T08:10:02+00:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Art1</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/61"/> - </VersionInfo> - </VersionItem> - <VersionItem> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/61/versions/3"/> - <VersionInfo> - <id>581</id> - <versionNo>3</versionNo> - <status>DRAFT</status> - <modificationDate>2021-07-26T08:16:50+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <creationDate>2021-07-26T08:16:50+00:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Art1</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/61"/> - </VersionInfo> - </VersionItem> - </VersionList> + description: No content - the given price is deleted. 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. + description: Error - the user is not authorized to delete this price. + summary: Delete product price + description: Deletes product price. parameters: - - name: contentId + - name: code in: path - description: "" + description: PriceDeleteController identifier required: true deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false - /content/objects/{contentId}/versions/{versionNo}: - get: - operationId: ibexa.rest.load_content_in_version - tags: - - Objects - responses: - 200: - description: If set, the version list is returned in XML or JSON format. - 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: ~ - - id: 479 - fieldDefinitionIdentifier: short_description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - id: 480 - fieldDefinitionIdentifier: description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - 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: ~ - height: ~ - mimeType: image/svg+xml - application/vnd.ibexa.api.Version+xml: - schema: - $ref: '#/components/schemas/Version' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/107/versions/5"> - <VersionInfo> - <id>581</id> - <versionNo>5</versionNo> - <status>ARCHIVED</status> - <modificationDate>2023-05-24T06:11:50+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <creationDate>2023-05-24T06:09:49+00:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Features</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/107"/> - </VersionInfo> - <Fields> - <field> - <id>477</id> - <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Features</fieldValue> - </field> - <field> - <id>478</id> - <fieldDefinitionIdentifier>short_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue/> - </field> - <field> - <id>479</id> - <fieldDefinitionIdentifier>short_description</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> - <fieldValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </fieldValue> - </field> - <field> - <id>480</id> - <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> - <fieldValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/107/versions/5/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/placeholder</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - 304: - description: Not Modified - the ETag matches 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: false - deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: contentId + - name: id in: path - description: "" + description: PriceDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: versionNo - in: path - description: "" + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - post: - operationId: ibexa.rest.content.create_draft_from_version + patch: + operationId: ibexa.product_catalog.rest.prices.update tags: - - Objects + - Product responses: - 201: - description: Created. + 200: + description: OK - updates product price. content: - application/vnd.ibexa.api.Version+json: + application/vnd.ibexa.api.CustomPrice+json: schema: - $ref: '#/components/schemas/VersionWrapper' + $ref: '#/components/schemas/CustomPriceWrapper' 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: ~ - - id: 479 - fieldDefinitionIdentifier: short_description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - id: 480 - fieldDefinitionIdentifier: description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - 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: ~ - height: ~ - mimeType: image/svg+xml - application/vnd.ibexa.api.Version+xml: + 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: ~ + application/vnd.ibexa.api.Price+json: schema: - $ref: '#/components/schemas/Version' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/107/versions/5"> - <VersionInfo> - <id>581</id> - <versionNo>5</versionNo> - <status>ARCHIVED</status> - <modificationDate>2023-05-24T06:11:50+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <creationDate>2023-05-24T06:09:49+00:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Features</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/107"/> - </VersionInfo> - <Fields> - <field> - <id>477</id> - <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Features</fieldValue> - </field> - <field> - <id>478</id> - <fieldDefinitionIdentifier>short_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue/> - </field> - <field> - <id>479</id> - <fieldDefinitionIdentifier>short_description</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> - <fieldValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </fieldValue> - </field> - <field> - <id>480</id> - <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_richtext</fieldTypeIdentifier> - <fieldValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/107/versions/5/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/placeholder</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> + $ref: '#/components/schemas/PriceWrapper' + example: + Price: + _media-type: application/vnd.ibexa.api.Price+json + id: 2 + amount: "35.00" + base_amount: "35.00" + Currency: + _media-type: application/vnd.ibexa.api.Currency+json + id: 5 + code: USD + subunits: 2 + enabled: true + money: "3500" + base_money: "3500" + 400: + description: Error - the input does not match the input schema definition. 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. + description: Error - the user is not authorized to update this price. + summary: Update product price + description: Updates product price. parameters: - - name: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + - name: code + in: path + description: PriceUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: contentId + - name: id in: path - description: "" + description: PriceUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: versionNo - in: path - description: "" + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: No payload required - content: [] + description: Update price or custom price for given currency. + 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: ibexa.rest.delete_content_version + operationId: ibexa.product_catalog.rest.products.delete tags: - - Objects + - Product responses: 204: - description: No Content - the version is deleted. - 404: - description: Error - the content item or version were not found. + description: No content - the given product is deleted. 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. + description: Error - the user is not authorized to delete this product. + summary: Delete product + description: Deletes the given product. parameters: - - name: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: contentId + - name: identifier in: path - description: "" + description: ProductDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: versionNo - in: path - description: "" + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - patch: - operationId: ibexa.rest.update_version + /product/catalog/products/{productTypeIdentifier}: + post: + operationId: ibexa.product_catalog.rest.products.create tags: - - Objects + - Product responses: - 200: - description: If set, the updated version is returned in XML or JSON format. + 201: + description: If set, the new product is returned in XML or JSON format. content: - application/vnd.ibexa.api.Version+json: + application/vnd.ibexa.api.ProductCreate+json: schema: - $ref: '#/components/schemas/VersionWrapper' + $ref: '#/components/schemas/ProductWrapper' 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: + 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: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + - id: 615 + fieldDefinitionIdentifier: image + languageCode: eng-GB + fieldTypeIdentifier: ibexa_image_asset + fieldValue: + destinationContentId: ~ + alternativeText: ~ + source: ~ + 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: ~ + height: ~ + 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 - 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: ~ - - id: 479 - fieldDefinitionIdentifier: short_description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - id: 480 - fieldDefinitionIdentifier: description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - Relations: - _media-type: application/vnd.ibexa.api.RelationList+json - _href: /api/ibexa/v2/content/objects/107/versions/5/relations - Relation: [] + 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: /placeholder + resource: /bundles/ibexaadminui/img/ibexa-icons.svg#file width: ~ height: ~ mimeType: image/svg+xml - application/vnd.ibexa.api.Version+xml: - schema: - $ref: '#/components/schemas/Version' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <Version href="/content/objects/23/versions/4" media-type="application/vnd.ibexa.api.Version+xml"> - <VersionInfo> - <id>45</id> - <versionNo>4</versionNo> - <status>DRAFT</status> - <modificationDate>2012-02-20T12:00:00</modificationDate> - <Creator href="/user/users/44" media-type="application/vnd.ibexa.api.User+xml" /> - <creationDate>22012-02-20T12:00:00</creationDate> - <initialLanguageCode>ger-DE</initialLanguageCode> - <names> - <value languageCode="ger-DE">Neuer Titel</value> - </names> - <Content href="/content/objects/23" media-type="application/vnd.ibexa.api.ContentInfo+xml" /> - </VersionInfo> - <Fields> - <field> - <id>1234</id> - <fieldDefinitionIdentifier>title</fieldDefinitionIdentifier> - <languageCode>ger-DE</languageCode> - <fieldValue>Neuer Titel</fieldValue> - </field> - <field> - <id>1235</id> - <fieldDefinitionIdentifier>summary</fieldDefinitionIdentifier> - <languageCode>ger-DE</languageCode> - <fieldValue>Dies ist eine neuse Zusammenfassungy</fieldValue> - </field> - <field> - <fieldDefinitionIdentifier>authors</fieldDefinitionIdentifier> - <languageCode>ger-DE</languageCode> - <fieldValue> - <authors> - <author name="Klaus Mustermann" email="klaus.mustermann@example.net" /> - </authors> - </fieldValue> - </field> - </Fields> - <Relations> - <Relation href="/content/object/32/versions/2/relations/43" media-type="application/vnd.ibexa.api.Relation+xml"> - <SourceContent href="/content/objects/23" - media-type="application/vnd.ibexa.api.ContentInfo+xml" /> - <DestinationContent href="/content/objects/45" - media-type="application/vnd.ibexa.api.ContentInfo+xml" /> - <RelationType>COMMON</RelationType> - </Relation> - </Relations> - </Version> + 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 version. + description: Error - the user is not authorized to update this product. 403: - description: Error - the version is not allowed to change - i.e. version - is not a DRAFT. + description: Error - a product with the same name already exists. 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. + description: Error - no product with the given code exists. + summary: Create product + description: Creates a new product. parameters: - - name: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + - name: productTypeIdentifier + in: path + description: ProductCreateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: If-match + - name: X-CSRF-Token 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: contentId - in: path - description: "" + description: The CSRF token is required when passing user session. 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 VersionUpdate schema encoded in XML or JSON format. + description: The product schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.VersionUpdate+json: - schema: - $ref: '#/components/schemas/VersionUpdateWrapper' - application/vnd.ibexa.api.VersionUpdate+xml: + application/vnd.ibexa.api.ProductCreate+json: schema: - $ref: '#/components/schemas/VersionUpdate' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <VersionUpdate xmlns:p="http://ibexa.co/API/Values" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://ibexa.co/API/Values ../VersionUpdate.xsd "> - <modificationDate>2012-02-20T12:00:00</modificationDate> - <initialLanguageCode>ger-DE</initialLanguageCode> - <fields> - <field> - <id>1234</id> - <fieldDefinitionIdentifier>title</fieldDefinitionIdentifier> - <languageCode>ger-DE</languageCode> - <fieldValue>Neuer Titel</fieldValue> - </field> - <field> - <id>1235</id> - <fieldDefinitionIdentifier>summary</fieldDefinitionIdentifier> - <languageCode>ger-DE</languageCode> - <fieldValue>Dies ist eine neuse Zusammenfassungy</fieldValue> - </field> - </fields> - </VersionUpdate> + $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 - /content/objects/{contentId}/versions/{versionNo}/relations: + /product/catalog/attributes: get: - operationId: ibexa.rest.load_version_relations + operationId: ibexa.product_catalog.rest.attributes tags: - - Objects + - Product Attribute responses: 200: - description: If set, the Relation is returned in XML or JSON format. + description: AttributeList - If set, the attributes list is returned in + XML or JSON format. content: - application/vnd.ibexa.api.RelationList+json: + application/vnd.ibexa.api.AttributeList+json: schema: - $ref: '#/components/schemas/RelationListWrapper' + $ref: '#/components/schemas/AttributeListWrapper' 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: + 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/RelationList' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/107/versions/9/relations"> - <Relation media-type="application/vnd.ibexa.api.Relation+xml" href="/api/ibexa/v2/content/objects/107/versions/9/relations/7"> - <SourceContent media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/107"/> - <DestinationContent media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/52"/> - <RelationType>LINK</RelationType> - </Relation> - </Relations> + $ref: '#/components/schemas/AttributeList' 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. + 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: [] + requestBody: + description: Attribute filter + content: + application/vnd.ibexa.api.AttributeListGet+json: + schema: + $ref: '#/components/schemas/AttributeListGetWrapper' + example: + AttributeListGet: + group_name_prefix: a + name_prefix: a + offset: 0 + limit: 10 + application/vnd.ibexa.api.AttributeListGet+xml: + schema: + $ref: '#/components/schemas/AttributeListGet' + required: false + post: + operationId: ibexa.product_catalog.rest.attributes.create + tags: + - Product Attribute + responses: + 201: + description: If set, the new attribute is returned in XML or JSON format. + content: + application/vnd.ibexa.api.Attribute+json: + schema: + $ref: '#/components/schemas/AttributeWrapper' + example: + Attribute: + _media-type: application/vnd.ibexa.api.Attribute+json + identifier: foo + name: Attribute + description: description + type: Checkbox + type_identifier: checkbox + value: true + group: Attribute Test + position: 0 + options: [] + 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: contentId - in: path - description: "" + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: versionNo + requestBody: + description: The attribute schema encoded in XML or JSON format. + 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 + /product/catalog/attributes/translation/{id}/{languageCode}: + delete: + operationId: ibexa.product_catalog.rest.attributes.translation.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: "" + description: AttributeTranslationDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - post: - operationId: ibexa.rest.create_relation - tags: - - Objects - responses: - 201: - description: If set, the updated version is returned in XML or JSON format. - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <Relation media-type="application/vnd.ibexa.api.Relation+xml" href="/api/ibexa/v2/content/objects/59/versions/2/relations/40"> - <SourceContent media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/59"/> - <DestinationContent media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/59"/> - <RelationType>COMMON</RelationType> - </Relation> - summary: Create new Relation - description: Creates a new Relation of type COMMON for the given draft. - parameters: - - name: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + - name: languageCode + in: path + description: AttributeTranslationDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: contentId - in: path - description: "" + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: versionNo - in: path - description: "" + /product/catalog/attributes/view: + post: + operationId: ibexa.product_catalog.rest.attributes.view + tags: + - Product Attribute + responses: + 200: + description: The view in XML or JSON format. + 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: ~ + defaultRangeMaximumValue: ~ + 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: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The RelationCreate schema encoded in XML or JSON format. + description: The view input in XML or JSON format. content: - application/vnd.ibexa.api.RelationCreate+json: + application/vnd.ibexa.api.AttributeViewInput+json: schema: - $ref: '#/components/schemas/RelationCreateWrapper' + $ref: '#/components/schemas/AttributeViewInputWrapper' example: - RelationCreate: - Destination: - _href: /api/ibexa/v2/content/objects/59 - application/vnd.ibexa.api.RelationCreate+xml: + 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/RelationCreate' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <RelationCreate> - <Destination href="/api/ibexa/v2/content/objects/59"/> - </RelationCreate> + $ref: '#/components/schemas/AttributeViewInput' required: false - deprecated: false - /content/objects/{contentId}/versions/{versionNo}/relations/{relationId}: + /product/catalog/attributes/{id}: get: - operationId: ibexa.rest.load_version_relation + operationId: ibexa.product_catalog.rest.attributes.get tags: - - Objects + - Product Attribute responses: 200: - description: OK - loads a Relation for the given content item. + description: Attribute - If set, the given attribute is returned in XML + or JSON format. content: - application/vnd.ibexa.api.Relation+json: + application/vnd.ibexa.api.Attribute+json: schema: - $ref: '#/components/schemas/RelationWrapper' + $ref: '#/components/schemas/AttributeWrapper' 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: + Attribute: + _media-type: application/vnd.ibexa.api.Attribute+json + identifier: attrib2 + name: Attrib2 + description: "" + type: Checkbox + type_identifier: checkbox + value: true + group: Attribute Group Test + position: 0 + options: [] + application/vnd.ibexa.api.Attribute+xml: schema: - $ref: '#/components/schemas/Relation' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <Relation media-type="application/vnd.ibexa.api.Relation+xml" href="/api/ibexa/v2/content/objects/86/versions/1/relations/1"> - <SourceContent media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/86"/> - <DestinationContent media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/86"/> - <RelationType>COMMON</RelationType> - </Relation> + $ref: '#/components/schemas/Attribute' 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. + description: Error - the user has no permission to read the attribute. + summary: Load attribute + description: Loads given attribute. parameters: - - name: contentId + - name: id in: path - description: "" + description: AttributeLoadByIdentifierController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: versionNo + delete: + operationId: ibexa.product_catalog.rest.attributes.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: "" + description: AttributeDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: relationId - in: path - description: "" + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - delete: - operationId: ibexa.rest.remove_relation + /product/catalog/attributes/{id}/{group_id}: + patch: + operationId: ibexa.product_catalog.rest.attributes.update tags: - - Objects + - Product Attribute responses: - 204: - description: No Content - deleted a Relation of the given draft. + 201: + description: If set, the updated attribute is returned in XML or JSON format. + 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 delete this Relation. + description: Error - the user is not authorized to create this attribute. 403: - description: Error - the Relation is not of type COMMON or the given version - is not a draft. + description: Error - an attribute with the same name already exists. 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. + description: Error - the attribute with the given ID does not exist. + summary: Update attribute + description: Updates an attribute. parameters: - - name: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: contentId + - name: id in: path - description: "" + description: AttributeUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: versionNo + - name: group_id in: path - description: "" + description: AttributeUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: relationId - in: path - description: "" + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. 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: ibexa.rest.delete_translation_from_draft - 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - 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: 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: ibexa.order_management.rest.order.cancel - 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: X-CSRF-Token - in: header - description: The CSRF token. - 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: No payload required - content: [] + description: If set, the updated attribute group is returned in XML or JSON + format. + 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 - x-badges: - - name: Commerce - color: '#A32768' - position: after - /orders/order/{identifier}: - get: - operationId: ibexa.order_management.rest.order.identifier - 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: 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}: + /product/catalog/attribute_groups: get: - operationId: ibexa.order_management.rest.order + operationId: ibexa.product_catalog.rest.attribute_groups tags: - - Orders + - Product Attribute Group responses: 200: - description: OK - loads the order. + description: AttributeGroupList - If set, the attribute group list is returned + in XML or JSON format. content: - application/vnd.ibexa.api.Order+json: + application/vnd.ibexa.api.AttributeGroupList+json: schema: - $ref: '#/components/schemas/OrderWrapper' + $ref: '#/components/schemas/AttributeGroupListWrapper' example: - Order: - _media-type: application/vnd.ibexa.api.Order+json - id: 1 - identifier: 02ce9f94-e36b-4acf-92f7-eb93cda6af71 - created: - date: "2023-10-18 06:24:00.000000" - timezone_type: 3 - timezone: UTC - modified: - date: "2023-10-18 06:24:00.000000" - timezone_type: 3 - timezone: UTC - status: pending - source: local_shop - OrderUser: - _media-type: application/vnd.ibexa.api.OrderUser+json - id: ~ - name: Anonymous User - email: test@test.com - OrderCurrency: - _media-type: application/vnd.ibexa.api.OrderCurrency+json - id: 2 - code: EUR - OrderValue: - _media-type: application/vnd.ibexa.api.OrderValue+json - vat: - amount: "96" - currency: EUR - total_gross: - amount: "1512" - currency: EUR - total_net: - amount: "1200" - currency: EUR - shipping_cost: - amount: "216" - currency: EUR - OrderItemsList: - - _media-type: application/vnd.ibexa.api.OrderItem+json - quantity: 1 - OrderItemValue: - _media-type: application/vnd.ibexa.api.OrderItemValue+json - unit_price_gross: - amount: "1296" - currency: EUR - unit_price_net: - amount: "1200" - currency: EUR - vat_rate: "8.00" - subtotal_price_gross: - amount: "1296" - currency: EUR - subtotal_price_net: - amount: "1200" - currency: EUR - OrderItemProduct: - _media-type: application/vnd.ibexa.api.OrderItemProduct+json - id: 83 - code: test123 - name: test123 - context: - shipping_address: - name: ~ - country: PL - fields: - tax_id: "16" - region: Polska - locality: "Krak\xF3w" - street: Krupnicza 16 - postal_code: 31-123 - email: test@test.com - phone_number: "123123123" - billing_address: - name: ~ - country: PL - fields: - tax_id: "16" - region: Polska - locality: "Krak\xF3w" - street: Krupnicza 16 - postal_code: 31-123 - email: test@test.com - phone_number: "123123123" - entries_count: 1 - same_for_shipping: true - select_shipping: - shipping_method: - identifier: test - name: test - payment_method: - identifier: test - name: test - type: online - summary: [] - shipping_cost_incl_vat: - amount: "216" - currency: EUR - 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: 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: ibexa.order_management.rest.order.update - tags: - - Orders - responses: - 200: - description: If set, the updated order is returned in XML or JSON format. - content: - application/vnd.ibexa.api.Order+json: + 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/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. + $ref: '#/components/schemas/AttributeGroupList' 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: X-CSRF-Token - in: header - description: The CSRF token. - 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 + 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: [] requestBody: - description: The OrderUpdate schema encoded in XML or JSON format. + description: The AttributeGroupListGet schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.OrderUpdate+json: + application/vnd.ibexa.api.AttributeGroupListGet+json: schema: - $ref: '#/components/schemas/OrderUpdateWrapper' + $ref: '#/components/schemas/AttributeGroupListGetWrapper' example: - OrderUpdate: - status: cancelled - transition: cancel + AttributeGroupListGet: + prefix: s + offset: 0 + limit: 10 required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /orders/orders: - get: - operationId: ibexa.order_management.rest.orders - 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: [] - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after post: - operationId: ibexa.order_management.rest.order.create + operationId: ibexa.product_catalog.rest.attribute_groups.create tags: - - Orders + - Product Attribute Group responses: - 200: - description: If set, the new order is returned in JSON format. + 201: + description: If set, the new attribute group is returned in XML or JSON + format. content: - application/vnd.ibexa.api.Order+json: + application/vnd.ibexa.api.AttributeGroup+json: schema: - $ref: '#/components/schemas/OrderWrapper' + $ref: '#/components/schemas/AttributeGroupWrapper' 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 + AttributeGroup: + _media-type: application/vnd.ibexa.api.AttributeGroup+json + name: Attribute Group Test + identifier: attr_group_test + 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 order. - 406: - description: Error - a order with this identifier already exists. - summary: Create order - description: Creates a new order. + 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: X-CSRF-Token in: header - description: The CSRF token. + description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The Order schema encoded in XML or JSON format. + description: The AttributeGroup schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.OrderCreate+json: + application/vnd.ibexa.api.AttributeGroupCreate+json: schema: - $ref: '#/components/schemas/OrderCreateWrapper' + $ref: '#/components/schemas/AttributeGroupCreateWrapper' 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 + AttributeGroupCreate: + identifier: attr_group_test + names: + eng-GB: Attribute Group Test + position: 0 required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /payment-method: - post: - operationId: ibexa.rest.payment_method.create + /product/catalog/attribute_groups/translation/{id}/{languageCode}: + delete: + operationId: ibexa.product_catalog.rest.attribute_groups.translation.delete tags: - - Payments + - Product Attribute Group 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. + description: No content - the given attribute group translation is deleted. 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. + 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: AttributeGroupTranslationDeleteController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: languageCode + in: path + description: AttributeGroupTranslationDeleteController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false - name: X-CSRF-Token in: header - description: The CSRF token. + description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - requestBody: - description: The Payment Method input schema encoded in XML or JSON. - 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: |- - <PaymentMethodCreateStruct> - <identifier>bank_transfer</identifier> - <type>offline</type> - <names> - <eng-GB>Bank transfer</eng-GB> - </names> - </PaymentMethodCreateStruct> - required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /payment-method/view: + /product/catalog/attribute_groups/view: post: - operationId: ibexa.rest.payment_method.view + operationId: ibexa.product_catalog.rest.attribute_groups.view tags: - - Payments + - Product Attribute Group responses: 200: description: The view in XML or JSON format. content: - application/vnd.ibexa.api.PaymentMethodView+json: + application/vnd.ibexa.api.AttributeGroupView+json: schema: - $ref: '#/components/schemas/PaymentMethodViewWrapper' + $ref: '#/components/schemas/AttributeGroupViewWrapper' example: - PaymentMethodView: - _media-type: application/vnd.ibexa.api.PaymentMethodView+json - identifier: 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: 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: + 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/PaymentMethodView' + $ref: '#/components/schemas/AttributeGroupView' 400: description: Error - the input does not match the input schema definition. - summary: List payment methods + 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: X-CSRF-Token in: header - description: The CSRF token. + description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: description: The view input in XML or JSON format. content: - application/vnd.ibexa.api.PaymentMethodViewInput+json: + application/vnd.ibexa.api.AttributeGroupViewInput+json: schema: - $ref: '#/components/schemas/PaymentMethodViewInputWrapper' + $ref: '#/components/schemas/AttributeGroupViewInputWrapper' example: - PaymentMethodViewInput: - identifier: example - PaymentMethodQuery: - offset: 0 - limit: 10 - application/vnd.ibexa.api.PaymentMethodViewInput+xml: + ViewInput: + identifier: TitleView + AttributeGroupQuery: + limit: "10" + offset: "0" + name_prefix: test + application/vnd.ibexa.api.AttributeGroupViewInput+xml: schema: - $ref: '#/components/schemas/PaymentMethodViewInput' + $ref: '#/components/schemas/AttributeGroupViewInput' required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /payment-method/{identifier}: + /product/catalog/attribute_groups/{id}: get: - operationId: ibexa.rest.payment_method.get_by_identifier + operationId: ibexa.product_catalog.rest.attribute_groups.get tags: - - Payments + - Product Attribute Group responses: 200: - description: OK - loads the payment method. + description: AttributeGroupGet - If set, the attribute group List is returned + in XML or JSON format. content: - application/vnd.ibexa.api.PaymentMethod+json: + application/vnd.ibexa.api.AttributeGroup+json: schema: - $ref: '#/components/schemas/PaymentMethodWrapper' + $ref: '#/components/schemas/AttributeGroupWrapper' 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: + AttributeGroup: + _media-type: application/vnd.ibexa.api.AttributeGroup+json + name: Attribute Group Test + identifier: attr_group_test + position: 0 + application/vnd.ibexa.api.AttributeGroup+xml: schema: - $ref: '#/components/schemas/PaymentMethod' + $ref: '#/components/schemas/AttributeGroup' 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. + description: Error - the user has no permission to read attribute groups. + summary: Load attribute group + description: Returns the given attribute group. parameters: - - name: identifier + - name: id in: path - description: "" + description: AttributeGroupLoadByIdentifierController identifier 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 + requestBody: + description: An optional AttributeGroupGet schema encoded in XML or JSON format. + 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 delete: - operationId: ibexa.rest.payment_method.delete + operationId: ibexa.product_catalog.rest.attribute_groups.delete tags: - - Payments + - Product Attribute Group responses: 204: - description: No Content + description: No content - the given attribute group is deleted. 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. + description: Error - the user is not authorized to delete this attribute + group. + summary: Delete attribute group + description: Deletes an attribute group. parameters: - - name: X-CSRF-Token - in: header - description: The CSRF token. + - name: id + in: path + description: AttributeGroupDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: identifier - in: path - description: "" + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. 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: ibexa.rest.payment_method.update + operationId: ibexa.product_catalog.rest.attribute_groups.update tags: - - Payments + - Product Attribute Group responses: - 200: - description: OK + 201: + description: If set, the updated attribute group is returned in XML or JSON + format. content: - application/vnd.ibexa.api.PaymentMethod+json: + application/vnd.ibexa.api.AttributeGroup+json: schema: - $ref: '#/components/schemas/PaymentMethodWrapper' + $ref: '#/components/schemas/AttributeGroupWrapper' 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: + 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/PaymentMethod' + $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 update Payment Method. + 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 payment methods does not exist. - summary: Update payment method - description: Updates the PaymentMethodUpdateController resource. + description: Error - the group with the given ID does not exist. + summary: Update attribute group + description: Updates an attribute group. parameters: - - name: X-CSRF-Token - in: header - description: The CSRF token. + - name: id + in: path + description: AttributeGroupUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: identifier - in: path - description: "" + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The Payment Method input schema encoded in XML or JSON. + description: The attribute group update schema is sent in XML or JSON format. content: - application/vnd.ibexa.api.PaymentMethodUpdateStruct+json: + application/vnd.ibexa.api.AttributeGroupUpdate+json: schema: - $ref: '#/components/schemas/PaymentMethodUpdateStructWrapper' + $ref: '#/components/schemas/AttributeGroupUpdateWrapper' example: - PaymentMethodUpdateStructParser: + AttributeGroupUpdate: + identifier: ag_colors names: - eng-GB: Bank transfer (updated) - application/vnd.ibexa.api.PaymentMethodUpdateStruct+xml: + eng-GB: Colors Group + position: 0 + application/vnd.ibexa.api.AttributeGroupUpdate+xml: schema: - $ref: '#/components/schemas/PaymentMethodUpdateStruct' - example: |- - <?xml version="1.0" encoding="UTF-8"?> - <PaymentMethodUpdateStructParser> - <names> - <eng-GB>Bank transfer (updated)</eng-GB> - </names> - </PaymentMethodUpdateStructParser> + $ref: '#/components/schemas/AttributeGroupUpdate' required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /payment-method/{id}: + /product/catalog/attribute_types: get: - operationId: ibexa.rest.payment_method.get + operationId: ibexa.product_catalog.rest.attribute_types tags: - - Payments + - Product Attribute Type responses: 200: - description: OK - loads the payment method. + description: OK - returns a list of Attribute Types content: - application/vnd.ibexa.api.PaymentMethod+json: + application/vnd.ibexa.api.AttributeTypeList+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. + $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: [] + /product/catalog/attribute_types/{identifier}: + get: + operationId: ibexa.product_catalog.rest.attribute_type + 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 payment methods does not exist. - summary: Load payment method by id - description: Loads an payment method by its id. + description: Error - The Attribute Type does not exist. + summary: Get Attribute Type + description: Gets an Attribute Type by its identifier. parameters: - - name: id + - name: identifier in: path - description: "" + description: AttributeTypeLoadByIdentifierController identifier 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: ibexa.product_catalog.rest.products + /product/catalog/catalogs: + post: + operationId: ibexa.product_catalog.rest.catalogs.create tags: - - Product + - Product Catalog responses: - 200: - description: If set, the products are returned in XML or JSON format. + 201: + description: If set, the new catalog is returned in XML or JSON format. content: - application/vnd.ibexa.api.ProductList+json: + application/vnd.ibexa.api.CatalogCreate+json: schema: - $ref: '#/components/schemas/ProductListWrapper' + $ref: '#/components/schemas/CatalogWrapper' 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: ~ - height: ~ - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - id: 615 - fieldDefinitionIdentifier: image - languageCode: eng-GB - fieldTypeIdentifier: ibexa_image_asset - fieldValue: - destinationContentId: ~ - alternativeText: ~ - source: ~ - 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: ~ - height: ~ - 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: ~ - height: ~ - mimeType: image/svg+xml - created_at: 1645787893 - updated_at: 1645787893 - AttributesList: [] + 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 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: [] + 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: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false requestBody: - description: The product list schema encoded in XML or JSON format. + description: The catalog schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.ProductListGet+json: + application/vnd.ibexa.api.CatalogCreate+json: schema: - $ref: '#/components/schemas/ProductListGetWrapper' + $ref: '#/components/schemas/CatalogCreateWrapper' example: - ProductListGet: - offset: 0 - limit: 10 - languages: - - eng-GB + 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/products/view: + /product/catalog/catalogs/copy/{identifier}: post: - operationId: ibexa.product_catalog.rest.products.view + operationId: ibexa.product_catalog.rest.catalogs.copy tags: - - Product + - Product Catalog + responses: + 201: + description: If set, the copied catalog is returned in XML or JSON format. + 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: identifier + in: path + description: CatalogCopyController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + requestBody: + description: If set, the copied catalog is returned in XML or JSON format. + content: + application/vnd.ibexa.api.CatalogCopy+json: + schema: + $ref: '#/components/schemas/CatalogCopyWrapper' + example: + CatalogCopy: + identifier: test_catalog_copied + creator_id: 14 + required: false + /product/catalog/catalogs/filters: + get: + operationId: ibexa.product_catalog.rest.catalog.filters + tags: + - Product Catalog + responses: + 200: + description: If set, the filters are returned in XML or JSON format. + 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: [] + /product/catalog/catalogs/sort_clauses: + get: + operationId: ibexa.product_catalog.rest.catalog.sort_clauses + tags: + - Product Catalog + responses: + 200: + description: If set, the clauses are returned in XML or JSON format. + 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: [] + /product/catalog/catalogs/view: + post: + operationId: ibexa.product_catalog.rest.catalogs.view + tags: + - Product Catalog responses: 200: description: The view in XML or JSON format. content: - application/vnd.ibexa.api.ProductView+json: + application/vnd.ibexa.api.CatalogView+json: schema: - $ref: '#/components/schemas/ProductViewWrapper' + $ref: '#/components/schemas/CatalogViewWrapper' example: - ProductView: - _media-type: application/vnd.ibexa.api.ProductView+json + CatalogView: + _media-type: application/vnd.ibexa.api.CatalogView+json identifier: TitleView - ProductQuery: - _media-type: application/vnd.ibexa.api.ProductQuery+json + CatalogQuery: + _media-type: application/vnd.ibexa.api.CatalogQuery+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: ~ - - _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: ~ - value: ~ - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - id: 304 - fieldDefinitionIdentifier: image - languageCode: eng-GB - fieldTypeIdentifier: ibexa_image_asset - fieldValue: - destinationContentId: ~ - alternativeText: ~ - source: ~ - - 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: ~ - height: ~ - 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: ~ - height: ~ - 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: ~ - value: ~ - 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" + 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: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + requestBody: + description: The view input in XML or JSON format. + 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 + /product/catalog/catalogs/{identifier}: + get: + operationId: ibexa.product_catalog.rest.catalogs.get + tags: + - Product Catalog + responses: + 200: + description: If set, the catalog is returned in XML or JSON format. + 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 + name: Snow Equipment + description: "" + User: + _media-type: application/vnd.ibexa.api.User+json + _href: /api/ibexa/v2/user/users/14 + created: 1666090438 + modified: 1666090438 + status: draft + Criteria: + - _media-type: application/vnd.ibexa.api.ProductCode+json + ProductCodeCriterion: + _media-type: application/vnd.ibexa.api.ProductCodeCriterion+json + codes: + - ski + - snowboard + - _media-type: application/vnd.ibexa.api.ProductAvailability+json + ProductAvailabilityCriterion: + _media-type: application/vnd.ibexa.api.ProductAvailabilityCriterion+json + is_available: true + - _media-type: application/vnd.ibexa.api.ColorAttribute+json + ColorAttributeCriterion: + _media-type: application/vnd.ibexa.api.ColorAttributeCriterion+json + identifier: color + value: + - '#000000' + - '#FFFFFF' + - _media-type: application/vnd.ibexa.api.CreatedAt+json + CreatedAtCriterion: + _media-type: application/vnd.ibexa.api.CreatedAtCriterion+json + created_at: + date: "2022-09-12 00:00:00.000000" + timezone_type: 3 + timezone: Europe/Warsaw + operator: '>=' + - _media-type: application/vnd.ibexa.api.FloatAttribute+json + FloatAttributeCriterion: + _media-type: application/vnd.ibexa.api.FloatAttributeCriterion+json + identifier: width + value: 16.6 + - _media-type: application/vnd.ibexa.api.IntegerAttributeRange+json + IntegerAttributeRangeCriterion: + _media-type: application/vnd.ibexa.api.IntegerAttributeRangeCriterion+json + identifier: length + min: 180 + max: 230 + 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: identifier + in: path + description: CatalogLoadByIdentifierController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + delete: + operationId: ibexa.product_catalog.rest.catalogs.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: CatalogDeleteController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + patch: + operationId: ibexa.product_catalog.rest.catalogs.update + tags: + - Product Catalog + responses: + 201: + description: If set, the updated catalog is returned in XML or JSON format. + 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_updated + name: Snow Equipment updated + description: Snow Equipment catalog for 2022 + User: + _media-type: application/vnd.ibexa.api.User+json + _href: /api/ibexa/v2/user/users/14 + created: 1666090438 + modified: 1666091260 + status: published + Criteria: + - _media-type: application/vnd.ibexa.api.ProductCode+json + ProductCodeCriterion: + _media-type: application/vnd.ibexa.api.ProductCodeCriterion+json + codes: + - ski + - _media-type: application/vnd.ibexa.api.ProductAvailability+json + ProductAvailabilityCriterion: + _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: identifier + in: path + description: CatalogUpdateController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + requestBody: + description: If set, the updated catalog is returned in XML or JSON format. + 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 + /product/catalog/catalogs/{identifier}/products/view: + post: + operationId: ibexa.product_catalog.rest.catalogs.products.view + tags: + - Product Catalog + responses: + 200: + description: The view in XML or JSON format. + 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: 1 + ProductList: + _media-type: application/vnd.ibexa.api.ProductList+json + Product: - _media-type: application/vnd.ibexa.api.Product+json - code: ERGO - isBaseProduct: false - isVariant: false - name: Ergo Office Desk + code: test + name: test 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: ~ - - _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: ~ - value: ~ + identifier: quickdraw + name: Quickdraw + AttributeAssignmentList: [] Content: _media-type: application/vnd.ibexa.api.Content+json - _href: /api/ibexa/v2/content/objects/66 - _remoteId: 1e7449c13671b56ed3907929a2af3ad9 - _id: 66 + _href: /api/ibexa/v2/content/objects/187 + _remoteId: b0608be4ef4dc978ad603d02ac3c9ad1 + _id: 187 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/53 - Name: Ergo Office Desk - TranslatedName: Ergo Office Desk + _href: /api/ibexa/v2/content/types/55 + Name: test + TranslatedName: test Versions: _media-type: application/vnd.ibexa.api.VersionList+json - _href: /api/ibexa/v2/content/objects/66/versions + _href: /api/ibexa/v2/content/objects/187/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/66/currentversion + _href: /api/ibexa/v2/content/objects/187/currentversion Version: _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/66/versions/2 + _href: /api/ibexa/v2/content/objects/187/versions/1 VersionInfo: - id: 528 - versionNo: 2 + id: 665 + versionNo: 1 status: PUBLISHED - modificationDate: "2023-04-12T14:06:14+00:00" + modificationDate: "2022-08-26T11:16:49+02: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" + creationDate: "2022-08-26T11:16:49+02:00" initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: @@ -16354,28 +10543,26 @@ paths: names: value: - _languageCode: eng-GB - '#text': Ergo Office Desk + '#text': test Content: _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/66 + _href: /api/ibexa/v2/content/objects/187 Fields: field: - - id: 295 + - id: 915 fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string - fieldValue: Ergo Office Desk - - id: 296 + fieldValue: test + - id: 916 fieldDefinitionIdentifier: product_specification languageCode: eng-GB fieldTypeIdentifier: ibexa_product_specification fieldValue: - id: 3 - code: ERGO - attributes: - - black - - [] - - id: 297 + id: 60 + code: test + attributes: [] + - id: 917 fieldDefinitionIdentifier: description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext @@ -16386,7 +10573,7 @@ paths: xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - id: 298 + - id: 918 fieldDefinitionIdentifier: image languageCode: eng-GB fieldTypeIdentifier: ibexa_image_asset @@ -16394,25 +10581,20 @@ paths: destinationContentId: ~ alternativeText: ~ source: ~ - - id: 299 + - id: 919 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: "" + taxonomy: ~ Relations: _media-type: application/vnd.ibexa.api.RelationList+json - _href: /api/ibexa/v2/content/objects/66/versions/2/relations + _href: /api/ibexa/v2/content/objects/187/versions/1/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json - resource: /placeholder + resource: /bundles/ibexaadminui/img/ibexa-icons.svg#file width: ~ height: ~ mimeType: image/svg+xml @@ -16421,103 +10603,56 @@ paths: _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json - _href: /api/ibexa/v2/content/objects/66/locations + _href: /api/ibexa/v2/content/objects/187/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" + lastModificationDate: "2022-08-26T11:16:49+02:00" + publishedDate: "2022-08-26T11:16:49+02:00" mainLanguageCode: eng-GB - currentVersionNo: 2 + 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 + _href: /api/ibexa/v2/content/objects/187/objectstates Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json - resource: /placeholder + resource: /bundles/ibexaadminui/img/ibexa-icons.svg#file width: ~ height: ~ 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: ~ - value: ~ - 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 + created_at: 1661505409 + updated_at: 1661505409 + AttributesList: [] 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 + 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: identifier + in: path + description: CatalogProductsViewController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: description: The view input in XML or JSON format. content: @@ -16528,1339 +10663,1050 @@ paths: 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: ~ + Query: + ProductCodeCriterion: test + ProductAvailabilityCriterion: true application/vnd.ibexa.api.ProductViewInput+xml: schema: $ref: '#/components/schemas/ProductViewInput' required: false - deprecated: false - /product/catalog/products/{code}: + /product/catalog/currencies: get: - operationId: ibexa.product_catalog.rest.product + operationId: ibexa.product_catalog.rest.currencies tags: - - Product + - Product Currency responses: 200: - description: If set, the products are returned in XML or JSON format. + description: OK - loads currencies. content: - application/vnd.ibexa.api.Product+json: + application/vnd.ibexa.api.CurrencyList+json: schema: - $ref: '#/components/schemas/ProductWrapper' + $ref: '#/components/schemas/CurrencyListWrapper' example: - Product: - _media-type: application/vnd.ibexa.api.Product+json - code: DRESUN - name: Yellow sundress - ProductType: - _media-type: application/vnd.ibexa.api.ProductType+json - identifier: dress - name: Dress - AttributeAssignmentList: - - _media-type: application/vnd.ibexa.api.AttributeAssignment+json - is_required: false - is_discriminator: false - Attribute: - _media-type: application/vnd.ibexa.api.Attribute+json - identifier: size - name: Size - description: "" - type: Integer - type_identifier: integer - value: 5 - group: Hat - position: 0 - options: [] - 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: Yellow sundress - TranslatedName: Yellow sundress - 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': Yellow sundress - 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: Yellow sundress - - id: 613 - fieldDefinitionIdentifier: product_specification - languageCode: eng-GB - fieldTypeIdentifier: ibexa_product_specification - fieldValue: - id: 25 - code: DRESUN - attributes: - - 10 - - id: 614 - fieldDefinitionIdentifier: description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - id: 615 - fieldDefinitionIdentifier: image - languageCode: eng-GB - fieldTypeIdentifier: ibexa_image_asset - fieldValue: - destinationContentId: ~ - alternativeText: ~ - source: ~ - 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: ~ - height: ~ - 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: ~ - height: ~ - mimeType: image/svg+xml - created_at: 1647006758 - updated_at: 1647006758 - AttributesList: - - _media-type: application/vnd.ibexa.api.Attribute+json - identifier: size - name: Size - description: "" - type: Integer - type_identifier: integer - value: 5 - group: Clothes - position: 0 - options: [] + 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 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. + description: Error - the user has no permission to read currencies. + summary: Load currencies + description: Loads the list of currencies. + parameters: [] + post: + operationId: ibexa.product_catalog.rest.currencies.create + tags: + - Product Currency + responses: + 200: + description: If set, the new currency is returned in JSON format. + content: + application/vnd.ibexa.api.Currency+json: + schema: + $ref: '#/components/schemas/CurrencyWrapper' + example: + Currency: + _media-type: application/vnd.ibexa.api.Currency+json + id: 181 + code: cur + subunits: 1 + enabled: true + 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: code - in: path - description: "" + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: An optional product schema encoded in XML or JSON format. + description: The Currency schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.ProductGet+json: + application/vnd.ibexa.api.CurrencyCreate+json: schema: - $ref: '#/components/schemas/ProductGetWrapper' + $ref: '#/components/schemas/CurrencyCreateWrapper' example: - ProductGet: - languages: - - eng-GB + CurrencyCreate: + code: cur + subunits: 1 + enabled: true required: false - deprecated: false - patch: - operationId: ibexa.product_catalog.rest.products.update + /product/catalog/currencies/view: + post: + operationId: ibexa.product_catalog.rest.currencies.view tags: - - Product + - Product Currency responses: - 201: - description: If set, the updated product is returned in XML or JSON format. + 200: + description: The view in XML or JSON format. content: - application/vnd.ibexa.api.Product+json: + application/vnd.ibexa.api.CurrencyView+json: schema: - $ref: '#/components/schemas/ProductWrapper' + $ref: '#/components/schemas/CurrencyViewWrapper' example: - Product: - _media-type: application/vnd.ibexa.api.Product+json - code: bbbb - name: fgh - ProductType: - _media-type: application/vnd.ibexa.api.ProductType+json - identifier: test_pt321 - name: New Product Type - AttributeAssignmentList: - - _media-type: application/vnd.ibexa.api.AttributeAssignment+json - is_required: false - is_discriminator: true - Attribute: - _media-type: application/vnd.ibexa.api.Attribute+json - identifier: testAttr - name: testAttr - description: "" - type: Checkbox - type_identifier: checkbox - value: true - group: Test Attribute group - position: 0 - options: [] - 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: fgh - TranslatedName: fgh - 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': fgh - 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: fgh - - id: 613 - fieldDefinitionIdentifier: product_specification - languageCode: eng-GB - fieldTypeIdentifier: ibexa_product_specification - fieldValue: - id: 25 - code: bbbb - attributes: - - 10 - - id: 614 - fieldDefinitionIdentifier: description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - id: 615 - fieldDefinitionIdentifier: image - languageCode: eng-GB - fieldTypeIdentifier: ibexa_image_asset - fieldValue: - destinationContentId: ~ - alternativeText: ~ - source: ~ - 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: ~ - height: ~ - 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: ~ - height: ~ - mimeType: image/svg+xml - created_at: 1646398748 - updated_at: 1646398748 - AttributesList: - - _media-type: application/vnd.ibexa.api.Attribute+json - identifier: testAttr - name: testAttr - description: "" - type: Checkbox - type_identifier: checkbox - value: true - group: Test Attribute group - position: 0 - options: [] - - _media-type: application/vnd.ibexa.api.Attribute+json - identifier: nnnn - name: nnnn - description: "" - type: Checkbox - type_identifier: checkbox - value: true - group: Test Attribute group - position: 0 - options: [] + 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. - 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. + 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: code - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: If set, the updated product is returned in XML or JSON format. + description: The view input in XML or JSON format. content: - application/vnd.ibexa.api.ProductUpdate+json: + application/vnd.ibexa.api.CurrencyViewInput+json: schema: - $ref: '#/components/schemas/ProductUpdateWrapper' + $ref: '#/components/schemas/CurrencyViewInputWrapper' 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 + 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/products/{code}/prices: + /product/catalog/currencies/{id}: get: - operationId: ibexa.product_catalog.rest.prices.list + operationId: ibexa.product_catalog.rest.currencies.get tags: - - Product + - Product Currency responses: 200: - description: OK - loads the list of product prices. + description: OK - loads the currency. content: - application/vnd.ibexa.api.PriceList+json: + application/vnd.ibexa.api.Currency+json: schema: - $ref: '#/components/schemas/PriceListWrapper' + $ref: '#/components/schemas/CurrencyWrapper' 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 + Currency: + _media-type: application/vnd.ibexa.api.Currency+json + id: 3 + code: ALL + subunits: 2 + enabled: false 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. + 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: code + - name: id in: path - description: "" + description: CurrencyLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - post: - operationId: ibexa.product_catalog.rest.prices.create + delete: + operationId: ibexa.product_catalog.rest.currencies.delete tags: - - Product + - Product Currency responses: 200: - description: OK - creates product price. + 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: CurrencyDeleteController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + patch: + operationId: ibexa.product_catalog.rest.currencies.update + tags: + - Product Currency + responses: + 200: + description: If set, the updated currency is returned in XML or JSON format. content: - application/vnd.ibexa.api.CustomPrice+json: - schema: - $ref: '#/components/schemas/CustomPriceWrapper' - example: - CustomPrice: - _media-type: application/vnd.ibexa.api.CustomPrice+json - id: 5 - amount: "15.00" - base_amount: "25.00" - Currency: - _media-type: application/vnd.ibexa.api.Currency+json - id: 2 - code: EUR - subunits: 2 - enabled: true - money: "1500" - base_money: "2500" - custom_money: "1500" - custom_amount: "15.00" - application/vnd.ibexa.api.Price+json: + application/vnd.ibexa.api.Currency+json: schema: - $ref: '#/components/schemas/PriceWrapper' + $ref: '#/components/schemas/CurrencyWrapper' 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" + 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 price. - summary: Create product price or custom price - description: Create product price or custom price. + 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: code + - name: id in: path - description: "" + description: CurrencyUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The product price schema encoded in JSON format. + description: The CurrencyUpdate schema encoded in XML or JSON format. 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: + application/vnd.ibexa.api.CurrencyUpdate+json: schema: - $ref: '#/components/schemas/PriceCreateStructWrapper' + $ref: '#/components/schemas/CurrencyUpdateWrapper' example: - PriceCreateStruct: - amount: 9 - currency: CHF + CurrencyUpdate: + subunits: 1 + enabled: false required: false - deprecated: false - /product/catalog/products/{code}/prices/{currencyCode}: + /product/catalog/customer_groups: get: - operationId: ibexa.product_catalog.rest.prices.get.base_price + operationId: ibexa.product_catalog.rest.customer_groups.list tags: - - Product + - Product Customer Group responses: 200: - description: OK - gets price in given currency. + description: If set, the customer groups list is returned in XML or JSON + format. content: - application/vnd.ibexa.api.Price+json: + application/vnd.ibexa.api.CustomerGroupList+json: schema: - $ref: '#/components/schemas/PriceWrapper' + $ref: '#/components/schemas/CustomerGroupListWrapper' example: - Price: - _media-type: application/vnd.ibexa.api.Price+json - id: 1 - amount: "12.00" - base_amount: "12.00" - Currency: - _media-type: application/vnd.ibexa.api.Currency+json + 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 - code: EUR - subunits: 2 - enabled: true - money: "1200" - base_money: "1200" + name: Contractors + identifier: contractors + description: "" + users: [] + global_price_rate: "-20.00" 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. + description: Error - the user has no permission to read customer groups. + summary: Load customer groups + description: Returns a list of customer groups + parameters: [] + post: + operationId: ibexa.product_catalog.rest.customer_group.create + tags: + - Product Customer Group + responses: + 201: + description: If set, the new customer group is returned in XML or JSON format. + content: + application/vnd.ibexa.api.CustomerGroup+json: + schema: + $ref: '#/components/schemas/CustomerGroupWrapper' + example: + CustomerGroup: + _media-type: application/vnd.ibexa.api.CustomerGroup+json + id: 5 + name: test-en + identifier: test + description: test-desc-en + users: [] + global_price_rate: "1.00" + 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: code - in: path - description: "" + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: currencyCode - in: path - description: "" + requestBody: + description: The CustomerGroupCreate schema encoded in XML or JSON format. + 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 + /product/catalog/customer_groups/view: + post: + operationId: ibexa.product_catalog.rest.customer_groups.view + tags: + - Product Customer Group + responses: + 200: + description: The view in XML or JSON format. + 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: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. 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}: + requestBody: + description: The view input in XML or JSON format. + 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 + /product/catalog/customer_groups/{identifier}: get: - operationId: ibexa.product_catalog.rest.prices.get.custom_price + operationId: ibexa.product_catalog.rest.customer_groups.identifier tags: - - Product + - Product Customer Group responses: 200: - description: OK - gets price in given currency and customer group. + description: If set, the customer group is returned in XML or JSON format. content: - application/vnd.ibexa.api.CustomPrice+json: + application/vnd.ibexa.api.CustomerGroup+json: schema: - $ref: '#/components/schemas/CustomPriceWrapper' + $ref: '#/components/schemas/CustomerGroupWrapper' example: - CustomPrice: - _media-type: application/vnd.ibexa.api.CustomPrice+json - id: 3 - amount: "11.50" - base_amount: "10.00" - Currency: - _media-type: application/vnd.ibexa.api.Currency+json - id: 5 - code: USD - subunits: 2 - enabled: true - money: "1150" - base_money: "1000" - custom_money: "1150" - custom_amount: "11.50" - custom_rule: "15.00" + CustomerGroup: + _media-type: application/vnd.ibexa.api.CustomerGroup+json + id: 1 + name: Resellers + identifier: resellers + description: "" + users: [] + global_price_rate: "0.00" 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. + description: Error - the user has no permission to read customer groups. + summary: Load customer group + description: Returns a customer group parameters: - - name: code + - name: identifier in: path - description: "" + description: CustomerGroupLoadByIdentifierController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: currencyCode + delete: + operationId: ibexa.product_catalog.rest.customer_groups.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: "" + description: CustomerGroupDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: customerGroupIdentifier - in: path - description: "" + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. 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: ibexa.product_catalog.rest.prices.delete + patch: + operationId: ibexa.product_catalog.rest.customer_group.update tags: - - Product + - Product Customer Group responses: - 200: - description: No content - the given price is deleted. + 201: + description: If set, the updated customer group is returned in XML or JSON + format. + 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 delete this price. - summary: Delete product price - description: Deletes product price. + description: Error - the user is not authorized to update a customer group. + summary: Update customer group + description: Updates the given customer group. parameters: - - name: code - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: id + - name: identifier in: path - description: "" + description: CustomerGroupUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - patch: - operationId: ibexa.product_catalog.rest.prices.update + requestBody: + description: The CustomerGroupUpdate schema encoded in XML or JSON format. + 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 + /product/catalog/customer_groups/{id}: + get: + operationId: ibexa.product_catalog.rest.customer_group tags: - - Product + - Product Customer Group responses: 200: - description: OK - updates product price. + description: If set, the customer group is returned in XML or JSON format. 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: ~ - application/vnd.ibexa.api.Price+json: + application/vnd.ibexa.api.CustomerGroup+json: schema: - $ref: '#/components/schemas/PriceWrapper' + $ref: '#/components/schemas/CustomerGroupWrapper' example: - Price: - _media-type: application/vnd.ibexa.api.Price+json - id: 2 - amount: "35.00" - base_amount: "35.00" - Currency: - _media-type: application/vnd.ibexa.api.Currency+json - id: 5 - code: USD - subunits: 2 - enabled: true - money: "3500" - base_money: "3500" - 400: - description: Error - the input does not match the input schema definition. + 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 is not authorized to update this price. - summary: Update product price - description: Updates product price. + description: Error - the user has no permission to read customer groups. + summary: Load customer group + description: Returns a customer group parameters: - - 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: "" + description: CustomerGroupLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: - type: string + type: integer style: simple explode: false - allowReserved: false + /product/catalog/regions: + get: + operationId: ibexa.product_catalog.rest.regions + 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: [] + /product/catalog/regions/view: + post: + operationId: ibexa.product_catalog.rest.regions.view + tags: + - Product Region + responses: + 200: + description: The view in XML or JSON format. + 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: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: Update price or custom price for given currency. + description: The view input in XML or JSON format. content: - application/vnd.ibexa.api.CustomPriceUpdateStruct+json: + application/vnd.ibexa.api.RegionViewInput+json: schema: - $ref: '#/components/schemas/CustomPriceUpdateStructWrapper' + $ref: '#/components/schemas/RegionViewInputWrapper' example: - CustomPriceUpdateStruct: - amount: 2500 - customAmount: 1700 - currency: USD - application/vnd.ibexa.api.PriceUpdateStruct+json: + ViewInput: + identifier: TitleView + RegionQuery: + limit: "10" + offset: "0" + application/vnd.ibexa.api.RegionViewInput+xml: schema: - $ref: '#/components/schemas/PriceUpdateStructWrapper' - example: - PriceUpdateStruct: - amount: 3500 - currency: USD + $ref: '#/components/schemas/RegionViewInput' required: false - deprecated: false - /product/catalog/products/{identifier}: - delete: - operationId: ibexa.product_catalog.rest.products.delete + /product/catalog/regions/{identifier}: + get: + operationId: ibexa.product_catalog.rest.region tags: - - Product + - Product Region 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. + 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: identifier in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. + description: RegionLoadByIdentifierController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - /product/catalog/products/{productTypeIdentifier}: - post: - operationId: ibexa.product_catalog.rest.products.create + /product/catalog/product_types: + get: + operationId: ibexa.product_catalog.rest.product_types tags: - - Product + - Product Type responses: - 201: - description: If set, the new product is returned in XML or JSON format. + 200: + description: ProductTypeList - If set, the product type list is returned + in XML or JSON format. content: - application/vnd.ibexa.api.ProductCreate+json: + application/vnd.ibexa.api.ProductTypeList+json: schema: - $ref: '#/components/schemas/ProductWrapper' + $ref: '#/components/schemas/ProductTypeListWrapper' example: - Product: - _media-type: application/vnd.ibexa.api.Product+json - code: wsk_98845 - name: HUMMINGBIRD PRO DRY 9,2MM + ProductTypeList: + _media-type: application/vnd.ibexa.api.ProductTypeList+json ProductType: - _media-type: application/vnd.ibexa.api.ProductType+json - identifier: d_rope - name: Dynamic ropes + - _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: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - id: 615 - fieldDefinitionIdentifier: image - languageCode: eng-GB - fieldTypeIdentifier: ibexa_image_asset - fieldValue: - destinationContentId: ~ - alternativeText: ~ - source: ~ - 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: ~ - height: ~ - 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: ~ - height: ~ - mimeType: image/svg+xml - created_at: 1645787815 - updated_at: 1645787815 - AttributesList: [] + 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: [] + requestBody: + description: The ProductTypeList schema encoded in XML or JSON format. + 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 + post: + operationId: ibexa.product_catalog.rest.product_types.create + tags: + - Product Type + responses: + 201: + description: If set, the new product type is returned in XML or JSON format. + content: + application/vnd.ibexa.api.ProductType+json: + schema: + $ref: '#/components/schemas/ProductTypeWrapper' + example: + ProductType: + _media-type: application/vnd.ibexa.api.ProductType+json + identifier: test_pt321 + name: New Product Type + AttributeAssignmentList: + - _media-type: application/vnd.ibexa.api.AttributeAssignment+json + is_required: false + is_discriminator: true + Attribute: + _media-type: application/vnd.ibexa.api.Attribute+json + identifier: testAttr + name: testAttr + description: "" + type: Checkbox + type_identifier: checkbox + value: true + group: Test Attribute group + position: 0 + options: [] 400: description: Error - the input does not match the input schema definition. 401: - description: Error - the user is not authorized to update this product. + description: Error - the user is not authorized to create this product type. 403: - description: Error - a product with the same name already exists. + description: Error - a product type with the same name already exists. 404: - description: Error - no product with the given code exists. - summary: Create product - description: Creates a new product. + description: Error - the product type with the given ID does not exist. + summary: Create product type + description: Creates a new product type. parameters: - - name: productTypeIdentifier - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The product schema encoded in XML or JSON format. + description: The ProductType schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.ProductCreate+json: + application/vnd.ibexa.api.ProductTypeCreate+json: schema: - $ref: '#/components/schemas/ProductCreateWrapper' + $ref: '#/components/schemas/ProductTypeCreateWrapper' 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 + 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': ~ + creationDate: "2002-06-18T09:21:38+00:00" + modificationDate: "2021-06-28T11:31:22+00:00" + 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': ~ + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: 255 + minStringLength: ~ + main_language_code: eng-GB + assigned_attributes: + - identifier: testAttr + is_required: false + is_discriminator: true required: false - deprecated: false - /product/catalog/attributes: + /product/catalog/product_types/is_used/{identifier}: get: - operationId: ibexa.product_catalog.rest.attributes + operationId: ibexa.product_catalog.rest.product_types.is_used tags: - - Product Attribute + - Product Type responses: 200: - description: AttributeList - If set, the attributes list is returned in - XML or JSON format. + description: OK - product type usage is returned. 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: + application/vnd.ibexa.api.ProductTypeUsage+json: 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: [] - requestBody: - description: Attribute filter - content: - application/vnd.ibexa.api.AttributeListGet+json: - schema: - $ref: '#/components/schemas/AttributeListGetWrapper' - example: - AttributeListGet: - group_name_prefix: a - name_prefix: a - offset: 0 - limit: 10 - application/vnd.ibexa.api.AttributeListGet+xml: - schema: - $ref: '#/components/schemas/AttributeListGet' - required: false - deprecated: false - post: - operationId: ibexa.product_catalog.rest.attributes.create - tags: - - Product Attribute - responses: - 201: - description: If set, the new attribute is returned in XML or JSON format. - content: - application/vnd.ibexa.api.Attribute+json: + $ref: '#/components/schemas/ProductTypeUsageWrapper' + application/vnd.ibexa.api.ProductTypeUsage+xml: schema: - $ref: '#/components/schemas/AttributeWrapper' - example: - Attribute: - _media-type: application/vnd.ibexa.api.Attribute+json - identifier: foo - name: Attribute - description: description - type: Checkbox - type_identifier: checkbox - value: true - group: Attribute Test - position: 0 - options: [] - 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: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The attribute schema encoded in XML or JSON format. - 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: ibexa.product_catalog.rest.attributes.translation.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. + $ref: '#/components/schemas/ProductTypeUsage' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <ProductTypeUsage media-type="application/vnd.ibexa.api.ProductTypeUsage+xml"> + <is_used>1</is_used> + </ProductTypeUsage> + 404: + description: Error - product type not found. + summary: Check product type usage + description: Checks whether the product type is in use. parameters: - - name: id - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: languageCode + - name: identifier in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. + description: ProductTypeIsUsedController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - /product/catalog/attributes/view: + /product/catalog/product_types/view: post: - operationId: ibexa.product_catalog.rest.attributes.view + operationId: ibexa.product_catalog.rest.product_types.view tags: - - Product Attribute + - Product Type responses: 200: description: The view in XML or JSON format. content: - application/vnd.ibexa.api.AttributeView+json: + application/vnd.ibexa.api.ProductTypeView+json: schema: - $ref: '#/components/schemas/AttributeViewWrapper' + $ref: '#/components/schemas/ProductTypeViewWrapper' example: - AttributeView: - _media-type: application/vnd.ibexa.api.AttributeView+json + ProductTypeView: + _media-type: application/vnd.ibexa.api.ProductTypeView+json identifier: TitleView - AttributeQuery: - _media-type: application/vnd.ibexa.api.AttributeQuery+json + ProductTypeQuery: + _media-type: application/vnd.ibexa.api.ProductTypeQuery+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: ~ - defaultRangeMaximumValue: ~ - application/vnd.ibexa.api.AttributeView+xml: + 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: ~ + defaultRangeMaximumValue: ~ + - _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/AttributeView' + $ref: '#/components/schemas/ProductTypeView' 400: description: Error - the input does not match the input schema definition. - summary: Filter attributes + 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: @@ -17869,11585 +11715,2704 @@ paths: description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: description: The view input in XML or JSON format. content: - application/vnd.ibexa.api.AttributeViewInput+json: + application/vnd.ibexa.api.ProductTypeViewInput+json: schema: - $ref: '#/components/schemas/AttributeViewInputWrapper' + $ref: '#/components/schemas/ProductTypeViewInputWrapper' example: ViewInput: identifier: TitleView - AttributeQuery: + ProductTypeQuery: limit: "10" offset: "0" - Query: - AttributeNameCriterion: measure - AttributeGroupIdentifierCriterion: test_attribute_group - application/vnd.ibexa.api.AttributeViewInput+xml: + name_prefix: new + application/vnd.ibexa.api.ProductTypeViewInput+xml: schema: - $ref: '#/components/schemas/AttributeViewInput' + $ref: '#/components/schemas/ProductTypeViewInput' required: false - deprecated: false - /product/catalog/attributes/{id}: + /product/catalog/product_types/{identifier}: get: - operationId: ibexa.product_catalog.rest.attributes.get + operationId: ibexa.product_catalog.rest.product_type tags: - - Product Attribute + - Product Type responses: 200: - description: Attribute - If set, the given attribute is returned in XML - or JSON format. + description: OK - load the product type content: - application/vnd.ibexa.api.Attribute+json: + application/vnd.ibexa.api.ProductType+json: schema: - $ref: '#/components/schemas/AttributeWrapper' + $ref: '#/components/schemas/ProductTypeWrapper' example: - Attribute: - _media-type: application/vnd.ibexa.api.Attribute+json - identifier: attrib2 - name: Attrib2 - description: "" - type: Checkbox - type_identifier: checkbox - value: true - group: Attribute Group Test - position: 0 - options: [] - application/vnd.ibexa.api.Attribute+xml: + ProductType: + _media-type: application/vnd.ibexa.api.ProductType+json + identifier: d_rope + name: Dynamic ropes + AttributeAssignmentList: [] + application/vnd.ibexa.api.ProductType+xml: schema: - $ref: '#/components/schemas/Attribute' + $ref: '#/components/schemas/ProductType' 401: - description: Error - the user has no permission to read the attribute. - summary: Load attribute - description: Loads given attribute. + 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: id + - name: identifier in: path - description: "" + description: ProductTypeLoadByIdentifierController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false + /product/catalog/product_types/{id}: delete: - operationId: ibexa.product_catalog.rest.attributes.delete + operationId: ibexa.product_catalog.rest.product_types.delete tags: - - Product Attribute + - Product Type responses: - 200: - description: No Content. + 204: + description: No content - the given product type is deleted. 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. + 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: "" + description: ProductTypeDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. 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: ibexa.product_catalog.rest.attributes.update + operationId: ibexa.product_catalog.rest.product_types.update tags: - - Product Attribute + - Product Type responses: 201: - description: If set, the updated attribute is returned in XML or JSON format. + description: If set, the updated product type is returned in XML or JSON + format. content: - application/vnd.ibexa.api.Attribute+json: + application/vnd.ibexa.api.ProductType+json: schema: - $ref: '#/components/schemas/AttributeWrapper' + $ref: '#/components/schemas/ProductTypeWrapper' 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: [] + 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 attribute. - 403: - description: Error - an attribute with the same name already exists. + description: Error - the user is not authorized to create this product type. 404: - description: Error - the attribute with the given ID does not exist. - summary: Update attribute - description: Updates an attribute. + description: Error - the product type with the given ID does not exist. + summary: Update product type + description: Updates product type. parameters: - 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: "" + description: ProductTypeUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: If set, the updated attribute group is returned in XML or JSON - format. + description: If set, the updated product type is returned in XML or JSON format. content: - application/vnd.ibexa.api.AttributeUpdate+json: + application/vnd.ibexa.api.ProductTypeUpdate+json: schema: - $ref: '#/components/schemas/AttributeUpdateWrapper' + $ref: '#/components/schemas/ProductTypeUpdateWrapper' example: - AttributeUpdate: - identifier: attr_group - names: - eng-GB: Attribute Group - descriptions: - eng-GB: description - position: 0 - options: - foo: bar + 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/attribute_groups: + /product/catalog/product_variant/{code}: get: - operationId: ibexa.product_catalog.rest.attribute_groups + operationId: ibexa.product_catalog.rest.product_variant tags: - - Product Attribute Group + - Product Variant responses: 200: - description: AttributeGroupList - If set, the attribute group list is returned - in XML or JSON format. + description: OK - loads the product variant. content: - application/vnd.ibexa.api.AttributeGroupList+json: + application/vnd.ibexa.api.ProductVariant+json: schema: - $ref: '#/components/schemas/AttributeGroupListWrapper' + $ref: '#/components/schemas/ProductVariantWrapper' 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: [] - requestBody: - description: The AttributeGroupListGet schema encoded in XML or JSON format. - 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: ibexa.product_catalog.rest.attribute_groups.create - tags: - - Product Attribute Group - responses: - 201: - description: If set, the new attribute group is returned in XML or JSON - format. - content: - application/vnd.ibexa.api.AttributeGroup+json: - schema: - $ref: '#/components/schemas/AttributeGroupWrapper' - example: - AttributeGroup: - _media-type: application/vnd.ibexa.api.AttributeGroup+json - name: Attribute Group Test - identifier: attr_group_test - 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: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The AttributeGroup schema encoded in XML or JSON format. - 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: ibexa.product_catalog.rest.attribute_groups.translation.delete - tags: - - Product Attribute Group - responses: - 200: - description: No content - the given attribute group translation is deleted. + ProductVariant: + _media-type: application/vnd.ibexa.api.ProductVariant+json + code: macbook + name: Macbook Air 32/232 + Product: + _media-type: application/vnd.ibexa.api.Product+json + code: mac_air + name: Macbook Air + ProductType: + _media-type: application/vnd.ibexa.api.ProductType+json + identifier: laptop + name: Laptop + AttributeAssignmentList: + - _media-type: application/vnd.ibexa.api.AttributeAssignment+json + is_required: false + is_discriminator: true + Attribute: + _media-type: application/vnd.ibexa.api.Attribute+json + identifier: number + name: number + 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: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>test</para></section> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>test</p></section> + - id: 719 + fieldDefinitionIdentifier: image + languageCode: eng-GB + fieldTypeIdentifier: ibexa_image_asset + fieldValue: + destinationContentId: ~ + alternativeText: ~ + source: ~ + - id: 720 + fieldDefinitionIdentifier: category + languageCode: eng-GB + fieldTypeIdentifier: ibexa_taxonomy_entry_assignment + fieldValue: + taxonomy_entries: [] + taxonomy: ~ + 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: ~ + height: ~ + 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: ~ + height: ~ + 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 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. + 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: id - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: languageCode + - name: code in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. + description: ProductVariantLoadByCodeController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - /product/catalog/attribute_groups/view: + /product/catalog/product_variants/generate/{baseProductCode}: post: - operationId: ibexa.product_catalog.rest.attribute_groups.view - tags: - - Product Attribute Group - responses: - 200: - description: The view in XML or JSON format. - 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: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The view input in XML or JSON format. - 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: ibexa.product_catalog.rest.attribute_groups.get - tags: - - Product Attribute Group - responses: - 200: - description: AttributeGroupGet - If set, the attribute group List is returned - in XML or JSON format. - content: - application/vnd.ibexa.api.AttributeGroup+json: - schema: - $ref: '#/components/schemas/AttributeGroupWrapper' - example: - AttributeGroup: - _media-type: application/vnd.ibexa.api.AttributeGroup+json - name: Attribute Group Test - identifier: attr_group_test - 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: id - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: An optional AttributeGroupGet schema encoded in XML or JSON format. - 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: ibexa.product_catalog.rest.attribute_groups.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 - - name: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false - patch: - operationId: ibexa.product_catalog.rest.attribute_groups.update + operationId: ibexa.product_catalog.rest.product_variants.generate tags: - - Product Attribute Group + - Product Variant responses: 201: - description: If set, the updated attribute group is returned in XML or JSON - format. - 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' + 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 attribute - group. + description: Error - the user is not authorized to create this product variant. 403: - description: Error - an attribute group with the same identifier already - exists. + description: Error - a product variant with the same name already exists. 404: - description: Error - the group with the given ID does not exist. - summary: Update attribute group - description: Updates an attribute group. + 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: id + - name: baseProductCode in: path - description: "" + description: ProductVariantGenereateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The attribute group update schema is sent in XML or JSON format. + description: The product variant schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.AttributeGroupUpdate+json: + application/vnd.ibexa.api.ProductVariantGenerate+json: schema: - $ref: '#/components/schemas/AttributeGroupUpdateWrapper' + $ref: '#/components/schemas/ProductVariantGenerateWrapper' example: - AttributeGroupUpdate: - identifier: ag_colors - names: - eng-GB: Colors Group - position: 0 - application/vnd.ibexa.api.AttributeGroupUpdate+xml: - schema: - $ref: '#/components/schemas/AttributeGroupUpdate' + ProductVariantGenerate: + attributes: + width: + - 123 + colors: + - '#000000' + - '#ffffff' + - '#d4d400' + - '#ff0000' required: false - deprecated: false - /product/catalog/attribute_types: - get: - operationId: ibexa.product_catalog.rest.attribute_types + /product/catalog/product_variants/view/{baseProductCode}: + post: + operationId: ibexa.product_catalog.rest.product_variants.view tags: - - Product Attribute Type + - Product Variant responses: 200: - description: OK - returns a list of Attribute Types + description: The view in XML or JSON format. 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: [] - deprecated: false - /product/catalog/attribute_types/{identifier}: - get: - operationId: ibexa.product_catalog.rest.attribute_type - tags: - - Product Attribute Type - responses: - 200: - description: OK - returns the Attribute Type - content: - application/vnd.ibexa.api.AttributeType+json: + application/vnd.ibexa.api.ProductVariantView+json: schema: - $ref: '#/components/schemas/AttributeTypeWrapper' - application/vnd.ibexa.api.AttributeType+xml: + $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: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>test</para></section> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>test</p></section> + - id: 719 + fieldDefinitionIdentifier: image + languageCode: eng-GB + fieldTypeIdentifier: ibexa_image_asset + fieldValue: + destinationContentId: ~ + alternativeText: ~ + source: ~ + - id: 720 + fieldDefinitionIdentifier: category + languageCode: eng-GB + fieldTypeIdentifier: ibexa_taxonomy_entry_assignment + fieldValue: + taxonomy_entries: [] + taxonomy: ~ + 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: ~ + height: ~ + 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: ~ + height: ~ + 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: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>test</para></section> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>test</p></section> + - id: 719 + fieldDefinitionIdentifier: image + languageCode: eng-GB + fieldTypeIdentifier: ibexa_image_asset + fieldValue: + destinationContentId: ~ + alternativeText: ~ + source: ~ + - id: 720 + fieldDefinitionIdentifier: category + languageCode: eng-GB + fieldTypeIdentifier: ibexa_taxonomy_entry_assignment + fieldValue: + taxonomy_entries: [] + taxonomy: ~ + 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: ~ + height: ~ + 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: ~ + height: ~ + 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/AttributeType' + $ref: '#/components/schemas/ProductVariantView' + 400: + description: Error - the input does not match the input schema definition. 404: - description: Error - The Attribute Type does not exist. - summary: Get Attribute Type - description: Gets an Attribute Type by its identifier. + 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: identifier + - name: baseProductCode in: path - description: "" + description: ProductVariantViewController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - /product/catalog/catalogs: + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + requestBody: + description: The view input in XML or JSON format. + 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 + /product/catalog/product_variants/{baseProductCode}: post: - operationId: ibexa.product_catalog.rest.catalogs.create + operationId: ibexa.product_catalog.rest.product_variants.create tags: - - Product Catalog + - Product Variant responses: 201: - description: If set, the new catalog is returned in XML or JSON format. - 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: '>=' + 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 update this catalog. + description: Error - the user is not authorized to create this product variant. 403: - description: Error - a catalog with the same name already exists. + description: Error - a product variant with the same name already exists. 404: - description: Error - no catalog with the given code exists. - summary: Create catalog - description: Creates a new catalog. + description: Error - no base product with the given code exists. + summary: Create product variant + description: Creates a new product variant. parameters: - - name: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. + - name: baseProductCode + in: path + description: ProductVariantCreateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - requestBody: - description: The catalog schema encoded in XML or JSON format. + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + requestBody: + description: The product variant schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.CatalogCreate+json: + application/vnd.ibexa.api.ProductVariantCreate+json: schema: - $ref: '#/components/schemas/CatalogCreateWrapper' + $ref: '#/components/schemas/ProductVariantCreateWrapper' 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 + ProductVariantCreate: + attributes: + width: 100 + height: 50 + color: '#000000' + code: macbook_pro required: false - deprecated: false - /product/catalog/catalogs/copy/{identifier}: - post: - operationId: ibexa.product_catalog.rest.catalogs.copy + /product/catalog/product_variants/{code}: + delete: + operationId: ibexa.product_catalog.rest.product_variants.delete tags: - - Product Catalog + - 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: ProductVariantDeleteController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: X-CSRF-Token + in: header + description: The CSRF token is required when passing user session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + patch: + operationId: ibexa.product_catalog.rest.product_variants.update + tags: + - Product Variant responses: 201: - description: If set, the copied catalog is returned in XML or JSON format. + description: If set, the updated product variant is returned in XML or JSON + format. content: - application/vnd.ibexa.api.Catalog+json: + application/vnd.ibexa.api.ProductVariant+json: schema: - $ref: '#/components/schemas/CatalogWrapper' + $ref: '#/components/schemas/ProductVariantWrapper' 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: '>=' + 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: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>test</para></section> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>test</p></section> + - id: 719 + fieldDefinitionIdentifier: image + languageCode: eng-GB + fieldTypeIdentifier: ibexa_image_asset + fieldValue: + destinationContentId: ~ + alternativeText: ~ + source: ~ + - id: 720 + fieldDefinitionIdentifier: category + languageCode: eng-GB + fieldTypeIdentifier: ibexa_taxonomy_entry_assignment + fieldValue: + taxonomy_entries: [] + taxonomy: ~ + 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: ~ + height: ~ + 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: ~ + height: ~ + 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 copy this catalog. + description: Error - the user is not authorized to update this product variant. 403: - description: Error - a catalog with the same identifier already exists. + description: Error - a product variant with the same code already exists. 404: - description: Error - no catalog with the given identifier exists. - summary: Copy catalog - description: Copies a catalog. + description: Error - no product variant with the given code exists. + summary: Update product variant + description: Updates product variant. parameters: - - name: identifier + - name: code in: path - description: "" + description: ProductVariantUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: If set, the copied catalog is returned in XML or JSON format. + description: The product variant update schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.CatalogCopy+json: + application/vnd.ibexa.api.ProductVariantUpdate+json: schema: - $ref: '#/components/schemas/CatalogCopyWrapper' + $ref: '#/components/schemas/ProductVariantUpdateWrapper' example: - CatalogCopy: - identifier: test_catalog_copied - creator_id: 14 + ProductVariantUpdate: + code: test + attributes: + number: 2 + testattr: 10 required: false - deprecated: false - /product/catalog/catalogs/filters: + /product/catalog/vat/{region}: get: - operationId: ibexa.product_catalog.rest.catalog.filters + operationId: ibexa.product_catalog.rest.vat.list tags: - - Product Catalog + - Product Vat responses: 200: - description: If set, the filters are returned in XML or JSON format. + description: OK - loads the VAT category list. content: - application/vnd.ibexa.api.ProductFilterList+json: + application/vnd.ibexa.api.VatCategoryList+json: schema: - $ref: '#/components/schemas/ProductFilterListWrapper' + $ref: '#/components/schemas/VatCategoryListWrapper' 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: [] - deprecated: false - /product/catalog/catalogs/sort_clauses: + 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: ~ + 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: region + in: path + description: VatCategoriesListController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + /product/catalog/vat/{region}/{identifier}: get: - operationId: ibexa.product_catalog.rest.catalog.sort_clauses - tags: - - Product Catalog - responses: - 200: - description: If set, the clauses are returned in XML or JSON format. - 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: [] - deprecated: false - /product/catalog/catalogs/view: - post: - operationId: ibexa.product_catalog.rest.catalogs.view + operationId: ibexa.product_catalog.rest.vat tags: - - Product Catalog + - Product Vat responses: 200: - description: The view in XML or JSON format. + description: OK - loads the VAT category. content: - application/vnd.ibexa.api.CatalogView+json: + application/vnd.ibexa.api.VatCategory+json: schema: - $ref: '#/components/schemas/CatalogViewWrapper' + $ref: '#/components/schemas/VatCategoryWrapper' 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. + 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: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. + - name: region + in: path + description: VatCategoryLoadByIdentifierController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - requestBody: - description: The view input in XML or JSON format. - 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}: + - name: identifier + in: path + description: VatCategoryLoadByIdentifierController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + /content/sections: get: - operationId: ibexa.product_catalog.rest.catalogs.get + operationId: ibexa.rest.list_sections tags: - - Product Catalog + - Section responses: 200: - description: If set, the catalog is returned in XML or JSON format. + description: If set, the Section list is returned in XML or JSON format. content: - application/vnd.ibexa.api.Catalog+json: + application/vnd.ibexa.api.SectionList+json: schema: - $ref: '#/components/schemas/CatalogWrapper' + $ref: '#/components/schemas/SectionListWrapper' example: - Catalog: - _media-type: application/vnd.ibexa.api.Catalog+json - identifier: test_catalog - name: Snow Equipment - description: "" - User: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - created: 1666090438 - modified: 1666090438 - status: draft - Criteria: - - _media-type: application/vnd.ibexa.api.ProductCode+json - ProductCodeCriterion: - _media-type: application/vnd.ibexa.api.ProductCodeCriterion+json - codes: - - ski - - snowboard - - _media-type: application/vnd.ibexa.api.ProductAvailability+json - ProductAvailabilityCriterion: - _media-type: application/vnd.ibexa.api.ProductAvailabilityCriterion+json - is_available: true - - _media-type: application/vnd.ibexa.api.ColorAttribute+json - ColorAttributeCriterion: - _media-type: application/vnd.ibexa.api.ColorAttributeCriterion+json - identifier: color - value: - - '#000000' - - '#FFFFFF' - - _media-type: application/vnd.ibexa.api.CreatedAt+json - CreatedAtCriterion: - _media-type: application/vnd.ibexa.api.CreatedAtCriterion+json - created_at: - date: "2022-09-12 00:00:00.000000" - timezone_type: 3 - timezone: Europe/Warsaw - operator: '>=' - - _media-type: application/vnd.ibexa.api.FloatAttribute+json - FloatAttributeCriterion: - _media-type: application/vnd.ibexa.api.FloatAttributeCriterion+json - identifier: width - value: 16.6 - - _media-type: application/vnd.ibexa.api.IntegerAttributeRange+json - IntegerAttributeRangeCriterion: - _media-type: application/vnd.ibexa.api.IntegerAttributeRangeCriterion+json - identifier: length - min: 180 - max: 230 - application/vnd.ibexa.api.Catalog+xml: + 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/Catalog' + $ref: '#/components/schemas/SectionList' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <SectionList media-type="application/vnd.ibexa.api.SectionList+xml" href="/api/ibexa/v2/content/sections"> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"> + <sectionId>1</sectionId> + <identifier>standard</identifier> + <name>Standard</name> + </Section> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"> + <sectionId>2</sectionId> + <identifier>users</identifier> + <name>Users</name> + </Section> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/3"> + <sectionId>3</sectionId> + <identifier>media</identifier> + <name>Media</name> + </Section> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/6"> + <sectionId>6</sectionId> + <identifier>form</identifier> + <name>Form</name> + </Section> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/7"> + <sectionId>7</sectionId> + <identifier>template</identifier> + <name>Template</name> + </Section> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/8"> + <sectionId>8</sectionId> + <identifier>restricted</identifier> + <name>Restricted</name> + </Section> + </SectionList> 401: - description: Error - the user is not authorized to view this catalog. + description: Error - The user has no permission to read the Section. + summary: Get Sections + description: Returns a list of all Sections. + parameters: + - name: If-None-Match + in: header + description: ETag + required: false + deprecated: false + schema: + type: string + style: simple + explode: false + post: + operationId: ibexa.rest.create_section + tags: + - Section + responses: + 201: + description: If set, the new Section is returned in XML or JSON format. + 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/13 + sectionId: 13 + identifier: restricted + name: Restricted + application/vnd.ibexa.api.Section+xml: + schema: + $ref: '#/components/schemas/Section' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/7"> + <sectionId>7</sectionId> + <identifier>restricted</identifier> + <name>Restricted</name> + </Section> + summary: Create new Section + description: Creates a new Section. + parameters: + - name: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + requestBody: + description: The Section input schema encoded in XML or JSON format. + 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: |- + <?xml version="1.0" encoding="UTF-8"?> + <SectionInput> + <identifier>restricted</identifier> + <name>Restricted</name> + </SectionInput> + required: false + /content/sections/{sectionId}: + get: + operationId: ibexa.rest.load_section + tags: + - Section + responses: + 200: + description: If set, the Section is returned in XML or JSON format. + 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/10 + sectionId: 10 + identifier: design + name: Design + application/vnd.ibexa.api.Section+xml: + schema: + $ref: '#/components/schemas/Section' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/5"> + <sectionId>10</sectionId> + <identifier>design</identifier> + <name>Design</name> + </Section> + 401: + description: Error - The user is not authorized to read this Section. 404: - description: Error - no catalog with the given identifier exists. - summary: Load catalog - description: Loads the given catalog. + description: Error - The Section does not exist. + summary: Get Section + description: Returns the Section by given Section ID. parameters: - - name: identifier + - name: If-None-match + in: header + description: ETag + required: false + deprecated: false + schema: + type: string + style: simple + explode: false + - name: sectionId in: path - description: "" + description: SectionLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false delete: - operationId: ibexa.product_catalog.rest.catalogs.delete + operationId: ibexa.rest.delete_section tags: - - Product Catalog + - Section responses: 204: - description: No content - the given catalog is deleted. + description: No Content - given Section is deleted. 401: - description: Error - the user is not authorized to delete this catalog. - summary: Delete catalog - description: Deletes the given catalog. + 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: identifier - in: path - description: "" + - name: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. + - name: sectionId + in: path + description: SectionDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false patch: - operationId: ibexa.product_catalog.rest.catalogs.update + operationId: ibexa.rest.update_section tags: - - Product Catalog + - Section responses: - 201: - description: If set, the updated catalog is returned in XML or JSON format. + 200: + description: OK - Section updated. content: - application/vnd.ibexa.api.Catalog+json: + application/vnd.ibexa.api.Section+json: schema: - $ref: '#/components/schemas/CatalogWrapper' + $ref: '#/components/schemas/SectionWrapper' example: - Catalog: - _media-type: application/vnd.ibexa.api.Catalog+json - identifier: test_catalog_updated - name: Snow Equipment updated - description: Snow Equipment catalog for 2022 - User: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - created: 1666090438 - modified: 1666091260 - status: published - Criteria: - - _media-type: application/vnd.ibexa.api.ProductCode+json - ProductCodeCriterion: - _media-type: application/vnd.ibexa.api.ProductCodeCriterion+json - codes: - - ski - - _media-type: application/vnd.ibexa.api.ProductAvailability+json - ProductAvailabilityCriterion: - _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: '>=' + 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: | + <?xml version="1.0" encoding="UTF-8"?> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/7"> + <sectionId>7</sectionId> + <identifier>template</identifier> + <name>Template</name> + </Section> 400: description: Error - the input does not match the input schema definition. 401: - description: Error - the user is not authorized to update this catalog. + description: Error - the user is not authorized to create this Section. 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. + 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: identifier - in: path - description: "" + - name: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: X-CSRF-Token + - name: If-Match in: header - description: The CSRF token is required when passing user session. + description: ETag + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: sectionId + in: path + description: SectionUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: If set, the updated catalog is returned in XML or JSON format. + description: The Section input schema encoded in XML or JSON. content: - application/vnd.ibexa.api.CatalogUpdate+json: + application/vnd.ibexa.api.SectionInput+json: schema: - $ref: '#/components/schemas/CatalogUpdateWrapper' + $ref: '#/components/schemas/SectionInputWrapper' 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 + SectionInput: + identifier: template + name: Template + application/vnd.ibexa.api.SectionInput+xml: + schema: + $ref: '#/components/schemas/SectionInput' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <SectionInput> + <identifier>template</identifier> + <name>Template</name> + </SectionInput> required: false - deprecated: false - /product/catalog/catalogs/{identifier}/products/view: - post: - operationId: ibexa.product_catalog.rest.catalogs.products.view + /segment_groups: + get: + operationId: ibexa.segmentation.rest.segment_groups.list tags: - - Product Catalog + - Segmentation responses: 200: - description: The view in XML or JSON format. + description: OK - list the segment groups. content: - application/vnd.ibexa.api.ProductView+json: + application/vnd.ibexa.api.SegmentGroupList+json: schema: - $ref: '#/components/schemas/ProductViewWrapper' + $ref: '#/components/schemas/SegmentGroupListWrapper' 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: 1 - ProductList: - _media-type: application/vnd.ibexa.api.ProductList+json - Product: - - _media-type: application/vnd.ibexa.api.Product+json - code: test - name: test - ProductType: - _media-type: application/vnd.ibexa.api.ProductType+json - identifier: quickdraw - name: Quickdraw - AttributeAssignmentList: [] - Content: - _media-type: application/vnd.ibexa.api.Content+json - _href: /api/ibexa/v2/content/objects/187 - _remoteId: b0608be4ef4dc978ad603d02ac3c9ad1 - _id: 187 - ContentType: - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/55 - Name: test - TranslatedName: test - Versions: - _media-type: application/vnd.ibexa.api.VersionList+json - _href: /api/ibexa/v2/content/objects/187/versions - CurrentVersion: - _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/187/currentversion - Version: - _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/187/versions/1 - VersionInfo: - id: 665 - versionNo: 1 - status: PUBLISHED - modificationDate: "2022-08-26T11:16:49+02:00" - Creator: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - creationDate: "2022-08-26T11:16: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': test - Content: - _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/187 - Fields: - field: - - id: 915 - fieldDefinitionIdentifier: name - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: test - - id: 916 - fieldDefinitionIdentifier: product_specification - languageCode: eng-GB - fieldTypeIdentifier: ibexa_product_specification - fieldValue: - id: 60 - code: test - attributes: [] - - id: 917 - fieldDefinitionIdentifier: description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - id: 918 - fieldDefinitionIdentifier: image - languageCode: eng-GB - fieldTypeIdentifier: ibexa_image_asset - fieldValue: - destinationContentId: ~ - alternativeText: ~ - source: ~ - - id: 919 - fieldDefinitionIdentifier: category - languageCode: eng-GB - fieldTypeIdentifier: ibexa_taxonomy_entry_assignment - fieldValue: - taxonomy_entries: [] - taxonomy: ~ - Relations: - _media-type: application/vnd.ibexa.api.RelationList+json - _href: /api/ibexa/v2/content/objects/187/versions/1/relations - Relation: [] - Thumbnail: - _media-type: application/vnd.ibexa.api.Thumbnail+json - resource: /bundles/ibexaadminui/img/ibexa-icons.svg#file - width: ~ - height: ~ - 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/187/locations - Owner: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - lastModificationDate: "2022-08-26T11:16:49+02:00" - publishedDate: "2022-08-26T11:16:49+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/187/objectstates - Thumbnail: - _media-type: application/vnd.ibexa.api.Thumbnail+json - resource: /bundles/ibexaadminui/img/ibexa-icons.svg#file - width: ~ - height: ~ - mimeType: image/svg+xml - created_at: 1661505409 - updated_at: 1661505409 - AttributesList: [] - application/vnd.ibexa.api.ProductView+xml: + 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/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: identifier - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The view input in XML or JSON format. - 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: ibexa.product_catalog.rest.currencies - tags: - - Product Currency - responses: - 200: - description: OK - loads currencies. + $ref: '#/components/schemas/SegmentGroupList' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <SegmentGroupList media-type="application/vnd.ibexa.api.SegmentGroupList+xml" href="/api/ibexa/v2/segment_groups"> + <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts"> + <id>1</id> + <identifier>corporate_accounts</identifier> + <name>Corporate Accounts</name> + </SegmentGroup> + </SegmentGroupList> + 401: + description: Error - the user is not authorized to list segment groups. content: - application/vnd.ibexa.api.CurrencyList+json: + application/vnd.ibexa.api.ErrorMessage+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. + $ref: '#/components/schemas/ErrorMessage' + application/vnd.ibexa.api.ErrorMessage+xml: + schema: + $ref: '#/components/schemas/ErrorMessage' + summary: List segment groups + description: Lists segment groups. parameters: [] - deprecated: false - post: - operationId: ibexa.product_catalog.rest.currencies.create + /segment_groups/{identifier}: + get: + operationId: ibexa.segmentation.rest.segment_groups.view tags: - - Product Currency + - Segmentation responses: 200: - description: If set, the new currency is returned in JSON format. + description: OK - return the segment group. content: - application/vnd.ibexa.api.Currency+json: + application/vnd.ibexa.api.SegmentGroup+json: schema: - $ref: '#/components/schemas/CurrencyWrapper' + $ref: '#/components/schemas/SegmentGroupWrapper' example: - Currency: - _media-type: application/vnd.ibexa.api.Currency+json - id: 181 - code: cur - subunits: 1 - enabled: true - 400: - description: Error - the input does not match the input schema definition. + 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: | + <?xml version="1.0" encoding="UTF-8"?> + <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts"> + <id>1</id> + <identifier>corporate_accounts</identifier> + <name>Corporate Accounts</name> + </SegmentGroup> 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. + 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: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. + - name: identifier + in: path + description: SegmentGroupViewController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - requestBody: - description: The Currency schema encoded in XML or JSON format. - 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: ibexa.product_catalog.rest.currencies.view + /segment_groups/{identifier}/segments: + get: + operationId: ibexa.segmentation.rest.segment_groups.list.segments tags: - - Product Currency + - Segmentation responses: 200: - description: The view in XML or JSON format. + description: OK - list the group's segments. content: - application/vnd.ibexa.api.CurrencyView+json: + application/vnd.ibexa.api.SegmentList+json: schema: - $ref: '#/components/schemas/CurrencyViewWrapper' + $ref: '#/components/schemas/SegmentListWrapper' 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: + 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/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. + $ref: '#/components/schemas/SegmentList' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <SegmentList media-type="application/vnd.ibexa.api.SegmentList+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts/segments"/> + 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: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. + - name: identifier + in: path + description: SegmentListController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - requestBody: - description: The view input in XML or JSON format. - 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}: + /segments/{identifier}: get: - operationId: ibexa.product_catalog.rest.currencies.get + operationId: ibexa.segmentation.rest.segments.view tags: - - Product Currency + - Segmentation responses: 200: - description: OK - loads the currency. + description: OK - Return the segment. content: - application/vnd.ibexa.api.Currency+json: + application/vnd.ibexa.api.Segment+json: schema: - $ref: '#/components/schemas/CurrencyWrapper' + $ref: '#/components/schemas/SegmentWrapper' example: - Currency: - _media-type: application/vnd.ibexa.api.Currency+json - id: 3 - code: ALL - subunits: 2 - enabled: false + Segment: + _media-type: application/vnd.ibexa.api.Segment+json + _href: /api/ibexa/v2/segments/corporate_account + id: 1 + identifier: corporate_account + name: Corporate Account + source: cohesivo + lastUpdatedBy: "14" + updatedAt: "2026-06-30T12:00:00+00:00" + SegmentGroup: + _media-type: application/vnd.ibexa.api.SegmentGroup+json + _href: /api/ibexa/v2/segment_groups/corporate_accounts + application/vnd.ibexa.api.Segment+xml: + schema: + $ref: '#/components/schemas/Segment' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <Segment media-type="application/vnd.ibexa.api.Segment+xml" href="/api/ibexa/v2/segments/corporate_account"> + <id>1</id> + <identifier>corporate_account</identifier> + <name>Corporate Account</name> + <source>cohesivo</source> + <lastUpdatedBy>14</lastUpdatedBy> + <updatedAt>2026-06-30T12:00:00+00:00</updatedAt> + <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts"/> + </Segment> 401: - description: Error - the user has no permission to read currencies. + description: Error - the user is not authorized to load this group's segments. 404: - description: Error - the currency does not exist. - summary: Load currency - description: Loads a currency. + description: Error - the identifier doesn't match any segment group. + summary: Load segment + description: Loads the identified segment. parameters: - - name: id + - name: identifier in: path - description: "" + description: SegmentViewController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false + /taxonomy/{taxonomyName}/entries: delete: - operationId: ibexa.product_catalog.rest.currencies.delete + operationId: ibexa.taxonomy.rest.entries.remove tags: - - Product Currency + - Taxonomy responses: - 200: - description: No content - the given currency is deleted. + 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 this currency. - summary: Delete currency - description: Deletes the given currency. + description: Error - The user is not authorized to delete some of the entries. + summary: Delete Entries + description: Bulk removes several taxonomy entries. parameters: - - name: id - in: path - description: "" + - name: X-CSRF-Token + in: header + description: The CSRF token. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. + - name: taxonomyName + in: path + description: TaxonomyEntryBulkRemoveController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - patch: - operationId: ibexa.product_catalog.rest.currencies.update + requestBody: + description: TaxonomyEntryBulkRemove schema encoded in XML or JSON format. + 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 + /taxonomy/{taxonomyName}/entries/move: + post: + operationId: ibexa.taxonomy.rest.entries.move tags: - - Product Currency + - Taxonomy responses: - 200: - description: If set, the updated currency is returned in XML or JSON format. - 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 + 204: + description: No Content - The entries have been moved. 400: - description: Error - the input does not match the input schema definition. + 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. + description: Error - The user is not authorized to move some of the entries. 404: - description: Error - the currency with the given ID does not exist. - summary: Update currency - description: Updates a currency. + 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: id - in: path - description: "" + - name: X-CSRF-Token + in: header + description: The CSRF token. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. + - name: taxonomyName + in: path + description: TaxonomyEntryBulkMoveController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The CurrencyUpdate schema encoded in XML or JSON format. + description: The TaxonomyEntryBulkMove schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.CurrencyUpdate+json: + application/vnd.ibexa.api.TaxonomyEntryBulkMove+json: schema: - $ref: '#/components/schemas/CurrencyUpdateWrapper' + $ref: '#/components/schemas/TaxonomyEntryBulkMoveWrapper' example: - CurrencyUpdate: - subunits: 1 - enabled: false + 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 - /product/catalog/customer_groups: + /taxonomy/{taxonomyName}/entry-assignment/{id}: get: - operationId: ibexa.product_catalog.rest.customer_groups.list + operationId: ibexa.taxonomy.rest.entry_assignment.load_by_id tags: - - Product Customer Group + - Taxonomy responses: 200: - description: If set, the customer groups list is returned in XML or JSON - format. + description: OK - returns the taxonomy entry Assignment. content: - application/vnd.ibexa.api.CustomerGroupList+json: + application/vnd.ibexa.api.TaxonomyEntryAssignment+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: [] - deprecated: false + $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: taxonomyName + in: path + description: TaxonomyEntryAssignmentLoadByIdController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: id + in: path + description: TaxonomyEntryAssignmentLoadByIdController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + /taxonomy/{taxonomyName}/entry-assignments/assign-to-content: post: - operationId: ibexa.product_catalog.rest.customer_group.create + operationId: ibexa.taxonomy.rest.entry_assignments.assign_to_content tags: - - Product Customer Group + - Taxonomy responses: 201: - description: If set, the new customer group is returned in XML or JSON format. - content: - application/vnd.ibexa.api.CustomerGroup+json: - schema: - $ref: '#/components/schemas/CustomerGroupWrapper' - example: - CustomerGroup: - _media-type: application/vnd.ibexa.api.CustomerGroup+json - id: 5 - name: test-en - identifier: test - description: test-desc-en - users: [] - global_price_rate: "1.00" + description: No Content. 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. + description: Error - the user is not authorized to assign this Entry. + summary: Assign entry + description: Assigns taxonomy entry to a content item. parameters: - name: X-CSRF-Token in: header - description: The CSRF token is required when passing user session. + description: The CSRF token. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: taxonomyName + in: path + description: TaxonomyEntryAssignmentAssignController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The CustomerGroupCreate schema encoded in XML or JSON format. + description: TaxonomyEntryAssignToContent schema encoded in JSON format. content: - application/vnd.ibexa.api.CustomerGroupCreate+json: + application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json: schema: - $ref: '#/components/schemas/CustomerGroupCreateWrapper' + $ref: '#/components/schemas/TaxonomyEntryAssignToContentWrapper' example: - CustomerGroupCreate: - identifier: customer_group - names: - eng-GB: Customer Group - descriptions: - eng-GB: Customer Group description - global_price_rate: "1" + TaxonomyEntryAssignToContent: + content: 130 + entries: + - 2 + - 3 required: false - deprecated: false - /product/catalog/customer_groups/view: - post: - operationId: ibexa.product_catalog.rest.customer_groups.view + /taxonomy/{taxonomyName}/entry-assignments/content-id/{contentId}: + get: + operationId: ibexa.taxonomy.rest.entry_assignments.load tags: - - Product Customer Group + - Taxonomy responses: 200: - description: The view in XML or JSON format. + description: OK - returns the assigment collection. content: - application/vnd.ibexa.api.CustomerGroupView+json: + application/vnd.ibexa.api.EntryAssignmentCollection+json: schema: - $ref: '#/components/schemas/CustomerGroupViewWrapper' + $ref: '#/components/schemas/EntryAssignmentCollectionWrapper' 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: + 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/CustomerGroupView' + $ref: '#/components/schemas/EntryAssignmentCollection' + example: |- + <?xml version="1.0" encoding="UTF-8"?> + <EntryAssignmentCollection media-type="application/vnd.ibexa.api.EntryAssignmentCollection+xml"> + <content media-type="application/vnd.ibexa.api.Content+xml"> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/1" remoteId="9459d3c29e15006e45197295722c7ade" id="1"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"/> + <Name>Ibexa Platform</Name> + <TranslatedName>Ibexa Platform</TranslatedName> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/1/versions"/> + <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/1/currentversion"/> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/1/locations"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <lastModificationDate>2023-01-01T00:00:00+00:00</lastModificationDate> + <publishedDate>2015-11-30T13:10:46+00:00</publishedDate> + <mainLanguageCode>eng-GB</mainLanguageCode> + <currentVersionNo>10</currentVersionNo> + <alwaysAvailable>true</alwaysAvailable> + <isHidden>false</isHidden> + <status>PUBLISHED</status> + <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/1/objectstates"/> + </Content> + </content> + <TaxonomyEntryAssignment media-type="application/vnd.ibexa.api.TaxonomyEntryAssignment+xml"> + <id>1</id> + <content media-type="application/vnd.ibexa.api.Content+xml"> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/1" remoteId="9459d3c29e15006e45197295722c7ade" id="1"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"/> + <Name>Ibexa Platform</Name> + <TranslatedName>Ibexa Platform</TranslatedName> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/1/versions"/> + <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/1/currentversion"/> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/1/locations"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <lastModificationDate>2023-01-01T00:00:00+00:00</lastModificationDate> + <publishedDate>2015-11-30T13:10:46+00:00</publishedDate> + <mainLanguageCode>eng-GB</mainLanguageCode> + <currentVersionNo>10</currentVersionNo> + <alwaysAvailable>true</alwaysAvailable> + <isHidden>false</isHidden> + <status>PUBLISHED</status> + <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/1/objectstates"/> + </Content> + </content> + <entry media-type="application/vnd.ibexa.api.TaxonomyEntry+xml"> + <TaxonomyEntry media-type="application/vnd.ibexa.api.TaxonomyEntry+xml"> + <id>3</id> + <identifier>example</identifier> + <name>Example</name> + <contentId>65</contentId> + <content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/65"/> + <taxonomy>tags</taxonomy> + </TaxonomyEntry> + </entry> + </TaxonomyEntryAssignment> + </EntryAssignmentCollection> + 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: taxonomyName + in: path + description: TaxonomyEntryAssignmentLoadController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: contentId + in: path + description: TaxonomyEntryAssignmentLoadController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + /taxonomy/{taxonomyName}/entry-assignments/unassign-from-content: + post: + operationId: ibexa.taxonomy.rest.entry_assignments.unassign_from_content + tags: + - Taxonomy + responses: + 201: + description: No Content. 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. + 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: X-CSRF-Token in: header - description: The CSRF token is required when passing user session. + description: The CSRF token. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: taxonomyName + in: path + description: TaxonomyEntryAssignmentUnassignController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The view input in XML or JSON format. + description: TaxonomyEntryUnassignFromContent schema encoded in JSON format. content: - application/vnd.ibexa.api.CustomerGroupViewInput+json: + application/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json: schema: - $ref: '#/components/schemas/CustomerGroupViewInputWrapper' + $ref: '#/components/schemas/TaxonomyEntryUnassignFromContentWrapper' example: - ViewInput: - identifier: TitleView - CustomerGroupQuery: - limit: "10" - offset: "0" - application/vnd.ibexa.api.CustomerGroupViewInput+xml: - schema: - $ref: '#/components/schemas/CustomerGroupViewInput' + TaxonomyEntryUnassignFromContent: + content: 130 + entries: + - 2 + - 3 required: false - deprecated: false - /product/catalog/customer_groups/{identifier}: + /taxonomy/{taxonomyName}/entry/content-id/{contentId}: get: - operationId: ibexa.product_catalog.rest.customer_groups.identifier + operationId: ibexa.taxonomy.rest.entry.load_by_content_id tags: - - Product Customer Group + - Taxonomy responses: 200: - description: If set, the customer group is returned in XML or JSON format. + description: OK - returns the taxonomy Entry. content: - application/vnd.ibexa.api.CustomerGroup+json: + application/vnd.ibexa.api.TaxonomyEntry+json: schema: - $ref: '#/components/schemas/CustomerGroupWrapper' - example: - CustomerGroup: - _media-type: application/vnd.ibexa.api.CustomerGroup+json - id: 1 - name: Resellers - identifier: resellers - description: "" - users: [] - global_price_rate: "0.00" + $ref: '#/components/schemas/TaxonomyEntryWrapper' + application/vnd.ibexa.api.TaxonomyEntry+xml: + schema: + $ref: '#/components/schemas/TaxonomyEntry' 401: - description: Error - the user has no permission to read customer groups. - summary: Load customer group - description: Returns a customer group + 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: identifier + - name: taxonomyName in: path - description: "" + description: TaxonomyEntryLoadByContentIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - delete: - operationId: ibexa.product_catalog.rest.customer_groups.delete + - name: contentId + in: path + description: TaxonomyEntryLoadByContentIdController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + /taxonomy/{taxonomyName}/entry/identifier/{identifier}: + get: + operationId: ibexa.taxonomy.rest.entry.load_by_identifier tags: - - Product Customer Group + - Taxonomy responses: - 204: - description: No content - the given customer group is deleted. + 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 delete this customer - group. - summary: Delete customer group - description: Deletes the given customer group. + 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: identifier + - name: taxonomyName in: path - description: "" + description: TaxonomyEntryLoadByIdentifierController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. + - name: identifier + in: path + description: TaxonomyEntryLoadByIdentifierController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - patch: - operationId: ibexa.product_catalog.rest.customer_group.update + /taxonomy/{taxonomyName}/entry/{id}: + get: + operationId: ibexa.taxonomy.rest.entry.load_by_id tags: - - Product Customer Group + - Taxonomy responses: - 201: - description: If set, the updated customer group is returned in XML or JSON - format. + 200: + description: OK - returns the taxonomy Entry. content: - application/vnd.ibexa.api.CustomerGroup+json: + application/vnd.ibexa.api.TaxonomyEntry+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. + $ref: '#/components/schemas/TaxonomyEntryWrapper' + application/vnd.ibexa.api.TaxonomyEntry+xml: + schema: + $ref: '#/components/schemas/TaxonomyEntry' 401: - description: Error - the user is not authorized to update a customer group. - summary: Update customer group - description: Updates the given customer group. + 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: identifier + - name: taxonomyName in: path - description: "" + description: TaxonomyEntryLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. + - name: id + in: path + description: TaxonomyEntryLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - requestBody: - description: The CustomerGroupUpdate schema encoded in XML or JSON format. - 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}: + /content/trash: get: - operationId: ibexa.product_catalog.rest.customer_group + operationId: ibexa.rest.load_trash_items tags: - - Product Customer Group + - Trash responses: 200: - description: If set, the customer group is returned in XML or JSON format. + description: OK - returns the list of items in the Trash. content: - application/vnd.ibexa.api.CustomerGroup+json: + application/vnd.ibexa.api.Trash+json: schema: - $ref: '#/components/schemas/CustomerGroupWrapper' + $ref: '#/components/schemas/TrashWrapper' 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: 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: ibexa.product_catalog.rest.regions - 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: + 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/RegionList' + $ref: '#/components/schemas/Trash' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <Trash media-type="application/vnd.ibexa.api.Trash+xml" href="/api/ibexa/v2/content/trash"> + <TrashItem media-type="application/vnd.ibexa.api.TrashItem+xml" href="/api/ibexa/v2/content/trash/58"> + <id>58</id> + <priority>0</priority> + <hidden>false</hidden> + <invisible>false</invisible> + <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/56"/> + <pathString>/1/2/56/58/</pathString> + <depth>3</depth> + <childCount>0</childCount> + <remoteId>59800915ad2eb8514de0bebe84f6ccba</remoteId> + <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/52"/> + <sortField>PATH</sortField> + <sortOrder>ASC</sortOrder> + <ContentInfo media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/52"> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/52" remoteId="881da87102313b0354dc2aa8f0e4b63b" id="52"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"/> + <Name>Folder 1</Name> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/52/versions"/> + <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/52/currentversion"/> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/52/locations"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <lastModificationDate>2019-02-06T09:03:09+01:00</lastModificationDate> + <publishedDate>2019-02-06T09:03:09+01:00</publishedDate> + <mainLanguageCode>eng-GB</mainLanguageCode> + <currentVersionNo>1</currentVersionNo> + <alwaysAvailable>true</alwaysAvailable> + <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/52/objectstates"/> + </Content> + </ContentInfo> + </TrashItem> + </Trash> 401: - description: Error - the user has no permission to read regions. - summary: Load regions - description: Loads the list of regions. + 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: [] - deprecated: false - /product/catalog/regions/view: - post: - operationId: ibexa.product_catalog.rest.regions.view + delete: + operationId: ibexa.rest.empty_trash tags: - - Product Region + - Trash responses: - 200: - description: The view in XML or JSON format. - 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. + 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: - name: X-CSRF-Token in: header - description: The CSRF token is required when passing user session. + description: The CSRF Token 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 view input in XML or JSON format. - 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}: + /content/trash/{trashItemid}: get: - operationId: ibexa.product_catalog.rest.region + operationId: ibexa.rest.load_trash_item tags: - - Product Region + - Trash responses: 200: - description: OK - loads region. + description: If set, the item in Trash is returned in XML or JSON format. content: - application/vnd.ibexa.api.Region+json: + application/vnd.ibexa.api.TrashItem+json: schema: - $ref: '#/components/schemas/RegionWrapper' - application/vnd.ibexa.api.Region+xml: + $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/Region' + $ref: '#/components/schemas/TrashItem' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <TrashItem media-type="application/vnd.ibexa.api.TrashItem+xml" href="/api/ibexa/v2/content/trash/81"> + <id>81</id> + <priority>0</priority> + <hidden>false</hidden> + <invisible>false</invisible> + <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/42"/> + <pathString>/1/2/42/81/</pathString> + <depth>3</depth> + <childCount>0</childCount> + <remoteId>135e8a84b61848a67be36e9552d2724d</remoteId> + <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/99"/> + <sortField>PATH</sortField> + <sortOrder>ASC</sortOrder> + <ContentInfo media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/99"> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/99" remoteId="ae2b4568c0d2e7a4a9bca9495e73591a" id="99"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"/> + <Name>Folder 1</Name> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/99/versions"/> + <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/99/currentversion"/> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/99/locations"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <lastModificationDate>2019-04-25T12:45:58+02:00</lastModificationDate> + <publishedDate>2019-04-25T12:45:58+02:00</publishedDate> + <mainLanguageCode>eng-GB</mainLanguageCode> + <currentVersionNo>1</currentVersionNo> + <alwaysAvailable>true</alwaysAvailable> + <status>TRASHED</status> + <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/99/objectstates"/> + </Content> + </ContentInfo> + </TrashItem> + 401: + description: Error - The user has no permission to read the item in Trash. 404: - description: Error - the region does not exist. - summary: Load region - description: Loads a region by its identifier + 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: identifier + - name: trashItemid in: path - description: "" + description: TrashItemLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - /product/catalog/product_types: - get: - operationId: ibexa.product_catalog.rest.product_types - tags: - - Product Type - responses: - 200: - description: ProductTypeList - If set, the product type list is returned - in XML or JSON format. - 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: [] - requestBody: - description: The ProductTypeList schema encoded in XML or JSON format. - 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: ibexa.product_catalog.rest.product_types.create + delete: + operationId: ibexa.rest.delete_trash_item tags: - - Product Type + - Trash responses: - 201: - description: If set, the new product type is returned in XML or JSON format. - content: - application/vnd.ibexa.api.ProductType+json: - schema: - $ref: '#/components/schemas/ProductTypeWrapper' - example: - ProductType: - _media-type: application/vnd.ibexa.api.ProductType+json - identifier: test_pt321 - name: New Product Type - AttributeAssignmentList: - - _media-type: application/vnd.ibexa.api.AttributeAssignment+json - is_required: false - is_discriminator: true - Attribute: - _media-type: application/vnd.ibexa.api.Attribute+json - identifier: testAttr - name: testAttr - description: "" - type: Checkbox - type_identifier: checkbox - value: true - group: Test Attribute group - position: 0 - options: [] - 400: - description: Error - the input does not match the input schema definition. + 204: + description: No Content - item deleted. 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. + description: Error - The user is not authorized to delete the provided item. 404: - description: Error - the product type with the given ID does not exist. - summary: Create product type - description: Creates a new product type. + description: Error - The provided item does not exist in Trash. + summary: Delete Trash item + description: Deletes the provided item from Trash. parameters: - name: X-CSRF-Token in: header - description: The CSRF token is required when passing user session. + description: The CSRF Token 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 ProductType schema encoded in XML or JSON format. - 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': ~ - creationDate: "2002-06-18T09:21:38+00:00" - modificationDate: "2021-06-28T11:31:22+00:00" - 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': ~ - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: 255 - minStringLength: ~ - 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: ibexa.product_catalog.rest.product_types.is_used - 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' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <ProductTypeUsage media-type="application/vnd.ibexa.api.ProductTypeUsage+xml"> - <is_used>1</is_used> - </ProductTypeUsage> - 404: - description: Error - product type not found. - summary: Check product type usage - description: Checks whether the product type is in use. - 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/product_types/view: - post: - operationId: ibexa.product_catalog.rest.product_types.view - tags: - - Product Type - responses: - 200: - description: The view in XML or JSON format. - 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: ~ - defaultRangeMaximumValue: ~ - - _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: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The view input in XML or JSON format. - 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: ibexa.product_catalog.rest.product_type - tags: - - Product Type - responses: - 200: - description: OK - load the product type - content: - application/vnd.ibexa.api.ProductType+json: - schema: - $ref: '#/components/schemas/ProductTypeWrapper' - example: - ProductType: - _media-type: application/vnd.ibexa.api.ProductType+json - identifier: d_rope - name: Dynamic ropes - AttributeAssignmentList: [] - application/vnd.ibexa.api.ProductType+xml: - schema: - $ref: '#/components/schemas/ProductType' - 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: 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: ibexa.product_catalog.rest.product_types.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 - - name: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false - patch: - operationId: ibexa.product_catalog.rest.product_types.update - tags: - - Product Type - responses: - 201: - description: If set, the updated product type is returned in XML or JSON - format. - 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: id + - name: trashItemid in: path - description: "" + description: TrashItemDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: If set, the updated product type is returned in XML or JSON format. - 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}: + /content/types: get: - operationId: ibexa.product_catalog.rest.product_variant + operationId: ibexa.rest.list_content_types tags: - - Product Variant + - Type responses: 200: - description: OK - loads the product variant. + description: OK - returns a list of content types. content: - application/vnd.ibexa.api.ProductVariant+json: + application/vnd.ibexa.api.ContentTypeInfoList+json: schema: - $ref: '#/components/schemas/ProductVariantWrapper' - example: - ProductVariant: - _media-type: application/vnd.ibexa.api.ProductVariant+json - code: macbook - name: Macbook Air 32/232 - Product: - _media-type: application/vnd.ibexa.api.Product+json - code: mac_air - name: Macbook Air - ProductType: - _media-type: application/vnd.ibexa.api.ProductType+json - identifier: laptop - name: Laptop - AttributeAssignmentList: - - _media-type: application/vnd.ibexa.api.AttributeAssignment+json - is_required: false - is_discriminator: true - Attribute: - _media-type: application/vnd.ibexa.api.Attribute+json - identifier: number - name: number - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>test</para></section> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>test</p></section> - - id: 719 - fieldDefinitionIdentifier: image - languageCode: eng-GB - fieldTypeIdentifier: ibexa_image_asset - fieldValue: - destinationContentId: ~ - alternativeText: ~ - source: ~ - - id: 720 - fieldDefinitionIdentifier: category - languageCode: eng-GB - fieldTypeIdentifier: ibexa_taxonomy_entry_assignment - fieldValue: - taxonomy_entries: [] - taxonomy: ~ - 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: ~ - height: ~ - 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: ~ - height: ~ - 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 - 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: 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: ibexa.product_catalog.rest.product_variants.generate - 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: baseProductCode - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The product variant schema encoded in XML or JSON format. - 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: ibexa.product_catalog.rest.product_variants.view - tags: - - Product Variant - responses: - 200: - description: The view in XML or JSON format. - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>test</para></section> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>test</p></section> - - id: 719 - fieldDefinitionIdentifier: image - languageCode: eng-GB - fieldTypeIdentifier: ibexa_image_asset - fieldValue: - destinationContentId: ~ - alternativeText: ~ - source: ~ - - id: 720 - fieldDefinitionIdentifier: category - languageCode: eng-GB - fieldTypeIdentifier: ibexa_taxonomy_entry_assignment - fieldValue: - taxonomy_entries: [] - taxonomy: ~ - 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: ~ - height: ~ - 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: ~ - height: ~ - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>test</para></section> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>test</p></section> - - id: 719 - fieldDefinitionIdentifier: image - languageCode: eng-GB - fieldTypeIdentifier: ibexa_image_asset - fieldValue: - destinationContentId: ~ - alternativeText: ~ - source: ~ - - id: 720 - fieldDefinitionIdentifier: category - languageCode: eng-GB - fieldTypeIdentifier: ibexa_taxonomy_entry_assignment - fieldValue: - taxonomy_entries: [] - taxonomy: ~ - 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: ~ - height: ~ - 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: ~ - height: ~ - 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: baseProductCode - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The view input in XML or JSON format. - 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: ibexa.product_catalog.rest.product_variants.create - 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: baseProductCode - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The product variant schema encoded in XML or JSON format. - 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: ibexa.product_catalog.rest.product_variants.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 - - name: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false - patch: - operationId: ibexa.product_catalog.rest.product_variants.update - tags: - - Product Variant - responses: - 201: - description: If set, the updated product variant is returned in XML or JSON - format. - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>test</para></section> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>test</p></section> - - id: 719 - fieldDefinitionIdentifier: image - languageCode: eng-GB - fieldTypeIdentifier: ibexa_image_asset - fieldValue: - destinationContentId: ~ - alternativeText: ~ - source: ~ - - id: 720 - fieldDefinitionIdentifier: category - languageCode: eng-GB - fieldTypeIdentifier: ibexa_taxonomy_entry_assignment - fieldValue: - taxonomy_entries: [] - taxonomy: ~ - 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: ~ - height: ~ - 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: ~ - height: ~ - 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: code - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The product variant update schema encoded in XML or JSON format. - 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: ibexa.product_catalog.rest.vat.list - tags: - - Product Vat - responses: - 200: - description: OK - loads the VAT category list. - 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: ~ - 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: 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: ibexa.product_catalog.rest.vat - tags: - - Product Vat - responses: - 200: - description: OK - loads the VAT category. - 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: 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: ibexa.rest.list_sections - tags: - - Section - responses: - 200: - description: If set, the Section list is returned in XML or JSON format. - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <SectionList media-type="application/vnd.ibexa.api.SectionList+xml" href="/api/ibexa/v2/content/sections"> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"> - <sectionId>1</sectionId> - <identifier>standard</identifier> - <name>Standard</name> - </Section> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"> - <sectionId>2</sectionId> - <identifier>users</identifier> - <name>Users</name> - </Section> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/3"> - <sectionId>3</sectionId> - <identifier>media</identifier> - <name>Media</name> - </Section> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/6"> - <sectionId>6</sectionId> - <identifier>form</identifier> - <name>Form</name> - </Section> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/7"> - <sectionId>7</sectionId> - <identifier>template</identifier> - <name>Template</name> - </Section> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/8"> - <sectionId>8</sectionId> - <identifier>restricted</identifier> - <name>Restricted</name> - </Section> - </SectionList> - 401: - description: Error - The user has no permission to read the Section. - summary: Get Sections - description: Returns a list of all Sections. - parameters: - - name: If-None-Match - in: header - description: ETag - required: false - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false - post: - operationId: ibexa.rest.create_section - tags: - - Section - responses: - 201: - description: If set, the new Section is returned in XML or JSON format. - 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/13 - sectionId: 13 - identifier: restricted - name: Restricted - application/vnd.ibexa.api.Section+xml: - schema: - $ref: '#/components/schemas/Section' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/7"> - <sectionId>7</sectionId> - <identifier>restricted</identifier> - <name>Restricted</name> - </Section> - summary: Create new Section - description: Creates a new Section. - parameters: - - name: X-CSRF-Token - in: header - description: The CSRF Token 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 Section input schema encoded in XML or JSON format. - 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: |- - <?xml version="1.0" encoding="UTF-8"?> - <SectionInput> - <identifier>restricted</identifier> - <name>Restricted</name> - </SectionInput> - required: false - deprecated: false - /content/sections/{sectionId}: - get: - operationId: ibexa.rest.load_section - tags: - - Section - responses: - 200: - description: If set, the Section is returned in XML or JSON format. - 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/10 - sectionId: 10 - identifier: design - name: Design - application/vnd.ibexa.api.Section+xml: - schema: - $ref: '#/components/schemas/Section' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/5"> - <sectionId>10</sectionId> - <identifier>design</identifier> - <name>Design</name> - </Section> - 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: If-None-match - in: header - description: ETag - required: false - 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: ibexa.rest.delete_section - 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - 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 - patch: - operationId: ibexa.rest.update_section - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/7"> - <sectionId>7</sectionId> - <identifier>template</identifier> - <name>Template</name> - </Section> - 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - 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 Section input schema encoded in XML or JSON. - content: - application/vnd.ibexa.api.SectionInput+json: - schema: - $ref: '#/components/schemas/SectionInputWrapper' - example: - SectionInput: - identifier: template - name: Template - application/vnd.ibexa.api.SectionInput+xml: - schema: - $ref: '#/components/schemas/SectionInput' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <SectionInput> - <identifier>template</identifier> - <name>Template</name> - </SectionInput> - required: false - deprecated: false - /segment_groups: - get: - operationId: ibexa.segmentation.rest.segment_groups.list - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <SegmentGroupList media-type="application/vnd.ibexa.api.SegmentGroupList+xml" href="/api/ibexa/v2/segment_groups"> - <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts"> - <id>1</id> - <identifier>corporate_accounts</identifier> - <name>Corporate Accounts</name> - </SegmentGroup> - </SegmentGroupList> - 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: [] - deprecated: false - x-badges: - - name: Experience - color: '#D3822B' - - name: Commerce - color: '#A32768' - position: after - /segment_groups/{identifier}: - get: - operationId: ibexa.segmentation.rest.segment_groups.view - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts"> - <id>1</id> - <identifier>corporate_accounts</identifier> - <name>Corporate Accounts</name> - </SegmentGroup> - 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: 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: ibexa.segmentation.rest.segment_groups.list.segments - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <SegmentList media-type="application/vnd.ibexa.api.SegmentList+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts/segments"/> - 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: 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: ibexa.segmentation.rest.segments.view - tags: - - Segmentation - responses: - 200: - description: OK - Return the segment. - content: - application/vnd.ibexa.api.Segment+json: - schema: - $ref: '#/components/schemas/SegmentWrapper' - example: - Segment: - _media-type: application/vnd.ibexa.api.Segment+json - _href: /api/ibexa/v2/segments/corporate_account - id: 1 - identifier: corporate_account - name: Corporate Account - source: ibexa - lastUpdatedBy: "14" - updatedAt: "2026-06-30T12:00:00+00:00" - SegmentGroup: - _media-type: application/vnd.ibexa.api.SegmentGroup+json - _href: /api/ibexa/v2/segment_groups/corporate_accounts - application/vnd.ibexa.api.Segment+xml: - schema: - $ref: '#/components/schemas/Segment' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <Segment media-type="application/vnd.ibexa.api.Segment+xml" href="/api/ibexa/v2/segments/corporate_account"> - <id>1</id> - <identifier>corporate_account</identifier> - <name>Corporate Account</name> - <source>ibexa</source> - <lastUpdatedBy>14</lastUpdatedBy> - <updatedAt>2026-06-30T12:00:00+00:00</updatedAt> - <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts"/> - </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: 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 - /orders/order/{orderIdentifier}/shipments: - post: - operationId: ibexa.shipping.rest.shipment.create - tags: - - Shipping - responses: - 200: - description: The created 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/12345678-1234-5678-9abc-123456789abc - Amount: - value: "1922" - 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 - application/vnd.ibexa.api.Shipment+xml: - schema: - $ref: '#/components/schemas/Shipment' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <Shipment media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/new_identifier"> - <id>1</id> - <identifier>new_identifier</identifier> - <status>prepared</status> - <transitions> - <transition>send-to-carrier</transition> - <transition>cancel</transition> - </transitions> - <Order media-type="application/vnd.ibexa.api.Order+xml" href="/api/ibexa/v2/orders/order/12345678-1234-5678-9abc-123456789abc"/> - <Amount> - <value>1922</value> - <currency>EUR</currency> - </Amount> - <createdAt>2023-06-26T15:40:28+02:00</createdAt> - <updatedAt>2023-06-26T15:40:28+02:00</updatedAt> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Method media-type="application/vnd.ibexa.api.ShippingMethod+xml" href="/api/ibexa/v2/shipping/methods/parcel_locker"/> - </Shipment> - 400: - description: Error - the input does not match the input schema definition. - 401: - description: Error - the user is not authorized to create a shipment or - to update this order. - 404: - description: Error - the order with the given identifier does not exist. - 201: - description: Not supported - 200 OK is returned on success. - 422: - description: Not supported - 400 Bad Request is returned on unprocessable - input. - summary: Create shipment - description: Creates a shipment. - parameters: - - name: X-CSRF-Token - in: header - description: The CSRF token. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: orderIdentifier - in: path - description: The order's identifier to create a shipment for. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The shipment to create. - content: - application/vnd.ibexa.api.ShipmentCreate+json: - schema: - $ref: '#/components/schemas/ShipmentCreateWrapper' - example: - ShipmentCreate: - identifier: abc - ShippingMethod: - _media-type: application/vnd.ibexa.api.ShippingMethod+json - _href: /api/ibexa/v2/shipping/methods/parcel_locker - Amount: - value: "1922" - currency: EUR - Owner: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - Context: - key1: value1 - key2: value2 - application/vnd.ibexa.api.ShipmentCreate+xml: - schema: - $ref: '#/components/schemas/ShipmentCreate' - example: | - <?xml version="1.0" encoding="UTF-8" ?> - <ShipmentCreate> - <identifier>abc</identifier> - <ShippingMethod media-type="application/vnd.ibexa.api.ShippingMethod+json" href="/api/ibexa/v2/shipping/methods/parcel_locker"/> - <Amount> - <value>1922</value> - <currency>EUR</currency> - </Amount> - <Owner media-type="application/vnd.ibexa.api.User+json" href="/api/ibexa/v2/user/users/14"/> - <Context> - <key1>value1</key1> - <key2>value2</key2> - </Context> - </ShipmentCreate> - required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /shipments: - get: - operationId: ibexa.shipping.rest.shipment.all.find - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ShipmentRefList media-type="application/vnd.ibexa.api.ShipmentRefList+xml" href="/api/ibexa/v2/shipments"> - <ShipmentRef media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/foo"/> - <ShipmentRef media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/bar"/> - <ShipmentRef media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/baz"/> - <ShipmentRef media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/qux"/> - </ShipmentRefList> - 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: [] - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /shipments/{identifier}: - get: - operationId: ibexa.shipping.rest.shipment.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/ae741491-e80c-49f2-8a44-5163b4afa144 - id: 1 - identifier: ae741491-e80c-49f2-8a44-5163b4afa144 - status: pending - transitions: - transitionList: - - prepare - - cancel - Order: - _media-type: application/vnd.ibexa.api.Order+json - _href: /api/ibexa/v2/orders/order/33f6db52-478f-41f1-afbe-6d38f6a4704f - Amount: - value: "2257" - currency: EUR - createdAt: "2023-06-26T15:40:28+02:00" - updatedAt: "2023-06-26T15:40:28+02:00" - Owner: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - Method: - _media-type: application/vnd.ibexa.api.ShippingMethod+json - _href: /api/ibexa/v2/shipping/methods/parcel_locker_delivery - application/vnd.ibexa.api.Shipment+xml: - schema: - $ref: '#/components/schemas/Shipment' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <Shipment media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/ae741491-e80c-49f2-8a44-5163b4afa144"> - <id>1</id> - <identifier>ae741491-e80c-49f2-8a44-5163b4afa144</identifier> - <status>pending</status> - <transitions> - <transition>prepare</transition> - <transition>cancel</transition> - </transitions> - <Order media-type="application/vnd.ibexa.api.Order+xml" href="/api/ibexa/v2/orders/order/33f6db52-478f-41f1-afbe-6d38f6a4704f"/> - <Amount> - <value>2257</value> - <currency>EUR</currency> - </Amount> - <createdAt>2023-06-26T15:40:28+02:00</createdAt> - <updatedAt>2023-06-26T15:40:28+02:00</updatedAt> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Method media-type="application/vnd.ibexa.api.ShippingMethod+xml" href="/api/ibexa/v2/shipping/methods/parcel_locker_delivery"/> - </Shipment> - 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: identifier - in: path - description: The shipment identifier. - 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: ibexa.shipping.rest.shipment.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: X-CSRF-Token - in: header - description: The CSRF token. - 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 - patch: - operationId: ibexa.shipping.rest.shipment.update - tags: - - Shipping - responses: - 200: - description: If set, the updated shipment is returned in XML or JSON format. - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <Shipment media-type="application/vnd.ibexa.api.Shipment+xml" href="/api/ibexa/v2/shipments/new_identifier"> - <id>1</id> - <identifier>new_identifier</identifier> - <status>prepared</status> - <transitions> - <transition>send-to-carrier</transition> - <transition>cancel</transition> - </transitions> - <Order media-type="application/vnd.ibexa.api.Order+xml" href="/api/ibexa/v2/orders/order/33f6db52-478f-41f1-afbe-6d38f6a4704f"/> - <Amount> - <value>2257</value> - <currency>EUR</currency> - </Amount> - <createdAt>2023-06-26T15:40:28+02:00</createdAt> - <updatedAt>2023-06-26T15:40:28+02:00</updatedAt> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Method media-type="application/vnd.ibexa.api.ShippingMethod+xml" href="/api/ibexa/v2/shipping/methods/parcel_locker_delivery"/> - </Shipment> - 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: X-CSRF-Token - in: header - description: The CSRF token. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: identifier - in: path - description: The shipment identifier. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The ShipmentUpdate schema encoded in XML or JSON format. - 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: | - <?xml version="1.0" encoding="UTF-8" ?> - <ShipmentUpdate> - <identifier>new_identifier</identifier> - <transition>prepare</transition> - <Owner media-type='application/vnd.ibexa.api.User+json' href='/api/ibexa/v2/user/users/14'/> - <Context> - <item1>value1</item1> - <item2>value2</item2> - </Context> - </ShipmentUpdate> - required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /shipping/method-types: - get: - operationId: ibexa.shipping.rest.shipping_method.type.list - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ShippingMethodTypesList media-type="application/vnd.ibexa.api.ShippingMethodTypesList+xml" href="/api/ibexa/v2/shipping/method-types"> - <ShippingMethodType media-type="application/vnd.ibexa.api.ShippingMethodType+xml" href="/api/ibexa/v2/shipping/method-types/flat_rate"> - <identifier>flat_rate</identifier> - <name>Flat rate</name> - </ShippingMethodType> - <ShippingMethodType media-type="application/vnd.ibexa.api.ShippingMethodType+xml" href="/api/ibexa/v2/shipping/method-types/free"> - <identifier>free</identifier> - <name>Free shipping</name> - </ShippingMethodType> - </ShippingMethodTypesList> - 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: [] - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /shipping/method-types/{identifier}: - get: - operationId: ibexa.shipping.rest.shipping_method.type.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: | - <?xml version="1.0" encoding="UTF-8"?> - <ShippingMethodType media-type="application/vnd.ibexa.api.ShippingMethodType+xml" href="/api/ibexa/v2/shipping/method-types/flat_rate"> - <identifier>flat_rate</identifier> - <name>Flat rate</name> - </ShippingMethodType> - 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: 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: ibexa.shipping.rest.shipping_method.find - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ShippingMethodRefList media-type="application/vnd.ibexa.api.ShippingMethodRefList+xml" href="/api/ibexa/v2/shipping/methods"> - <ShippingMethodRef media-type="application/vnd.ibexa.api.ShippingMethod+xml" href="/api/ibexa/v2/shipping/methods/parcel_delivery"/> - <ShippingMethodRef media-type="application/vnd.ibexa.api.ShippingMethod+xml" href="/api/ibexa/v2/shipping/methods/parcel_locker_delivery"/> - </ShippingMethodRefList> - 401: - description: Error - the user has no permission to read shipping methods. - summary: Load shipping methods - description: Loads shipping methods. - parameters: [] - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /shipping/methods/{identifier}: - get: - operationId: ibexa.shipping.rest.shipping_method.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: | - <?xml version="1.0" encoding="UTF-8"?> - <ShippingMethod media-type="application/vnd.ibexa.api.ShippingMethod+xml" href="/api/ibexa/v2/shipping/methods/method1"> - <identifier>method1</identifier> - <name>AmE Method 1</name> - <names> - <value languageCode="eng-US">AmE Method 1</value> - <value languageCode="eng-GB">BrE Method 1</value> - </names> - <description>AmE Description of Method 1</description> - <descriptions> - <value languageCode="eng-US">AmE Description of Method 1</value> - <value languageCode="eng-GB">BrE Description of Method 1</value> - </descriptions> - <enabled>true</enabled> - <options> - <value key="price">20.0000</value> - <value key="currency">EUR</value> - </options> - <regions> - <RegionRef media-type="application/vnd.ibexa.api.Region+xml" href="/api/ibexa/v2/product/catalog/regions/default"/> - </regions> - <type media-type="application/vnd.ibexa.api.ShippingMethodType+xml" href="/api/ibexa/v2/shipping/method-types/flat_rate"/> - </ShippingMethod> - 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: 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: ibexa.rest.shopping_list.list - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ShoppingListCollection xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> - <totalCount>2</totalCount> - <count>2</count> - <ShoppingList> - <identifier>550e8400-e29b-41d4-a716-446655440000</identifier> - <name>My Shopping List</name> - <isDefault>1</isDefault> - <owner href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> - <entries> - <identifier>650e8400-e29b-41d4-a716-446655440001</identifier> - <product href="/api/ibexa/v2/product/catalog/products/PRODUCT-001" media-type="application/vnd.ibexa.api.Product+xml"> - <code>PRODUCT-001</code> - <name>Sample Product</name> - </product> - <addedAt>2024-10-29T12:15:00+00:00</addedAt> - </entries> - <createdAt>2024-10-29T12:00:00+00:00</createdAt> - <updatedAt>2024-10-29T12:00:00+00:00</updatedAt> - </ShoppingList> - <ShoppingList> - <identifier>660e8400-e29b-41d4-a716-446655440001</identifier> - <name>Weekend Shopping</name> - <isDefault>0</isDefault> - <owner href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> - <entries/> - <createdAt>2024-10-30T08:30:00+00:00</createdAt> - <updatedAt>2024-10-30T08:30:00+00:00</updatedAt> - </ShoppingList> - </ShoppingListCollection> - 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: ibexa.rest.shopping_list.create - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ShoppingList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> - <identifier>550e8400-e29b-41d4-a716-446655440000</identifier> - <name>My Shopping List</name> - <isDefault>0</isDefault> - <owner href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> - <entries> - <identifier>650e8400-e29b-41d4-a716-446655440001</identifier> - <product href="/api/ibexa/v2/product/catalog/products/PRODUCT-001" media-type="application/vnd.ibexa.api.Product+xml"> - <code>PRODUCT-001</code> - <name>Sample Product</name> - </product> - <addedAt>2024-10-29T12:15:00+00:00</addedAt> - </entries> - <createdAt>2024-10-29T12:00:00+00:00</createdAt> - <updatedAt>2024-10-29T12:00:00+00:00</updatedAt> - </ShoppingList> - 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: Shopping list to create - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ShoppingListCreate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> - <name>My Shopping List</name> - </ShoppingListCreate> - 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: ibexa.rest.shopping_list.add_to_default_entries - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ShoppingList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> - <identifier>550e8400-e29b-41d4-a716-446655440000</identifier> - <name>My Shopping List</name> - <isDefault>0</isDefault> - <owner href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> - <entries> - <identifier>650e8400-e29b-41d4-a716-446655440001</identifier> - <product href="/api/ibexa/v2/product/catalog/products/PRODUCT-001" media-type="application/vnd.ibexa.api.Product+xml"> - <code>PRODUCT-001</code> - <name>Sample Product</name> - </product> - <addedAt>2024-10-29T12:15:00+00:00</addedAt> - </entries> - <createdAt>2024-10-29T12:00:00+00:00</createdAt> - <updatedAt>2024-10-29T12:00:00+00:00</updatedAt> - </ShoppingList> - 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: Entries to add to the default shopping list - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ShoppingListEntriesAdd xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> - <entries> - <Entry> - <productCode>PRODUCT-001</productCode> - </Entry> - <Entry> - <productCode>PRODUCT-002</productCode> - </Entry> - </entries> - </ShoppingListEntriesAdd> - required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - - name: LTS Update - color: '#5DA7C0' - position: after - /shopping-list/{identifier}: - get: - operationId: ibexa.rest.shopping_list.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: | - <?xml version="1.0" encoding="UTF-8"?> - <ShoppingList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> - <identifier>550e8400-e29b-41d4-a716-446655440000</identifier> - <name>My Shopping List</name> - <isDefault>0</isDefault> - <owner href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> - <entries> - <identifier>650e8400-e29b-41d4-a716-446655440001</identifier> - <product href="/api/ibexa/v2/product/catalog/products/PRODUCT-001" media-type="application/vnd.ibexa.api.Product+xml"> - <code>PRODUCT-001</code> - <name>Sample Product</name> - </product> - <addedAt>2024-10-29T12:15:00+00:00</addedAt> - </entries> - <entries> - <identifier>650e8400-e29b-41d4-a716-446655440002</identifier> - <product href="/api/ibexa/v2/product/catalog/products/PRODUCT-002" media-type="application/vnd.ibexa.api.Product+xml"> - <code>PRODUCT-002</code> - <name>Another Product</name> - </product> - <addedAt>2024-10-29T12:30:00+00:00</addedAt> - </entries> - <createdAt>2024-10-29T12:00:00+00:00</createdAt> - <updatedAt>2024-10-29T12:00:00+00:00</updatedAt> - </ShoppingList> - 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: ibexa.rest.shopping_list.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: ibexa.rest.shopping_list.update - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ShoppingList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> - <identifier>550e8400-e29b-41d4-a716-446655440000</identifier> - <name>Updated Shopping List Name</name> - <isDefault>0</isDefault> - <owner href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> - <entries> - <identifier>650e8400-e29b-41d4-a716-446655440001</identifier> - <product href="/api/ibexa/v2/product/catalog/products/PRODUCT-001" media-type="application/vnd.ibexa.api.Product+xml"> - <code>PRODUCT-001</code> - <name>Sample Product</name> - </product> - <addedAt>2024-10-29T12:15:00+00:00</addedAt> - </entries> - <createdAt>2024-10-29T12:00:00+00:00</createdAt> - <updatedAt>2024-10-29T12:30:00+00:00</updatedAt> - </ShoppingList> - 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: Shopping list metadata to update - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ShoppingListUpdate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> - <name>Updated Shopping List Name</name> - </ShoppingListUpdate> - 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: ibexa.rest.cart.shopping_list.add_entries_to_cart - 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 ShoppingListEntryIdentifiers schema encoded in XML or JSON - format. - content: - application/vnd.ibexa.api.ShoppingListEntryIdentifiers+json: - schema: - $ref: '#/components/schemas/ShoppingListEntryIdentifiersWrapper' - example: - ShoppingListEntryIdentifiers: - entries: - - identifier: entry-001 - - identifier: entry-003 - application/vnd.ibexa.api.ShoppingListEntryIdentifiers+xml: - schema: - $ref: '#/components/schemas/ShoppingListEntryIdentifiers' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <ShoppingListEntryIdentifiers> - <entries> - <identifier>entry-001</identifier> - </entries> - <entries> - <identifier>entry-003</identifier> - </entries> - </ShoppingListEntryIdentifiers> - 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: ibexa.rest.cart.shopping_list.add_entries_to_cart.cart_identifier - 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 ShoppingListEntryIdentifiers schema encoded in XML or JSON - format. - content: - application/vnd.ibexa.api.ShoppingListEntryIdentifiers+json: - schema: - $ref: '#/components/schemas/ShoppingListEntryIdentifiersWrapper' - example: - ShoppingListEntryIdentifiers: - entries: - - identifier: entry-001 - - identifier: entry-003 - application/vnd.ibexa.api.ShoppingListEntryIdentifiers+xml: - schema: - $ref: '#/components/schemas/ShoppingListEntryIdentifiers' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <ShoppingListEntryIdentifiers> - <entries> - <identifier>entry-001</identifier> - </entries> - <entries> - <identifier>entry-003</identifier> - </entries> - </ShoppingListEntryIdentifiers> - 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: ibexa.rest.cart.shopping_list.add_to_cart - 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: ibexa.rest.cart.shopping_list.add_to_cart.car_identifier - 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: ibexa.rest.shopping_list.clear - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ShoppingList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> - <identifier>550e8400-e29b-41d4-a716-446655440000</identifier> - <name>My Shopping List</name> - <isDefault>0</isDefault> - <owner href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> - <entries/> - <createdAt>2024-10-29T12:00:00+00:00</createdAt> - <updatedAt>2024-10-29T12:15:00+00:00</updatedAt> - </ShoppingList> - 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: ibexa.rest.shopping_list.add_entries - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ShoppingList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> - <identifier>550e8400-e29b-41d4-a716-446655440000</identifier> - <name>My Shopping List</name> - <isDefault>0</isDefault> - <owner href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> - <entries> - <identifier>650e8400-e29b-41d4-a716-446655440001</identifier> - <product href="/api/ibexa/v2/product/catalog/products/PRODUCT-001" media-type="application/vnd.ibexa.api.Product+xml"> - <code>PRODUCT-001</code> - <name>Sample Product</name> - </product> - <addedAt>2024-10-29T12:15:00+00:00</addedAt> - </entries> - <createdAt>2024-10-29T12:00:00+00:00</createdAt> - <updatedAt>2024-10-29T12:00:00+00:00</updatedAt> - </ShoppingList> - 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: Entries to add to the shopping list - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ShoppingListEntriesAdd xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> - <entries> - <Entry> - <productCode>PRODUCT-001</productCode> - </Entry> - <Entry> - <productCode>PRODUCT-002</productCode> - </Entry> - </entries> - </ShoppingListEntriesAdd> - 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: ibexa.rest.shopping_list.remove_entries - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ShoppingList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> - <identifier>550e8400-e29b-41d4-a716-446655440000</identifier> - <name>My Shopping List</name> - <isDefault>0</isDefault> - <owner href="/api/ibexa/v2/user/users/14" media-type="application/vnd.ibexa.api.User+xml"/> - <entries> - <identifier>650e8400-e29b-41d4-a716-446655440001</identifier> - <product href="/api/ibexa/v2/product/catalog/products/PRODUCT-001" media-type="application/vnd.ibexa.api.Product+xml"> - <code>PRODUCT-001</code> - <name>Sample Product</name> - </product> - <addedAt>2024-10-29T12:15:00+00:00</addedAt> - </entries> - <createdAt>2024-10-29T12:00:00+00:00</createdAt> - <updatedAt>2024-10-29T12:00:00+00:00</updatedAt> - </ShoppingList> - 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: Entries to remove from shopping list - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <ShoppingListEntriesRemove> - <identifiers> - <identifier>650e8400-e29b-41d4-a716-446655440001</identifier> - <identifier>650e8400-e29b-41d4-a716-446655440002</identifier> - </identifiers> - </ShoppingListEntriesRemove> - required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - - name: LTS Update - color: '#5DA7C0' - position: after - /taxonomy/{taxonomyName}/entries: - delete: - operationId: ibexa.taxonomy.rest.entries.remove - 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: X-CSRF-Token - in: header - description: The CSRF token. - 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: TaxonomyEntryBulkRemove schema encoded in XML or JSON format. - 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: ibexa.taxonomy.rest.entries.move - 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: X-CSRF-Token - in: header - description: The CSRF token. - 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 TaxonomyEntryBulkMove schema encoded in XML or JSON format. - 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: ibexa.taxonomy.rest.entry_assignment.load_by_id - 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: 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: ibexa.taxonomy.rest.entry_assignments.assign_to_content - 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: X-CSRF-Token - in: header - description: The CSRF token. - 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: TaxonomyEntryAssignToContent schema encoded in JSON format. - 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: ibexa.taxonomy.rest.entry_assignments.load - 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: |- - <?xml version="1.0" encoding="UTF-8"?> - <EntryAssignmentCollection media-type="application/vnd.ibexa.api.EntryAssignmentCollection+xml"> - <content media-type="application/vnd.ibexa.api.Content+xml"> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/1" remoteId="9459d3c29e15006e45197295722c7ade" id="1"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"/> - <Name>Ibexa Platform</Name> - <TranslatedName>Ibexa Platform</TranslatedName> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/1/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/1/currentversion"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/1/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <lastModificationDate>2023-01-01T00:00:00+00:00</lastModificationDate> - <publishedDate>2015-11-30T13:10:46+00:00</publishedDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>10</currentVersionNo> - <alwaysAvailable>true</alwaysAvailable> - <isHidden>false</isHidden> - <status>PUBLISHED</status> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/1/objectstates"/> - </Content> - </content> - <TaxonomyEntryAssignment media-type="application/vnd.ibexa.api.TaxonomyEntryAssignment+xml"> - <id>1</id> - <content media-type="application/vnd.ibexa.api.Content+xml"> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/1" remoteId="9459d3c29e15006e45197295722c7ade" id="1"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"/> - <Name>Ibexa Platform</Name> - <TranslatedName>Ibexa Platform</TranslatedName> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/1/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/1/currentversion"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/1/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <lastModificationDate>2023-01-01T00:00:00+00:00</lastModificationDate> - <publishedDate>2015-11-30T13:10:46+00:00</publishedDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>10</currentVersionNo> - <alwaysAvailable>true</alwaysAvailable> - <isHidden>false</isHidden> - <status>PUBLISHED</status> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/1/objectstates"/> - </Content> - </content> - <entry media-type="application/vnd.ibexa.api.TaxonomyEntry+xml"> - <TaxonomyEntry media-type="application/vnd.ibexa.api.TaxonomyEntry+xml"> - <id>3</id> - <identifier>example</identifier> - <name>Example</name> - <contentId>65</contentId> - <content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/65"/> - <taxonomy>tags</taxonomy> - </TaxonomyEntry> - </entry> - </TaxonomyEntryAssignment> - </EntryAssignmentCollection> - 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: 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: ibexa.taxonomy.rest.entry_assignments.unassign_from_content - 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: X-CSRF-Token - in: header - description: The CSRF token. - 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: TaxonomyEntryUnassignFromContent schema encoded in JSON format. - 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: ibexa.taxonomy.rest.entry.load_by_content_id - 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: 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: ibexa.taxonomy.rest.entry.load_by_identifier - 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: 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: ibexa.taxonomy.rest.entry.load_by_id - 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: 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: ibexa.rest.load_trash_items - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <Trash media-type="application/vnd.ibexa.api.Trash+xml" href="/api/ibexa/v2/content/trash"> - <TrashItem media-type="application/vnd.ibexa.api.TrashItem+xml" href="/api/ibexa/v2/content/trash/58"> - <id>58</id> - <priority>0</priority> - <hidden>false</hidden> - <invisible>false</invisible> - <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/56"/> - <pathString>/1/2/56/58/</pathString> - <depth>3</depth> - <childCount>0</childCount> - <remoteId>59800915ad2eb8514de0bebe84f6ccba</remoteId> - <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/52"/> - <sortField>PATH</sortField> - <sortOrder>ASC</sortOrder> - <ContentInfo media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/52"> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/52" remoteId="881da87102313b0354dc2aa8f0e4b63b" id="52"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"/> - <Name>Folder 1</Name> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/52/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/52/currentversion"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/52/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <lastModificationDate>2019-02-06T09:03:09+01:00</lastModificationDate> - <publishedDate>2019-02-06T09:03:09+01:00</publishedDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>1</currentVersionNo> - <alwaysAvailable>true</alwaysAvailable> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/52/objectstates"/> - </Content> - </ContentInfo> - </TrashItem> - </Trash> - 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: [] - deprecated: false - delete: - operationId: ibexa.rest.empty_trash - 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: - - name: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false - /content/trash/{trashItemid}: - get: - operationId: ibexa.rest.load_trash_item - tags: - - Trash - responses: - 200: - description: If set, the item in Trash is returned in XML or JSON format. - 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: | - <?xml version="1.0" encoding="UTF-8"?> - <TrashItem media-type="application/vnd.ibexa.api.TrashItem+xml" href="/api/ibexa/v2/content/trash/81"> - <id>81</id> - <priority>0</priority> - <hidden>false</hidden> - <invisible>false</invisible> - <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2/42"/> - <pathString>/1/2/42/81/</pathString> - <depth>3</depth> - <childCount>0</childCount> - <remoteId>135e8a84b61848a67be36e9552d2724d</remoteId> - <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/99"/> - <sortField>PATH</sortField> - <sortOrder>ASC</sortOrder> - <ContentInfo media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/99"> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/99" remoteId="ae2b4568c0d2e7a4a9bca9495e73591a" id="99"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"/> - <Name>Folder 1</Name> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/99/versions"/> - <CurrentVersion media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/99/currentversion"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/1"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/99/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <lastModificationDate>2019-04-25T12:45:58+02:00</lastModificationDate> - <publishedDate>2019-04-25T12:45:58+02:00</publishedDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <currentVersionNo>1</currentVersionNo> - <alwaysAvailable>true</alwaysAvailable> - <status>TRASHED</status> - <ObjectStates media-type="application/vnd.ibexa.api.ContentObjectStates+xml" href="/api/ibexa/v2/content/objects/99/objectstates"/> - </Content> - </ContentInfo> - </TrashItem> - 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: trashItemid - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false - delete: - operationId: ibexa.rest.delete_trash_item - 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - 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 - /content/types: - get: - operationId: ibexa.rest.list_content_types - 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: ~ - 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: ~ - - _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: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Short title - descriptions: - value: [] - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: 255 - minStringLength: ~ - - _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"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - 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"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - 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: ~ - 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: ~ - 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: ~ - - _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: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Short name - descriptions: - value: [] - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: 100 - minStringLength: ~ - - _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"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - 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"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - 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: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Title - descriptions: - value: [] - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: ~ - minStringLength: ~ - - _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: ~ - content_field_id: ~ - language_code: ~ - 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: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Title - descriptions: - value: - - _languageCode: eng-GB - '#text': Title - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: ~ - minStringLength: ~ - - _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: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Description - descriptions: - value: - - _languageCode: eng-GB - '#text': Landing page description - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: ~ - minStringLength: ~ - - _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: ~ - availableLayouts: ~ - editorMode: page_view_mode - validatorConfiguration: [] - application/vnd.ibexa.api.ContentTypeInfoList+xml: - schema: - $ref: '#/components/schemas/ContentTypeInfoList' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <ContentTypeList media-type="application/vnd.ibexa.api.ContentTypeList+xml" href="/api/ibexa/v2/content/typegroups/1/types"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"> - <id>2</id> - <status>DEFINED</status> - <identifier>article</identifier> - <names> - <value languageCode="eng-GB">Article</value> - </names> - <descriptions/> - <creationDate>2002-06-18T09:21:38+00:00</creationDate> - <modificationDate>2004-04-20T09:56:29+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2/draft"/> - <remoteId>c15b600eb9198b1924063b5a68758232</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><short_title|title></nameSchema> - <isContainer>true</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>false</defaultAlwaysAvailable> - <defaultSortField>PATH</defaultSortField> - <defaultSortOrder>ASC</defaultSortOrder> - <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions"> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/1"> - <id>1</id> - <identifier>title</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>1</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue>New article</defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Title</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">255</value> - <value key="minStringLength"/></value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/152"> - <id>152</id> - <identifier>short_title</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>2</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Short title</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">255</value> - <value key="minStringLength"/></value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/153"> - <id>153</id> - <identifier>author</identifier> - <fieldType>ibexa_author</fieldType> - <fieldGroup></fieldGroup> - <position>3</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Author</value> - </names> - <descriptions/> - <fieldSettings> - <value key="defaultAuthor">1</value> - </fieldSettings> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/120"> - <id>120</id> - <identifier>intro</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup></fieldGroup> - <position>4</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Intro</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/121"> - <id>121</id> - <identifier>body</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup></fieldGroup> - <position>5</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Body</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/123"> - <id>123</id> - <identifier>enable_comments</identifier> - <fieldType>ibexa_boolean</fieldType> - <fieldGroup></fieldGroup> - <position>6</position> - <isTranslatable>false</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue>false</defaultValue> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Enable comments</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/154"> - <id>154</id> - <identifier>image</identifier> - <fieldType>ibexa_object_relation</fieldType> - <fieldGroup></fieldGroup> - <position>7</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="destinationContentId"/> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Image</value> - </names> - <descriptions/> - <fieldSettings> - <value key="selectionMethod">SELECTION_BROWSE</value> - <value key="selectionRoot"></value> - <value key="selectionContentTypes"/> - </fieldSettings> - <validatorConfiguration/> - </FieldDefinition> - </FieldDefinitions> - </ContentType> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"> - <id>1</id> - <status>DEFINED</status> - <identifier>folder</identifier> - <names> - <value languageCode="eng-GB">Folder</value> - </names> - <descriptions/> - <creationDate>2002-06-18T09:21:38+00:00</creationDate> - <modificationDate>2015-11-29T21:14:32+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/1/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1/draft"/> - <remoteId>a3d405b81be900468eb153d774f4f0d2</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><short_name|name></nameSchema> - <isContainer>true</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>true</defaultAlwaysAvailable> - <defaultSortField>PATH</defaultSortField> - <defaultSortOrder>ASC</defaultSortOrder> - <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions"> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/4"> - <id>4</id> - <identifier>name</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>1</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue>Folder</defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Name</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">255</value> - <value key="minStringLength"/></value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/155"> - <id>155</id> - <identifier>short_name</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>2</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Short name</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">100</value> - <value key="minStringLength"/></value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/119"> - <id>119</id> - <identifier>short_description</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup></fieldGroup> - <position>3</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Short description</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/156"> - <id>156</id> - <identifier>description</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup></fieldGroup> - <position>4</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Description</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - </FieldDefinitions> - </ContentType> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/43"> - <id>43</id> - <status>DEFINED</status> - <identifier>form</identifier> - <names> - <value languageCode="eng-GB">Form</value> - </names> - <descriptions/> - <creationDate>2018-09-17T06:46:13+00:00</creationDate> - <modificationDate>2018-09-17T06:47:14+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/43/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/43/draft"/> - <remoteId>6f7f21df775a33c1e4bbc76b48c38476</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><title></nameSchema> - <isContainer>false</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>true</defaultAlwaysAvailable> - <defaultSortField>PUBLISHED</defaultSortField> - <defaultSortOrder>DESC</defaultSortOrder> - <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions"> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions/188"> - <id>188</id> - <identifier>title</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup>content</fieldGroup> - <position>1</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Title</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength"/> - <value key="minStringLength"/></value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions/189"> - <id>189</id> - <identifier>form</identifier> - <fieldType>ibexa_form</fieldType> - <fieldGroup>content</fieldGroup> - <position>2</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="fields"/> - <value key="content_id"/> - <value key="content_field_id"/> - <value key="language_code"/> - </defaultValue> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Form</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - </FieldDefinitions> - </ContentType> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/42"> - <id>42</id> - <status>DEFINED</status> - <identifier>landing_page</identifier> - <names> - <value languageCode="eng-GB">Landing page</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <creationDate>2015-07-03T12:00:26+00:00</creationDate> - <modificationDate>2015-07-03T12:00:26+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/42/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/42/draft"/> - <remoteId>60c03e9758465eb69d56b3afb6adf18e</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><name></nameSchema> - <isContainer>true</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>true</defaultAlwaysAvailable> - <defaultSortField>PUBLISHED</defaultSortField> - <defaultSortOrder>DESC</defaultSortOrder> - <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions"> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/185"> - <id>185</id> - <identifier>name</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup>content</fieldGroup> - <position>10</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Title</value> - </names> - <descriptions> - <value languageCode="eng-GB">Title</value> - </descriptions> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength"/> - <value key="minStringLength"/></value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/186"> - <id>186</id> - <identifier>description</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup>content</fieldGroup> - <position>20</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Description</value> - </names> - <descriptions> - <value languageCode="eng-GB">Landing page description</value> - </descriptions> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength"/> - <value key="minStringLength"/></value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/187"> - <id>187</id> - <identifier>page</identifier> - <fieldType>ibexa_landing_page</fieldType> - <fieldGroup>content</fieldGroup> - <position>30</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="layout">default</value> - <value key="zones"> - <value> - <value key="id">default_id</value> - <value key="name">default</value> - <value key="blocks"/></value> - </value> - </defaultValue> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Landing page</value> - </names> - <descriptions> - <value languageCode="eng-GB">Landing page</value> - </descriptions> - <fieldSettings> - <value key="availableBlocks"/> - <value key="availableLayouts"/> - <value key="editorMode">page_view_mode</value> - </fieldSettings> - <validatorConfiguration/> - </FieldDefinition> - </FieldDefinitions> - </ContentType> - </ContentTypeList> - 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: [] - deprecated: false - /content/types/view: - post: - operationId: ibexa.rest.content_types.view - tags: - - Type - responses: - 200: - description: The view in XML or JSON format. - 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: ~ - 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: ~ - - _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: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Short title - descriptions: - value: [] - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: 255 - minStringLength: ~ - - _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"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - 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"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - 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: ~ - 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: ~ - 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: ~ - - _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: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Short name - descriptions: - value: [] - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: 100 - minStringLength: ~ - - _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"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - 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"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - 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: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Title - descriptions: - value: [] - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: ~ - minStringLength: ~ - - _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: ~ - content_field_id: ~ - language_code: ~ - 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: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Title - descriptions: - value: - - _languageCode: eng-GB - '#text': Title - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: ~ - minStringLength: ~ - - _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: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Description - descriptions: - value: - - _languageCode: eng-GB - '#text': Landing page description - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: ~ - minStringLength: ~ - - _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: ~ - availableLayouts: ~ - editorMode: page_view_mode - validatorConfiguration: [] - application/vnd.ibexa.api.ContentTypeList+xml: - schema: - $ref: '#/components/schemas/ContentTypeInfoList' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <ContentTypeList media-type="application/vnd.ibexa.api.ContentTypeList+xml" href="/api/ibexa/v2/content/typegroups/1/types"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"> - <id>2</id> - <status>DEFINED</status> - <identifier>article</identifier> - <names> - <value languageCode="eng-GB">Article</value> - </names> - <descriptions/> - <creationDate>2002-06-18T09:21:38+00:00</creationDate> - <modificationDate>2004-04-20T09:56:29+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2/draft"/> - <remoteId>c15b600eb9198b1924063b5a68758232</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><short_title|title></nameSchema> - <isContainer>true</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>false</defaultAlwaysAvailable> - <defaultSortField>PATH</defaultSortField> - <defaultSortOrder>ASC</defaultSortOrder> - <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions"> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/1"> - <id>1</id> - <identifier>title</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>1</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue>New article</defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Title</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">255</value> - <value key="minStringLength"/></value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/152"> - <id>152</id> - <identifier>short_title</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>2</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Short title</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">255</value> - <value key="minStringLength"/></value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/153"> - <id>153</id> - <identifier>author</identifier> - <fieldType>ibexa_author</fieldType> - <fieldGroup></fieldGroup> - <position>3</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Author</value> - </names> - <descriptions/> - <fieldSettings> - <value key="defaultAuthor">1</value> - </fieldSettings> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/120"> - <id>120</id> - <identifier>intro</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup></fieldGroup> - <position>4</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Intro</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/121"> - <id>121</id> - <identifier>body</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup></fieldGroup> - <position>5</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Body</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/123"> - <id>123</id> - <identifier>enable_comments</identifier> - <fieldType>ibexa_boolean</fieldType> - <fieldGroup></fieldGroup> - <position>6</position> - <isTranslatable>false</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue>false</defaultValue> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Enable comments</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/154"> - <id>154</id> - <identifier>image</identifier> - <fieldType>ibexa_object_relation</fieldType> - <fieldGroup></fieldGroup> - <position>7</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="destinationContentId"/> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Image</value> - </names> - <descriptions/> - <fieldSettings> - <value key="selectionMethod">SELECTION_BROWSE</value> - <value key="selectionRoot"></value> - <value key="selectionContentTypes"/> - </fieldSettings> - <validatorConfiguration/> - </FieldDefinition> - </FieldDefinitions> - </ContentType> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"> - <id>1</id> - <status>DEFINED</status> - <identifier>folder</identifier> - <names> - <value languageCode="eng-GB">Folder</value> - </names> - <descriptions/> - <creationDate>2002-06-18T09:21:38+00:00</creationDate> - <modificationDate>2015-11-29T21:14:32+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/1/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1/draft"/> - <remoteId>a3d405b81be900468eb153d774f4f0d2</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><short_name|name></nameSchema> - <isContainer>true</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>true</defaultAlwaysAvailable> - <defaultSortField>PATH</defaultSortField> - <defaultSortOrder>ASC</defaultSortOrder> - <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions"> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/4"> - <id>4</id> - <identifier>name</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>1</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue>Folder</defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Name</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">255</value> - <value key="minStringLength"/></value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/155"> - <id>155</id> - <identifier>short_name</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>2</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Short name</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">100</value> - <value key="minStringLength"/></value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/119"> - <id>119</id> - <identifier>short_description</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup></fieldGroup> - <position>3</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Short description</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/156"> - <id>156</id> - <identifier>description</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup></fieldGroup> - <position>4</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Description</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - </FieldDefinitions> - </ContentType> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/43"> - <id>43</id> - <status>DEFINED</status> - <identifier>form</identifier> - <names> - <value languageCode="eng-GB">Form</value> - </names> - <descriptions/> - <creationDate>2018-09-17T06:46:13+00:00</creationDate> - <modificationDate>2018-09-17T06:47:14+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/43/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/43/draft"/> - <remoteId>6f7f21df775a33c1e4bbc76b48c38476</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><title></nameSchema> - <isContainer>false</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>true</defaultAlwaysAvailable> - <defaultSortField>PUBLISHED</defaultSortField> - <defaultSortOrder>DESC</defaultSortOrder> - <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions"> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions/188"> - <id>188</id> - <identifier>title</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup>content</fieldGroup> - <position>1</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Title</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength"/> - <value key="minStringLength"/></value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions/189"> - <id>189</id> - <identifier>form</identifier> - <fieldType>ibexa_form</fieldType> - <fieldGroup>content</fieldGroup> - <position>2</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="fields"/> - <value key="content_id"/> - <value key="content_field_id"/> - <value key="language_code"/> - </defaultValue> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Form</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - </FieldDefinitions> - </ContentType> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/42"> - <id>42</id> - <status>DEFINED</status> - <identifier>landing_page</identifier> - <names> - <value languageCode="eng-GB">Landing page</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <creationDate>2015-07-03T12:00:26+00:00</creationDate> - <modificationDate>2015-07-03T12:00:26+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/42/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/42/draft"/> - <remoteId>60c03e9758465eb69d56b3afb6adf18e</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><name></nameSchema> - <isContainer>true</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>true</defaultAlwaysAvailable> - <defaultSortField>PUBLISHED</defaultSortField> - <defaultSortOrder>DESC</defaultSortOrder> - <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions"> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/185"> - <id>185</id> - <identifier>name</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup>content</fieldGroup> - <position>10</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Title</value> - </names> - <descriptions> - <value languageCode="eng-GB">Title</value> - </descriptions> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength"/> - <value key="minStringLength"/></value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/186"> - <id>186</id> - <identifier>description</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup>content</fieldGroup> - <position>20</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Description</value> - </names> - <descriptions> - <value languageCode="eng-GB">Landing page description</value> - </descriptions> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength"/> - <value key="minStringLength"/></value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/187"> - <id>187</id> - <identifier>page</identifier> - <fieldType>ibexa_landing_page</fieldType> - <fieldGroup>content</fieldGroup> - <position>30</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="layout">default</value> - <value key="zones"> - <value> - <value key="id">default_id</value> - <value key="name">default</value> - <value key="blocks"/></value> - </value> - </defaultValue> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Landing page</value> - </names> - <descriptions> - <value languageCode="eng-GB">Landing page</value> - </descriptions> - <fieldSettings> - <value key="availableBlocks"/> - <value key="availableLayouts"/> - <value key="editorMode">page_view_mode</value> - </fieldSettings> - <validatorConfiguration/> - </FieldDefinition> - </FieldDefinitions> - </ContentType> - </ContentTypeList> - 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: X-CSRF-Token - in: header - description: The CSRF Token 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 view input in XML or JSON format. - content: - application/vnd.ibexa.api.ContentTypeViewInput+json: - schema: - $ref: '#/components/schemas/ContentTypeViewInputWrapper' - example: - ViewInput: - identifier: ContentTypeView - ContentTypeQuery: - limit: "10" - offset: "1" - Query: - ContentTypeIdCriterion: - - 1 - - 2 - ContentTypeIdentifierCriterion: folder - IsSystemCriterion: true - ContentTypeGroupIdCriterion: 1 - ContainsFieldDefinitionIdCriterion: 2 - SortClauses: - Identifier: descending - Id: ascending - application/vnd.ibexa.api.ContentTypeViewInput+xml: - schema: - $ref: '#/components/schemas/ContentTypeViewInput' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <ViewInput> - <identifier>ContentTypeView</identifier> - <ContentTypeQuery> - <limit>10</limit> - <offset>1</offset> - <Query> - <ContentTypeIdCriterion>1</ContentTypeIdCriterion> - <ContentTypeIdCriterion>2</ContentTypeIdCriterion> - <ContentTypeIdentifierCriterion>folder</ContentTypeIdentifierCriterion> - <IsSystemCriterion>true</IsSystemCriterion> - <ContentTypeGroupIdCriterion>1</ContentTypeGroupIdCriterion> - <ContainsFieldDefinitionIdCriterion>2</ContainsFieldDefinitionIdCriterion> - </Query> - <SortClauses> - <Identifier>descending</Identifier> - <Id>ascending</Id> - </SortClauses> - </ContentTypeQuery> - </ViewInput> - required: false - deprecated: false - /content/types/{contentTypeId}: - get: - operationId: ibexa.rest.load_content_type - 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': ~ - 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': ~ - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: 255 - minStringLength: ~ - - _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: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Short title - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: 255 - minStringLength: ~ - - _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': ~ - 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"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Intro - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - 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"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Body - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - 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': ~ - 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: ~ - alternativeText: ~ - source: ~ - isSearchable: false - names: - value: - - _languageCode: eng-GB - '#text': Image - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: [] - application/vnd.ibexa.api.ContentType+xml: - schema: - $ref: '#/components/schemas/ContentType' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"> - <id>2</id> - <status>DEFINED</status> - <identifier>article</identifier> - <names> - <value languageCode="eng-GB">Article</value> - </names> - <descriptions/> - <creationDate>2002-06-18T11:21:38+02:00</creationDate> - <modificationDate>2004-04-20T11:56:29+02:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2/draft"/> - <remoteId>c15b600eb9198b1924063b5a68758232</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><short_title|title></nameSchema> - <isContainer>true</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>false</defaultAlwaysAvailable> - <defaultSortField>PATH</defaultSortField> - <defaultSortOrder>ASC</defaultSortOrder> - <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions"> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/1"> - <id>1</id> - <identifier>title</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>1</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue>New article</defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Title</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">255</value> - <value key="minStringLength"/></value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/152"> - <id>152</id> - <identifier>short_title</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>2</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Short title</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">255</value> - <value key="minStringLength"/></value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/153"> - <id>153</id> - <identifier>author</identifier> - <fieldType>ibexa_author</fieldType> - <fieldGroup></fieldGroup> - <position>3</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Author</value> - </names> - <descriptions/> - <fieldSettings> - <value key="defaultAuthor">1</value> - </fieldSettings> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/120"> - <id>120</id> - <identifier>intro</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup></fieldGroup> - <position>4</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Intro</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/121"> - <id>121</id> - <identifier>body</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup></fieldGroup> - <position>5</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Body</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/123"> - <id>123</id> - <identifier>enable_comments</identifier> - <fieldType>ibexa_boolean</fieldType> - <fieldGroup></fieldGroup> - <position>6</position> - <isTranslatable>false</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue>false</defaultValue> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Enable comments</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/154"> - <id>154</id> - <identifier>image</identifier> - <fieldType>ibexa_object_relation</fieldType> - <fieldGroup></fieldGroup> - <position>7</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="destinationContentId"/> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Image</value> - </names> - <descriptions/> - <fieldSettings> - <value key="selectionMethod">SELECTION_BROWSE</value> - <value key="selectionRoot"></value> - <value key="selectionContentTypes"/> - </fieldSettings> - <validatorConfiguration/> - </FieldDefinition> - </FieldDefinitions> - </ContentType> - 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: If-None-Match - in: header - description: ETag - required: false - 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: ibexa.rest.create_content_type_draft - 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/1/draft - id: 1 - status: DRAFT - identifier: folder - names: - value: - - _languageCode: eng-GB - '#text': Folder - descriptions: - value: [] - creationDate: "2002-06-18T09:21:38+00:00" - modificationDate: "2021-08-11T11:17:58+00:00" - Creator: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - Modifier: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - Groups: - _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json - _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: ~ - nameSchema: <short_name|name> - 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"?> - <ContentTypeInfo media-type="application/vnd.ibexa.api.ContentTypeInfo+xml" href="/api/ibexa/v2/content/types/3/draft"> - <id>3</id> - <status>DRAFT</status> - <identifier>user_group</identifier> - <names> - <value languageCode="eng-GB">User group</value> - </names> - <descriptions/> - <creationDate>2002-06-18T11:21:38+02:00</creationDate> - <modificationDate>2019-02-25T14:41:53+01:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/3/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/3/draft"/> - <remoteId>25b4268cdcd01921b808a0d854b877ef</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><name></nameSchema> - <isContainer>true</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>true</defaultAlwaysAvailable> - <defaultSortField>PATH</defaultSortField> - <defaultSortOrder>ASC</defaultSortOrder> - </ContentTypeInfo> - 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - 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 content type Update schema encoded in XML or JSON format. - 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"?> - <ContentTypeUpdate> - <defaultAlwaysAvailable>true</defaultAlwaysAvailable> - </ContentTypeUpdate> - required: false - deprecated: false - delete: - operationId: ibexa.rest.delete_content_type - 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - 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}/draft: - get: - operationId: ibexa.rest.load_content_type_draft - 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': ~ - 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': ~ - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: 255 - minStringLength: ~ - - _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: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Short title - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: 255 - minStringLength: ~ - - _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': ~ - 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"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Intro - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - 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"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Body - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - 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': ~ - 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: ~ - alternativeText: ~ - source: ~ - isSearchable: false - names: - value: - - _languageCode: eng-GB - '#text': Image - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: [] - application/vnd.ibexa.api.ContentType+xml: - schema: - $ref: '#/components/schemas/ContentType' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/14"> - <id>14</id> - <status>DEFINED</status> - <identifier>copy_of_article_14</identifier> - <names> - <value languageCode="eng-GB">Updated content type name</value> - </names> - <descriptions> - <value languageCode="eng-GB">This is an updated content type description</value> - </descriptions> - <creationDate>2019-02-06T10:56:36+01:00</creationDate> - <modificationDate>2019-02-25T12:15:51+01:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/14/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/14/draft"/> - <remoteId>d7ae816f22fe929e67a359a2ef6e7cde</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><short_title|title></nameSchema> - <isContainer>true</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>false</defaultAlwaysAvailable> - <defaultSortField>PATH</defaultSortField> - <defaultSortOrder>ASC</defaultSortOrder> - <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/14/fieldDefinitions"> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/14/fieldDefinitions/188"> - <id>188</id> - <identifier>title</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>1</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue>New article</defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Title</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">255</value> - <value key="minStringLength"/></value> - </validatorConfiguration> - </FieldDefinition> - </FieldDefinitions> - </ContentType> - 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: contentTypeId - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false - delete: - operationId: ibexa.rest.delete_content_type_draft - 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - 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 - patch: - operationId: ibexa.rest.update_content_type_draft - 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: ~ - 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"?> - <ContentTypeInfo media-type="application/vnd.ibexa.api.ContentTypeInfo+xml" href="/api/ibexa/v2/content/types/14/draft"> - <id>14</id> - <status>DRAFT</status> - <identifier>new_content_type</identifier> - <names> - <value languageCode="eng-GB">Updated content type name</value> - </names> - <descriptions> - <value languageCode="eng-GB">This is an updated content type description</value> - </descriptions> - <creationDate>2019-02-06T10:56:36+01:00</creationDate> - <modificationDate>2019-02-25T12:15:51+01:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/14/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/14/draft"/> - <remoteId>d7ae816f22fe929e67a359a2ef6e7cde</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><short_title|title></nameSchema> - <isContainer>true</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>false</defaultAlwaysAvailable> - <defaultSortField>PATH</defaultSortField> - <defaultSortOrder>ASC</defaultSortOrder> - </ContentTypeInfo> - 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - 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 content type update schema encoded in XML or JSON format. - content: - application/vnd.ibexa.api.ContentTypeUpdate+json: - schema: - $ref: '#/components/schemas/ContentTypeUpdateWrapper' - example: - ContentTypeUpdate: - _media-type: application/vnd.ibexa.api.ContentTypeUpdate - names: - value: - - _languageCode: eng-GB - '#text': Updated content type name - descriptions: - value: - - _languageCode: eng-GB - '#text': This is an updated content type description - application/vnd.ibexa.api.ContentTypeUpdate+xml: - schema: - $ref: '#/components/schemas/ContentTypeUpdate' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <ContentTypeUpdate> - <names> - <value languageCode="eng-GB">Updated content type name</value> - </names> - <descriptions> - <value languageCode="eng-GB">This is an updated content type description</value> - </descriptions> - </ContentTypeUpdate> - required: false - deprecated: false - /content/types/{contentTypeId}/draft/fieldDefinitions: - get: - operationId: ibexa.rest.load_content_type_draft_field_definition_list - 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: contentTypeId - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false - post: - operationId: ibexa.rest.add_content_type_draft_field_definition - 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: ~ - alternativeText: ~ - source: ~ - isSearchable: false - names: - value: - - _languageCode: eng-GB - '#text': Image - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: [] - application/vnd.ibexa.api.FieldDefinition+xml: - schema: - $ref: '#/components/schemas/FieldDefinition' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/14/draft/fieldDefinitions/221"> - <id>221</id> - <identifier>name2</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>0</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names/> - <descriptions/> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">32</value> - <value key="minStringLength">8</value> - </value> - </validatorConfiguration> - </FieldDefinition> - 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - 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 Field Definition Create schema encoded in XML or JSON format. - 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"?> - <FieldDefinitionCreate> - <identifier>name</identifier> - <fieldType>ibexa_string</fieldType> - <isRequired>true</isRequired> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">32</value> - <value key="minStringLength">8</value> - </value> - </validatorConfiguration> - </FieldDefinitionCreate> - required: false - deprecated: false - /content/types/{contentTypeId}/draft/fieldDefinitions/{fieldDefinitionId}: - get: - operationId: ibexa.rest.load_content_type_draft_field_definition - 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: ~ - alternativeText: ~ - source: ~ - isSearchable: false - names: - value: - - _languageCode: eng-GB - '#text': Image - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: [] - application/vnd.ibexa.api.FieldDefinition+xml: - schema: - $ref: '#/components/schemas/FieldDefinition' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/195"> - <id>195</id> - <identifier>image</identifier> - <fieldType>ibexa_image_asset</fieldType> - <fieldGroup>content</fieldGroup> - <position>7</position> - <isTranslatable>false</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="destinationContentId"/> - <value key="alternativeText"/> - <value key="source"/> - </defaultValue> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Image</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - 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: 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: ibexa.rest.remove_content_type_draft_field_definition - 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - 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 - patch: - operationId: ibexa.rest.update_content_type_draft_field_definition - 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: ~ - alternativeText: ~ - source: ~ - isSearchable: false - names: - value: - - _languageCode: eng-GB - '#text': Image - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: [] - application/vnd.ibexa.api.FieldDefinition+xml: - schema: - $ref: '#/components/schemas/FieldDefinition' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/15/draft/fieldDefinitions/197"> - <id>197</id> - <identifier>author</identifier> - <fieldType>ibexa_author</fieldType> - <fieldGroup>new_field_group</fieldGroup> - <position>10</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Author</value> - </names> - <descriptions/> - <fieldSettings> - <value key="defaultAuthor">1</value> - </fieldSettings> - <validatorConfiguration/> - </FieldDefinition> - 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - 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 Field definition update schema encoded in XML or JSON format. - 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"?> - <FieldDefinitionUpdate> - <fieldGroup>new_field_group</fieldGroup> - <position>10</position> - </FieldDefinitionUpdate> - required: false - deprecated: false - /content/types/{contentTypeId}/fieldDefinitions: - get: - operationId: ibexa.rest.load_content_type_field_definition_list - 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: 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: ibexa.rest.load_content_type_field_definition - 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: ~ - alternativeText: ~ - source: ~ - isSearchable: false - names: - value: - - _languageCode: eng-GB - '#text': Image - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: [] - application/vnd.ibexa.api.FieldDefinition+xml: - schema: - $ref: '#/components/schemas/FieldDefinition' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/195"> - <id>195</id> - <identifier>image</identifier> - <fieldType>ibexa_image_asset</fieldType> - <fieldGroup>content</fieldGroup> - <position>7</position> - <isTranslatable>false</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="destinationContentId"/> - <value key="alternativeText"/> - <value key="source"/> - </defaultValue> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Image</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - 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: 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: ibexa.rest.load_groups_of_content_type - tags: - - Type - responses: - 200: - description: If set, the content type group list is returned in XML or JSON - format. - 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 - application/vnd.ibexa.api.ContentTypeGroupRefList+xml: - schema: - $ref: '#/components/schemas/ContentTypeGroupRefList' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <ContentTypeGroupRefList media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/typegroups/2/types"> - <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/1"/> - </ContentTypeGroupRefList> - 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: contentTypeId - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false - post: - operationId: ibexa.rest.link_content_type_to_group - tags: - - Type - responses: - 200: - description: If set, the updated content type group list is returned in - XML or JSON format. - 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"?> - <ContentTypeGroupRefList media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/typegroups/15/types"> - <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/1"> - <unlink href="/api/ibexa/v2/content/types/15/groups/1" method="DELETE"/> - </ContentTypeGroupRef> - <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/3"> - <unlink href="/api/ibexa/v2/content/types/15/groups/3" method="DELETE"/> - </ContentTypeGroupRef> - <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/2"> - <unlink href="/api/ibexa/v2/content/types/15/groups/2" method="DELETE"/> - </ContentTypeGroupRef> - </ContentTypeGroupRefList> - 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - 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: group - in: query - description: 'Destination content type group URI; for example with content - type group 4: `?group=/api/ibexa/v2/content/typegroups/4`' - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: form - explode: false - allowReserved: false - requestBody: - description: No payload required - content: [] - required: false - deprecated: false - /content/types/{contentTypeId}/groups/{id}: - delete: - operationId: ibexa.rest.unlink_content_type_from_group - tags: - - Type - responses: - 200: - description: If set, the updated content type group list is returned in - XML or JSON format. - 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"?> - <ContentTypeGroupRefList media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/typegroups/15/types"> - <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/1"> - <unlink href="/api/ibexa/v2/content/types/15/groups/1" method="DELETE"/> - </ContentTypeGroupRef> - <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/2"> - <unlink href="/api/ibexa/v2/content/types/15/groups/2" method="DELETE"/> - </ContentTypeGroupRef> - </ContentTypeGroupRefList> - 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - 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: ibexa.rest.load_content_type_group_list - 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"?> - <ContentTypeGroupList media-type="application/vnd.ibexa.api.ContentTypeGroupList+xml" href="/api/ibexa/v2/content/typegroups"> - <ContentTypeGroup media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/1"> - <id>1</id> - <identifier>Content</identifier> - <created>2002-09-05T11:08:48+02:00</created> - <modified>2002-10-06T18:35:06+02:00</modified> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <ContentTypes media-type="application/vnd.ibexa.api.ContentTypeInfoList+xml" href="/api/ibexa/v2/content/typegroups/1/types"/> - </ContentTypeGroup> - <ContentTypeGroup media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/2"> - <id>2</id> - <identifier>Users</identifier> - <created>2002-09-05T11:09:01+02:00</created> - <modified>2002-10-06T18:35:13+02:00</modified> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <ContentTypes media-type="application/vnd.ibexa.api.ContentTypeInfoList+xml" href="/api/ibexa/v2/content/typegroups/2/types"/> - </ContentTypeGroup> - <ContentTypeGroup media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/3"> - <id>3</id> - <identifier>Media</identifier> - <created>2002-09-14T15:22:23+02:00</created> - <modified>2002-10-06T18:35:20+02:00</modified> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <ContentTypes media-type="application/vnd.ibexa.api.ContentTypeInfoList+xml" href="/api/ibexa/v2/content/typegroups/3/types"/> - </ContentTypeGroup> - </ContentTypeGroupList> - 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: [] - deprecated: false - post: - operationId: ibexa.rest.create_content_type_group - 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/6 - id: 6 - identifier: newContentTypeGroup - created: "2021-08-11T09:44:18+00:00" - modified: "2021-08-11T09:44:18+00:00" - Creator: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - Modifier: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - ContentTypes: - _media-type: application/vnd.ibexa.api.ContentTypeInfoList+json - _href: /api/ibexa/v2/content/typegroups/6/types - application/vnd.ibexa.api.ContentTypeGroup+xml: - schema: - $ref: '#/components/schemas/ContentTypeGroup' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <ContentTypeGroup href="/content/typesgroups/7" media-type="application/vnd.ibexa.api.ContentTypeGroup+xml"> - <id>7</id> - <identifier>newContentTypeGroup</identifier> - <created>2012-02-31T12:45:00</created> - <modified>2012-02-31T12:45:00</modified> - <Creator href="/user/users/13" media-type="application/vnd.ibexa.api.User+xml"/> - <Modifier href="/user/users/13" media-type="application/vnd.ibexa.api.User+xml"/> - <ContentTypes href="/content/typegroups/7/types" media-type="application/vnd.ibexa.api.ContentTypeList+xml"/> - </ContentTypeGroup> - 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: X-CSRF-Token - in: header - description: The CSRF Token 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 content type group input schema encoded in XML or JSON. - 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"?> - <ContentTypeGroupInput> - <identifier>newContentTypeGroup</identifier> - </ContentTypeGroupInput> - required: false - deprecated: false - /content/typegroups/{contentTypeGroupId}: - get: - operationId: ibexa.rest.load_content_type_group - tags: - - Type Groups - responses: - 200: - description: OK - returns the content type group. - content: - application/vnd.ibexa.api.ContentTypeGroup+json: - schema: - $ref: '#/components/schemas/ContentTypeListWrapper' + $ref: '#/components/schemas/ContentTypeInfoListWrapper' example: ContentTypeList: _media-type: application/vnd.ibexa.api.ContentTypeList+json @@ -29463,11 +14428,9 @@ paths: - _languageCode: eng-GB '#text': Article descriptions: - value: - - _languageCode: eng-GB - '#text': ~ + value: [] creationDate: "2002-06-18T09:21:38+00:00" - modificationDate: "2021-06-28T11:31:22+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 @@ -29481,7 +14444,7 @@ paths: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2/draft remoteId: c15b600eb9198b1924063b5a68758232 - urlAliasSchema: "" + urlAliasSchema: ~ nameSchema: <short_title|title> isContainer: true mainLanguageCode: eng-GB @@ -29509,9 +14472,7 @@ paths: - _languageCode: eng-GB '#text': Title descriptions: - value: - - _languageCode: eng-GB - '#text': ~ + value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: @@ -29534,9 +14495,7 @@ paths: - _languageCode: eng-GB '#text': Short title descriptions: - value: - - _languageCode: eng-GB - '#text': ~ + value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: @@ -29559,9 +14518,7 @@ paths: - _languageCode: eng-GB '#text': Author descriptions: - value: - - _languageCode: eng-GB - '#text': ~ + value: [] fieldSettings: defaultAuthor: 1 validatorConfiguration: [] @@ -29588,9 +14545,7 @@ paths: - _languageCode: eng-GB '#text': Intro descriptions: - value: - - _languageCode: eng-GB - '#text': ~ + value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json @@ -29616,73 +14571,916 @@ paths: - _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: ~ + isSearchable: true + names: value: - _languageCode: eng-GB - '#text': ~ + '#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: ~ + 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: ~ + - _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: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Short name + descriptions: + value: [] + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: 100 + minStringLength: ~ + - _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"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + 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"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + 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: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Title + descriptions: + value: [] + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: ~ + minStringLength: ~ + - _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: ~ + content_field_id: ~ + language_code: ~ + 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: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Title + descriptions: + value: + - _languageCode: eng-GB + '#text': Title + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: ~ + minStringLength: ~ - _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 + _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: false - isSearchable: false + defaultValue: ~ + isSearchable: true names: value: - _languageCode: eng-GB - '#text': Enable comments + '#text': Description descriptions: value: - _languageCode: eng-GB - '#text': ~ + '#text': Landing page description fieldSettings: [] - validatorConfiguration: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: ~ + minStringLength: ~ - _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 + _href: /api/ibexa/v2/content/types/42/fieldDefinitions/187 + id: 187 + identifier: page + fieldType: ibexa_landing_page fieldGroup: content - position: 7 - isTranslatable: false + position: 30 + isTranslatable: true isRequired: false isInfoCollector: false defaultValue: - destinationContentId: ~ - alternativeText: ~ - source: ~ + layout: default + zones: + - id: default_id + name: default + blocks: [] isSearchable: false names: value: - _languageCode: eng-GB - '#text': Image + '#text': Landing page descriptions: value: - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] + '#text': Landing page + fieldSettings: + availableBlocks: ~ + availableLayouts: ~ + editorMode: page_view_mode validatorConfiguration: [] + application/vnd.ibexa.api.ContentTypeInfoList+xml: + schema: + $ref: '#/components/schemas/ContentTypeInfoList' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <ContentTypeList media-type="application/vnd.ibexa.api.ContentTypeList+xml" href="/api/ibexa/v2/content/typegroups/1/types"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"> + <id>2</id> + <status>DEFINED</status> + <identifier>article</identifier> + <names> + <value languageCode="eng-GB">Article</value> + </names> + <descriptions/> + <creationDate>2002-06-18T09:21:38+00:00</creationDate> + <modificationDate>2004-04-20T09:56:29+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2/draft"/> + <remoteId>c15b600eb9198b1924063b5a68758232</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><short_title|title></nameSchema> + <isContainer>true</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>false</defaultAlwaysAvailable> + <defaultSortField>PATH</defaultSortField> + <defaultSortOrder>ASC</defaultSortOrder> + <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions"> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/1"> + <id>1</id> + <identifier>title</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>1</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue>New article</defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Title</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">255</value> + <value key="minStringLength"/></value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/152"> + <id>152</id> + <identifier>short_title</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>2</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Short title</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">255</value> + <value key="minStringLength"/></value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/153"> + <id>153</id> + <identifier>author</identifier> + <fieldType>ibexa_author</fieldType> + <fieldGroup></fieldGroup> + <position>3</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>false</isSearchable> + <names> + <value languageCode="eng-GB">Author</value> + </names> + <descriptions/> + <fieldSettings> + <value key="defaultAuthor">1</value> + </fieldSettings> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/120"> + <id>120</id> + <identifier>intro</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup></fieldGroup> + <position>4</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Intro</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/121"> + <id>121</id> + <identifier>body</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup></fieldGroup> + <position>5</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Body</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/123"> + <id>123</id> + <identifier>enable_comments</identifier> + <fieldType>ibexa_boolean</fieldType> + <fieldGroup></fieldGroup> + <position>6</position> + <isTranslatable>false</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue>false</defaultValue> + <isSearchable>false</isSearchable> + <names> + <value languageCode="eng-GB">Enable comments</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/154"> + <id>154</id> + <identifier>image</identifier> + <fieldType>ibexa_object_relation</fieldType> + <fieldGroup></fieldGroup> + <position>7</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="destinationContentId"/> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Image</value> + </names> + <descriptions/> + <fieldSettings> + <value key="selectionMethod">SELECTION_BROWSE</value> + <value key="selectionRoot"></value> + <value key="selectionContentTypes"/> + </fieldSettings> + <validatorConfiguration/> + </FieldDefinition> + </FieldDefinitions> + </ContentType> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"> + <id>1</id> + <status>DEFINED</status> + <identifier>folder</identifier> + <names> + <value languageCode="eng-GB">Folder</value> + </names> + <descriptions/> + <creationDate>2002-06-18T09:21:38+00:00</creationDate> + <modificationDate>2015-11-29T21:14:32+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/1/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1/draft"/> + <remoteId>a3d405b81be900468eb153d774f4f0d2</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><short_name|name></nameSchema> + <isContainer>true</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>true</defaultAlwaysAvailable> + <defaultSortField>PATH</defaultSortField> + <defaultSortOrder>ASC</defaultSortOrder> + <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions"> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/4"> + <id>4</id> + <identifier>name</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>1</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue>Folder</defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Name</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">255</value> + <value key="minStringLength"/></value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/155"> + <id>155</id> + <identifier>short_name</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>2</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Short name</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">100</value> + <value key="minStringLength"/></value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/119"> + <id>119</id> + <identifier>short_description</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup></fieldGroup> + <position>3</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Short description</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/156"> + <id>156</id> + <identifier>description</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup></fieldGroup> + <position>4</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Description</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + </FieldDefinitions> + </ContentType> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/43"> + <id>43</id> + <status>DEFINED</status> + <identifier>form</identifier> + <names> + <value languageCode="eng-GB">Form</value> + </names> + <descriptions/> + <creationDate>2018-09-17T06:46:13+00:00</creationDate> + <modificationDate>2018-09-17T06:47:14+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/43/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/43/draft"/> + <remoteId>6f7f21df775a33c1e4bbc76b48c38476</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><title></nameSchema> + <isContainer>false</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>true</defaultAlwaysAvailable> + <defaultSortField>PUBLISHED</defaultSortField> + <defaultSortOrder>DESC</defaultSortOrder> + <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions"> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions/188"> + <id>188</id> + <identifier>title</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup>content</fieldGroup> + <position>1</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Title</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength"/> + <value key="minStringLength"/></value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions/189"> + <id>189</id> + <identifier>form</identifier> + <fieldType>ibexa_form</fieldType> + <fieldGroup>content</fieldGroup> + <position>2</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="fields"/> + <value key="content_id"/> + <value key="content_field_id"/> + <value key="language_code"/> + </defaultValue> + <isSearchable>false</isSearchable> + <names> + <value languageCode="eng-GB">Form</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + </FieldDefinitions> + </ContentType> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/42"> + <id>42</id> + <status>DEFINED</status> + <identifier>landing_page</identifier> + <names> + <value languageCode="eng-GB">Landing page</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <creationDate>2015-07-03T12:00:26+00:00</creationDate> + <modificationDate>2015-07-03T12:00:26+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/42/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/42/draft"/> + <remoteId>60c03e9758465eb69d56b3afb6adf18e</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><name></nameSchema> + <isContainer>true</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>true</defaultAlwaysAvailable> + <defaultSortField>PUBLISHED</defaultSortField> + <defaultSortOrder>DESC</defaultSortOrder> + <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions"> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/185"> + <id>185</id> + <identifier>name</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup>content</fieldGroup> + <position>10</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Title</value> + </names> + <descriptions> + <value languageCode="eng-GB">Title</value> + </descriptions> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength"/> + <value key="minStringLength"/></value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/186"> + <id>186</id> + <identifier>description</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup>content</fieldGroup> + <position>20</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Description</value> + </names> + <descriptions> + <value languageCode="eng-GB">Landing page description</value> + </descriptions> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength"/> + <value key="minStringLength"/></value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/187"> + <id>187</id> + <identifier>page</identifier> + <fieldType>ibexa_landing_page</fieldType> + <fieldGroup>content</fieldGroup> + <position>30</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="layout">default</value> + <value key="zones"> + <value> + <value key="id">default_id</value> + <value key="name">default</value> + <value key="blocks"/></value> + </value> + </defaultValue> + <isSearchable>false</isSearchable> + <names> + <value languageCode="eng-GB">Landing page</value> + </names> + <descriptions> + <value languageCode="eng-GB">Landing page</value> + </descriptions> + <fieldSettings> + <value key="availableBlocks"/> + <value key="availableLayouts"/> + <value key="editorMode">page_view_mode</value> + </fieldSettings> + <validatorConfiguration/> + </FieldDefinition> + </FieldDefinitions> + </ContentType> + </ContentTypeList> + 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: [] + /content/types/view: + post: + operationId: ibexa.rest.content_types.view + tags: + - Type + responses: + 200: + description: The view in XML or JSON format. + 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/50 - id: 50 + _href: /api/ibexa/v2/content/types/2 + id: 2 status: DEFINED - identifier: copy_of_article_50 + identifier: article names: value: - _languageCode: eng-GB '#text': Article descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - creationDate: "2021-07-14T10:30:00+00:00" - modificationDate: "2021-07-14T10:30:00+00:00" + 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 @@ -29691,12 +15489,12 @@ paths: _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json - _href: /api/ibexa/v2/content/types/50/groups + _href: /api/ibexa/v2/content/types/2/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/50/draft - remoteId: fc9434492469d136ffe13377bfdcbb28 - urlAliasSchema: "" + _href: /api/ibexa/v2/content/types/2/draft + remoteId: c15b600eb9198b1924063b5a68758232 + urlAliasSchema: ~ nameSchema: <short_title|title> isContainer: true mainLanguageCode: eng-GB @@ -29705,11 +15503,11 @@ paths: defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json - _href: /api/ibexa/v2/content/types/50/fieldDefinitions + _href: /api/ibexa/v2/content/types/2/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/50/fieldDefinitions/197 - id: 197 + _href: /api/ibexa/v2/content/types/2/fieldDefinitions/1 + id: 1 identifier: title fieldType: ibexa_string fieldGroup: "" @@ -29724,17 +15522,15 @@ paths: - _languageCode: eng-GB '#text': Title descriptions: - value: - - _languageCode: eng-GB - '#text': ~ + value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: ~ - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/50/fieldDefinitions/198 - id: 198 + _href: /api/ibexa/v2/content/types/2/fieldDefinitions/152 + id: 152 identifier: short_title fieldType: ibexa_string fieldGroup: "" @@ -29749,17 +15545,15 @@ paths: - _languageCode: eng-GB '#text': Short title descriptions: - value: - - _languageCode: eng-GB - '#text': ~ + value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: ~ - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/50/fieldDefinitions/199 - id: 199 + _href: /api/ibexa/v2/content/types/2/fieldDefinitions/153 + id: 153 identifier: author fieldType: ibexa_author fieldGroup: "" @@ -29774,15 +15568,13 @@ paths: - _languageCode: eng-GB '#text': Author descriptions: - value: - - _languageCode: eng-GB - '#text': ~ + value: [] fieldSettings: defaultAuthor: 1 validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/50/fieldDefinitions/200 - id: 200 + _href: /api/ibexa/v2/content/types/2/fieldDefinitions/120 + id: 120 identifier: intro fieldType: ibexa_richtext fieldGroup: "" @@ -29803,14 +15595,12 @@ paths: - _languageCode: eng-GB '#text': Intro descriptions: - value: - - _languageCode: eng-GB - '#text': ~ + value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/50/fieldDefinitions/201 - id: 201 + _href: /api/ibexa/v2/content/types/2/fieldDefinitions/121 + id: 121 identifier: body fieldType: ibexa_richtext fieldGroup: "" @@ -29831,14 +15621,12 @@ paths: - _languageCode: eng-GB '#text': Body descriptions: - value: - - _languageCode: eng-GB - '#text': ~ + value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/50/fieldDefinitions/202 - id: 202 + _href: /api/ibexa/v2/content/types/2/fieldDefinitions/123 + id: 123 identifier: enable_comments fieldType: ibexa_boolean fieldGroup: "" @@ -29853,152 +15641,32 @@ paths: - _languageCode: eng-GB '#text': Enable comments descriptions: - value: - - _languageCode: eng-GB - '#text': ~ + value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/50/fieldDefinitions/203 - id: 203 + _href: /api/ibexa/v2/content/types/2/fieldDefinitions/154 + id: 154 identifier: image - fieldType: ibexa_image_asset - fieldGroup: content + fieldType: ibexa_object_relation + fieldGroup: "" position: 7 - isTranslatable: false - isRequired: false - isInfoCollector: false - defaultValue: - destinationContentId: ~ - alternativeText: ~ - source: ~ - isSearchable: false - names: - value: - - _languageCode: eng-GB - '#text': Image - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: [] - - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/44 - id: 44 - status: DEFINED - identifier: dog_breed - names: - value: - - _languageCode: eng-GB - '#text': Dog Breed - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - creationDate: "2021-06-28T11:28:00+00:00" - modificationDate: "2021-06-28T11:29:02+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/44/groups - Draft: - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/44/draft - remoteId: b348c95f7c573d4d502d6b59f80e618a - urlAliasSchema: "" - nameSchema: <name> - 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/44/fieldDefinitions - FieldDefinition: - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/44/fieldDefinitions/190 - id: 190 - identifier: name - fieldType: ibexa_string - fieldGroup: content - position: 1 - isTranslatable: true - isRequired: false - isInfoCollector: false - defaultValue: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Name - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: ~ - minStringLength: ~ - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/44/fieldDefinitions/191 - id: 191 - identifier: photo - fieldType: ibexa_image_asset - fieldGroup: content - position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: destinationContentId: ~ - alternativeText: ~ - source: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Photo - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: [] - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/44/fieldDefinitions/192 - id: 192 - identifier: description - fieldType: ibexa_richtext - fieldGroup: content - position: 3 - isTranslatable: true - isRequired: false - isInfoCollector: false - defaultValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB - '#text': Full Description + '#text': Image descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] + value: [] + fieldSettings: + selectionMethod: SELECTION_BROWSE + selectionRoot: "" + selectionContentTypes: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/1 @@ -30107,278 +15775,47 @@ paths: '#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"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - 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/55 - id: 55 - status: DEFINED - identifier: folder_55 - names: - value: - - _languageCode: eng-GB - '#text': Folder - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - creationDate: "2021-07-28T07:57:22+00:00" - modificationDate: "2021-07-28T07:57:34+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/55/groups - Draft: - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/55/draft - remoteId: 4eb7bc76f6d0bd1d5ded2d8936cc6afb - urlAliasSchema: "" - 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/55/fieldDefinitions - FieldDefinition: - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/55/fieldDefinitions/210 - id: 210 - 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: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: 255 - minStringLength: ~ - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/55/fieldDefinitions/211 - id: 211 - identifier: short_name - fieldType: ibexa_string - fieldGroup: "" - position: 2 - isTranslatable: true - isRequired: false - isInfoCollector: false - defaultValue: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Short name - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: 100 - minStringLength: ~ - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/55/fieldDefinitions/212 - id: 212 - identifier: short_description - fieldType: ibexa_richtext - fieldGroup: "" - position: 3 - isTranslatable: true - isRequired: false - isInfoCollector: false - defaultValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Short description - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: [] - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/55/fieldDefinitions/213 - id: 213 - identifier: description - fieldType: ibexa_richtext - fieldGroup: "" - position: 4 - isTranslatable: true - isRequired: false - isInfoCollector: false - defaultValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Description - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - 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: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Title - descriptions: - value: [] - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: ~ - minStringLength: ~ - - _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 + 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: - fields: [] - content_id: ~ - content_field_id: ~ - language_code: ~ - isSearchable: false + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + isSearchable: true names: value: - _languageCode: eng-GB - '#text': Form + '#text': Description descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/45 - id: 45 + _href: /api/ibexa/v2/content/types/43 + id: 43 status: DEFINED - identifier: tip + identifier: form names: value: - _languageCode: eng-GB - '#text': Tip + '#text': Form descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - creationDate: "2021-06-28T11:29:19+00:00" - modificationDate: "2021-07-26T09:33:06+00:00" + 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 @@ -30387,11 +15824,11 @@ paths: _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json - _href: /api/ibexa/v2/content/types/45/groups + _href: /api/ibexa/v2/content/types/43/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/45/draft - remoteId: e6490e8a785edacd48629f2022be3125 + _href: /api/ibexa/v2/content/types/43/draft + remoteId: 6f7f21df775a33c1e4bbc76b48c38476 urlAliasSchema: "" nameSchema: <title> isContainer: false @@ -30401,17 +15838,17 @@ paths: defaultSortOrder: DESC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json - _href: /api/ibexa/v2/content/types/45/fieldDefinitions + _href: /api/ibexa/v2/content/types/43/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/45/fieldDefinitions/193 - id: 193 + _href: /api/ibexa/v2/content/types/43/fieldDefinitions/188 + id: 188 identifier: title fieldType: ibexa_string fieldGroup: content position: 1 isTranslatable: true - isRequired: false + isRequired: true isInfoCollector: false defaultValue: ~ isSearchable: true @@ -30420,63 +15857,34 @@ paths: - _languageCode: eng-GB '#text': Title descriptions: - value: - - _languageCode: eng-GB - '#text': ~ + value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: ~ minStringLength: ~ - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/45/fieldDefinitions/194 - id: 194 - identifier: body - fieldType: ibexa_text + _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: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Body - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: - textRows: 10 - validatorConfiguration: [] - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/45/fieldDefinitions/204 - id: 204 - identifier: richtext - fieldType: ibexa_richtext - fieldGroup: content - position: 3 - isTranslatable: true - isRequired: false - isInfoCollector: false defaultValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - isSearchable: true + fields: [] + content_id: ~ + content_field_id: ~ + language_code: ~ + isSearchable: false names: value: - _languageCode: eng-GB - '#text': richtext + '#text': Form descriptions: - value: - - _languageCode: eng-GB - '#text': ~ + value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json @@ -30598,1937 +16006,2572 @@ paths: availableLayouts: ~ editorMode: page_view_mode validatorConfiguration: [] - application/vnd.ibexa.api.ContentTypeGroup+xml: + application/vnd.ibexa.api.ContentTypeList+xml: schema: - $ref: '#/components/schemas/ContentTypeList' + $ref: '#/components/schemas/ContentTypeInfoList' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentTypeList media-type="application/vnd.ibexa.api.ContentTypeList+xml" href="/api/ibexa/v2/content/typegroups/1/types"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"> - <id>2</id> - <status>DEFINED</status> - <identifier>article</identifier> - <names> - <value languageCode="eng-GB">Article</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <creationDate>2002-06-18T09:21:38+00:00</creationDate> - <modificationDate>2021-06-28T11:31:22+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2/draft"/> - <remoteId>c15b600eb9198b1924063b5a68758232</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><short_title|title></nameSchema> - <isContainer>true</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>false</defaultAlwaysAvailable> - <defaultSortField>PATH</defaultSortField> - <defaultSortOrder>ASC</defaultSortOrder> - <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions"> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/1"> - <id>1</id> - <identifier>title</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>1</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue>New article</defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Title</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">255</value> - <value key="minStringLength"/> - </value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/152"> - <id>152</id> - <identifier>short_title</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>2</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Short title</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">255</value> - <value key="minStringLength"/> - </value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/153"> - <id>153</id> - <identifier>author</identifier> - <fieldType>ibexa_author</fieldType> - <fieldGroup></fieldGroup> - <position>3</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Author</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings> - <value key="defaultAuthor">1</value> - </fieldSettings> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/120"> - <id>120</id> - <identifier>intro</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup></fieldGroup> - <position>4</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Intro</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/121"> - <id>121</id> - <identifier>body</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup></fieldGroup> - <position>5</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Body</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/123"> - <id>123</id> - <identifier>enable_comments</identifier> - <fieldType>ibexa_boolean</fieldType> - <fieldGroup></fieldGroup> - <position>6</position> - <isTranslatable>false</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue>false</defaultValue> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Enable comments</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/195"> - <id>195</id> - <identifier>image</identifier> - <fieldType>ibexa_image_asset</fieldType> - <fieldGroup>content</fieldGroup> - <position>7</position> - <isTranslatable>false</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="destinationContentId"/> - <value key="alternativeText"/> - <value key="source"/> - </defaultValue> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Image</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - </FieldDefinitions> - </ContentType> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/50"> - <id>50</id> - <status>DEFINED</status> - <identifier>copy_of_article_50</identifier> - <names> - <value languageCode="eng-GB">Article</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <creationDate>2021-07-14T10:30:00+00:00</creationDate> - <modificationDate>2021-07-14T10:30:00+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/50/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/50/draft"/> - <remoteId>fc9434492469d136ffe13377bfdcbb28</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><short_title|title></nameSchema> - <isContainer>true</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>false</defaultAlwaysAvailable> - <defaultSortField>PATH</defaultSortField> - <defaultSortOrder>ASC</defaultSortOrder> - <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions"> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/197"> - <id>197</id> - <identifier>title</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>1</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue>New article</defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Title</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">255</value> - <value key="minStringLength"/> - </value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/198"> - <id>198</id> - <identifier>short_title</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>2</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Short title</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">255</value> - <value key="minStringLength"/> - </value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/199"> - <id>199</id> - <identifier>author</identifier> - <fieldType>ibexa_author</fieldType> - <fieldGroup></fieldGroup> - <position>3</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Author</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings> - <value key="defaultAuthor">1</value> - </fieldSettings> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/200"> - <id>200</id> - <identifier>intro</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup></fieldGroup> - <position>4</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"> + <id>2</id> + <status>DEFINED</status> + <identifier>article</identifier> + <names> + <value languageCode="eng-GB">Article</value> + </names> + <descriptions/> + <creationDate>2002-06-18T09:21:38+00:00</creationDate> + <modificationDate>2004-04-20T09:56:29+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2/draft"/> + <remoteId>c15b600eb9198b1924063b5a68758232</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><short_title|title></nameSchema> + <isContainer>true</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>false</defaultAlwaysAvailable> + <defaultSortField>PATH</defaultSortField> + <defaultSortOrder>ASC</defaultSortOrder> + <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions"> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/1"> + <id>1</id> + <identifier>title</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>1</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue>New article</defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Title</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">255</value> + <value key="minStringLength"/></value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/152"> + <id>152</id> + <identifier>short_title</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>2</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Short title</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">255</value> + <value key="minStringLength"/></value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/153"> + <id>153</id> + <identifier>author</identifier> + <fieldType>ibexa_author</fieldType> + <fieldGroup></fieldGroup> + <position>3</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>false</isSearchable> + <names> + <value languageCode="eng-GB">Author</value> + </names> + <descriptions/> + <fieldSettings> + <value key="defaultAuthor">1</value> + </fieldSettings> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/120"> + <id>120</id> + <identifier>intro</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup></fieldGroup> + <position>4</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Intro</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/201"> - <id>201</id> - <identifier>body</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup></fieldGroup> - <position>5</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Intro</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/121"> + <id>121</id> + <identifier>body</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup></fieldGroup> + <position>5</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Body</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/202"> - <id>202</id> - <identifier>enable_comments</identifier> - <fieldType>ibexa_boolean</fieldType> - <fieldGroup></fieldGroup> - <position>6</position> - <isTranslatable>false</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue>false</defaultValue> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Enable comments</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/203"> - <id>203</id> - <identifier>image</identifier> - <fieldType>ibexa_image_asset</fieldType> - <fieldGroup>content</fieldGroup> - <position>7</position> - <isTranslatable>false</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="destinationContentId"/> - <value key="alternativeText"/> - <value key="source"/> - </defaultValue> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Image</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - </FieldDefinitions> - </ContentType> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/44"> - <id>44</id> - <status>DEFINED</status> - <identifier>dog_breed</identifier> - <names> - <value languageCode="eng-GB">Dog Breed</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <creationDate>2021-06-28T11:28:00+00:00</creationDate> - <modificationDate>2021-06-28T11:29:02+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/44/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/44/draft"/> - <remoteId>b348c95f7c573d4d502d6b59f80e618a</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><name></nameSchema> - <isContainer>false</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>true</defaultAlwaysAvailable> - <defaultSortField>PUBLISHED</defaultSortField> - <defaultSortOrder>DESC</defaultSortOrder> - <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/44/fieldDefinitions"> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/44/fieldDefinitions/190"> - <id>190</id> - <identifier>name</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup>content</fieldGroup> - <position>1</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Name</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength"/> - <value key="minStringLength"/> - </value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/44/fieldDefinitions/191"> - <id>191</id> - <identifier>photo</identifier> - <fieldType>ibexa_image_asset</fieldType> - <fieldGroup>content</fieldGroup> - <position>2</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="destinationContentId"/> - <value key="alternativeText"/> - <value key="source"/> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Photo</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/44/fieldDefinitions/192"> - <id>192</id> - <identifier>description</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup>content</fieldGroup> - <position>3</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Body</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/123"> + <id>123</id> + <identifier>enable_comments</identifier> + <fieldType>ibexa_boolean</fieldType> + <fieldGroup></fieldGroup> + <position>6</position> + <isTranslatable>false</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue>false</defaultValue> + <isSearchable>false</isSearchable> + <names> + <value languageCode="eng-GB">Enable comments</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/154"> + <id>154</id> + <identifier>image</identifier> + <fieldType>ibexa_object_relation</fieldType> + <fieldGroup></fieldGroup> + <position>7</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="destinationContentId"/> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Image</value> + </names> + <descriptions/> + <fieldSettings> + <value key="selectionMethod">SELECTION_BROWSE</value> + <value key="selectionRoot"></value> + <value key="selectionContentTypes"/> + </fieldSettings> + <validatorConfiguration/> + </FieldDefinition> + </FieldDefinitions> + </ContentType> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"> + <id>1</id> + <status>DEFINED</status> + <identifier>folder</identifier> + <names> + <value languageCode="eng-GB">Folder</value> + </names> + <descriptions/> + <creationDate>2002-06-18T09:21:38+00:00</creationDate> + <modificationDate>2015-11-29T21:14:32+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/1/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1/draft"/> + <remoteId>a3d405b81be900468eb153d774f4f0d2</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><short_name|name></nameSchema> + <isContainer>true</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>true</defaultAlwaysAvailable> + <defaultSortField>PATH</defaultSortField> + <defaultSortOrder>ASC</defaultSortOrder> + <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions"> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/4"> + <id>4</id> + <identifier>name</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>1</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue>Folder</defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Name</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">255</value> + <value key="minStringLength"/></value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/155"> + <id>155</id> + <identifier>short_name</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>2</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Short name</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">100</value> + <value key="minStringLength"/></value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/119"> + <id>119</id> + <identifier>short_description</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup></fieldGroup> + <position>3</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Full Description</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - </FieldDefinitions> - </ContentType> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"> - <id>1</id> - <status>DEFINED</status> - <identifier>folder</identifier> - <names> - <value languageCode="eng-GB">Folder</value> - </names> - <descriptions/> - <creationDate>2002-06-18T09:21:38+00:00</creationDate> - <modificationDate>2015-11-29T21:14:32+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/1/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1/draft"/> - <remoteId>a3d405b81be900468eb153d774f4f0d2</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><short_name|name></nameSchema> - <isContainer>true</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>true</defaultAlwaysAvailable> - <defaultSortField>PATH</defaultSortField> - <defaultSortOrder>ASC</defaultSortOrder> - <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions"> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/4"> - <id>4</id> - <identifier>name</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>1</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue>Folder</defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Name</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">255</value> - <value key="minStringLength"/> - </value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/155"> - <id>155</id> - <identifier>short_name</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>2</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Short name</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">100</value> - <value key="minStringLength"/> - </value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/119"> - <id>119</id> - <identifier>short_description</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup></fieldGroup> - <position>3</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Short description</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/156"> + <id>156</id> + <identifier>description</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup></fieldGroup> + <position>4</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> - </defaultValue> - <isSearchable>true</isSearchable> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Description</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + </FieldDefinitions> + </ContentType> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/43"> + <id>43</id> + <status>DEFINED</status> + <identifier>form</identifier> + <names> + <value languageCode="eng-GB">Form</value> + </names> + <descriptions/> + <creationDate>2018-09-17T06:46:13+00:00</creationDate> + <modificationDate>2018-09-17T06:47:14+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/43/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/43/draft"/> + <remoteId>6f7f21df775a33c1e4bbc76b48c38476</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><title></nameSchema> + <isContainer>false</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>true</defaultAlwaysAvailable> + <defaultSortField>PUBLISHED</defaultSortField> + <defaultSortOrder>DESC</defaultSortOrder> + <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions"> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions/188"> + <id>188</id> + <identifier>title</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup>content</fieldGroup> + <position>1</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Title</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength"/> + <value key="minStringLength"/></value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions/189"> + <id>189</id> + <identifier>form</identifier> + <fieldType>ibexa_form</fieldType> + <fieldGroup>content</fieldGroup> + <position>2</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="fields"/> + <value key="content_id"/> + <value key="content_field_id"/> + <value key="language_code"/> + </defaultValue> + <isSearchable>false</isSearchable> + <names> + <value languageCode="eng-GB">Form</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + </FieldDefinitions> + </ContentType> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/42"> + <id>42</id> + <status>DEFINED</status> + <identifier>landing_page</identifier> + <names> + <value languageCode="eng-GB">Landing page</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <creationDate>2015-07-03T12:00:26+00:00</creationDate> + <modificationDate>2015-07-03T12:00:26+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/42/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/42/draft"/> + <remoteId>60c03e9758465eb69d56b3afb6adf18e</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><name></nameSchema> + <isContainer>true</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>true</defaultAlwaysAvailable> + <defaultSortField>PUBLISHED</defaultSortField> + <defaultSortOrder>DESC</defaultSortOrder> + <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions"> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/185"> + <id>185</id> + <identifier>name</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup>content</fieldGroup> + <position>10</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Title</value> + </names> + <descriptions> + <value languageCode="eng-GB">Title</value> + </descriptions> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength"/> + <value key="minStringLength"/></value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/186"> + <id>186</id> + <identifier>description</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup>content</fieldGroup> + <position>20</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Description</value> + </names> + <descriptions> + <value languageCode="eng-GB">Landing page description</value> + </descriptions> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength"/> + <value key="minStringLength"/></value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/187"> + <id>187</id> + <identifier>page</identifier> + <fieldType>ibexa_landing_page</fieldType> + <fieldGroup>content</fieldGroup> + <position>30</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="layout">default</value> + <value key="zones"> + <value> + <value key="id">default_id</value> + <value key="name">default</value> + <value key="blocks"/></value> + </value> + </defaultValue> + <isSearchable>false</isSearchable> + <names> + <value languageCode="eng-GB">Landing page</value> + </names> + <descriptions> + <value languageCode="eng-GB">Landing page</value> + </descriptions> + <fieldSettings> + <value key="availableBlocks"/> + <value key="availableLayouts"/> + <value key="editorMode">page_view_mode</value> + </fieldSettings> + <validatorConfiguration/> + </FieldDefinition> + </FieldDefinitions> + </ContentType> + </ContentTypeList> + 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: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + requestBody: + description: The view input in XML or JSON format. + content: + application/vnd.ibexa.api.ContentTypeViewInput+json: + schema: + $ref: '#/components/schemas/ContentTypeViewInputWrapper' + example: + ViewInput: + identifier: ContentTypeView + ContentTypeQuery: + limit: "10" + offset: "1" + Query: + ContentTypeIdCriterion: + - 1 + - 2 + ContentTypeIdentifierCriterion: folder + IsSystemCriterion: true + ContentTypeGroupIdCriterion: 1 + ContainsFieldDefinitionIdCriterion: 2 + SortClauses: + Identifier: descending + Id: ascending + application/vnd.ibexa.api.ContentTypeViewInput+xml: + schema: + $ref: '#/components/schemas/ContentTypeViewInput' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <ViewInput> + <identifier>ContentTypeView</identifier> + <ContentTypeQuery> + <limit>10</limit> + <offset>1</offset> + <Query> + <ContentTypeIdCriterion>1</ContentTypeIdCriterion> + <ContentTypeIdCriterion>2</ContentTypeIdCriterion> + <ContentTypeIdentifierCriterion>folder</ContentTypeIdentifierCriterion> + <IsSystemCriterion>true</IsSystemCriterion> + <ContentTypeGroupIdCriterion>1</ContentTypeGroupIdCriterion> + <ContainsFieldDefinitionIdCriterion>2</ContainsFieldDefinitionIdCriterion> + </Query> + <SortClauses> + <Identifier>descending</Identifier> + <Id>ascending</Id> + </SortClauses> + </ContentTypeQuery> + </ViewInput> + required: false + /content/types/{contentTypeId}: + get: + operationId: ibexa.rest.load_content_type + 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': ~ + 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': ~ + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: 255 + minStringLength: ~ + - _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: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Short title + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: 255 + minStringLength: ~ + - _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': ~ + 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"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Intro + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + 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"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Body + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + 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': ~ + 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: ~ + alternativeText: ~ + source: ~ + isSearchable: false + names: + value: + - _languageCode: eng-GB + '#text': Image + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + validatorConfiguration: [] + application/vnd.ibexa.api.ContentType+xml: + schema: + $ref: '#/components/schemas/ContentType' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"> + <id>2</id> + <status>DEFINED</status> + <identifier>article</identifier> <names> - <value languageCode="eng-GB">Short description</value> + <value languageCode="eng-GB">Article</value> </names> <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/156"> - <id>156</id> - <identifier>description</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup></fieldGroup> - <position>4</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <creationDate>2002-06-18T11:21:38+02:00</creationDate> + <modificationDate>2004-04-20T11:56:29+02:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2/draft"/> + <remoteId>c15b600eb9198b1924063b5a68758232</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><short_title|title></nameSchema> + <isContainer>true</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>false</defaultAlwaysAvailable> + <defaultSortField>PATH</defaultSortField> + <defaultSortOrder>ASC</defaultSortOrder> + <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions"> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/1"> + <id>1</id> + <identifier>title</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>1</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue>New article</defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Title</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">255</value> + <value key="minStringLength"/></value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/152"> + <id>152</id> + <identifier>short_title</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>2</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Short title</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">255</value> + <value key="minStringLength"/></value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/153"> + <id>153</id> + <identifier>author</identifier> + <fieldType>ibexa_author</fieldType> + <fieldGroup></fieldGroup> + <position>3</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>false</isSearchable> + <names> + <value languageCode="eng-GB">Author</value> + </names> + <descriptions/> + <fieldSettings> + <value key="defaultAuthor">1</value> + </fieldSettings> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/120"> + <id>120</id> + <identifier>intro</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup></fieldGroup> + <position>4</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Description</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - </FieldDefinitions> - </ContentType> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/55"> - <id>55</id> - <status>DEFINED</status> - <identifier>folder_55</identifier> - <names> - <value languageCode="eng-GB">Folder</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <creationDate>2021-07-28T07:57:22+00:00</creationDate> - <modificationDate>2021-07-28T07:57:34+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/55/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/55/draft"/> - <remoteId>4eb7bc76f6d0bd1d5ded2d8936cc6afb</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><short_name|name></nameSchema> - <isContainer>true</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>true</defaultAlwaysAvailable> - <defaultSortField>PATH</defaultSortField> - <defaultSortOrder>ASC</defaultSortOrder> - <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/55/fieldDefinitions"> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/55/fieldDefinitions/210"> - <id>210</id> - <identifier>name</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>1</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue>Folder</defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Name</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">255</value> - <value key="minStringLength"/> - </value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/55/fieldDefinitions/211"> - <id>211</id> - <identifier>short_name</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>2</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Short name</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">100</value> - <value key="minStringLength"/> - </value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/55/fieldDefinitions/212"> - <id>212</id> - <identifier>short_description</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup></fieldGroup> - <position>3</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Intro</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/121"> + <id>121</id> + <identifier>body</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup></fieldGroup> + <position>5</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> - </defaultValue> - <isSearchable>true</isSearchable> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Body</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/123"> + <id>123</id> + <identifier>enable_comments</identifier> + <fieldType>ibexa_boolean</fieldType> + <fieldGroup></fieldGroup> + <position>6</position> + <isTranslatable>false</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue>false</defaultValue> + <isSearchable>false</isSearchable> + <names> + <value languageCode="eng-GB">Enable comments</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/154"> + <id>154</id> + <identifier>image</identifier> + <fieldType>ibexa_object_relation</fieldType> + <fieldGroup></fieldGroup> + <position>7</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="destinationContentId"/> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Image</value> + </names> + <descriptions/> + <fieldSettings> + <value key="selectionMethod">SELECTION_BROWSE</value> + <value key="selectionRoot"></value> + <value key="selectionContentTypes"/> + </fieldSettings> + <validatorConfiguration/> + </FieldDefinition> + </FieldDefinitions> + </ContentType> + 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: If-None-Match + in: header + description: ETag + required: false + deprecated: false + schema: + type: string + style: simple + explode: false + - name: contentTypeId + in: path + description: ContentTypeLoadByIdController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + post: + operationId: ibexa.rest.create_content_type_draft + 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/1/draft + id: 1 + status: DRAFT + identifier: folder + names: + value: + - _languageCode: eng-GB + '#text': Folder + descriptions: + value: [] + creationDate: "2002-06-18T09:21:38+00:00" + modificationDate: "2021-08-11T11:17:58+00:00" + Creator: + _media-type: application/vnd.ibexa.api.User+json + _href: /api/ibexa/v2/user/users/14 + Modifier: + _media-type: application/vnd.ibexa.api.User+json + _href: /api/ibexa/v2/user/users/14 + Groups: + _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json + _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: ~ + nameSchema: <short_name|name> + 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"?> + <ContentTypeInfo media-type="application/vnd.ibexa.api.ContentTypeInfo+xml" href="/api/ibexa/v2/content/types/3/draft"> + <id>3</id> + <status>DRAFT</status> + <identifier>user_group</identifier> + <names> + <value languageCode="eng-GB">User group</value> + </names> + <descriptions/> + <creationDate>2002-06-18T11:21:38+02:00</creationDate> + <modificationDate>2019-02-25T14:41:53+01:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/3/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/3/draft"/> + <remoteId>25b4268cdcd01921b808a0d854b877ef</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><name></nameSchema> + <isContainer>true</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>true</defaultAlwaysAvailable> + <defaultSortField>PATH</defaultSortField> + <defaultSortOrder>ASC</defaultSortOrder> + </ContentTypeInfo> + 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: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: contentTypeId + in: path + description: ContentTypeDraftCreateController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + requestBody: + description: The content type Update schema encoded in XML or JSON format. + 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"?> + <ContentTypeUpdate> + <defaultAlwaysAvailable>true</defaultAlwaysAvailable> + </ContentTypeUpdate> + required: false + delete: + operationId: ibexa.rest.delete_content_type + 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: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: contentTypeId + in: path + description: ContentTypeDeleteController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + /content/types/{contentTypeId}/draft: + get: + operationId: ibexa.rest.load_content_type_draft + 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': ~ + 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': ~ + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: 255 + minStringLength: ~ + - _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: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Short title + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: 255 + minStringLength: ~ + - _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': ~ + 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"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Intro + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + 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"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Body + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + 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': ~ + 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: ~ + alternativeText: ~ + source: ~ + isSearchable: false + names: + value: + - _languageCode: eng-GB + '#text': Image + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + validatorConfiguration: [] + application/vnd.ibexa.api.ContentType+xml: + schema: + $ref: '#/components/schemas/ContentType' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/14"> + <id>14</id> + <status>DEFINED</status> + <identifier>copy_of_article_14</identifier> <names> - <value languageCode="eng-GB">Short description</value> + <value languageCode="eng-GB">Updated content type name</value> </names> <descriptions> - <value languageCode="eng-GB"></value> + <value languageCode="eng-GB">This is an updated content type description</value> </descriptions> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/55/fieldDefinitions/213"> - <id>213</id> - <identifier>description</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup></fieldGroup> - <position>4</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> - </defaultValue> - <isSearchable>true</isSearchable> + <creationDate>2019-02-06T10:56:36+01:00</creationDate> + <modificationDate>2019-02-25T12:15:51+01:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/14/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/14/draft"/> + <remoteId>d7ae816f22fe929e67a359a2ef6e7cde</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><short_title|title></nameSchema> + <isContainer>true</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>false</defaultAlwaysAvailable> + <defaultSortField>PATH</defaultSortField> + <defaultSortOrder>ASC</defaultSortOrder> + <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/14/fieldDefinitions"> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/14/fieldDefinitions/188"> + <id>188</id> + <identifier>title</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>1</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue>New article</defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Title</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">255</value> + <value key="minStringLength"/></value> + </validatorConfiguration> + </FieldDefinition> + </FieldDefinitions> + </ContentType> + 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: contentTypeId + in: path + description: ContentTypeDraftLoadController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + delete: + operationId: ibexa.rest.delete_content_type_draft + 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: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: contentTypeId + in: path + description: ContentTypeDraftDeleteController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + patch: + operationId: ibexa.rest.update_content_type_draft + 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: ~ + 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"?> + <ContentTypeInfo media-type="application/vnd.ibexa.api.ContentTypeInfo+xml" href="/api/ibexa/v2/content/types/14/draft"> + <id>14</id> + <status>DRAFT</status> + <identifier>new_content_type</identifier> <names> - <value languageCode="eng-GB">Description</value> + <value languageCode="eng-GB">Updated content type name</value> </names> <descriptions> - <value languageCode="eng-GB"></value> + <value languageCode="eng-GB">This is an updated content type description</value> </descriptions> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - </FieldDefinitions> - </ContentType> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/43"> - <id>43</id> - <status>DEFINED</status> - <identifier>form</identifier> - <names> - <value languageCode="eng-GB">Form</value> - </names> - <descriptions/> - <creationDate>2018-09-17T06:46:13+00:00</creationDate> - <modificationDate>2018-09-17T06:47:14+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/43/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/43/draft"/> - <remoteId>6f7f21df775a33c1e4bbc76b48c38476</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><title></nameSchema> - <isContainer>false</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>true</defaultAlwaysAvailable> - <defaultSortField>PUBLISHED</defaultSortField> - <defaultSortOrder>DESC</defaultSortOrder> - <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions"> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions/188"> - <id>188</id> - <identifier>title</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup>content</fieldGroup> - <position>1</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Title</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength"/> - <value key="minStringLength"/> - </value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions/189"> - <id>189</id> - <identifier>form</identifier> - <fieldType>ibexa_form</fieldType> - <fieldGroup>content</fieldGroup> - <position>2</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="fields"/> - <value key="content_id"/> - <value key="content_field_id"/> - <value key="language_code"/> - </defaultValue> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Form</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - </FieldDefinitions> - </ContentType> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/45"> - <id>45</id> - <status>DEFINED</status> - <identifier>tip</identifier> + <creationDate>2019-02-06T10:56:36+01:00</creationDate> + <modificationDate>2019-02-25T12:15:51+01:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/14/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/14/draft"/> + <remoteId>d7ae816f22fe929e67a359a2ef6e7cde</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><short_title|title></nameSchema> + <isContainer>true</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>false</defaultAlwaysAvailable> + <defaultSortField>PATH</defaultSortField> + <defaultSortOrder>ASC</defaultSortOrder> + </ContentTypeInfo> + 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: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: contentTypeId + in: path + description: ContentTypeDraftUpdateController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + requestBody: + description: The content type update schema encoded in XML or JSON format. + content: + application/vnd.ibexa.api.ContentTypeUpdate+json: + schema: + $ref: '#/components/schemas/ContentTypeUpdateWrapper' + example: + ContentTypeUpdate: + _media-type: application/vnd.ibexa.api.ContentTypeUpdate + names: + value: + - _languageCode: eng-GB + '#text': Updated content type name + descriptions: + value: + - _languageCode: eng-GB + '#text': This is an updated content type description + application/vnd.ibexa.api.ContentTypeUpdate+xml: + schema: + $ref: '#/components/schemas/ContentTypeUpdate' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <ContentTypeUpdate> <names> - <value languageCode="eng-GB">Tip</value> + <value languageCode="eng-GB">Updated content type name</value> </names> <descriptions> - <value languageCode="eng-GB"></value> + <value languageCode="eng-GB">This is an updated content type description</value> </descriptions> - <creationDate>2021-06-28T11:29:19+00:00</creationDate> - <modificationDate>2021-07-26T09:33:06+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/45/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/45/draft"/> - <remoteId>e6490e8a785edacd48629f2022be3125</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><title></nameSchema> - <isContainer>false</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>true</defaultAlwaysAvailable> - <defaultSortField>PUBLISHED</defaultSortField> - <defaultSortOrder>DESC</defaultSortOrder> - <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/45/fieldDefinitions"> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/45/fieldDefinitions/193"> - <id>193</id> - <identifier>title</identifier> + </ContentTypeUpdate> + required: false + /content/types/{contentTypeId}/draft/fieldDefinitions: + get: + operationId: ibexa.rest.load_content_type_draft_field_definition_list + 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: contentTypeId + in: path + description: ContentTypeDraftFieldDefinitionListController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + post: + operationId: ibexa.rest.add_content_type_draft_field_definition + 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: ~ + alternativeText: ~ + source: ~ + isSearchable: false + names: + value: + - _languageCode: eng-GB + '#text': Image + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + validatorConfiguration: [] + application/vnd.ibexa.api.FieldDefinition+xml: + schema: + $ref: '#/components/schemas/FieldDefinition' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/14/draft/fieldDefinitions/221"> + <id>221</id> + <identifier>name2</identifier> <fieldType>ibexa_string</fieldType> - <fieldGroup>content</fieldGroup> - <position>1</position> + <fieldGroup></fieldGroup> + <position>0</position> <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> + <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Title</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> + <names/> + <descriptions/> <fieldSettings/> <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength"/> - <value key="minStringLength"/> - </value> + <value key="StringLengthValidator"> + <value key="maxStringLength">32</value> + <value key="minStringLength">8</value> + </value> </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/45/fieldDefinitions/194"> - <id>194</id> - <identifier>body</identifier> - <fieldType>ibexa_text</fieldType> - <fieldGroup>content</fieldGroup> - <position>2</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Body</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <fieldSettings> - <value key="textRows">10</value> - </fieldSettings> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/45/fieldDefinitions/204"> - <id>204</id> - <identifier>richtext</identifier> - <fieldType>ibexa_richtext</fieldType> + </FieldDefinition> + 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: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: contentTypeId + in: path + description: ContentTypeDraftFieldDefinitionAddController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + requestBody: + description: The Field Definition Create schema encoded in XML or JSON format. + 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"?> + <FieldDefinitionCreate> + <identifier>name</identifier> + <fieldType>ibexa_string</fieldType> + <isRequired>true</isRequired> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">32</value> + <value key="minStringLength">8</value> + </value> + </validatorConfiguration> + </FieldDefinitionCreate> + required: false + /content/types/{contentTypeId}/draft/fieldDefinitions/{fieldDefinitionId}: + get: + operationId: ibexa.rest.load_content_type_draft_field_definition + 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: ~ + alternativeText: ~ + source: ~ + isSearchable: false + names: + value: + - _languageCode: eng-GB + '#text': Image + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + validatorConfiguration: [] + application/vnd.ibexa.api.FieldDefinition+xml: + schema: + $ref: '#/components/schemas/FieldDefinition' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/195"> + <id>195</id> + <identifier>image</identifier> + <fieldType>ibexa_image_asset</fieldType> <fieldGroup>content</fieldGroup> - <position>3</position> - <isTranslatable>true</isTranslatable> + <position>7</position> + <isTranslatable>false</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - </value> + <value key="destinationContentId"/> + <value key="alternativeText"/> + <value key="source"/> </defaultValue> - <isSearchable>true</isSearchable> + <isSearchable>false</isSearchable> <names> - <value languageCode="eng-GB">richtext</value> + <value languageCode="eng-GB">Image</value> </names> <descriptions> - <value languageCode="eng-GB"></value> + <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration/> - </FieldDefinition> - </FieldDefinitions> - </ContentType> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/42"> - <id>42</id> - <status>DEFINED</status> - <identifier>landing_page</identifier> - <names> - <value languageCode="eng-GB">Landing page</value> - </names> - <descriptions> - <value languageCode="eng-GB"></value> - </descriptions> - <creationDate>2015-07-03T12:00:26+00:00</creationDate> - <modificationDate>2015-07-03T12:00:26+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/42/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/42/draft"/> - <remoteId>60c03e9758465eb69d56b3afb6adf18e</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><name></nameSchema> - <isContainer>true</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>true</defaultAlwaysAvailable> - <defaultSortField>PUBLISHED</defaultSortField> - <defaultSortOrder>DESC</defaultSortOrder> - <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions"> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/185"> - <id>185</id> - <identifier>name</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup>content</fieldGroup> + </FieldDefinition> + 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: contentTypeId + in: path + description: ContentTypeDraftFieldDefinitionLoadByIdController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: fieldDefinitionId + in: path + description: ContentTypeDraftFieldDefinitionLoadByIdController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + delete: + operationId: ibexa.rest.remove_content_type_draft_field_definition + 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: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: contentTypeId + in: path + description: ContentTypeDraftFieldDefinitionDeleteController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: fieldDefinitionId + in: path + description: ContentTypeDraftFieldDefinitionDeleteController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + patch: + operationId: ibexa.rest.update_content_type_draft_field_definition + 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: ~ + alternativeText: ~ + source: ~ + isSearchable: false + names: + value: + - _languageCode: eng-GB + '#text': Image + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + validatorConfiguration: [] + application/vnd.ibexa.api.FieldDefinition+xml: + schema: + $ref: '#/components/schemas/FieldDefinition' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/15/draft/fieldDefinitions/197"> + <id>197</id> + <identifier>author</identifier> + <fieldType>ibexa_author</fieldType> + <fieldGroup>new_field_group</fieldGroup> <position>10</position> <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Title</value> - </names> - <descriptions> - <value languageCode="eng-GB">Title</value> - </descriptions> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength"/> - <value key="minStringLength"/> - </value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/186"> - <id>186</id> - <identifier>description</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup>content</fieldGroup> - <position>20</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> + <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> - <isSearchable>true</isSearchable> + <isSearchable>false</isSearchable> <names> - <value languageCode="eng-GB">Description</value> + <value languageCode="eng-GB">Author</value> </names> - <descriptions> - <value languageCode="eng-GB">Landing page description</value> - </descriptions> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength"/> - <value key="minStringLength"/> - </value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/187"> - <id>187</id> - <identifier>page</identifier> - <fieldType>ibexa_landing_page</fieldType> + <descriptions/> + <fieldSettings> + <value key="defaultAuthor">1</value> + </fieldSettings> + <validatorConfiguration/> + </FieldDefinition> + 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: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: contentTypeId + in: path + description: ContentTypeDraftFieldDefinitionUpdateController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: fieldDefinitionId + in: path + description: ContentTypeDraftFieldDefinitionUpdateController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + requestBody: + description: The Field definition update schema encoded in XML or JSON format. + 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"?> + <FieldDefinitionUpdate> + <fieldGroup>new_field_group</fieldGroup> + <position>10</position> + </FieldDefinitionUpdate> + required: false + /content/types/{contentTypeId}/fieldDefinitions: + get: + operationId: ibexa.rest.load_content_type_field_definition_list + 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: contentTypeId + in: path + description: ContentTypeFieldDefinitionListController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + /content/types/{contentTypeId}/fieldDefinitions/{fieldDefinitionId}: + get: + operationId: ibexa.rest.load_content_type_field_definition + 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: ~ + alternativeText: ~ + source: ~ + isSearchable: false + names: + value: + - _languageCode: eng-GB + '#text': Image + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + validatorConfiguration: [] + application/vnd.ibexa.api.FieldDefinition+xml: + schema: + $ref: '#/components/schemas/FieldDefinition' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/195"> + <id>195</id> + <identifier>image</identifier> + <fieldType>ibexa_image_asset</fieldType> <fieldGroup>content</fieldGroup> - <position>30</position> - <isTranslatable>true</isTranslatable> + <position>7</position> + <isTranslatable>false</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> - <value key="layout">default</value> - <value key="zones"> - <value> - <value key="id">default_id</value> - <value key="name">default</value> - <value key="blocks"/> - </value> - </value> + <value key="destinationContentId"/> + <value key="alternativeText"/> + <value key="source"/> </defaultValue> <isSearchable>false</isSearchable> <names> - <value languageCode="eng-GB">Landing page</value> + <value languageCode="eng-GB">Image</value> </names> <descriptions> - <value languageCode="eng-GB">Landing page</value> + <value languageCode="eng-GB"></value> </descriptions> - <fieldSettings> - <value key="availableBlocks"/> - <value key="availableLayouts"/> - <value key="editorMode">page_view_mode</value> - </fieldSettings> + <fieldSettings/> <validatorConfiguration/> - </FieldDefinition> - </FieldDefinitions> - </ContentType> - </ContentTypeList> + </FieldDefinition> 401: - description: Error - The user is not authorized to read this content type - group. + description: Error - The user is not authorized to read the content type. 404: - description: Error - The content type group does not exist. - summary: Get content type group - description: Returns the content type group with provided ID. + description: Error - The content type does not exist. + summary: Get Field definition + description: Returns the Field definition by the given ID. parameters: - - name: If-None-Match - in: header - description: ETag - required: false + - name: contentTypeId + in: path + description: ContentTypeFieldDefinitionLoadByIdController identifier + required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: contentTypeGroupId + - name: fieldDefinitionId in: path - description: "" + description: ContentTypeFieldDefinitionLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - delete: - operationId: ibexa.rest.delete_content_type_group + /content/types/{contentTypeId}/groups: + get: + operationId: ibexa.rest.load_groups_of_content_type tags: - - Type Groups + - Type responses: - 204: - description: No Content - content type group deleted. + 200: + description: If set, the content type group list is returned in XML or JSON + format. + 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 + application/vnd.ibexa.api.ContentTypeGroupRefList+xml: + schema: + $ref: '#/components/schemas/ContentTypeGroupRefList' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <ContentTypeGroupRefList media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/typegroups/2/types"> + <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/1"/> + </ContentTypeGroupRefList> 401: - description: Error - The user is not authorized to delete this content type - group. - 403: - description: Error - The content type group is not empty. + description: Error - The user is not authorized to read this content type. 404: - description: Error - The content type group does not exist. - summary: Delete content type group - description: Deletes the provided content type group. + 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: contentTypeId + in: path + description: ContentTypeGroupListController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + post: + operationId: ibexa.rest.link_content_type_to_group + tags: + - Type + responses: + 200: + description: If set, the updated content type group list is returned in + XML or JSON format. + 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"?> + <ContentTypeGroupRefList media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/typegroups/15/types"> + <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/1"> + <unlink href="/api/ibexa/v2/content/types/15/groups/1" method="DELETE"/> + </ContentTypeGroupRef> + <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/3"> + <unlink href="/api/ibexa/v2/content/types/15/groups/3" method="DELETE"/> + </ContentTypeGroupRef> + <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/2"> + <unlink href="/api/ibexa/v2/content/types/15/groups/2" method="DELETE"/> + </ContentTypeGroupRef> + </ContentTypeGroupRefList> + 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: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: contentTypeGroupId + - name: contentTypeId in: path - description: "" + description: ContentTypeLinkToGroupController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - patch: - operationId: ibexa.rest.update_content_type_group + - name: group + in: query + description: 'Destination content type group URI; for example with content + type group 4: `?group=/api/ibexa/v2/content/typegroups/4`' + required: true + deprecated: false + schema: + type: string + style: form + explode: false + requestBody: + description: No payload required + content: [] + required: false + /content/types/{contentTypeId}/groups/{id}: + delete: + operationId: ibexa.rest.unlink_content_type_from_group tags: - - Type Groups + - Type responses: 200: - description: Content type group updated. + description: If set, the updated content type group list is returned in + XML or JSON format. content: - application/vnd.ibexa.api.ContentTypeGroup+json: + application/vnd.ibexa.api.ContentTypeGroupRefList+json: schema: - $ref: '#/components/schemas/ContentTypeGroupWrapper' + $ref: '#/components/schemas/ContentTypeGroupRefListWrapper' 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: + 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/ContentTypeGroup' + $ref: '#/components/schemas/ContentTypeGroupRefList' example: | <?xml version="1.0" encoding="UTF-8"?> - <ContentTypeGroup media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/1"> - <id>4</id> - <identifier>updatedIdentifer</identifier> - <created>2002-09-05T11:08:48+02:00</created> - <modified>2019-02-22T14:42:55+01:00</modified> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <ContentTypes media-type="application/vnd.ibexa.api.ContentTypeInfoList+xml" href="/api/ibexa/v2/content/typegroups/1/types"/> - </ContentTypeGroup> - 400: - description: Error - The input does not match the input schema definition. + <ContentTypeGroupRefList media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/typegroups/15/types"> + <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/1"> + <unlink href="/api/ibexa/v2/content/types/15/groups/1" method="DELETE"/> + </ContentTypeGroupRef> + <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/2"> + <unlink href="/api/ibexa/v2/content/types/15/groups/2" method="DELETE"/> + </ContentTypeGroupRef> + </ContentTypeGroupRefList> 401: - description: Error - The user is not authorized to create this content type - group. + description: Error - The user is not authorized to delete this content type. 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. + 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: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. 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. + - name: contentTypeId + in: path + description: ContentTypeUnlinkFromGroupController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: contentTypeGroupId + - name: id in: path - description: "" + description: ContentTypeUnlinkFromGroupController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - requestBody: - description: The content type group input schema encoded in XML or JSON format. - content: - application/vnd.ibexa.api.ContentTypeGroupInput+json: - schema: - $ref: '#/components/schemas/ContentTypeGroupInputWrapper' - example: - ContentTypeGroupInput: - identifier: updatedIdentifer - application/vnd.ibexa.api.ContentTypeGroupInput+xml: - schema: - $ref: '#/components/schemas/ContentTypeGroupInput' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <ContentTypeGroupInput> - <identifier>updatedIdentifer</identifier> - </ContentTypeGroupInput> - required: false - deprecated: false - /content/typegroups/{contentTypeGroupId}/types: + /content/typegroups: get: - operationId: ibexa.rest.list_content_types_for_group + operationId: ibexa.rest.load_content_type_group_list tags: - Type Groups responses: 200: - description: OK - returns a list on content types. + description: OK - returns a list of content type groups. content: - application/vnd.ibexa.api.ContentTypeInfoList+json: + application/vnd.ibexa.api.ContentTypeGroupList+json: schema: - $ref: '#/components/schemas/ContentTypeInfoListWrapper' + $ref: '#/components/schemas/ContentTypeGroupListWrapper' example: - ContentTypeList: - _media-type: application/vnd.ibexa.api.ContentTypeList+json - _href: /api/ibexa/v2/content/types - ContentType: - - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/2 - id: 2 - status: DEFINED - identifier: article - names: - value: - - _languageCode: eng-GB - '#text': Article - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - 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': ~ - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: 255 - minStringLength: ~ - - _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: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Short title - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: 255 - minStringLength: ~ - - _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': ~ - 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"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Intro - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - 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"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Body - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - 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': ~ - 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: ~ - alternativeText: ~ - source: ~ - isSearchable: false - names: - value: - - _languageCode: eng-GB - '#text': Image - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: [] - - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/50 - id: 50 - status: DEFINED - identifier: copy_of_article_50 - names: - value: - - _languageCode: eng-GB - '#text': Article - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - creationDate: "2021-07-14T10:30:00+00:00" - modificationDate: "2021-07-14T10:30:00+00:00" + 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 - Groups: - _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json - _href: /api/ibexa/v2/content/types/50/groups - Draft: - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/50/draft - remoteId: fc9434492469d136ffe13377bfdcbb28 - 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/50/fieldDefinitions - FieldDefinition: - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/50/fieldDefinitions/197 - id: 197 - 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': ~ - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: 255 - minStringLength: ~ - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/50/fieldDefinitions/198 - id: 198 - identifier: short_title - fieldType: ibexa_string - fieldGroup: "" - position: 2 - isTranslatable: true - isRequired: false - isInfoCollector: false - defaultValue: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Short title - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: 255 - minStringLength: ~ - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/50/fieldDefinitions/199 - id: 199 - 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': ~ - fieldSettings: - defaultAuthor: 1 - validatorConfiguration: [] - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/50/fieldDefinitions/200 - id: 200 - identifier: intro - fieldType: ibexa_richtext - fieldGroup: "" - position: 4 - isTranslatable: true - isRequired: true - isInfoCollector: false - defaultValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Intro - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: [] - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/50/fieldDefinitions/201 - id: 201 - identifier: body - fieldType: ibexa_richtext - fieldGroup: "" - position: 5 - isTranslatable: true - isRequired: false - isInfoCollector: false - defaultValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Body - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: [] - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/50/fieldDefinitions/202 - id: 202 - 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': ~ - fieldSettings: [] - validatorConfiguration: [] - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/50/fieldDefinitions/203 - id: 203 - identifier: image - fieldType: ibexa_image_asset - fieldGroup: content - position: 7 - isTranslatable: false - isRequired: false - isInfoCollector: false - defaultValue: - destinationContentId: ~ - alternativeText: ~ - source: ~ - isSearchable: false - names: - value: - - _languageCode: eng-GB - '#text': Image - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: [] - - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/44 - id: 44 - status: DEFINED - identifier: dog_breed - names: - value: - - _languageCode: eng-GB - '#text': Dog Breed - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - creationDate: "2021-06-28T11:28:00+00:00" - modificationDate: "2021-06-28T11:29:02+00:00" + 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 - Groups: - _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json - _href: /api/ibexa/v2/content/types/44/groups - Draft: - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/44/draft - remoteId: b348c95f7c573d4d502d6b59f80e618a - urlAliasSchema: "" - nameSchema: <name> - 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/44/fieldDefinitions - FieldDefinition: - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/44/fieldDefinitions/190 - id: 190 - identifier: name - fieldType: ibexa_string - fieldGroup: content - position: 1 - isTranslatable: true - isRequired: false - isInfoCollector: false - defaultValue: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Name - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: ~ - minStringLength: ~ - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/44/fieldDefinitions/191 - id: 191 - identifier: photo - fieldType: ibexa_image_asset - fieldGroup: content - position: 2 - isTranslatable: true - isRequired: false - isInfoCollector: false - defaultValue: - destinationContentId: ~ - alternativeText: ~ - source: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Photo - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - validatorConfiguration: [] - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/44/fieldDefinitions/192 - id: 192 - identifier: description - fieldType: ibexa_richtext - fieldGroup: content - position: 3 - isTranslatable: true - isRequired: false - isInfoCollector: false - defaultValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Full Description - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - fieldSettings: [] - 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" + 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 - 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: ~ - 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: ~ - - _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: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Short name - descriptions: - value: [] - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: 100 - minStringLength: ~ - - _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"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - 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"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Description - descriptions: - value: [] - fieldSettings: [] - validatorConfiguration: [] + 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"?> + <ContentTypeGroupList media-type="application/vnd.ibexa.api.ContentTypeGroupList+xml" href="/api/ibexa/v2/content/typegroups"> + <ContentTypeGroup media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/1"> + <id>1</id> + <identifier>Content</identifier> + <created>2002-09-05T11:08:48+02:00</created> + <modified>2002-10-06T18:35:06+02:00</modified> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <ContentTypes media-type="application/vnd.ibexa.api.ContentTypeInfoList+xml" href="/api/ibexa/v2/content/typegroups/1/types"/> + </ContentTypeGroup> + <ContentTypeGroup media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/2"> + <id>2</id> + <identifier>Users</identifier> + <created>2002-09-05T11:09:01+02:00</created> + <modified>2002-10-06T18:35:13+02:00</modified> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <ContentTypes media-type="application/vnd.ibexa.api.ContentTypeInfoList+xml" href="/api/ibexa/v2/content/typegroups/2/types"/> + </ContentTypeGroup> + <ContentTypeGroup media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/3"> + <id>3</id> + <identifier>Media</identifier> + <created>2002-09-14T15:22:23+02:00</created> + <modified>2002-10-06T18:35:20+02:00</modified> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <ContentTypes media-type="application/vnd.ibexa.api.ContentTypeInfoList+xml" href="/api/ibexa/v2/content/typegroups/3/types"/> + </ContentTypeGroup> + </ContentTypeGroupList> + 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: [] + post: + operationId: ibexa.rest.create_content_type_group + 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/6 + id: 6 + identifier: newContentTypeGroup + created: "2021-08-11T09:44:18+00:00" + modified: "2021-08-11T09:44:18+00:00" + Creator: + _media-type: application/vnd.ibexa.api.User+json + _href: /api/ibexa/v2/user/users/14 + Modifier: + _media-type: application/vnd.ibexa.api.User+json + _href: /api/ibexa/v2/user/users/14 + ContentTypes: + _media-type: application/vnd.ibexa.api.ContentTypeInfoList+json + _href: /api/ibexa/v2/content/typegroups/6/types + application/vnd.ibexa.api.ContentTypeGroup+xml: + schema: + $ref: '#/components/schemas/ContentTypeGroup' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <ContentTypeGroup href="/content/typesgroups/7" media-type="application/vnd.ibexa.api.ContentTypeGroup+xml"> + <id>7</id> + <identifier>newContentTypeGroup</identifier> + <created>2012-02-31T12:45:00</created> + <modified>2012-02-31T12:45:00</modified> + <Creator href="/user/users/13" media-type="application/vnd.ibexa.api.User+xml"/> + <Modifier href="/user/users/13" media-type="application/vnd.ibexa.api.User+xml"/> + <ContentTypes href="/content/typegroups/7/types" media-type="application/vnd.ibexa.api.ContentTypeList+xml"/> + </ContentTypeGroup> + 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: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + requestBody: + description: The content type group input schema encoded in XML or JSON. + 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"?> + <ContentTypeGroupInput> + <identifier>newContentTypeGroup</identifier> + </ContentTypeGroupInput> + required: false + /content/typegroups/{contentTypeGroupId}: + get: + operationId: ibexa.rest.load_content_type_group + 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/43 - id: 43 + _href: /api/ibexa/v2/content/types/2 + id: 2 status: DEFINED - identifier: form + identifier: article names: value: - _languageCode: eng-GB - '#text': Form + '#text': Article descriptions: - value: [] - creationDate: "2018-09-17T06:46:13+00:00" - modificationDate: "2018-09-17T06:47:14+00:00" + value: + - _languageCode: eng-GB + '#text': ~ + 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 @@ -32537,115 +18580,54 @@ paths: _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json - _href: /api/ibexa/v2/content/types/43/groups + _href: /api/ibexa/v2/content/types/2/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/43/draft - remoteId: 6f7f21df775a33c1e4bbc76b48c38476 + _href: /api/ibexa/v2/content/types/2/draft + remoteId: c15b600eb9198b1924063b5a68758232 urlAliasSchema: "" - nameSchema: <title> - isContainer: false + nameSchema: <short_title|title> + isContainer: true mainLanguageCode: eng-GB - defaultAlwaysAvailable: true - defaultSortField: PUBLISHED - defaultSortOrder: DESC + defaultAlwaysAvailable: false + defaultSortField: PATH + defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json - _href: /api/ibexa/v2/content/types/43/fieldDefinitions + _href: /api/ibexa/v2/content/types/2/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/43/fieldDefinitions/188 - id: 188 + _href: /api/ibexa/v2/content/types/2/fieldDefinitions/1 + id: 1 identifier: title fieldType: ibexa_string - fieldGroup: content + fieldGroup: "" position: 1 isTranslatable: true isRequired: true isInfoCollector: false - defaultValue: ~ + defaultValue: New article isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: - value: [] + value: + - _languageCode: eng-GB + '#text': ~ fieldSettings: [] validatorConfiguration: StringLengthValidator: - maxStringLength: ~ + maxStringLength: 255 minStringLength: ~ - _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: ~ - content_field_id: ~ - language_code: ~ - 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/45 - id: 45 - status: DEFINED - identifier: tip - names: - value: - - _languageCode: eng-GB - '#text': Tip - descriptions: - value: - - _languageCode: eng-GB - '#text': ~ - creationDate: "2021-06-28T11:29:19+00:00" - modificationDate: "2021-07-26T09:33: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 - Groups: - _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json - _href: /api/ibexa/v2/content/types/45/groups - Draft: - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/45/draft - remoteId: e6490e8a785edacd48629f2022be3125 - 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/45/fieldDefinitions - FieldDefinition: - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/45/fieldDefinitions/193 - id: 193 - identifier: title + _href: /api/ibexa/v2/content/types/2/fieldDefinitions/152 + id: 152 + identifier: short_title fieldType: ibexa_string - fieldGroup: content - position: 1 + fieldGroup: "" + position: 2 isTranslatable: true isRequired: false isInfoCollector: false @@ -32654,7 +18636,7 @@ paths: names: value: - _languageCode: eng-GB - '#text': Title + '#text': Short title descriptions: value: - _languageCode: eng-GB @@ -32662,40 +18644,40 @@ paths: fieldSettings: [] validatorConfiguration: StringLengthValidator: - maxStringLength: ~ + maxStringLength: 255 minStringLength: ~ - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/45/fieldDefinitions/194 - id: 194 - identifier: body - fieldType: ibexa_text - fieldGroup: content - position: 2 + _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: true + defaultValue: [] + isSearchable: false names: value: - _languageCode: eng-GB - '#text': Body + '#text': Author descriptions: value: - _languageCode: eng-GB '#text': ~ fieldSettings: - textRows: 10 + defaultAuthor: 1 validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/45/fieldDefinitions/204 - id: 204 - identifier: richtext + _href: /api/ibexa/v2/content/types/2/fieldDefinitions/120 + id: 120 + identifier: intro fieldType: ibexa_richtext - fieldGroup: content - position: 3 + fieldGroup: "" + position: 4 isTranslatable: true - isRequired: false + isRequired: true isInfoCollector: false defaultValue: xml: | @@ -32708,302 +18690,103 @@ paths: names: value: - _languageCode: eng-GB - '#text': richtext + '#text': Intro descriptions: value: - _languageCode: eng-GB '#text': ~ 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: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Title - descriptions: - value: - - _languageCode: eng-GB - '#text': Title - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: ~ - minStringLength: ~ - - _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: ~ - isSearchable: true - names: - value: - - _languageCode: eng-GB - '#text': Description - descriptions: - value: - - _languageCode: eng-GB - '#text': Landing page description - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: ~ - minStringLength: ~ - _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 + _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: - 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: ~ - availableLayouts: ~ - editorMode: page_view_mode - validatorConfiguration: [] - - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/4 - id: 4 - status: DEFINED - identifier: user - names: - value: - - _languageCode: eng-GB - '#text': User - descriptions: - value: [] - creationDate: "2002-06-18T09:21:38+00:00" - modificationDate: "2004-04-15T08:39: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/4/groups - Draft: - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/4/draft - remoteId: 40faa822edc579b02c25f6bb7beec3ad - urlAliasSchema: ~ - nameSchema: <first_name> <last_name> - isContainer: false - mainLanguageCode: eng-GB - defaultAlwaysAvailable: true - defaultSortField: PATH - defaultSortOrder: ASC - FieldDefinitions: - _media-type: application/vnd.ibexa.api.FieldDefinitionList+json - _href: /api/ibexa/v2/content/types/4/fieldDefinitions - FieldDefinition: - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/4/fieldDefinitions/8 - id: 8 - identifier: first_name - fieldType: ibexa_string - fieldGroup: "" - position: 1 - isTranslatable: true - isRequired: true - isInfoCollector: false - defaultValue: ~ + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB - '#text': First name + '#text': Body descriptions: - value: [] - fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: 255 - minStringLength: ~ - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/4/fieldDefinitions/9 - id: 9 - identifier: last_name - fieldType: ibexa_string - fieldGroup: "" - position: 2 - isTranslatable: true - isRequired: true - isInfoCollector: false - defaultValue: ~ - isSearchable: true - names: value: - _languageCode: eng-GB - '#text': Last name - descriptions: - value: [] + '#text': ~ fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: 255 - minStringLength: ~ + validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/4/fieldDefinitions/12 - id: 12 - identifier: user_account - fieldType: ibexa_user + _href: /api/ibexa/v2/content/types/2/fieldDefinitions/123 + id: 123 + identifier: enable_comments + fieldType: ibexa_boolean fieldGroup: "" - position: 3 + position: 6 isTranslatable: false - isRequired: true + isRequired: false isInfoCollector: false - defaultValue: ~ + defaultValue: false isSearchable: false names: value: - _languageCode: eng-GB - '#text': User account + '#text': Enable comments descriptions: - value: [] - fieldSettings: - PasswordTTL: 0 - PasswordTTLWarning: 0 - RequireUniqueEmail: false - UsernamePattern: ^[^@]+$ - validatorConfiguration: - PasswordValueValidator: - requireAtLeastOneUpperCaseCharacter: true - requireAtLeastOneLowerCaseCharacter: true - requireAtLeastOneNumericCharacter: true - requireAtLeastOneNonAlphanumericCharacter: false - requireNewPassword: false - minLength: 10 - - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/4/fieldDefinitions/179 - id: 179 - identifier: signature - fieldType: ibexa_text - fieldGroup: "" - position: 4 - isTranslatable: true - isRequired: false - isInfoCollector: false - defaultValue: ~ - isSearchable: true - names: value: - _languageCode: eng-GB - '#text': Signature - descriptions: - value: [] - fieldSettings: - textRows: 10 + '#text': ~ + fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/4/fieldDefinitions/180 - id: 180 - identifier: image - fieldType: ibexa_image - fieldGroup: "" - position: 5 - isTranslatable: true + _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: ~ + defaultValue: + destinationContentId: ~ + alternativeText: ~ + source: ~ isSearchable: false names: value: - _languageCode: eng-GB '#text': Image descriptions: - value: [] + value: + - _languageCode: eng-GB + '#text': ~ fieldSettings: [] - validatorConfiguration: - FileSizeValidator: - maxFileSize: 10 + validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/3 - id: 3 + _href: /api/ibexa/v2/content/types/50 + id: 50 status: DEFINED - identifier: user_group + identifier: copy_of_article_50 names: value: - _languageCode: eng-GB - '#text': User group + '#text': Article descriptions: - value: [] - creationDate: "2002-06-18T09:21:38+00:00" - modificationDate: "2003-03-24T08:32:23+00:00" + value: + - _languageCode: eng-GB + '#text': ~ + creationDate: "2021-07-14T10:30:00+00:00" + modificationDate: "2021-07-14T10:30:00+00:00" Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 @@ -33012,49 +18795,51 @@ paths: _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json - _href: /api/ibexa/v2/content/types/3/groups + _href: /api/ibexa/v2/content/types/50/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/3/draft - remoteId: 25b4268cdcd01921b808a0d854b877ef - urlAliasSchema: ~ - nameSchema: <name> + _href: /api/ibexa/v2/content/types/50/draft + remoteId: fc9434492469d136ffe13377bfdcbb28 + urlAliasSchema: "" + nameSchema: <short_title|title> isContainer: true mainLanguageCode: eng-GB - defaultAlwaysAvailable: true + defaultAlwaysAvailable: false defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json - _href: /api/ibexa/v2/content/types/3/fieldDefinitions + _href: /api/ibexa/v2/content/types/50/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/3/fieldDefinitions/6 - id: 6 - identifier: name + _href: /api/ibexa/v2/content/types/50/fieldDefinitions/197 + id: 197 + identifier: title fieldType: ibexa_string fieldGroup: "" position: 1 isTranslatable: true isRequired: true isInfoCollector: false - defaultValue: ~ + defaultValue: New article isSearchable: true names: value: - _languageCode: eng-GB - '#text': Name + '#text': Title descriptions: - value: [] + value: + - _languageCode: eng-GB + '#text': ~ fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: ~ - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/3/fieldDefinitions/7 - id: 7 - identifier: description + _href: /api/ibexa/v2/content/types/50/fieldDefinitions/198 + id: 198 + identifier: short_title fieldType: ibexa_string fieldGroup: "" position: 2 @@ -33066,81 +18851,74 @@ paths: names: value: - _languageCode: eng-GB - '#text': Description + '#text': Short title descriptions: - value: [] + value: + - _languageCode: eng-GB + '#text': ~ fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: ~ - - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/12 - id: 12 - status: DEFINED - identifier: file - names: - value: - - _languageCode: eng-GB - '#text': File - descriptions: - value: [] - creationDate: "2003-05-08T09:17:52+00:00" - modificationDate: "2003-05-08T09:21:09+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/12/groups - Draft: - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/12/draft - remoteId: 637d58bfddf164627bdfd265733280a0 - urlAliasSchema: ~ - nameSchema: <name> - isContainer: false - mainLanguageCode: eng-GB - defaultAlwaysAvailable: true - defaultSortField: PATH - defaultSortOrder: ASC - FieldDefinitions: - _media-type: application/vnd.ibexa.api.FieldDefinitionList+json - _href: /api/ibexa/v2/content/types/12/fieldDefinitions - FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/12/fieldDefinitions/146 - id: 146 - identifier: name - fieldType: ibexa_string + _href: /api/ibexa/v2/content/types/50/fieldDefinitions/199 + id: 199 + identifier: author + fieldType: ibexa_author fieldGroup: "" - position: 1 + position: 3 + isTranslatable: true + isRequired: false + isInfoCollector: false + defaultValue: [] + isSearchable: false + names: + value: + - _languageCode: eng-GB + '#text': Author + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: + defaultAuthor: 1 + validatorConfiguration: [] + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/50/fieldDefinitions/200 + id: 200 + identifier: intro + fieldType: ibexa_richtext + fieldGroup: "" + position: 4 isTranslatable: true isRequired: true isInfoCollector: false - defaultValue: New file + defaultValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB - '#text': Name + '#text': Intro descriptions: - value: [] + value: + - _languageCode: eng-GB + '#text': ~ fieldSettings: [] - validatorConfiguration: - StringLengthValidator: - maxStringLength: ~ - minStringLength: ~ + validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/12/fieldDefinitions/147 - id: 147 - identifier: description + _href: /api/ibexa/v2/content/types/50/fieldDefinitions/201 + id: 201 + identifier: body fieldType: ibexa_richtext fieldGroup: "" - position: 2 + position: 5 isTranslatable: true isRequired: false isInfoCollector: false @@ -33155,46 +18933,75 @@ paths: names: value: - _languageCode: eng-GB - '#text': Description + '#text': Body descriptions: - value: [] + value: + - _languageCode: eng-GB + '#text': ~ fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/12/fieldDefinitions/148 - id: 148 - identifier: file - fieldType: ibexa_author + _href: /api/ibexa/v2/content/types/50/fieldDefinitions/202 + id: 202 + identifier: enable_comments + fieldType: ibexa_boolean fieldGroup: "" - position: 3 - isTranslatable: true - isRequired: true + position: 6 + isTranslatable: false + isRequired: false isInfoCollector: false - defaultValue: ~ + defaultValue: false isSearchable: false names: value: - _languageCode: eng-GB - '#text': File + '#text': Enable comments descriptions: - value: [] + value: + - _languageCode: eng-GB + '#text': ~ fieldSettings: [] - validatorConfiguration: - FileSizeValidator: - maxFileSize: ~ + validatorConfiguration: [] + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/50/fieldDefinitions/203 + id: 203 + identifier: image + fieldType: ibexa_image_asset + fieldGroup: content + position: 7 + isTranslatable: false + isRequired: false + isInfoCollector: false + defaultValue: + destinationContentId: ~ + alternativeText: ~ + source: ~ + isSearchable: false + names: + value: + - _languageCode: eng-GB + '#text': Image + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/5 - id: 5 + _href: /api/ibexa/v2/content/types/44 + id: 44 status: DEFINED - identifier: image + identifier: dog_breed names: value: - _languageCode: eng-GB - '#text': Image + '#text': Dog Breed descriptions: - value: [] - creationDate: "2002-09-08T11:36:32+00:00" - modificationDate: "2003-03-24T08:33:04+00:00" + value: + - _languageCode: eng-GB + '#text': ~ + creationDate: "2021-06-28T11:28:00+00:00" + modificationDate: "2021-06-28T11:29:02+00:00" Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 @@ -33203,31 +19010,31 @@ paths: _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json - _href: /api/ibexa/v2/content/types/5/groups + _href: /api/ibexa/v2/content/types/44/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/5/draft - remoteId: f6df12aa74e36230eb675f364fccd25a - urlAliasSchema: ~ + _href: /api/ibexa/v2/content/types/44/draft + remoteId: b348c95f7c573d4d502d6b59f80e618a + urlAliasSchema: "" nameSchema: <name> isContainer: false mainLanguageCode: eng-GB defaultAlwaysAvailable: true - defaultSortField: PATH - defaultSortOrder: ASC + defaultSortField: PUBLISHED + defaultSortOrder: DESC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json - _href: /api/ibexa/v2/content/types/5/fieldDefinitions + _href: /api/ibexa/v2/content/types/44/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/5/fieldDefinitions/116 - id: 116 + _href: /api/ibexa/v2/content/types/44/fieldDefinitions/190 + id: 190 identifier: name fieldType: ibexa_string - fieldGroup: "" + fieldGroup: content position: 1 isTranslatable: true - isRequired: true + isRequired: false isInfoCollector: false defaultValue: ~ isSearchable: true @@ -33236,134 +19043,80 @@ paths: - _languageCode: eng-GB '#text': Name descriptions: - value: [] + value: + - _languageCode: eng-GB + '#text': ~ fieldSettings: [] validatorConfiguration: StringLengthValidator: - maxStringLength: 150 + maxStringLength: ~ minStringLength: ~ - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/5/fieldDefinitions/117 - id: 117 - identifier: caption - fieldType: ibexa_richtext - fieldGroup: "" + _href: /api/ibexa/v2/content/types/44/fieldDefinitions/191 + id: 191 + identifier: photo + fieldType: ibexa_image_asset + fieldGroup: content position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + destinationContentId: ~ + alternativeText: ~ + source: ~ isSearchable: true names: value: - _languageCode: eng-GB - '#text': Caption + '#text': Photo descriptions: - value: [] + value: + - _languageCode: eng-GB + '#text': ~ fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/5/fieldDefinitions/118 - id: 118 - identifier: image - fieldType: ibexa_image - fieldGroup: "" + _href: /api/ibexa/v2/content/types/44/fieldDefinitions/192 + id: 192 + identifier: description + fieldType: ibexa_richtext + fieldGroup: content position: 3 isTranslatable: true isRequired: false isInfoCollector: false - defaultValue: ~ - isSearchable: false + defaultValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + isSearchable: true names: value: - _languageCode: eng-GB - '#text': Image + '#text': Full Description descriptions: - value: [] + value: + - _languageCode: eng-GB + '#text': ~ fieldSettings: [] - validatorConfiguration: - FileSizeValidator: - maxFileSize: 10 - application/vnd.ibexa.api.ContentTypeInfoList+xml: - schema: - $ref: '#/components/schemas/ContentTypeInfoList' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <ContentTypeInfoList media-type="application/vnd.ibexa.api.ContentTypeInfoList+xml" href="/api/ibexa/v2/content/typegroups/1/types"> - <ContentTypeInfo media-type="application/vnd.ibexa.api.ContentTypeInfo+xml" href="/api/ibexa/v2/content/types/2"> - <id>2</id> - <status>DEFINED</status> - <identifier>article</identifier> - <names> - <value languageCode="eng-GB">Article</value> - </names> - <descriptions/> - <creationDate>2002-06-18T11:21:38+02:00</creationDate> - <modificationDate>2004-04-20T11:56:29+02:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2/draft"/> - <remoteId>c15b600eb9198b1924063b5a68758232</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><short_title|title></nameSchema> - <isContainer>true</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>false</defaultAlwaysAvailable> - <defaultSortField>PATH</defaultSortField> - <defaultSortOrder>ASC</defaultSortOrder> - </ContentTypeInfo> - <ContentTypeInfo media-type="application/vnd.ibexa.api.ContentTypeInfo+xml" href="/api/ibexa/v2/content/types/1"> - <id>1</id> - <status>DEFINED</status> - <identifier>folder</identifier> - <names> - <value languageCode="eng-GB">Folder</value> - </names> - <descriptions/> - <creationDate>2002-06-18T11:21:38+02:00</creationDate> - <modificationDate>2015-11-29T22:14:32+01:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/1/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1/draft"/> - <remoteId>a3d405b81be900468eb153d774f4f0d2</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><short_name|name></nameSchema> - <isContainer>true</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>true</defaultAlwaysAvailable> - <defaultSortField>PATH</defaultSortField> - <defaultSortOrder>ASC</defaultSortOrder> - </ContentTypeInfo> - </ContentTypeInfoList> - 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: + validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/2 - id: 2 + _href: /api/ibexa/v2/content/types/1 + id: 1 status: DEFINED - identifier: article + identifier: folder names: value: - _languageCode: eng-GB - '#text': Article + '#text': Folder descriptions: value: [] creationDate: "2002-06-18T09:21:38+00:00" - modificationDate: "2004-04-20T09:56:29+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 @@ -33372,38 +19125,38 @@ paths: _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json - _href: /api/ibexa/v2/content/types/2/groups + _href: /api/ibexa/v2/content/types/1/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/2/draft - remoteId: c15b600eb9198b1924063b5a68758232 + _href: /api/ibexa/v2/content/types/1/draft + remoteId: a3d405b81be900468eb153d774f4f0d2 urlAliasSchema: ~ - nameSchema: <short_title|title> + nameSchema: <short_name|name> isContainer: true mainLanguageCode: eng-GB - defaultAlwaysAvailable: false + defaultAlwaysAvailable: true defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json - _href: /api/ibexa/v2/content/types/2/fieldDefinitions + _href: /api/ibexa/v2/content/types/1/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/2/fieldDefinitions/1 - id: 1 - identifier: title + _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: New article + defaultValue: Folder isSearchable: true names: value: - _languageCode: eng-GB - '#text': Title + '#text': Name descriptions: value: [] fieldSettings: [] @@ -33412,9 +19165,9 @@ paths: maxStringLength: 255 minStringLength: ~ - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/2/fieldDefinitions/152 - id: 152 - identifier: short_title + _href: /api/ibexa/v2/content/types/1/fieldDefinitions/155 + id: 155 + identifier: short_name fieldType: ibexa_string fieldGroup: "" position: 2 @@ -33426,144 +19179,81 @@ paths: names: value: - _languageCode: eng-GB - '#text': Short title + '#text': Short name descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: - maxStringLength: 255 + maxStringLength: 100 minStringLength: ~ - _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"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - 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 + _href: /api/ibexa/v2/content/types/1/fieldDefinitions/119 + id: 119 + identifier: short_description fieldType: ibexa_richtext fieldGroup: "" - position: 5 - isTranslatable: true - isRequired: false - isInfoCollector: false - defaultValue: - xml: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> - xhtml5edit: | - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - 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 + position: 3 + isTranslatable: true isRequired: false isInfoCollector: false - defaultValue: false - isSearchable: false + defaultValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + isSearchable: true names: value: - _languageCode: eng-GB - '#text': Enable comments + '#text': Short description 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 + _href: /api/ibexa/v2/content/types/1/fieldDefinitions/156 + id: 156 + identifier: description + fieldType: ibexa_richtext fieldGroup: "" - position: 7 + position: 4 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: - destinationContentId: ~ + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB - '#text': Image + '#text': Description descriptions: value: [] - fieldSettings: - selectionMethod: SELECTION_BROWSE - selectionRoot: "" - selectionContentTypes: [] + fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/1 - id: 1 + _href: /api/ibexa/v2/content/types/55 + id: 55 status: DEFINED - identifier: folder + identifier: folder_55 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" + value: + - _languageCode: eng-GB + '#text': ~ + creationDate: "2021-07-28T07:57:22+00:00" + modificationDate: "2021-07-28T07:57:34+00:00" Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 @@ -33572,12 +19262,12 @@ paths: _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json - _href: /api/ibexa/v2/content/types/1/groups + _href: /api/ibexa/v2/content/types/55/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/1/draft - remoteId: a3d405b81be900468eb153d774f4f0d2 - urlAliasSchema: ~ + _href: /api/ibexa/v2/content/types/55/draft + remoteId: 4eb7bc76f6d0bd1d5ded2d8936cc6afb + urlAliasSchema: "" nameSchema: <short_name|name> isContainer: true mainLanguageCode: eng-GB @@ -33586,11 +19276,11 @@ paths: defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json - _href: /api/ibexa/v2/content/types/1/fieldDefinitions + _href: /api/ibexa/v2/content/types/55/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/1/fieldDefinitions/4 - id: 4 + _href: /api/ibexa/v2/content/types/55/fieldDefinitions/210 + id: 210 identifier: name fieldType: ibexa_string fieldGroup: "" @@ -33605,15 +19295,17 @@ paths: - _languageCode: eng-GB '#text': Name descriptions: - value: [] + value: + - _languageCode: eng-GB + '#text': ~ fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: ~ - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/1/fieldDefinitions/155 - id: 155 + _href: /api/ibexa/v2/content/types/55/fieldDefinitions/211 + id: 211 identifier: short_name fieldType: ibexa_string fieldGroup: "" @@ -33628,15 +19320,17 @@ paths: - _languageCode: eng-GB '#text': Short name descriptions: - value: [] + value: + - _languageCode: eng-GB + '#text': ~ fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 100 minStringLength: ~ - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/1/fieldDefinitions/119 - id: 119 + _href: /api/ibexa/v2/content/types/55/fieldDefinitions/212 + id: 212 identifier: short_description fieldType: ibexa_richtext fieldGroup: "" @@ -33657,12 +19351,14 @@ paths: - _languageCode: eng-GB '#text': Short description descriptions: - value: [] + value: + - _languageCode: eng-GB + '#text': ~ fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json - _href: /api/ibexa/v2/content/types/1/fieldDefinitions/156 - id: 156 + _href: /api/ibexa/v2/content/types/55/fieldDefinitions/213 + id: 213 identifier: description fieldType: ibexa_richtext fieldGroup: "" @@ -33683,7 +19379,9 @@ paths: - _languageCode: eng-GB '#text': Description descriptions: - value: [] + value: + - _languageCode: eng-GB + '#text': ~ fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json @@ -33770,6 +19468,121 @@ paths: value: [] fieldSettings: [] validatorConfiguration: [] + - _media-type: application/vnd.ibexa.api.ContentType+json + _href: /api/ibexa/v2/content/types/45 + id: 45 + status: DEFINED + identifier: tip + names: + value: + - _languageCode: eng-GB + '#text': Tip + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + creationDate: "2021-06-28T11:29:19+00:00" + modificationDate: "2021-07-26T09:33: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 + Groups: + _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json + _href: /api/ibexa/v2/content/types/45/groups + Draft: + _media-type: application/vnd.ibexa.api.ContentType+json + _href: /api/ibexa/v2/content/types/45/draft + remoteId: e6490e8a785edacd48629f2022be3125 + 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/45/fieldDefinitions + FieldDefinition: + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/45/fieldDefinitions/193 + id: 193 + identifier: title + fieldType: ibexa_string + fieldGroup: content + position: 1 + isTranslatable: true + isRequired: false + isInfoCollector: false + defaultValue: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Title + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: ~ + minStringLength: ~ + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/45/fieldDefinitions/194 + id: 194 + identifier: body + fieldType: ibexa_text + fieldGroup: content + position: 2 + isTranslatable: true + isRequired: false + isInfoCollector: false + defaultValue: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Body + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: + textRows: 10 + validatorConfiguration: [] + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/45/fieldDefinitions/204 + id: 204 + identifier: richtext + fieldType: ibexa_richtext + fieldGroup: content + position: 3 + isTranslatable: true + isRequired: false + isInfoCollector: false + defaultValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': richtext + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/42 id: 42 @@ -33889,2771 +19702,4145 @@ paths: availableLayouts: ~ editorMode: page_view_mode validatorConfiguration: [] - application/vnd.ibexa.api.ContentTypeList+xml: + application/vnd.ibexa.api.ContentTypeGroup+xml: schema: $ref: '#/components/schemas/ContentTypeList' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentTypeList media-type="application/vnd.ibexa.api.ContentTypeList+xml" href="/api/ibexa/v2/content/typegroups/1/types"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"> - <id>2</id> - <status>DEFINED</status> - <identifier>article</identifier> - <names> - <value languageCode="eng-GB">Article</value> - </names> - <descriptions/> - <creationDate>2002-06-18T11:21:38+02:00</creationDate> - <modificationDate>2004-04-20T11:56:29+02:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2/draft"/> - <remoteId>c15b600eb9198b1924063b5a68758232</remoteId> - <urlAliasSchema></urlAliasSchema> - <nameSchema><short_title|title></nameSchema> - <isContainer>true</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>false</defaultAlwaysAvailable> - <defaultSortField>PATH</defaultSortField> - <defaultSortOrder>ASC</defaultSortOrder> - <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions"> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/1"> - <id>1</id> - <identifier>title</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>1</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue>New article</defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Title</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">255</value> - <value key="minStringLength"/></value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/152"> - <id>152</id> - <identifier>short_title</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup></fieldGroup> - <position>2</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Short title</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="maxStringLength">255</value> - <value key="minStringLength"/></value> - </validatorConfiguration> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/153"> - <id>153</id> - <identifier>author</identifier> - <fieldType>ibexa_author</fieldType> - <fieldGroup></fieldGroup> - <position>3</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue/> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Author</value> - </names> - <descriptions/> - <fieldSettings> - <value key="defaultAuthor">1</value> - </fieldSettings> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/120"> - <id>120</id> - <identifier>intro</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup></fieldGroup> - <position>4</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"> + <id>2</id> + <status>DEFINED</status> + <identifier>article</identifier> + <names> + <value languageCode="eng-GB">Article</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <creationDate>2002-06-18T09:21:38+00:00</creationDate> + <modificationDate>2021-06-28T11:31:22+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2/draft"/> + <remoteId>c15b600eb9198b1924063b5a68758232</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><short_title|title></nameSchema> + <isContainer>true</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>false</defaultAlwaysAvailable> + <defaultSortField>PATH</defaultSortField> + <defaultSortOrder>ASC</defaultSortOrder> + <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions"> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/1"> + <id>1</id> + <identifier>title</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>1</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue>New article</defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Title</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">255</value> + <value key="minStringLength"/> + </value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/152"> + <id>152</id> + <identifier>short_title</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>2</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Short title</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">255</value> + <value key="minStringLength"/> + </value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/153"> + <id>153</id> + <identifier>author</identifier> + <fieldType>ibexa_author</fieldType> + <fieldGroup></fieldGroup> + <position>3</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>false</isSearchable> + <names> + <value languageCode="eng-GB">Author</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings> + <value key="defaultAuthor">1</value> + </fieldSettings> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/120"> + <id>120</id> + <identifier>intro</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup></fieldGroup> + <position>4</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Intro</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/121"> + <id>121</id> + <identifier>body</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup></fieldGroup> + <position>5</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Body</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/123"> + <id>123</id> + <identifier>enable_comments</identifier> + <fieldType>ibexa_boolean</fieldType> + <fieldGroup></fieldGroup> + <position>6</position> + <isTranslatable>false</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue>false</defaultValue> + <isSearchable>false</isSearchable> + <names> + <value languageCode="eng-GB">Enable comments</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/195"> + <id>195</id> + <identifier>image</identifier> + <fieldType>ibexa_image_asset</fieldType> + <fieldGroup>content</fieldGroup> + <position>7</position> + <isTranslatable>false</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="destinationContentId"/> + <value key="alternativeText"/> + <value key="source"/> + </defaultValue> + <isSearchable>false</isSearchable> + <names> + <value languageCode="eng-GB">Image</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + </FieldDefinitions> + </ContentType> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/50"> + <id>50</id> + <status>DEFINED</status> + <identifier>copy_of_article_50</identifier> + <names> + <value languageCode="eng-GB">Article</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <creationDate>2021-07-14T10:30:00+00:00</creationDate> + <modificationDate>2021-07-14T10:30:00+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/50/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/50/draft"/> + <remoteId>fc9434492469d136ffe13377bfdcbb28</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><short_title|title></nameSchema> + <isContainer>true</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>false</defaultAlwaysAvailable> + <defaultSortField>PATH</defaultSortField> + <defaultSortOrder>ASC</defaultSortOrder> + <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions"> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/197"> + <id>197</id> + <identifier>title</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>1</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue>New article</defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Title</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">255</value> + <value key="minStringLength"/> + </value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/198"> + <id>198</id> + <identifier>short_title</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>2</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Short title</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">255</value> + <value key="minStringLength"/> + </value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/199"> + <id>199</id> + <identifier>author</identifier> + <fieldType>ibexa_author</fieldType> + <fieldGroup></fieldGroup> + <position>3</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>false</isSearchable> + <names> + <value languageCode="eng-GB">Author</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings> + <value key="defaultAuthor">1</value> + </fieldSettings> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/200"> + <id>200</id> + <identifier>intro</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup></fieldGroup> + <position>4</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Intro</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/201"> + <id>201</id> + <identifier>body</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup></fieldGroup> + <position>5</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Body</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/202"> + <id>202</id> + <identifier>enable_comments</identifier> + <fieldType>ibexa_boolean</fieldType> + <fieldGroup></fieldGroup> + <position>6</position> + <isTranslatable>false</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue>false</defaultValue> + <isSearchable>false</isSearchable> + <names> + <value languageCode="eng-GB">Enable comments</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/203"> + <id>203</id> + <identifier>image</identifier> + <fieldType>ibexa_image_asset</fieldType> + <fieldGroup>content</fieldGroup> + <position>7</position> + <isTranslatable>false</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="destinationContentId"/> + <value key="alternativeText"/> + <value key="source"/> + </defaultValue> + <isSearchable>false</isSearchable> + <names> + <value languageCode="eng-GB">Image</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + </FieldDefinitions> + </ContentType> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/44"> + <id>44</id> + <status>DEFINED</status> + <identifier>dog_breed</identifier> + <names> + <value languageCode="eng-GB">Dog Breed</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <creationDate>2021-06-28T11:28:00+00:00</creationDate> + <modificationDate>2021-06-28T11:29:02+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/44/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/44/draft"/> + <remoteId>b348c95f7c573d4d502d6b59f80e618a</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><name></nameSchema> + <isContainer>false</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>true</defaultAlwaysAvailable> + <defaultSortField>PUBLISHED</defaultSortField> + <defaultSortOrder>DESC</defaultSortOrder> + <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/44/fieldDefinitions"> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/44/fieldDefinitions/190"> + <id>190</id> + <identifier>name</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup>content</fieldGroup> + <position>1</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Name</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength"/> + <value key="minStringLength"/> + </value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/44/fieldDefinitions/191"> + <id>191</id> + <identifier>photo</identifier> + <fieldType>ibexa_image_asset</fieldType> + <fieldGroup>content</fieldGroup> + <position>2</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="destinationContentId"/> + <value key="alternativeText"/> + <value key="source"/> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Photo</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/44/fieldDefinitions/192"> + <id>192</id> + <identifier>description</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup>content</fieldGroup> + <position>3</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Full Description</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + </FieldDefinitions> + </ContentType> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"> + <id>1</id> + <status>DEFINED</status> + <identifier>folder</identifier> + <names> + <value languageCode="eng-GB">Folder</value> + </names> + <descriptions/> + <creationDate>2002-06-18T09:21:38+00:00</creationDate> + <modificationDate>2015-11-29T21:14:32+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/1/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1/draft"/> + <remoteId>a3d405b81be900468eb153d774f4f0d2</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><short_name|name></nameSchema> + <isContainer>true</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>true</defaultAlwaysAvailable> + <defaultSortField>PATH</defaultSortField> + <defaultSortOrder>ASC</defaultSortOrder> + <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions"> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/4"> + <id>4</id> + <identifier>name</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>1</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue>Folder</defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Name</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">255</value> + <value key="minStringLength"/> + </value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/155"> + <id>155</id> + <identifier>short_name</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>2</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Short name</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">100</value> + <value key="minStringLength"/> + </value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/119"> + <id>119</id> + <identifier>short_description</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup></fieldGroup> + <position>3</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Short description</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/156"> + <id>156</id> + <identifier>description</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup></fieldGroup> + <position>4</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Description</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + </FieldDefinitions> + </ContentType> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/55"> + <id>55</id> + <status>DEFINED</status> + <identifier>folder_55</identifier> + <names> + <value languageCode="eng-GB">Folder</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <creationDate>2021-07-28T07:57:22+00:00</creationDate> + <modificationDate>2021-07-28T07:57:34+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/55/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/55/draft"/> + <remoteId>4eb7bc76f6d0bd1d5ded2d8936cc6afb</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><short_name|name></nameSchema> + <isContainer>true</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>true</defaultAlwaysAvailable> + <defaultSortField>PATH</defaultSortField> + <defaultSortOrder>ASC</defaultSortOrder> + <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/55/fieldDefinitions"> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/55/fieldDefinitions/210"> + <id>210</id> + <identifier>name</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>1</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue>Folder</defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Name</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">255</value> + <value key="minStringLength"/> + </value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/55/fieldDefinitions/211"> + <id>211</id> + <identifier>short_name</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>2</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Short name</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">100</value> + <value key="minStringLength"/> + </value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/55/fieldDefinitions/212"> + <id>212</id> + <identifier>short_description</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup></fieldGroup> + <position>3</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Short description</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/55/fieldDefinitions/213"> + <id>213</id> + <identifier>description</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup></fieldGroup> + <position>4</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Intro</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/121"> - <id>121</id> - <identifier>body</identifier> - <fieldType>ibexa_richtext</fieldType> - <fieldGroup></fieldGroup> - <position>5</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Description</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + </FieldDefinitions> + </ContentType> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/43"> + <id>43</id> + <status>DEFINED</status> + <identifier>form</identifier> + <names> + <value languageCode="eng-GB">Form</value> + </names> + <descriptions/> + <creationDate>2018-09-17T06:46:13+00:00</creationDate> + <modificationDate>2018-09-17T06:47:14+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/43/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/43/draft"/> + <remoteId>6f7f21df775a33c1e4bbc76b48c38476</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><title></nameSchema> + <isContainer>false</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>true</defaultAlwaysAvailable> + <defaultSortField>PUBLISHED</defaultSortField> + <defaultSortOrder>DESC</defaultSortOrder> + <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions"> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions/188"> + <id>188</id> + <identifier>title</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup>content</fieldGroup> + <position>1</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Title</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength"/> + <value key="minStringLength"/> + </value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions/189"> + <id>189</id> + <identifier>form</identifier> + <fieldType>ibexa_form</fieldType> + <fieldGroup>content</fieldGroup> + <position>2</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="fields"/> + <value key="content_id"/> + <value key="content_field_id"/> + <value key="language_code"/> + </defaultValue> + <isSearchable>false</isSearchable> + <names> + <value languageCode="eng-GB">Form</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + </FieldDefinitions> + </ContentType> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/45"> + <id>45</id> + <status>DEFINED</status> + <identifier>tip</identifier> + <names> + <value languageCode="eng-GB">Tip</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <creationDate>2021-06-28T11:29:19+00:00</creationDate> + <modificationDate>2021-07-26T09:33:06+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/45/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/45/draft"/> + <remoteId>e6490e8a785edacd48629f2022be3125</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><title></nameSchema> + <isContainer>false</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>true</defaultAlwaysAvailable> + <defaultSortField>PUBLISHED</defaultSortField> + <defaultSortOrder>DESC</defaultSortOrder> + <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/45/fieldDefinitions"> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/45/fieldDefinitions/193"> + <id>193</id> + <identifier>title</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup>content</fieldGroup> + <position>1</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Title</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength"/> + <value key="minStringLength"/> + </value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/45/fieldDefinitions/194"> + <id>194</id> + <identifier>body</identifier> + <fieldType>ibexa_text</fieldType> + <fieldGroup>content</fieldGroup> + <position>2</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Body</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <fieldSettings> + <value key="textRows">10</value> + </fieldSettings> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/45/fieldDefinitions/204"> + <id>204</id> + <identifier>richtext</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup>content</fieldGroup> + <position>3</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> - <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Body</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/123"> - <id>123</id> - <identifier>enable_comments</identifier> - <fieldType>ibexa_boolean</fieldType> - <fieldGroup></fieldGroup> - <position>6</position> - <isTranslatable>false</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue>false</defaultValue> - <isSearchable>false</isSearchable> - <names> - <value languageCode="eng-GB">Enable comments</value> - </names> - <descriptions/> - <fieldSettings/> - <validatorConfiguration/> - </FieldDefinition> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/154"> - <id>154</id> - <identifier>image</identifier> - <fieldType>ibexa_object_relation</fieldType> - <fieldGroup></fieldGroup> - <position>7</position> - <isTranslatable>true</isTranslatable> - <isRequired>false</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue> - <value key="destinationContentId"/> - </defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Image</value> - </names> - <descriptions/> - <fieldSettings> - <value key="selectionMethod">SELECTION_BROWSE</value> - <value key="selectionRoot"></value> - <value key="selectionContentTypes"/> - </fieldSettings> - <validatorConfiguration/> - </FieldDefinition> - </FieldDefinitions> - </ContentType> - </ContentTypeList> - 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: contentTypeGroupId - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false - post: - operationId: ibexa.rest.create_content_type - 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"?> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/20/draft"> - <id>20</id> - <status>DRAFT</status> - <identifier>newContentType</identifier> + </defaultValue> + <isSearchable>true</isSearchable> <names> - <value languageCode="eng-GB">New content type</value> + <value languageCode="eng-GB">richtext</value> </names> <descriptions> - <value languageCode="eng-GB">This is a description</value> + <value languageCode="eng-GB"></value> </descriptions> - <creationDate>2019-02-26T09:39:58+01:00</creationDate> - <modificationDate>2019-02-26T09:39:58+01:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/20/groups"/> - <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/20/draft"/> - <remoteId>remoteId-qwert548</remoteId> - <urlAliasSchema><title></urlAliasSchema> - <nameSchema><title></nameSchema> - <isContainer>true</isContainer> - <mainLanguageCode>eng-GB</mainLanguageCode> - <defaultAlwaysAvailable>true</defaultAlwaysAvailable> - <defaultSortField>PATH</defaultSortField> - <defaultSortOrder>ASC</defaultSortOrder> - <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/20/draft/fieldDefinitions"> - <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/20/draft/fieldDefinitions/223"> - <id>223</id> - <identifier>title</identifier> - <fieldType>ibexa_string</fieldType> - <fieldGroup>content</fieldGroup> - <position>1</position> - <isTranslatable>true</isTranslatable> - <isRequired>true</isRequired> - <isInfoCollector>false</isInfoCollector> - <defaultValue>New Title</defaultValue> - <isSearchable>true</isSearchable> - <names> - <value languageCode="eng-GB">Title</value> - </names> - <descriptions> - <value languageCode="eng-GB">This is the title</value> - </descriptions> - <fieldSettings/> - <validatorConfiguration> - <value key="StringLengthValidator"> - <value key="minStringLength">0</value> - <value key="maxStringLength"/></value> - </validatorConfiguration> - </FieldDefinition> - </FieldDefinitions> - </ContentType> - 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - 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 content type Create schema encoded in XML or JSON format. - 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"?> - <ContentTypeCreate> - <identifier>newContentType</identifier> - <names> - <value languageCode="eng-US">New content type</value> - </names> - <descriptions> - <value languageCode="eng-US">This is a description</value> - </descriptions> - <remoteId>remoteId-qwert548</remoteId> - <urlAliasSchema><title></urlAliasSchema> - <nameSchema><title></nameSchema> - <isContainer>true</isContainer> - <mainLanguageCode>eng-US</mainLanguageCode> - <defaultAlwaysAvailable>true</defaultAlwaysAvailable> - <defaultSortField>PATH</defaultSortField> - <defaultSortOrder>ASC</defaultSortOrder> - <FieldDefinitions> - <FieldDefinition> - <identifier>title</identifier> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + </FieldDefinitions> + </ContentType> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/42"> + <id>42</id> + <status>DEFINED</status> + <identifier>landing_page</identifier> + <names> + <value languageCode="eng-GB">Landing page</value> + </names> + <descriptions> + <value languageCode="eng-GB"></value> + </descriptions> + <creationDate>2015-07-03T12:00:26+00:00</creationDate> + <modificationDate>2015-07-03T12:00:26+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/42/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/42/draft"/> + <remoteId>60c03e9758465eb69d56b3afb6adf18e</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><name></nameSchema> + <isContainer>true</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>true</defaultAlwaysAvailable> + <defaultSortField>PUBLISHED</defaultSortField> + <defaultSortOrder>DESC</defaultSortOrder> + <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions"> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/185"> + <id>185</id> + <identifier>name</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup>content</fieldGroup> + <position>10</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Title</value> + </names> + <descriptions> + <value languageCode="eng-GB">Title</value> + </descriptions> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength"/> + <value key="minStringLength"/> + </value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/186"> + <id>186</id> + <identifier>description</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup>content</fieldGroup> - <position>1</position> + <position>20</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> - <defaultValue>New Title</defaultValue> + <defaultValue/> <isSearchable>true</isSearchable> <names> - <value languageCode="eng-US">Title</value> + <value languageCode="eng-GB">Description</value> </names> <descriptions> - <value languageCode="eng-US">This is the title</value> + <value languageCode="eng-GB">Landing page description</value> </descriptions> - </FieldDefinition> - <FieldDefinition> - <identifier>summary</identifier> - <fieldType>ezxmltext</fieldType> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength"/> + <value key="minStringLength"/> + </value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/187"> + <id>187</id> + <identifier>page</identifier> + <fieldType>ibexa_landing_page</fieldType> <fieldGroup>content</fieldGroup> - <position>2</position> + <position>30</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> - <value key="xml"><?xml version="1.0" encoding="utf-8"?><section/></value> + <value key="layout">default</value> + <value key="zones"> + <value> + <value key="id">default_id</value> + <value key="name">default</value> + <value key="blocks"/> + </value> + </value> </defaultValue> - <isSearchable>true</isSearchable> + <isSearchable>false</isSearchable> <names> - <value languageCode="eng-US">Summary</value> + <value languageCode="eng-GB">Landing page</value> </names> <descriptions> - <value languageCode="eng-US">This is the summary</value> + <value languageCode="eng-GB">Landing page</value> </descriptions> - </FieldDefinition> - </FieldDefinitions> - </ContentTypeCreate> - required: false - deprecated: false - /content/urlaliases: - get: - operationId: ibexa.rest.list_global_url_aliases - 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"?> - <UrlAliasRefList media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/urlaliases"> - <UrlAlias media-type="application/vnd.ibexa.api.UrlAlias+xml" href="/api/ibexa/v2/content/urlaliases/0-2cecdff5f90b8595d76b68c417b09f36" /> - </UrlAliasRefList> - 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: [] - deprecated: false - post: - operationId: ibexa.rest.create_url_alias - 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-f530173ad554787c1fe30dc929d98360 - _id: 0-f530173ad554787c1fe30dc929d98360 - _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"?> - <UrlAlias media-type="application/vnd.ibexa.api.UrlAlias+xml" href="/api/ibexa/v2/content/urlaliases/0-deca3dadca45c3dff7861274b8e67ed7" id="0-deca3dadca45c3dff7861274b8e67ed7" type="LOCATION"> - <location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/59"/> - <path>/example-urlalias</path> - <languageCodes>eng-GB</languageCodes> - <alwaysAvailable>true</alwaysAvailable> - <isHistory>false</isHistory> - <forward>true</forward> - <custom>true</custom> - </UrlAlias> - 400: - description: Error - The input does not match the input schema definition. + <fieldSettings> + <value key="availableBlocks"/> + <value key="availableLayouts"/> + <value key="editorMode">page_view_mode</value> + </fieldSettings> + <validatorConfiguration/> + </FieldDefinition> + </FieldDefinitions> + </ContentType> + </ContentTypeList> 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. + 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: X-CSRF-Token + - name: If-None-Match in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - required: true + description: ETag + required: false deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - requestBody: - description: The URL alias input schema encoded in XML or JSON format. - 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"?> - <UrlAliasCreate type="LOCATION"> - <location href='/api/ibexa/v2/content/locations/1/2/59' /> - <path>example-global</path> - <languageCode>eng-GB</languageCode> - <alwaysAvailable>true</alwaysAvailable> - <forward>true</forward> - </UrlAliasCreate> - required: false - deprecated: false - /content/urlaliases/{urlAliasId}: - get: - operationId: ibexa.rest.load_url_alias - 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"?> - <UrlAlias media-type="application/vnd.ibexa.api.UrlAlias+xml" href="/api/ibexa/v2/content/urlaliases/0-2cecdff5f90b8595d76b68c417b09f36" id="0-2cecdff5f90b8595d76b68c417b09f36" type="RESOURCE"> - <resource>content/view/full</resource> - <path>/example-global</path> - <languageCodes>eng-GB</languageCodes> - <alwaysAvailable>true</alwaysAvailable> - <isHistory>false</isHistory> - <forward>true</forward> - <custom>true</custom> - </UrlAlias> - 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: urlAliasId + - name: contentTypeGroupId in: path - description: "" + description: ContentTypeGroupLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false delete: - operationId: ibexa.rest.delete_url_alias + operationId: ibexa.rest.delete_content_type_group tags: - - Url Alias + - Type Groups responses: 204: - description: No Content - URL alias deleted. + description: No Content - content type group deleted. 401: - description: Error - The user is not authorized to delete a URL alias. + 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 URL alias does not exist. - summary: Delete URL alias - description: Deletes the provided URL alias. + description: Error - The content type group does not exist. + summary: Delete content type group + description: Deletes the provided content type group. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: urlAliasId + - name: contentTypeGroupId in: path - description: "" + description: ContentTypeGroupDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - /content/urlwildcards: - get: - operationId: ibexa.rest.list_url_wildcards + patch: + operationId: ibexa.rest.update_content_type_group tags: - - Url Wildcard + - Type Groups 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"?> - <UrlWildcardList media-type="application/vnd.ibexa.api.UrlWildcardList+xml" href="/api/ibexa/v2/content/urlwildcards"> - <UrlWildcard media-type="application/vnd.ibexa.api.UrlWildcard+xml" href="/api/ibexa/v2/content/urlwildcards/1" id="1"> - <sourceUrl>/api/ibexa/v2/content/location/2</sourceUrl> - <destinationUrl>/api/ibexa/v2/content/location/59</destinationUrl> - <forward>true</forward> - </UrlWildcard> - </UrlWildcardList> - 401: - description: Error - The user has no permission to read URL wildcards. - summary: List URL wildcards - description: Returns a list of URL wildcards. - parameters: [] - deprecated: false - post: - operationId: ibexa.rest.create_url_wildcard - tags: - - Url Wildcard - responses: - 201: - description: URL wildcard created. + description: Content type group updated. content: - application/vnd.ibexa.api.UrlWildcard+json: + application/vnd.ibexa.api.ContentTypeGroup+json: schema: - $ref: '#/components/schemas/UrlWildcardWrapper' + $ref: '#/components/schemas/ContentTypeGroupWrapper' example: - UrlWildcard: - _media-type: application/vnd.ibexa.api.UrlWildcard+json - _href: /api/ibexa/v2/content/urlwildcards/6 - _id: 6 - sourceUrl: /api/ibexa/v2/content/location/2 - destinationUrl: /api/ibexa/v2/content/location/59 - forward: true - application/vnd.ibexa.api.UrlWildcard+xml: + 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/UrlWildcard' + $ref: '#/components/schemas/ContentTypeGroup' example: | <?xml version="1.0" encoding="UTF-8"?> - <UrlWildcard media-type="application/vnd.ibexa.api.UrlWildcard+xml" href="/api/ibexa/v2/content/urlwildcards/1" id="1"> - <sourceUrl>/api/ibexa/v2/content/location/2</sourceUrl> - <destinationUrl>/api/ibexa/v2/content/location/59</destinationUrl> - <forward>true</forward> - </UrlWildcard> + <ContentTypeGroup media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/1"> + <id>4</id> + <identifier>updatedIdentifer</identifier> + <created>2002-09-05T11:08:48+02:00</created> + <modified>2019-02-22T14:42:55+01:00</modified> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <ContentTypes media-type="application/vnd.ibexa.api.ContentTypeInfoList+xml" href="/api/ibexa/v2/content/typegroups/1/types"/> + </ContentTypeGroup> 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. + description: Error - The user is not authorized to create this content type + group. 403: - description: Error - A URL wildcard with the same identifier already exists. - summary: Create URL wildcard - description: Creates a new URL wildcard. + 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: X-CSRF-Token in: header description: The CSRF Token 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 URL Wildcard input schema encoded in XML or JSON format. - 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: ibexa.rest.load_url_wildcard - 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"?> - <UrlWildcard media-type="application/vnd.ibexa.api.UrlWildcard+xml" href="/api/ibexa/v2/content/urlwildcards/4" id="4"> - <sourceUrl>/api/ibexa/v2/content/location/2</sourceUrl> - <destinationUrl>/api/ibexa/v2/content/location/59</destinationUrl> - <forward>true</forward> - </UrlWildcard> - 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: wildcardId - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - delete: - operationId: ibexa.rest.delete_url_wildcard - 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: X-CSRF-Token + - name: If-Match in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + 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: wildcardId + - name: contentTypeGroupId in: path - description: "" + description: ContentTypeGroupUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - /user/current: + requestBody: + description: The content type group input schema encoded in XML or JSON format. + content: + application/vnd.ibexa.api.ContentTypeGroupInput+json: + schema: + $ref: '#/components/schemas/ContentTypeGroupInputWrapper' + example: + ContentTypeGroupInput: + identifier: updatedIdentifer + application/vnd.ibexa.api.ContentTypeGroupInput+xml: + schema: + $ref: '#/components/schemas/ContentTypeGroupInput' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <ContentTypeGroupInput> + <identifier>updatedIdentifer</identifier> + </ContentTypeGroupInput> + required: false + /content/typegroups/{contentTypeGroupId}/types: get: - operationId: api_usercurrent_get + operationId: ibexa.rest.list_content_types_for_group tags: - - User + - Type Groups responses: 200: - description: OK - the User with the given ID. + description: OK - returns a list on content types. content: - application/vnd.ibexa.api.User+json: + application/vnd.ibexa.api.ContentTypeInfoList+json: schema: - $ref: '#/components/schemas/UserListWrapper' + $ref: '#/components/schemas/ContentTypeInfoListWrapper' 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: + ContentTypeList: + _media-type: application/vnd.ibexa.api.ContentTypeList+json + _href: /api/ibexa/v2/content/types + ContentType: + - _media-type: application/vnd.ibexa.api.ContentType+json + _href: /api/ibexa/v2/content/types/2 + id: 2 + status: DEFINED + identifier: article + names: + value: + - _languageCode: eng-GB + '#text': Article + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + 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': ~ + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: 255 + minStringLength: ~ + - _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: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Short title + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: 255 + minStringLength: ~ + - _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': ~ + 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"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Intro + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + 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"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Body + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + 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': ~ + 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: ~ + alternativeText: ~ + source: ~ + isSearchable: false + names: + value: + - _languageCode: eng-GB + '#text': Image + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + validatorConfiguration: [] + - _media-type: application/vnd.ibexa.api.ContentType+json + _href: /api/ibexa/v2/content/types/50 + id: 50 + status: DEFINED + identifier: copy_of_article_50 + names: + value: + - _languageCode: eng-GB + '#text': Article + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + creationDate: "2021-07-14T10:30:00+00:00" + modificationDate: "2021-07-14T10:30:00+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/50/groups + Draft: _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 + _href: /api/ibexa/v2/content/types/50/draft + remoteId: fc9434492469d136ffe13377bfdcbb28 + 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/50/fieldDefinitions + FieldDefinition: + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/50/fieldDefinitions/197 + id: 197 + 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': ~ + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: 255 + minStringLength: ~ + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/50/fieldDefinitions/198 + id: 198 + identifier: short_title + fieldType: ibexa_string + fieldGroup: "" + position: 2 + isTranslatable: true + isRequired: false + isInfoCollector: false + defaultValue: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Short title + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: 255 + minStringLength: ~ + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/50/fieldDefinitions/199 + id: 199 + 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': ~ + fieldSettings: + defaultAuthor: 1 + validatorConfiguration: [] + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/50/fieldDefinitions/200 + id: 200 + identifier: intro + fieldType: ibexa_richtext + fieldGroup: "" + position: 4 + isTranslatable: true + isRequired: true + isInfoCollector: false + defaultValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Intro + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + validatorConfiguration: [] + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/50/fieldDefinitions/201 + id: 201 + identifier: body + fieldType: ibexa_richtext + fieldGroup: "" + position: 5 + isTranslatable: true + isRequired: false + isInfoCollector: false + defaultValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Body + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + validatorConfiguration: [] + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/50/fieldDefinitions/202 + id: 202 + 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': ~ + fieldSettings: [] + validatorConfiguration: [] + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/50/fieldDefinitions/203 + id: 203 + identifier: image + fieldType: ibexa_image_asset + fieldGroup: content + position: 7 + isTranslatable: false + isRequired: false + isInfoCollector: false + defaultValue: + destinationContentId: ~ + alternativeText: ~ + source: ~ + isSearchable: false + names: + value: + - _languageCode: eng-GB + '#text': Image + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + validatorConfiguration: [] + - _media-type: application/vnd.ibexa.api.ContentType+json + _href: /api/ibexa/v2/content/types/44 + id: 44 + status: DEFINED + identifier: dog_breed + names: + value: + - _languageCode: eng-GB + '#text': Dog Breed + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + creationDate: "2021-06-28T11:28:00+00:00" + modificationDate: "2021-06-28T11:29:02+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.UserGroupRefList+json - _href: /api/ibexa/v2/user/users/79/groups - Owner: + _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json + _href: /api/ibexa/v2/content/types/44/groups + Draft: + _media-type: application/vnd.ibexa.api.ContentType+json + _href: /api/ibexa/v2/content/types/44/draft + remoteId: b348c95f7c573d4d502d6b59f80e618a + urlAliasSchema: "" + nameSchema: <name> + 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/44/fieldDefinitions + FieldDefinition: + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/44/fieldDefinitions/190 + id: 190 + identifier: name + fieldType: ibexa_string + fieldGroup: content + position: 1 + isTranslatable: true + isRequired: false + isInfoCollector: false + defaultValue: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Name + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: ~ + minStringLength: ~ + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/44/fieldDefinitions/191 + id: 191 + identifier: photo + fieldType: ibexa_image_asset + fieldGroup: content + position: 2 + isTranslatable: true + isRequired: false + isInfoCollector: false + defaultValue: + destinationContentId: ~ + alternativeText: ~ + source: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Photo + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + validatorConfiguration: [] + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/44/fieldDefinitions/192 + id: 192 + identifier: description + fieldType: ibexa_richtext + fieldGroup: content + position: 3 + isTranslatable: true + isRequired: false + isInfoCollector: false + defaultValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Full Description + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + 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/10 - publishDate: "2021-06-29T08:23:42+00:00" - lastModificationDate: "2021-06-29T08:23:42+00:00" + _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: ~ + nameSchema: <short_name|name> + isContainer: true 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 + 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': 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: ~ - - id: 345 - fieldDefinitionIdentifier: signature - languageCode: eng-GB - fieldTypeIdentifier: ibexa_text - fieldValue: ~ - - id: 346 - fieldDefinitionIdentifier: image - languageCode: eng-GB - fieldTypeIdentifier: ibexa_image - fieldValue: ~ - 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: ~ - height: ~ - 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"?> - <UserList media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/users"> - <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/79" id="79" remoteId="bcf0764b417f05af21852a1f03fb1f13"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/> - <name>Jose Vargas</name> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/79/versions"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/12/79"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/79/locations"/> - <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/79/groups"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> - <publishDate>2021-06-29T08:23:42+00:00</publishDate> - <lastModificationDate>2021-06-29T08:23:42+00:00</lastModificationDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <alwaysAvailable>true</alwaysAvailable> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/79/versions/1"> - <VersionInfo> - <id>547</id> - <versionNo>1</versionNo> - <status>PUBLISHED</status> - <modificationDate>2021-06-29T08:23:42+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> - <creationDate>2021-06-29T08:23:42+00:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Jose Vargas</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/79"/> - </VersionInfo> - <Fields> - <field> - <id>342</id> - <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Jose</fieldValue> - </field> - <field> - <id>343</id> - <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Vargas</fieldValue> - </field> - <field> - <id>344</id> - <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> - <fieldValue> - <value key="hasStoredLogin">true</value> - <value key="contentId">79</value> - <value key="login">josevargas</value> - <value key="email">aa@bb.cc</value> - <value key="passwordUpdatedAt">1624955022</value> - <value key="enabled">true</value> - <value key="maxLogin">0</value> - <value key="plainPassword"/> - </fieldValue> - </field> - <field> - <id>345</id> - <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier> - <fieldValue/> - </field> - <field> - <id>346</id> - <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier> - <fieldValue/> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/79/versions/1/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - <login>josevargas</login> - <email>aa@bb.cc</email> - <enabled>true</enabled> - <UserGroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/users/79/groups"/> - <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/79/roles"/> - </User> - </UserList> - 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: + '#text': Name + descriptions: + value: [] + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: 255 + minStringLength: ~ + - _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: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Short name + descriptions: + value: [] + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: 100 + minStringLength: ~ + - _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"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + 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"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + 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/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 + _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: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Title + descriptions: + value: [] + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: ~ + minStringLength: ~ + - _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: ~ + content_field_id: ~ + language_code: ~ + 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/45 + id: 45 + status: DEFINED + identifier: tip + names: + value: + - _languageCode: eng-GB + '#text': Tip + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + creationDate: "2021-06-28T11:29:19+00:00" + modificationDate: "2021-07-26T09:33: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 Groups: - _media-type: application/vnd.ibexa.api.UserGroupRefList+json - _href: /api/ibexa/v2/user/users/79/groups - Owner: + _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json + _href: /api/ibexa/v2/content/types/45/groups + Draft: + _media-type: application/vnd.ibexa.api.ContentType+json + _href: /api/ibexa/v2/content/types/45/draft + remoteId: e6490e8a785edacd48629f2022be3125 + 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/45/fieldDefinitions + FieldDefinition: + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/45/fieldDefinitions/193 + id: 193 + identifier: title + fieldType: ibexa_string + fieldGroup: content + position: 1 + isTranslatable: true + isRequired: false + isInfoCollector: false + defaultValue: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Title + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: ~ + minStringLength: ~ + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/45/fieldDefinitions/194 + id: 194 + identifier: body + fieldType: ibexa_text + fieldGroup: content + position: 2 + isTranslatable: true + isRequired: false + isInfoCollector: false + defaultValue: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Body + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + fieldSettings: + textRows: 10 + validatorConfiguration: [] + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/45/fieldDefinitions/204 + id: 204 + identifier: richtext + fieldType: ibexa_richtext + fieldGroup: content + position: 3 + isTranslatable: true + isRequired: false + isInfoCollector: false + defaultValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': richtext + descriptions: + value: + - _languageCode: eng-GB + '#text': ~ + 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/10 - publishDate: "2021-06-29T08:23:42+00:00" - lastModificationDate: "2021-06-29T08:23:42+00:00" + _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 - 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 + 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: ~ + isSearchable: true 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: ~ - - id: 345 - fieldDefinitionIdentifier: signature - languageCode: eng-GB - fieldTypeIdentifier: ibexa_text - fieldValue: ~ - - id: 346 - fieldDefinitionIdentifier: image - languageCode: eng-GB - fieldTypeIdentifier: ibexa_image - fieldValue: ~ - 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: ~ - height: ~ - 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"?> - <UserList media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/users"> - <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/79" id="79" remoteId="bcf0764b417f05af21852a1f03fb1f13"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/> - <name>Jose Vargas</name> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/79/versions"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/12/79"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/79/locations"/> - <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/79/groups"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> - <publishDate>2021-06-29T08:23:42+00:00</publishDate> - <lastModificationDate>2021-06-29T08:23:42+00:00</lastModificationDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <alwaysAvailable>true</alwaysAvailable> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/79/versions/1"> - <VersionInfo> - <id>547</id> - <versionNo>1</versionNo> - <status>PUBLISHED</status> - <modificationDate>2021-06-29T08:23:42+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> - <creationDate>2021-06-29T08:23:42+00:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Jose Vargas</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/79"/> - </VersionInfo> - <Fields> - <field> - <id>342</id> - <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Jose</fieldValue> - </field> - <field> - <id>343</id> - <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Vargas</fieldValue> - </field> - <field> - <id>344</id> - <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> - <fieldValue> - <value key="hasStoredLogin">true</value> - <value key="contentId">79</value> - <value key="login">josevargas</value> - <value key="email">aa@bb.cc</value> - <value key="passwordUpdatedAt">1624955022</value> - <value key="enabled">true</value> - <value key="maxLogin">0</value> - <value key="plainPassword"/> - </fieldValue> - </field> - <field> - <id>345</id> - <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier> - <fieldValue/> - </field> - <field> - <id>346</id> - <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier> - <fieldValue/> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/79/versions/1/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - <login>josevargas</login> - <email>aa@bb.cc</email> - <enabled>true</enabled> - <UserGroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/users/79/groups"/> - <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/79/roles"/> - </User> - </UserList> - 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"?> - <UserRefList media-type="application/vnd.ibexa.api.UserRefList+xml" href="/api/ibexa/v2/user/users"> - <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - </UserRefList> - 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 + '#text': Title + descriptions: + value: + - _languageCode: eng-GB + '#text': Title + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: ~ + minStringLength: ~ + - _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: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Description + descriptions: + value: + - _languageCode: eng-GB + '#text': Landing page description + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: ~ + minStringLength: ~ + - _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: ~ + availableLayouts: ~ + editorMode: page_view_mode + validatorConfiguration: [] + - _media-type: application/vnd.ibexa.api.ContentType+json + _href: /api/ibexa/v2/content/types/4 + id: 4 + status: DEFINED + identifier: user + names: + value: + - _languageCode: eng-GB + '#text': User + descriptions: + value: [] + creationDate: "2002-06-18T09:21:38+00:00" + modificationDate: "2004-04-15T08:39: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.UserGroupRefList+json - _href: /api/ibexa/v2/user/users/79/groups - Owner: + _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json + _href: /api/ibexa/v2/content/types/4/groups + Draft: + _media-type: application/vnd.ibexa.api.ContentType+json + _href: /api/ibexa/v2/content/types/4/draft + remoteId: 40faa822edc579b02c25f6bb7beec3ad + urlAliasSchema: ~ + nameSchema: <first_name> <last_name> + isContainer: false + mainLanguageCode: eng-GB + defaultAlwaysAvailable: true + defaultSortField: PATH + defaultSortOrder: ASC + FieldDefinitions: + _media-type: application/vnd.ibexa.api.FieldDefinitionList+json + _href: /api/ibexa/v2/content/types/4/fieldDefinitions + FieldDefinition: + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/4/fieldDefinitions/8 + id: 8 + identifier: first_name + fieldType: ibexa_string + fieldGroup: "" + position: 1 + isTranslatable: true + isRequired: true + isInfoCollector: false + defaultValue: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': First name + descriptions: + value: [] + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: 255 + minStringLength: ~ + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/4/fieldDefinitions/9 + id: 9 + identifier: last_name + fieldType: ibexa_string + fieldGroup: "" + position: 2 + isTranslatable: true + isRequired: true + isInfoCollector: false + defaultValue: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Last name + descriptions: + value: [] + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: 255 + minStringLength: ~ + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/4/fieldDefinitions/12 + id: 12 + identifier: user_account + fieldType: ibexa_user + fieldGroup: "" + position: 3 + isTranslatable: false + isRequired: true + isInfoCollector: false + defaultValue: ~ + isSearchable: false + names: + value: + - _languageCode: eng-GB + '#text': User account + descriptions: + value: [] + fieldSettings: + PasswordTTL: 0 + PasswordTTLWarning: 0 + RequireUniqueEmail: false + UsernamePattern: ^[^@]+$ + validatorConfiguration: + PasswordValueValidator: + requireAtLeastOneUpperCaseCharacter: true + requireAtLeastOneLowerCaseCharacter: true + requireAtLeastOneNumericCharacter: true + requireAtLeastOneNonAlphanumericCharacter: false + requireNewPassword: false + minLength: 10 + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/4/fieldDefinitions/179 + id: 179 + identifier: signature + fieldType: ibexa_text + fieldGroup: "" + position: 4 + isTranslatable: true + isRequired: false + isInfoCollector: false + defaultValue: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Signature + descriptions: + value: [] + fieldSettings: + textRows: 10 + validatorConfiguration: [] + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/4/fieldDefinitions/180 + id: 180 + identifier: image + fieldType: ibexa_image + fieldGroup: "" + position: 5 + isTranslatable: true + isRequired: false + isInfoCollector: false + defaultValue: ~ + isSearchable: false + names: + value: + - _languageCode: eng-GB + '#text': Image + descriptions: + value: [] + fieldSettings: [] + validatorConfiguration: + FileSizeValidator: + maxFileSize: 10 + - _media-type: application/vnd.ibexa.api.ContentType+json + _href: /api/ibexa/v2/content/types/3 + id: 3 + status: DEFINED + identifier: user_group + names: + value: + - _languageCode: eng-GB + '#text': User group + descriptions: + value: [] + creationDate: "2002-06-18T09:21:38+00:00" + modificationDate: "2003-03-24T08:32:23+00:00" + Creator: _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" + _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/3/groups + Draft: + _media-type: application/vnd.ibexa.api.ContentType+json + _href: /api/ibexa/v2/content/types/3/draft + remoteId: 25b4268cdcd01921b808a0d854b877ef + urlAliasSchema: ~ + nameSchema: <name> + isContainer: true 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 + defaultAlwaysAvailable: true + defaultSortField: PATH + defaultSortOrder: ASC + FieldDefinitions: + _media-type: application/vnd.ibexa.api.FieldDefinitionList+json + _href: /api/ibexa/v2/content/types/3/fieldDefinitions + FieldDefinition: + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/3/fieldDefinitions/6 + id: 6 + identifier: name + fieldType: ibexa_string + fieldGroup: "" + position: 1 + isTranslatable: true + isRequired: true + isInfoCollector: false + defaultValue: ~ + isSearchable: true 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: ~ - - id: 345 - fieldDefinitionIdentifier: signature - languageCode: eng-GB - fieldTypeIdentifier: ibexa_text - fieldValue: ~ - - id: 346 - fieldDefinitionIdentifier: image - languageCode: eng-GB - fieldTypeIdentifier: ibexa_image - fieldValue: ~ - 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: ~ - height: ~ - 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"?> - <UserList media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/users"> - <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/79" id="79" remoteId="bcf0764b417f05af21852a1f03fb1f13"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/> - <name>Jose Vargas</name> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/79/versions"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/12/79"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/79/locations"/> - <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/79/groups"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> - <publishDate>2021-06-29T08:23:42+00:00</publishDate> - <lastModificationDate>2021-06-29T08:23:42+00:00</lastModificationDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <alwaysAvailable>true</alwaysAvailable> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/79/versions/1"> - <VersionInfo> - <id>547</id> - <versionNo>1</versionNo> - <status>PUBLISHED</status> - <modificationDate>2021-06-29T08:23:42+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> - <creationDate>2021-06-29T08:23:42+00:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Jose Vargas</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/79"/> - </VersionInfo> - <Fields> - <field> - <id>342</id> - <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Jose</fieldValue> - </field> - <field> - <id>343</id> - <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Vargas</fieldValue> - </field> - <field> - <id>344</id> - <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> - <fieldValue> - <value key="hasStoredLogin">true</value> - <value key="contentId">79</value> - <value key="login">josevargas</value> - <value key="email">aa@bb.cc</value> - <value key="passwordUpdatedAt">1624955022</value> - <value key="enabled">true</value> - <value key="maxLogin">0</value> - <value key="plainPassword"/> - </fieldValue> - </field> - <field> - <id>345</id> - <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier> - <fieldValue/> - </field> - <field> - <id>346</id> - <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier> - <fieldValue/> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/79/versions/1/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - <login>josevargas</login> - <email>aa@bb.cc</email> - <enabled>true</enabled> - <UserGroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/users/79/groups"/> - <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/79/roles"/> - </User> - </UserList> - 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: ~ - enabled: false - maxLogin: 0 - plainPassword: ~ - - id: 345 - fieldDefinitionIdentifier: signature - languageCode: eng-GB - fieldTypeIdentifier: ibexa_text - fieldValue: ~ - - id: 346 - fieldDefinitionIdentifier: image - languageCode: eng-GB - fieldTypeIdentifier: ibexa_image - fieldValue: ~ - 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: ~ - height: ~ - 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: + '#text': Name + descriptions: + value: [] + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: 255 + minStringLength: ~ + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/3/fieldDefinitions/7 + id: 7 + identifier: description + fieldType: ibexa_string + fieldGroup: "" + position: 2 + isTranslatable: true + isRequired: false + isInfoCollector: false + defaultValue: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Description + descriptions: + value: [] + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: 255 + minStringLength: ~ + - _media-type: application/vnd.ibexa.api.ContentType+json + _href: /api/ibexa/v2/content/types/12 + id: 12 + status: DEFINED + identifier: file + names: + value: + - _languageCode: eng-GB + '#text': File + descriptions: + value: [] + creationDate: "2003-05-08T09:17:52+00:00" + modificationDate: "2003-05-08T09:21:09+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/12/groups + Draft: + _media-type: application/vnd.ibexa.api.ContentType+json + _href: /api/ibexa/v2/content/types/12/draft + remoteId: 637d58bfddf164627bdfd265733280a0 + urlAliasSchema: ~ + nameSchema: <name> + isContainer: false + mainLanguageCode: eng-GB + defaultAlwaysAvailable: true + defaultSortField: PATH + defaultSortOrder: ASC + FieldDefinitions: + _media-type: application/vnd.ibexa.api.FieldDefinitionList+json + _href: /api/ibexa/v2/content/types/12/fieldDefinitions + FieldDefinition: + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/12/fieldDefinitions/146 + id: 146 + identifier: name + fieldType: ibexa_string + fieldGroup: "" + position: 1 + isTranslatable: true + isRequired: true + isInfoCollector: false + defaultValue: New file + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Name + descriptions: + value: [] + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: ~ + minStringLength: ~ + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/12/fieldDefinitions/147 + id: 147 + identifier: description + fieldType: ibexa_richtext + fieldGroup: "" + position: 2 + isTranslatable: true + isRequired: false + isInfoCollector: false + defaultValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Description + descriptions: + value: [] + fieldSettings: [] + validatorConfiguration: [] + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/12/fieldDefinitions/148 + id: 148 + identifier: file + fieldType: ibexa_author + fieldGroup: "" + position: 3 + isTranslatable: true + isRequired: true + isInfoCollector: false + defaultValue: ~ + isSearchable: false + names: + value: + - _languageCode: eng-GB + '#text': File + descriptions: + value: [] + fieldSettings: [] + validatorConfiguration: + FileSizeValidator: + maxFileSize: ~ + - _media-type: application/vnd.ibexa.api.ContentType+json + _href: /api/ibexa/v2/content/types/5 + id: 5 + status: DEFINED + identifier: image + names: + value: + - _languageCode: eng-GB + '#text': Image + descriptions: + value: [] + creationDate: "2002-09-08T11:36:32+00:00" + modificationDate: "2003-03-24T08:33: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 + Groups: + _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json + _href: /api/ibexa/v2/content/types/5/groups + Draft: + _media-type: application/vnd.ibexa.api.ContentType+json + _href: /api/ibexa/v2/content/types/5/draft + remoteId: f6df12aa74e36230eb675f364fccd25a + urlAliasSchema: ~ + nameSchema: <name> + isContainer: false + mainLanguageCode: eng-GB + defaultAlwaysAvailable: true + defaultSortField: PATH + defaultSortOrder: ASC + FieldDefinitions: + _media-type: application/vnd.ibexa.api.FieldDefinitionList+json + _href: /api/ibexa/v2/content/types/5/fieldDefinitions + FieldDefinition: + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/5/fieldDefinitions/116 + id: 116 + identifier: name + fieldType: ibexa_string + fieldGroup: "" + position: 1 + isTranslatable: true + isRequired: true + isInfoCollector: false + defaultValue: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Name + descriptions: + value: [] + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: 150 + minStringLength: ~ + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/5/fieldDefinitions/117 + id: 117 + identifier: caption + fieldType: ibexa_richtext + fieldGroup: "" + position: 2 + isTranslatable: true + isRequired: false + isInfoCollector: false + defaultValue: + xml: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Caption + descriptions: + value: [] + fieldSettings: [] + validatorConfiguration: [] + - _media-type: application/vnd.ibexa.api.FieldDefinition+json + _href: /api/ibexa/v2/content/types/5/fieldDefinitions/118 + id: 118 + identifier: image + fieldType: ibexa_image + fieldGroup: "" + position: 3 + isTranslatable: true + isRequired: false + isInfoCollector: false + defaultValue: ~ + isSearchable: false + names: + value: + - _languageCode: eng-GB + '#text': Image + descriptions: + value: [] + fieldSettings: [] + validatorConfiguration: + FileSizeValidator: + maxFileSize: 10 + application/vnd.ibexa.api.ContentTypeInfoList+xml: schema: - $ref: '#/components/schemas/User' + $ref: '#/components/schemas/ContentTypeInfoList' example: | <?xml version="1.0" encoding="UTF-8"?> - <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/79" id="79" remoteId="bcf0764b417f05af21852a1f03fb1f13"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/> - <name>Jose Vargas</name> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/79/versions"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/12/79"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/79/locations"/> - <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/79/groups"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> - <publishDate>2021-06-29T08:23:42+00:00</publishDate> - <lastModificationDate>2021-07-29T11:45:07+00:00</lastModificationDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <alwaysAvailable>true</alwaysAvailable> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/79/versions/6"> - <VersionInfo> - <id>609</id> - <versionNo>6</versionNo> - <status>PUBLISHED</status> - <modificationDate>2021-07-29T11:45:07+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <creationDate>2021-07-29T11:45:07+00:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> - <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">Jose Vargas</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/79"/> - </VersionInfo> - <Fields> - <field> - <id>342</id> - <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Jose</fieldValue> - </field> - <field> - <id>343</id> - <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Vargas</fieldValue> - </field> - <field> - <id>344</id> - <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> - <fieldValue> - <value key="hasStoredLogin">true</value> - <value key="contentId">79</value> - <value key="login">josevargas</value> - <value key="email">aa@bb.cc</value> - <value key="passwordUpdatedAt"/> - <value key="enabled">false</value> - <value key="maxLogin">0</value> - <value key="plainPassword"/> - </fieldValue> - </field> - <field> - <id>345</id> - <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier> - <fieldValue/> - </field> - <field> - <id>346</id> - <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier> - <fieldValue/> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/79/versions/6/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - <login>josevargas</login> - <email>aa@bb.cc</email> - <enabled>false</enabled> - <UserGroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/users/79/groups"/> - <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/79/roles"/> - </User> - 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"?> - <UserUpdate> - <login>josevargas</login> - <enabled>false</enabled> - </UserUpdate> - 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: + <ContentTypeInfoList media-type="application/vnd.ibexa.api.ContentTypeInfoList+xml" href="/api/ibexa/v2/content/typegroups/1/types"> + <ContentTypeInfo media-type="application/vnd.ibexa.api.ContentTypeInfo+xml" href="/api/ibexa/v2/content/types/2"> + <id>2</id> + <status>DEFINED</status> + <identifier>article</identifier> + <names> + <value languageCode="eng-GB">Article</value> + </names> + <descriptions/> + <creationDate>2002-06-18T11:21:38+02:00</creationDate> + <modificationDate>2004-04-20T11:56:29+02:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2/draft"/> + <remoteId>c15b600eb9198b1924063b5a68758232</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><short_title|title></nameSchema> + <isContainer>true</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>false</defaultAlwaysAvailable> + <defaultSortField>PATH</defaultSortField> + <defaultSortOrder>ASC</defaultSortOrder> + </ContentTypeInfo> + <ContentTypeInfo media-type="application/vnd.ibexa.api.ContentTypeInfo+xml" href="/api/ibexa/v2/content/types/1"> + <id>1</id> + <status>DEFINED</status> + <identifier>folder</identifier> + <names> + <value languageCode="eng-GB">Folder</value> + </names> + <descriptions/> + <creationDate>2002-06-18T11:21:38+02:00</creationDate> + <modificationDate>2015-11-29T22:14:32+01:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/1/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1/draft"/> + <remoteId>a3d405b81be900468eb153d774f4f0d2</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><short_name|name></nameSchema> + <isContainer>true</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>true</defaultAlwaysAvailable> + <defaultSortField>PATH</defaultSortField> + <defaultSortOrder>ASC</defaultSortOrder> + </ContentTypeInfo> + </ContentTypeInfoList> + application/vnd.ibexa.api.ContentTypeList+json: schema: - $ref: '#/components/schemas/UserGroupRefListWrapper' + $ref: '#/components/schemas/ContentTypeListWrapper' 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: + 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: ~ + 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: ~ + - _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: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Short title + descriptions: + value: [] + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: 255 + minStringLength: ~ + - _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"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + 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"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + 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: ~ + 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: ~ + 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: ~ + - _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: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Short name + descriptions: + value: [] + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: 100 + minStringLength: ~ + - _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"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + 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"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + xhtml5edit: | + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + 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: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Title + descriptions: + value: [] + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: ~ + minStringLength: ~ + - _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: ~ + content_field_id: ~ + language_code: ~ + 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: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Title + descriptions: + value: + - _languageCode: eng-GB + '#text': Title + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: ~ + minStringLength: ~ + - _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: ~ + isSearchable: true + names: + value: + - _languageCode: eng-GB + '#text': Description + descriptions: + value: + - _languageCode: eng-GB + '#text': Landing page description + fieldSettings: [] + validatorConfiguration: + StringLengthValidator: + maxStringLength: ~ + minStringLength: ~ + - _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: ~ + availableLayouts: ~ + editorMode: page_view_mode + validatorConfiguration: [] + application/vnd.ibexa.api.ContentTypeList+xml: schema: - $ref: '#/components/schemas/UserGroupRefList' + $ref: '#/components/schemas/ContentTypeList' example: | <?xml version="1.0" encoding="UTF-8"?> - <UserGroupRefList media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/115/groups"> - <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/12"> - <unassign href="/api/ibexa/v2/user/users/79/groups/12" method="DELETE"/> - </UserGroup> - <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13"> - <unassign href="/api/ibexa/v2/user/users/115/groups/13" method="DELETE"/> - </UserGroup> - </UserGroupRefList> + <ContentTypeList media-type="application/vnd.ibexa.api.ContentTypeList+xml" href="/api/ibexa/v2/content/typegroups/1/types"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"> + <id>2</id> + <status>DEFINED</status> + <identifier>article</identifier> + <names> + <value languageCode="eng-GB">Article</value> + </names> + <descriptions/> + <creationDate>2002-06-18T11:21:38+02:00</creationDate> + <modificationDate>2004-04-20T11:56:29+02:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2/draft"/> + <remoteId>c15b600eb9198b1924063b5a68758232</remoteId> + <urlAliasSchema></urlAliasSchema> + <nameSchema><short_title|title></nameSchema> + <isContainer>true</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>false</defaultAlwaysAvailable> + <defaultSortField>PATH</defaultSortField> + <defaultSortOrder>ASC</defaultSortOrder> + <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions"> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/1"> + <id>1</id> + <identifier>title</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>1</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue>New article</defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Title</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">255</value> + <value key="minStringLength"/></value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/152"> + <id>152</id> + <identifier>short_title</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup></fieldGroup> + <position>2</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Short title</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="maxStringLength">255</value> + <value key="minStringLength"/></value> + </validatorConfiguration> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/153"> + <id>153</id> + <identifier>author</identifier> + <fieldType>ibexa_author</fieldType> + <fieldGroup></fieldGroup> + <position>3</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue/> + <isSearchable>false</isSearchable> + <names> + <value languageCode="eng-GB">Author</value> + </names> + <descriptions/> + <fieldSettings> + <value key="defaultAuthor">1</value> + </fieldSettings> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/120"> + <id>120</id> + <identifier>intro</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup></fieldGroup> + <position>4</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Intro</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/121"> + <id>121</id> + <identifier>body</identifier> + <fieldType>ibexa_richtext</fieldType> + <fieldGroup></fieldGroup> + <position>5</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> + </value> + <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + </value> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Body</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/123"> + <id>123</id> + <identifier>enable_comments</identifier> + <fieldType>ibexa_boolean</fieldType> + <fieldGroup></fieldGroup> + <position>6</position> + <isTranslatable>false</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue>false</defaultValue> + <isSearchable>false</isSearchable> + <names> + <value languageCode="eng-GB">Enable comments</value> + </names> + <descriptions/> + <fieldSettings/> + <validatorConfiguration/> + </FieldDefinition> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/154"> + <id>154</id> + <identifier>image</identifier> + <fieldType>ibexa_object_relation</fieldType> + <fieldGroup></fieldGroup> + <position>7</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="destinationContentId"/> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Image</value> + </names> + <descriptions/> + <fieldSettings> + <value key="selectionMethod">SELECTION_BROWSE</value> + <value key="selectionRoot"></value> + <value key="selectionContentTypes"/> + </fieldSettings> + <validatorConfiguration/> + </FieldDefinition> + </FieldDefinitions> + </ContentType> + </ContentTypeList> 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. + 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 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 + - name: contentTypeGroupId in: path - description: "" + description: ContentTypeListForGroupController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false post: - operationId: api_userusers_userIdgroups_post + operationId: ibexa.rest.create_content_type tags: - - User + - Type Groups responses: - 200: - description: "200" + 201: + description: Content type created. content: - application/vnd.ibexa.api.UserGroupRefList+json: + application/vnd.ibexa.api.ContentType+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: + $ref: '#/components/schemas/ContentTypeWrapper' + application/vnd.ibexa.api.ContentType+xml: schema: - $ref: '#/components/schemas/UserGroupRefList' + $ref: '#/components/schemas/ContentType' example: | <?xml version="1.0" encoding="UTF-8"?> - <UserGroupRefList media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/115/groups"> - <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/12"> - <unassign href="/api/ibexa/v2/user/users/79/groups/12" method="DELETE"/> - </UserGroup> - <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13"> - <unassign href="/api/ibexa/v2/user/users/115/groups/13" method="DELETE"/> - </UserGroup> - </UserGroupRefList> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/20/draft"> + <id>20</id> + <status>DRAFT</status> + <identifier>newContentType</identifier> + <names> + <value languageCode="eng-GB">New content type</value> + </names> + <descriptions> + <value languageCode="eng-GB">This is a description</value> + </descriptions> + <creationDate>2019-02-26T09:39:58+01:00</creationDate> + <modificationDate>2019-02-26T09:39:58+01:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/20/groups"/> + <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/20/draft"/> + <remoteId>remoteId-qwert548</remoteId> + <urlAliasSchema><title></urlAliasSchema> + <nameSchema><title></nameSchema> + <isContainer>true</isContainer> + <mainLanguageCode>eng-GB</mainLanguageCode> + <defaultAlwaysAvailable>true</defaultAlwaysAvailable> + <defaultSortField>PATH</defaultSortField> + <defaultSortOrder>ASC</defaultSortOrder> + <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/20/draft/fieldDefinitions"> + <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/20/draft/fieldDefinitions/223"> + <id>223</id> + <identifier>title</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup>content</fieldGroup> + <position>1</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue>New Title</defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-GB">Title</value> + </names> + <descriptions> + <value languageCode="eng-GB">This is the title</value> + </descriptions> + <fieldSettings/> + <validatorConfiguration> + <value key="StringLengthValidator"> + <value key="minStringLength">0</value> + <value key="maxStringLength"/></value> + </validatorConfiguration> + </FieldDefinition> + </FieldDefinitions> + </ContentType> + 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 assign User Groups. + description: Error - The user is not authorized to create this content type. 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. + 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 + - name: X-CSRF-Token in: header - description: If set, the link list of User Groups is returned in XML or JSON - format. + description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: userId + - name: contentTypeGroupId in: path - description: "" + description: ContentTypeCreateController identifier 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"?> - <UserGroupRefList media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/115/groups"> - <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/12"> - <unassign href="/api/ibexa/v2/user/users/79/groups/12" method="DELETE"/> - </UserGroup> - <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13"> - <unassign href="/api/ibexa/v2/user/users/115/groups/13" method="DELETE"/> - </UserGroup> - </UserGroupRefList> - 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: + description: The content type Create schema encoded in XML or JSON format. + 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"?> + <ContentTypeCreate> + <identifier>newContentType</identifier> + <names> + <value languageCode="eng-US">New content type</value> + </names> + <descriptions> + <value languageCode="eng-US">This is a description</value> + </descriptions> + <remoteId>remoteId-qwert548</remoteId> + <urlAliasSchema><title></urlAliasSchema> + <nameSchema><title></nameSchema> + <isContainer>true</isContainer> + <mainLanguageCode>eng-US</mainLanguageCode> + <defaultAlwaysAvailable>true</defaultAlwaysAvailable> + <defaultSortField>PATH</defaultSortField> + <defaultSortOrder>ASC</defaultSortOrder> + <FieldDefinitions> + <FieldDefinition> + <identifier>title</identifier> + <fieldType>ibexa_string</fieldType> + <fieldGroup>content</fieldGroup> + <position>1</position> + <isTranslatable>true</isTranslatable> + <isRequired>true</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue>New Title</defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-US">Title</value> + </names> + <descriptions> + <value languageCode="eng-US">This is the title</value> + </descriptions> + </FieldDefinition> + <FieldDefinition> + <identifier>summary</identifier> + <fieldType>ezxmltext</fieldType> + <fieldGroup>content</fieldGroup> + <position>2</position> + <isTranslatable>true</isTranslatable> + <isRequired>false</isRequired> + <isInfoCollector>false</isInfoCollector> + <defaultValue> + <value key="xml"><?xml version="1.0" encoding="utf-8"?><section/></value> + </defaultValue> + <isSearchable>true</isSearchable> + <names> + <value languageCode="eng-US">Summary</value> + </names> + <descriptions> + <value languageCode="eng-US">This is the summary</value> + </descriptions> + </FieldDefinition> + </FieldDefinitions> + </ContentTypeCreate> + required: false + /content/urlaliases: get: - operationId: ibexa.rest.load_role_assignments_for_user + operationId: ibexa.rest.list_global_url_aliases tags: - - User + - Url Alias responses: 200: - description: If set, the Role assignment list is returned in XML or JSON - format. + description: OK - returns the list of URL aliases. content: - application/vnd.ibexa.api.RoleAssignmentList+json: + application/vnd.ibexa.api.UrlAliasRefList+json: schema: - $ref: '#/components/schemas/RoleAssignmentListWrapper' + $ref: '#/components/schemas/UrlAliasRefListWrapper' example: - RoleAssignmentList: - _media-type: application/vnd.ibexa.api.RoleAssignmentList+json - _href: /api/ibexa/v2/user/users/115/roles - RoleAssignment: - - _media-type: application/vnd.ibexa.api.RoleAssignment+json - _href: /api/ibexa/v2/user/users/115/roles/2 - limitation: - _identifier: Section - values: - ref: - - _media-type: application/vnd.ibexa.api.ref+json - _href: "1" - Role: - _media-type: application/vnd.ibexa.api.Role+json - _href: /api/ibexa/v2/user/roles/2 - application/vnd.ibexa.api.RoleAssignmentList+xml: + 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/RoleAssignmentList' + $ref: '#/components/schemas/UrlAliasRefList' example: | <?xml version="1.0" encoding="UTF-8"?> - <RoleAssignmentList media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/115/roles"> - <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/users/115/roles/2"> - <limitation identifier="Section"> - <values> - <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/> - </values> - </limitation> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/2"/> - </RoleAssignment> - </RoleAssignmentList> - 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: userId - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false + <UrlAliasRefList media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/urlaliases"> + <UrlAlias media-type="application/vnd.ibexa.api.UrlAlias+xml" href="/api/ibexa/v2/content/urlaliases/0-2cecdff5f90b8595d76b68c417b09f36" /> + </UrlAliasRefList> + 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: [] post: - operationId: ibexa.rest.assign_role_to_user + operationId: ibexa.rest.create_url_alias tags: - - User + - Url Alias responses: - 200: - description: If set, the updated Role assignment list is returned in XML - or JSON format. + 201: + description: URL alias created. content: - application/vnd.ibexa.api.RoleAssignmentList+json: + application/vnd.ibexa.api.UrlAlias+json: schema: - $ref: '#/components/schemas/RoleAssignmentListWrapper' + $ref: '#/components/schemas/UrlAliasWrapper' example: - RoleAssignmentList: - _media-type: application/vnd.ibexa.api.RoleAssignmentList+json - _href: /api/ibexa/v2/user/users/115/roles - RoleAssignment: - - _media-type: application/vnd.ibexa.api.RoleAssignment+json - _href: /api/ibexa/v2/user/users/115/roles/2 - limitation: - _identifier: Section - values: - ref: - - _media-type: application/vnd.ibexa.api.ref+json - _href: "2" - Role: - _media-type: application/vnd.ibexa.api.Role+json - _href: /api/ibexa/v2/user/roles/2 - - _media-type: application/vnd.ibexa.api.RoleAssignment+json - _href: /api/ibexa/v2/user/users/115/roles/2 - limitation: - _identifier: Section - values: - ref: - - _media-type: application/vnd.ibexa.api.ref+json - _href: "1" - Role: - _media-type: application/vnd.ibexa.api.Role+json - _href: /api/ibexa/v2/user/roles/2 - application/vnd.ibexa.api.RoleAssignmentList+xml: + UrlAlias: + _media-type: application/vnd.ibexa.api.UrlAlias+json + _href: /api/ibexa/v2/content/urlaliases/0-f530173ad554787c1fe30dc929d98360 + _id: 0-f530173ad554787c1fe30dc929d98360 + _type: RESOURCE + resource: content/view/full + path: /example-global + languageCodes: eng-GB + alwaysAvailable: true + isHistory: false + forward: true + custom: true + application/vnd.ibexa.api.UrlAlias+xml: schema: - $ref: '#/components/schemas/RoleAssignmentList' + $ref: '#/components/schemas/UrlAlias' example: | <?xml version="1.0" encoding="UTF-8"?> - <RoleAssignmentList media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/115/roles"> - <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/users/115/roles/2"> - <limitation identifier="Section"> - <values> - <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/> - </values> - </limitation> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/2"/> - </RoleAssignment> - <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/users/115/roles/2"> - <limitation identifier="Section"> - <values> - <ref media-type="application/vnd.ibexa.api.ref+xml" href="2"/> - </values> - </limitation> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/2"/> - </RoleAssignment> - </RoleAssignmentList> + <UrlAlias media-type="application/vnd.ibexa.api.UrlAlias+xml" href="/api/ibexa/v2/content/urlaliases/0-deca3dadca45c3dff7861274b8e67ed7" id="0-deca3dadca45c3dff7861274b8e67ed7" type="LOCATION"> + <location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/59"/> + <path>/example-urlalias</path> + <languageCodes>eng-GB</languageCodes> + <alwaysAvailable>true</alwaysAvailable> + <isHistory>false</isHistory> + <forward>true</forward> + <custom>true</custom> + </UrlAlias> 400: - description: Error - validation of limitation in RoleAssignInput fails. + description: Error - The input does not match the input schema definition. 401: - description: Error - the user is not authorized to assign this Role. - summary: Assign Role to User - description: Assigns a Role to a user. + 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: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. 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 RoleAssignInput schema encoded in XML or JSON format. + description: The URL alias input schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.RoleAssignInput+json: + application/vnd.ibexa.api.UrlAliasCreate+json: schema: - $ref: '#/components/schemas/RoleAssignInputWrapper' + $ref: '#/components/schemas/UrlAliasCreateWrapper' 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: + 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/RoleAssignInput' + $ref: '#/components/schemas/UrlAliasCreate' example: | <?xml version="1.0" encoding="UTF-8"?> - <RoleAssignInput> - <Role href="/api/ibexa/v2/user/roles/2" media-type="application/vnd.ibexa.api.RoleAssignInput+xml"/> - <limitation identifier="Section"> - <values> - <ref href="/api/ibexa/v2/content/sections/1" media-type="application/vnd.ibexa.api.Section+xml" /> - <ref href="/api/ibexa/v2/content/sections/2" media-type="application/vnd.ibexa.api.Section+xml" /> - </values> - </limitation> - </RoleAssignInput> + <UrlAliasCreate type="LOCATION"> + <location href='/api/ibexa/v2/content/locations/1/2/59' /> + <path>example-global</path> + <languageCode>eng-GB</languageCode> + <alwaysAvailable>true</alwaysAvailable> + <forward>true</forward> + </UrlAliasCreate> required: false - deprecated: false - /user/users/{userId}/roles/{roleId}: + /content/urlaliases/{urlAliasId}: get: - operationId: ibexa.rest.load_role_assignment_for_user + operationId: ibexa.rest.load_url_alias tags: - - User + - Url Alias responses: 200: - description: OK - Role assignment to the given User Group. + description: OK - returns the URL alias. content: - application/vnd.ibexa.api.RoleAssignment+json: + application/vnd.ibexa.api.UrlAlias+json: schema: - $ref: '#/components/schemas/RoleAssignmentWrapper' + $ref: '#/components/schemas/UrlAliasWrapper' 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: + 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/RoleAssignment' + $ref: '#/components/schemas/UrlAlias' example: | <?xml version="1.0" encoding="UTF-8"?> - <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/users/113/roles/3"> - <limitation identifier="Section"> - <values> - <ref media-type="application/vnd.ibexa.api.ref+xml" href="6"/> - </values> - </limitation> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/3"/> - </RoleAssignment> + <UrlAlias media-type="application/vnd.ibexa.api.UrlAlias+xml" href="/api/ibexa/v2/content/urlaliases/0-2cecdff5f90b8595d76b68c417b09f36" id="0-2cecdff5f90b8595d76b68c417b09f36" type="RESOURCE"> + <resource>content/view/full</resource> + <path>/example-global</path> + <languageCodes>eng-GB</languageCodes> + <alwaysAvailable>true</alwaysAvailable> + <isHistory>false</isHistory> + <forward>true</forward> + <custom>true</custom> + </UrlAlias> 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. + 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: userId - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: roleId + - name: urlAliasId in: path - description: "" + description: URLAliasLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false delete: - operationId: ibexa.rest.unassign_role_from_user + operationId: ibexa.rest.delete_url_alias tags: - - User + - Url Alias responses: - 200: - description: If set, the updated Role assignment list is returned in XML - or JSON format. - 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"?> - <RoleAssignmentList href="/user/groups/1/5/65/roles" media-type="application/vnd.ibexa.api.RoleAssignmentList+xml"> - <RoleAssignment href="/user/groups/1/5/65/roles/5" media-type="application/vnd.ibexa.api.RoleAssignment+xml"> - <Role href="/user/roles/5" media-type="application/vnd.ibexa.api.Role+xml"/> - </RoleAssignment> - <RoleAssignment href="/user/groups/1/5/65/roles/11" media-type="application/vnd.ibexa.api.RoleAssignment+xml"> - <limitation identifier="Section"> - <values> - <ref href="/content/sections/1" media-type="application/vnd.ibexa.api.Section+xml" /> - <ref href="/content/sections/4" media-type="application/vnd.ibexa.api.Section+xml" /> - </values> - </limitation> - <Role href="/user/roles/11" media-type="application/vnd.ibexa.api.Role+xml"/> - </RoleAssignment> - </RoleAssignmentList> + 204: + description: No Content - URL alias deleted. 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. + 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: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. 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 + - name: urlAliasId in: path - description: "" + description: URLAliasDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - /user/users/{userId}/segments: + /content/urlwildcards: get: - operationId: ibexa.segmentation.rest.user.segments.view + operationId: ibexa.rest.list_url_wildcards tags: - - User + - Url Wildcard responses: 200: - description: If set, the user's segment list is returned in XML or JSON - format. + description: OK - returns a list of URL wildcards. content: - application/vnd.ibexa.api.UserSegmentList+json: + application/vnd.ibexa.api.UrlWildcardList+json: schema: - $ref: '#/components/schemas/UserSegmentListWrapper' + $ref: '#/components/schemas/UrlWildcardListWrapper' 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 - source: ibexa - lastUpdatedBy: "14" - updatedAt: "2026-06-30T12:00:00+00:00" - 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: + 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/UserSegmentList' + $ref: '#/components/schemas/UrlWildcardList' example: | <?xml version="1.0" encoding="UTF-8"?> - <UserSegmentList media-type="application/vnd.ibexa.api.UserSegmentList+xml" href="/api/ibexa/v2/user/users/14/segments"> - <UserSegment media-type="application/vnd.ibexa.api.UserSegment+xml"> - <id>1</id> - <identifier>corporate_account</identifier> - <name>Corporate Account</name> - <source>ibexa</source> - <lastUpdatedBy>14</lastUpdatedBy> - <updatedAt>2026-06-30T12:00:00+00:00</updatedAt> - <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts"/> - <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/1234"/> - </UserSegment> - </UserSegmentList> - 404: - description: Error - the user doesn't exist. - summary: View user segments - description: Return user's segment list. - parameters: - - name: userId - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false + <UrlWildcardList media-type="application/vnd.ibexa.api.UrlWildcardList+xml" href="/api/ibexa/v2/content/urlwildcards"> + <UrlWildcard media-type="application/vnd.ibexa.api.UrlWildcard+xml" href="/api/ibexa/v2/content/urlwildcards/1" id="1"> + <sourceUrl>/api/ibexa/v2/content/location/2</sourceUrl> + <destinationUrl>/api/ibexa/v2/content/location/59</destinationUrl> + <forward>true</forward> + </UrlWildcard> + </UrlWildcardList> + 401: + description: Error - The user has no permission to read URL wildcards. + summary: List URL wildcards + description: Returns a list of URL wildcards. + parameters: [] post: - operationId: ibexa.segmentation.rest.user.segments.assign + operationId: ibexa.rest.create_url_wildcard tags: - - User + - Url Wildcard responses: - 204: - description: No Content - segments assigned to user + 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/6 + _id: 6 + 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"?> + <UrlWildcard media-type="application/vnd.ibexa.api.UrlWildcard+xml" href="/api/ibexa/v2/content/urlwildcards/1" id="1"> + <sourceUrl>/api/ibexa/v2/content/location/2</sourceUrl> + <destinationUrl>/api/ibexa/v2/content/location/59</destinationUrl> + <forward>true</forward> + </UrlWildcard> + 400: + description: Error - The input does not match the input schema definition. 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. + 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: X-CSRF-Token in: header - description: The CSRF token. Used for POST, PATCH and DELETE requests. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: userId - in: path - description: "" + description: The CSRF Token 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 UserSegmentAssignInput schema encoded in XML or JSON format. + description: The URL Wildcard input schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.UserSegmentAssignInput+json: + application/vnd.ibexa.api.UrlWildcardCreate+json: schema: - $ref: '#/components/schemas/UserSegmentAssignInputWrapper' + $ref: '#/components/schemas/UrlWildcardCreateWrapper' example: - UserSegmentAssignInput: - segments: - - corporate_account - application/vnd.ibexa.api.UserSegmentAssignInput+xml: + 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/UserSegmentAssignInput' - example: | - <UserSegmentAssignInput> - <segments>corporate_account</segments> - </UserSegmentAssignInput> + $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 - /user/users/{userId}/segments/{segmentIdentifier}: - delete: - operationId: ibexa.segmentation.rest.user.segments.unnassign + /content/urlwildcards/{wildcardId}: + get: + operationId: ibexa.rest.load_url_wildcard tags: - - User + - Url Wildcard responses: - 204: - description: No Content - segments unassigned from user + 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"?> + <UrlWildcard media-type="application/vnd.ibexa.api.UrlWildcard+xml" href="/api/ibexa/v2/content/urlwildcards/4" id="4"> + <sourceUrl>/api/ibexa/v2/content/location/2</sourceUrl> + <destinationUrl>/api/ibexa/v2/content/location/59</destinationUrl> + <forward>true</forward> + </UrlWildcard> 401: - description: Error - the requesting user is not authorized to unassign this - segment from the given user. + description: Error - The user is not authorized to read URL wildcards. 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. + description: Error - The URL wildcard does not exist. + summary: Get URL wildcard + description: Returns the URL wildcard with the given ID. parameters: - - name: X-CSRF-Token - in: header - description: The CSRF token. Used for POST, PATCH and DELETE requests. + - name: wildcardId + in: path + description: URLWildcardLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: userId - in: path - description: "" + delete: + operationId: ibexa.rest.delete_url_wildcard + 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: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: segmentIdentifier + - name: wildcardId in: path - description: "" + description: URLWildcardDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - /user/groups: + /user/current: get: - operationId: api_usergroups_get + operationId: api_usercurrent_get tags: - - User Group + - User responses: 200: - description: "200" + description: OK - the User with the given ID. content: - application/vnd.ibexa.api.UserGroupList+json: + application/vnd.ibexa.api.User+json: schema: - $ref: '#/components/schemas/UserGroupListWrapper' + $ref: '#/components/schemas/UserListWrapper' 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 + 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: Administrator User + name: Jose Vargas Versions: _media-type: application/vnd.ibexa.api.VersionList+json - _href: /api/ibexa/v2/content/objects/14/versions + _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/13/15 + _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/14/locations + _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/14 - publishDate: "2002-10-06T16:13:50+00:00" - lastModificationDate: "2011-03-25T14:07:04+00:00" + _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/14/versions/3 + _href: /api/ibexa/v2/content/objects/79/versions/1 VersionInfo: - id: 499 - versionNo: 3 + id: 547 + versionNo: 1 status: PUBLISHED - modificationDate: "2011-03-25T14:07:04+00:00" + modificationDate: "2021-06-29T08:23:42+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" + _href: /api/ibexa/v2/user/users/10 + creationDate: "2021-06-29T08:23:42+00:00" initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: @@ -36663,48 +23850,48 @@ paths: names: value: - _languageCode: eng-GB - '#text': Administrator User + '#text': Jose Vargas Content: _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/14 + _href: /api/ibexa/v2/content/objects/79 Fields: field: - - id: 28 + - id: 342 fieldDefinitionIdentifier: first_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string - fieldValue: Administrator - - id: 29 + fieldValue: Jose + - id: 343 fieldDefinitionIdentifier: last_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string - fieldValue: User - - id: 30 + fieldValue: Vargas + - id: 344 fieldDefinitionIdentifier: user_account languageCode: eng-GB fieldTypeIdentifier: ibexa_user fieldValue: hasStoredLogin: true - contentId: 14 - login: admin - email: admin@link.invalid - passwordUpdatedAt: ~ + contentId: 79 + login: josevargas + email: aa@bb.cc + passwordUpdatedAt: 1624955022 enabled: true - maxLogin: 10 + maxLogin: 0 plainPassword: ~ - - id: 178 + - id: 345 fieldDefinitionIdentifier: signature languageCode: eng-GB fieldTypeIdentifier: ibexa_text fieldValue: ~ - - id: 180 + - id: 346 fieldDefinitionIdentifier: image languageCode: eng-GB fieldTypeIdentifier: ibexa_image fieldValue: ~ Relations: _media-type: application/vnd.ibexa.api.RelationList+json - _href: /api/ibexa/v2/content/objects/14/versions/3/relations + _href: /api/ibexa/v2/content/objects/79/versions/1/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json @@ -36712,44 +23899,42 @@ paths: width: ~ height: ~ mimeType: image/svg+xml - ParentUserGroup: - _media-type: application/vnd.ibexa.api.UserGroup+json - _href: /api/ibexa/v2/user/groups/1/5/13 - Subgroups: + login: josevargas + email: aa@bb.cc + enabled: true + UserGroups: _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 + _href: /api/ibexa/v2/user/users/79/groups 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: + _href: /api/ibexa/v2/user/users/79/roles + application/vnd.ibexa.api.User+xml: schema: - $ref: '#/components/schemas/UserGroupList' + $ref: '#/components/schemas/UserList' example: | <?xml version="1.0" encoding="UTF-8"?> - <UserGroupList media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/groups"> - <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13/15" id="14" remoteId="1bb4fe25487f05527efa8bfd394cecc7"> + <UserList media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/users"> + <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/79" id="79" remoteId="bcf0764b417f05af21852a1f03fb1f13"> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/> - <name>Administrator User</name> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/14/versions"/> + <name>Jose Vargas</name> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/79/versions"/> <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/13/15"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/14/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <publishDate>2002-10-06T16:13:50+00:00</publishDate> - <lastModificationDate>2011-03-25T14:07:04+00:00</lastModificationDate> + <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/12/79"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/79/locations"/> + <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/79/groups"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> + <publishDate>2021-06-29T08:23:42+00:00</publishDate> + <lastModificationDate>2021-06-29T08:23:42+00:00</lastModificationDate> <mainLanguageCode>eng-GB</mainLanguageCode> <alwaysAvailable>true</alwaysAvailable> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/14/versions/3"> + <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/79/versions/1"> <VersionInfo> - <id>499</id> - <versionNo>3</versionNo> + <id>547</id> + <versionNo>1</versionNo> <status>PUBLISHED</status> - <modificationDate>2011-03-25T14:07:04+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <creationDate>2011-03-25T14:03:03+00:00</creationDate> + <modificationDate>2021-06-29T08:23:42+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> + <creationDate>2021-06-29T08:23:42+00:00</creationDate> <initialLanguageCode>eng-GB</initialLanguageCode> <languageCodes>eng-GB</languageCodes> <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> @@ -36758,57 +23943,57 @@ paths: </Language> </VersionTranslationInfo> <names> - <value languageCode="eng-GB">Administrator User</value> + <value languageCode="eng-GB">Jose Vargas</value> </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/14"/> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/79"/> </VersionInfo> <Fields> <field> - <id>28</id> + <id>342</id> <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Administrator</fieldValue> + <fieldValue>Jose</fieldValue> </field> <field> - <id>29</id> + <id>343</id> <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>User</fieldValue> + <fieldValue>Vargas</fieldValue> </field> <field> - <id>30</id> + <id>344</id> <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> <fieldValue> <value key="hasStoredLogin">true</value> - <value key="contentId">14</value> - <value key="login">admin</value> - <value key="email">admin@link.invalid</value> - <value key="passwordUpdatedAt"/> + <value key="contentId">79</value> + <value key="login">josevargas</value> + <value key="email">aa@bb.cc</value> + <value key="passwordUpdatedAt">1624955022</value> <value key="enabled">true</value> - <value key="maxLogin">10</value> + <value key="maxLogin">0</value> <value key="plainPassword"/> </fieldValue> </field> <field> - <id>178</id> + <id>345</id> <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier> <fieldValue/> </field> <field> - <id>180</id> + <id>346</id> <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier> <fieldValue/> </field> </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/14/versions/3/relations"/> + <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/79/versions/1/relations"/> <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource> <width></width> @@ -36816,588 +24001,633 @@ paths: <mimeType>image/svg+xml</mimeType> </Thumbnail> </Version> - <ParentUserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13"/> - <Subgroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/groups/1/5/13/15/subgroups"/> - <Users media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/groups/1/5/13/15/users"/> - <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/13/15/roles"/> - </UserGroup> - </UserGroupList> - 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"?> - <UserGroupRefList media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/115/groups"> - <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/12"> - <unassign href="/api/ibexa/v2/user/users/79/groups/12" method="DELETE"/> - </UserGroup> - <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13"> - <unassign href="/api/ibexa/v2/user/users/115/groups/13" method="DELETE"/> - </UserGroup> - </UserGroupRefList> + <login>josevargas</login> + <email>aa@bb.cc</email> + <enabled>true</enabled> + <UserGroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/users/79/groups"/> + <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/79/roles"/> + </User> + </UserList> 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. + 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: 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. + 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/groups/root: + /user/users: 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 + operationId: api_userusers_get tags: - - User Group + - User responses: - 201: - description: Created - the User Group has been created + 200: + description: OK - Loads Users either for a given remote ID or Role. content: - application/vnd.ibexa.api.UserGroup+json: + application/vnd.ibexa.api.UserList+json: schema: - $ref: '#/components/schemas/UserGroupWrapper' + $ref: '#/components/schemas/UserListWrapper' 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: ~ - height: ~ - 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: + 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: ~ + - id: 345 + fieldDefinitionIdentifier: signature + languageCode: eng-GB + fieldTypeIdentifier: ibexa_text + fieldValue: ~ + - id: 346 + fieldDefinitionIdentifier: image + languageCode: eng-GB + fieldTypeIdentifier: ibexa_image + fieldValue: ~ + 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: ~ + height: ~ + 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/UserGroup' + $ref: '#/components/schemas/UserList' example: | <?xml version="1.0" encoding="UTF-8"?> - <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/79" id="85" remoteId="remoteId-qwert098"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/3"/> - <name>UserGroup2</name> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/85/versions"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/79"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/85/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <publishDate>2021-08-09T09:03:35+00:00</publishDate> - <lastModificationDate>2021-08-09T09:03:35+00:00</lastModificationDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <alwaysAvailable>true</alwaysAvailable> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/85/versions/1"> - <VersionInfo> - <id>576</id> - <versionNo>1</versionNo> - <status>PUBLISHED</status> - <modificationDate>2021-08-09T09:03:35+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <creationDate>2021-08-09T09:03:35+00:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> + <UserList media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/users"> + <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/79" id="79" remoteId="bcf0764b417f05af21852a1f03fb1f13"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/> + <name>Jose Vargas</name> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/79/versions"/> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> + <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/12/79"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/79/locations"/> + <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/79/groups"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> + <publishDate>2021-06-29T08:23:42+00:00</publishDate> + <lastModificationDate>2021-06-29T08:23:42+00:00</lastModificationDate> + <mainLanguageCode>eng-GB</mainLanguageCode> + <alwaysAvailable>true</alwaysAvailable> + <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/79/versions/1"> + <VersionInfo> + <id>547</id> + <versionNo>1</versionNo> + <status>PUBLISHED</status> + <modificationDate>2021-06-29T08:23:42+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> + <creationDate>2021-06-29T08:23:42+00:00</creationDate> + <initialLanguageCode>eng-GB</initialLanguageCode> + <languageCodes>eng-GB</languageCodes> + <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> + <Language> + <languageCode>eng-GB</languageCode> + </Language> + </VersionTranslationInfo> + <names> + <value languageCode="eng-GB">Jose Vargas</value> + </names> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/79"/> + </VersionInfo> + <Fields> + <field> + <id>342</id> + <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">UserGroup2</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/85"/> - </VersionInfo> - <Fields> - <field> - <id>380</id> - <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>UserGroup2</fieldValue> - </field> - <field> - <id>381</id> - <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>This is the description of the user group</fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/85/versions/1/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user_group</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - <ParentUserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5"/> - <Subgroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/groups/1/5/79/subgroups"/> - <Users media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/groups/1/5/79/users"/> - <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/79/roles"/> - </UserGroup> - 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'. + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue>Jose</fieldValue> + </field> + <field> + <id>343</id> + <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue>Vargas</fieldValue> + </field> + <field> + <id>344</id> + <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> + <fieldValue> + <value key="hasStoredLogin">true</value> + <value key="contentId">79</value> + <value key="login">josevargas</value> + <value key="email">aa@bb.cc</value> + <value key="passwordUpdatedAt">1624955022</value> + <value key="enabled">true</value> + <value key="maxLogin">0</value> + <value key="plainPassword"/> + </fieldValue> + </field> + <field> + <id>345</id> + <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier> + <fieldValue/> + </field> + <field> + <id>346</id> + <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier> + <fieldValue/> + </field> + </Fields> + <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/79/versions/1/relations"/> + <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> + <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource> + <width></width> + <height></height> + <mimeType>image/svg+xml</mimeType> + </Thumbnail> + </Version> + <login>josevargas</login> + <email>aa@bb.cc</email> + <enabled>true</enabled> + <UserGroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/users/79/groups"/> + <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/79/roles"/> + </User> + </UserList> + 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"?> + <UserRefList media-type="application/vnd.ibexa.api.UserRefList+xml" href="/api/ibexa/v2/user/users"> + <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + </UserRefList> + 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: 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. + 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 - 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"?> - <UserGroupCreate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <remoteId>remoteId-qwert098</remoteId> - <fields> - <field> - <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldValue>UserGroup</fieldValue> - </field> - <field> - <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldValue>This is the description of the user group</fieldValue> - </field> - </fields> - </UserGroupCreate> - required: false - deprecated: false - /user/groups/{path}: + 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: [] + /user/users/{userId}: get: - operationId: api_usergroups_path_get + operationId: api_userusers_userId_get tags: - - User Group + - User responses: 200: - description: OK - loads User Groups. + description: OK - the User with the given ID. content: - application/vnd.ibexa.api.UserGroup+json: + application/vnd.ibexa.api.User+json: schema: - $ref: '#/components/schemas/UserGroupWrapper' + $ref: '#/components/schemas/UserListWrapper' 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: ~ - height: ~ - 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: + 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: ~ + - id: 345 + fieldDefinitionIdentifier: signature + languageCode: eng-GB + fieldTypeIdentifier: ibexa_text + fieldValue: ~ + - id: 346 + fieldDefinitionIdentifier: image + languageCode: eng-GB + fieldTypeIdentifier: ibexa_image + fieldValue: ~ + 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: ~ + height: ~ + 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/UserGroup' + $ref: '#/components/schemas/UserList' example: | <?xml version="1.0" encoding="UTF-8"?> - <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/79" id="85" remoteId="remoteId-qwert098"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/3"/> - <name>UserGroup2</name> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/85/versions"/> - <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/79"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/85/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <publishDate>2021-08-09T09:03:35+00:00</publishDate> - <lastModificationDate>2021-08-09T09:03:35+00:00</lastModificationDate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <alwaysAvailable>true</alwaysAvailable> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/85/versions/1"> - <VersionInfo> - <id>576</id> - <versionNo>1</versionNo> - <status>PUBLISHED</status> - <modificationDate>2021-08-09T09:03:35+00:00</modificationDate> - <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <creationDate>2021-08-09T09:03:35+00:00</creationDate> - <initialLanguageCode>eng-GB</initialLanguageCode> - <languageCodes>eng-GB</languageCodes> - <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> - <Language> + <UserList media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/users"> + <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/79" id="79" remoteId="bcf0764b417f05af21852a1f03fb1f13"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/> + <name>Jose Vargas</name> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/79/versions"/> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> + <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/12/79"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/79/locations"/> + <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/79/groups"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> + <publishDate>2021-06-29T08:23:42+00:00</publishDate> + <lastModificationDate>2021-06-29T08:23:42+00:00</lastModificationDate> + <mainLanguageCode>eng-GB</mainLanguageCode> + <alwaysAvailable>true</alwaysAvailable> + <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/79/versions/1"> + <VersionInfo> + <id>547</id> + <versionNo>1</versionNo> + <status>PUBLISHED</status> + <modificationDate>2021-06-29T08:23:42+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> + <creationDate>2021-06-29T08:23:42+00:00</creationDate> + <initialLanguageCode>eng-GB</initialLanguageCode> + <languageCodes>eng-GB</languageCodes> + <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> + <Language> + <languageCode>eng-GB</languageCode> + </Language> + </VersionTranslationInfo> + <names> + <value languageCode="eng-GB">Jose Vargas</value> + </names> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/79"/> + </VersionInfo> + <Fields> + <field> + <id>342</id> + <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> - </Language> - </VersionTranslationInfo> - <names> - <value languageCode="eng-GB">UserGroup2</value> - </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/85"/> - </VersionInfo> - <Fields> - <field> - <id>380</id> - <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>UserGroup2</fieldValue> - </field> - <field> - <id>381</id> - <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>This is the description of the user group</fieldValue> - </field> - </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/85/versions/1/relations"/> - <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user_group</resource> - <width></width> - <height></height> - <mimeType>image/svg+xml</mimeType> - </Thumbnail> - </Version> - <ParentUserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5"/> - <Subgroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/groups/1/5/79/subgroups"/> - <Users media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/groups/1/5/79/users"/> - <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/79/roles"/> - </UserGroup> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue>Jose</fieldValue> + </field> + <field> + <id>343</id> + <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue>Vargas</fieldValue> + </field> + <field> + <id>344</id> + <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> + <fieldValue> + <value key="hasStoredLogin">true</value> + <value key="contentId">79</value> + <value key="login">josevargas</value> + <value key="email">aa@bb.cc</value> + <value key="passwordUpdatedAt">1624955022</value> + <value key="enabled">true</value> + <value key="maxLogin">0</value> + <value key="plainPassword"/> + </fieldValue> + </field> + <field> + <id>345</id> + <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier> + <fieldValue/> + </field> + <field> + <id>346</id> + <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier> + <fieldValue/> + </field> + </Fields> + <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/79/versions/1/relations"/> + <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> + <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource> + <width></width> + <height></height> + <mimeType>image/svg+xml</mimeType> + </Thumbnail> + </Version> + <login>josevargas</login> + <email>aa@bb.cc</email> + <enabled>true</enabled> + <UserGroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/users/79/groups"/> + <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/79/roles"/> + </User> + </UserList> 401: - description: Error - the user has no permission to read User Groups. + description: Error - the user has no permission to read Users. 404: - description: Error - the User Group does not exist. - summary: Load User Group - description: Loads User Groups for the given {path}. + 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 new User Group is returned in XML or JSON format. + 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: path + - name: userId in: path - description: "" + description: UserLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false delete: - operationId: api_usergroups_path_delete + operationId: api_userusers_userId_delete tags: - - User Group + - User responses: 204: - description: No content - the given User Group is deleted. + description: No Content. 401: - description: Error - the user is not authorized to delete this content type. + description: Error - the user is not authorized to delete this User. 403: - description: Error - the User Group is not empty. - summary: Delete User Group - description: The given User Group is deleted. + 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: path + - name: userId in: path - description: "" + description: UserDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false patch: - operationId: api_usergroups_path_patch + operationId: api_userusers_userId_patch tags: - - User Group + - User responses: 200: - description: OK - updated User Group. + description: OK - User updated. content: - application/vnd.ibexa.api.UserGroup+json: + application/vnd.ibexa.api.User+json: schema: - $ref: '#/components/schemas/UserGroupWrapper' + $ref: '#/components/schemas/UserWrapper' example: - UserGroup: - _media-type: application/vnd.ibexa.api.UserGroup+json - _href: /api/ibexa/v2/user/groups/1/5/81 - _id: 87 - _remoteId: remoteId-qwert098 + 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/3 - name: UserGroup2 + _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/87/versions + _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/81 + _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/87/locations + _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/14 - publishDate: "2021-08-09T09:06:49+00:00" - lastModificationDate: "2021-08-09T09:06:49+00:00" + _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/87/versions/1 + _href: /api/ibexa/v2/content/objects/79/versions/11 VersionInfo: - id: 578 - versionNo: 1 + id: 614 + versionNo: 11 status: PUBLISHED - modificationDate: "2021-08-09T09:06:49+00:00" + 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-08-09T09:06:49+00:00" + creationDate: "2021-07-29T12:00:24+00:00" initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: @@ -37407,69 +24637,90 @@ paths: names: value: - _languageCode: eng-GB - '#text': UserGroup2 + '#text': Jose Vargas Content: _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/87 + _href: /api/ibexa/v2/content/objects/79 Fields: field: - - id: 384 - fieldDefinitionIdentifier: name + - id: 342 + fieldDefinitionIdentifier: first_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string - fieldValue: UserGroup2 - - id: 385 - fieldDefinitionIdentifier: description + fieldValue: Jose + - id: 343 + fieldDefinitionIdentifier: last_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string - fieldValue: This is the description of the user group + 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: ~ + enabled: false + maxLogin: 0 + plainPassword: ~ + - id: 345 + fieldDefinitionIdentifier: signature + languageCode: eng-GB + fieldTypeIdentifier: ibexa_text + fieldValue: ~ + - id: 346 + fieldDefinitionIdentifier: image + languageCode: eng-GB + fieldTypeIdentifier: ibexa_image + fieldValue: ~ Relations: _media-type: application/vnd.ibexa.api.RelationList+json - _href: /api/ibexa/v2/content/objects/87/versions/1/relations + _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_group + resource: /bundles/ezplatformadminui/img/ez-icons.svg#user width: ~ height: ~ mimeType: image/svg+xml - ParentUserGroup: - _media-type: application/vnd.ibexa.api.UserGroup+json - _href: /api/ibexa/v2/user/groups/1/5 - Subgroups: + login: josevargas + email: aa@bb.cc + enabled: false + UserGroups: _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 + _href: /api/ibexa/v2/user/users/79/groups 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: + _href: /api/ibexa/v2/user/users/79/roles + application/vnd.ibexa.api.User+xml: schema: - $ref: '#/components/schemas/UserGroup' + $ref: '#/components/schemas/User' example: | <?xml version="1.0" encoding="UTF-8"?> - <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/79" id="85" remoteId="remoteId-qwert098"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/3"/> - <name>UserGroup2</name> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/85/versions"/> + <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/79" id="79" remoteId="bcf0764b417f05af21852a1f03fb1f13"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/> + <name>Jose Vargas</name> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/79/versions"/> <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/79"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/85/locations"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <publishDate>2021-08-09T09:03:35+00:00</publishDate> - <lastModificationDate>2021-08-09T09:03:35+00:00</lastModificationDate> + <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/12/79"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/79/locations"/> + <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/79/groups"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> + <publishDate>2021-06-29T08:23:42+00:00</publishDate> + <lastModificationDate>2021-07-29T11:45:07+00:00</lastModificationDate> <mainLanguageCode>eng-GB</mainLanguageCode> <alwaysAvailable>true</alwaysAvailable> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/85/versions/1"> + <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/79/versions/6"> <VersionInfo> - <id>576</id> - <versionNo>1</versionNo> + <id>609</id> + <versionNo>6</versionNo> <status>PUBLISHED</status> - <modificationDate>2021-08-09T09:03:35+00:00</modificationDate> + <modificationDate>2021-07-29T11:45:07+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <creationDate>2021-08-09T09:03:35+00:00</creationDate> + <creationDate>2021-07-29T11:45:07+00:00</creationDate> <initialLanguageCode>eng-GB</initialLanguageCode> <languageCodes>eng-GB</languageCodes> <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> @@ -37478,117 +24729,377 @@ paths: </Language> </VersionTranslationInfo> <names> - <value languageCode="eng-GB">UserGroup2</value> + <value languageCode="eng-GB">Jose Vargas</value> </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/85"/> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/79"/> </VersionInfo> <Fields> <field> - <id>380</id> - <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> + <id>342</id> + <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>UserGroup2</fieldValue> + <fieldValue>Jose</fieldValue> </field> <field> - <id>381</id> - <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> + <id>343</id> + <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>This is the description of the user group</fieldValue> + <fieldValue>Vargas</fieldValue> + </field> + <field> + <id>344</id> + <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> + <fieldValue> + <value key="hasStoredLogin">true</value> + <value key="contentId">79</value> + <value key="login">josevargas</value> + <value key="email">aa@bb.cc</value> + <value key="passwordUpdatedAt"/> + <value key="enabled">false</value> + <value key="maxLogin">0</value> + <value key="plainPassword"/> + </fieldValue> + </field> + <field> + <id>345</id> + <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier> + <fieldValue/> + </field> + <field> + <id>346</id> + <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier> + <fieldValue/> </field> </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/85/versions/1/relations"/> + <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/79/versions/6/relations"/> <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user_group</resource> + <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource> <width></width> <height></height> <mimeType>image/svg+xml</mimeType> </Thumbnail> </Version> - <ParentUserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5"/> - <Subgroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/groups/1/5/79/subgroups"/> - <Users media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/groups/1/5/79/users"/> - <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/79/roles"/> - </UserGroup> + <login>josevargas</login> + <email>aa@bb.cc</email> + <enabled>false</enabled> + <UserGroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/users/79/groups"/> + <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/79/roles"/> + </User> 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. + 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 + schema: + type: string + style: simple + explode: false + - name: Content-Type + in: header + description: The UserUpdate schema encoded in XML or JSON format. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: If-Match + in: header + description: Performs a PATCH only if the specified ETag is the current one. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: userId + in: path + description: UserUpdateController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: 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"?> + <UserUpdate> + <login>josevargas</login> + <enabled>false</enabled> + </UserUpdate> + required: 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 + schema: + type: string + style: simple + explode: false + - name: userId + in: path + description: UserDraftListController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + /user/users/{userId}/groups: + get: + operationId: api_userusers_userIdgroups_get + tags: + - User + responses: + 200: + description: OK - list of the User Groups the User belongs to. + 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"?> + <UserGroupRefList media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/115/groups"> + <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/12"> + <unassign href="/api/ibexa/v2/user/users/79/groups/12" method="DELETE"/> + </UserGroup> + <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13"> + <unassign href="/api/ibexa/v2/user/users/115/groups/13" method="DELETE"/> + </UserGroup> + </UserGroupRefList> + 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 + schema: + type: string + style: simple + explode: false + - name: userId + in: path + description: UserGroupsOfUserListController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + post: + operationId: api_userusers_userIdgroups_post + tags: + - User + responses: + 200: + description: OK - the User has been assigned to the User Group. + 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"?> + <UserGroupRefList media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/115/groups"> + <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/12"> + <unassign href="/api/ibexa/v2/user/users/79/groups/12" method="DELETE"/> + </UserGroup> + <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13"> + <unassign href="/api/ibexa/v2/user/users/115/groups/13" method="DELETE"/> + </UserGroup> + </UserGroupRefList> + 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 new User Group is returned in XML or JSON format. + 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: Content-Type - in: header - description: The UserGroupUpdate schema encoded in XML or JSON format. + - name: userId + in: path + description: UserAssignToUserGroupController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: If-Match + requestBody: + description: The new UserAssignToUserGroupController resource + content: [] + required: false + /user/users/{userId}/groups/{groupId}: + delete: + operationId: api_userusers_userIdgroups_groupId_delete + tags: + - User + responses: + 200: + description: OK - the User has been unassigned from the User Group. + 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"?> + <UserGroupRefList media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/115/groups"> + <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/12"> + <unassign href="/api/ibexa/v2/user/users/79/groups/12" method="DELETE"/> + </UserGroup> + <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13"> + <unassign href="/api/ibexa/v2/user/users/115/groups/13" method="DELETE"/> + </UserGroup> + </UserGroupRefList> + 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: Performs the PATCH only if the specified ETag is the current - one. Otherwise a 412 is returned. + 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: path + - name: userId in: path - description: "" + description: UserUnassignFromUserGroupController identifier 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: + - name: groupId + in: path + description: UserUnassignFromUserGroupController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + /user/users/{userId}/roles: get: - operationId: ibexa.rest.load_role_assignments_for_user_group + operationId: ibexa.rest.load_role_assignments_for_user tags: - - User Group + - User responses: 200: description: If set, the Role assignment list is returned in XML or JSON @@ -37598,41 +25109,54 @@ paths: schema: $ref: '#/components/schemas/RoleAssignmentListWrapper' example: - RoleAssignment: - _media-type: application/vnd.ibexa.api.RoleAssignment+json - _href: /api/ibexa/v2/user/groups/1/42/44/roles/1 - Role: - _media-type: application/vnd.ibexa.api.Role+json - _href: /api/ibexa/v2/user/roles/1 + RoleAssignmentList: + _media-type: application/vnd.ibexa.api.RoleAssignmentList+json + _href: /api/ibexa/v2/user/users/115/roles + RoleAssignment: + - _media-type: application/vnd.ibexa.api.RoleAssignment+json + _href: /api/ibexa/v2/user/users/115/roles/2 + limitation: + _identifier: Section + values: + ref: + - _media-type: application/vnd.ibexa.api.ref+json + _href: "1" + Role: + _media-type: application/vnd.ibexa.api.Role+json + _href: /api/ibexa/v2/user/roles/2 application/vnd.ibexa.api.RoleAssignmentList+xml: schema: $ref: '#/components/schemas/RoleAssignmentList' example: | <?xml version="1.0" encoding="UTF-8"?> - <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/42/44/roles/1"> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/1"/> - </RoleAssignment> + <RoleAssignmentList media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/115/roles"> + <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/users/115/roles/2"> + <limitation identifier="Section"> + <values> + <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/> + </values> + </limitation> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/2"/> + </RoleAssignment> + </RoleAssignmentList> 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. + summary: Load Roles for User + description: Returns a list of all Roles assigned to the given User. parameters: - - name: path + - name: userId in: path - description: "" + description: RoleAssignmentForUserListController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false post: - operationId: ibexa.rest.assign_role_to_user_group + operationId: ibexa.rest.assign_role_to_user tags: - - User Group + - User responses: 200: description: If set, the updated Role assignment list is returned in XML @@ -37644,10 +25168,27 @@ paths: example: RoleAssignmentList: _media-type: application/vnd.ibexa.api.RoleAssignmentList+json - _href: /api/ibexa/v2/user/groups/1/12/2/roles + _href: /api/ibexa/v2/user/users/115/roles RoleAssignment: - _media-type: application/vnd.ibexa.api.RoleAssignment+json - _href: /api/ibexa/v2/user/groups/1/12/2/roles/2 + _href: /api/ibexa/v2/user/users/115/roles/2 + limitation: + _identifier: Section + values: + ref: + - _media-type: application/vnd.ibexa.api.ref+json + _href: "2" + Role: + _media-type: application/vnd.ibexa.api.Role+json + _href: /api/ibexa/v2/user/roles/2 + - _media-type: application/vnd.ibexa.api.RoleAssignment+json + _href: /api/ibexa/v2/user/users/115/roles/2 + limitation: + _identifier: Section + values: + ref: + - _media-type: application/vnd.ibexa.api.ref+json + _href: "1" Role: _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/2 @@ -37656,61 +25197,49 @@ paths: $ref: '#/components/schemas/RoleAssignmentList' example: | <?xml version="1.0" encoding="UTF-8"?> - <RoleAssignmentList media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles"> - <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles/3"> - <limitation identifier="Section"> - <values> - <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/> - </values> - </limitation> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/3"/> - </RoleAssignment> - <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles/10"> - <limitation identifier="Section"> - <values> - <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/> - </values> - </limitation> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/10"/> - </RoleAssignment> - <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles/10"> - <limitation identifier="Section"> - <values> - <ref media-type="application/vnd.ibexa.api.ref+xml" href="4"/> - </values> - </limitation> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/10"/> - </RoleAssignment> + <RoleAssignmentList media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/115/roles"> + <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/users/115/roles/2"> + <limitation identifier="Section"> + <values> + <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/> + </values> + </limitation> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/2"/> + </RoleAssignment> + <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/users/115/roles/2"> + <limitation identifier="Section"> + <values> + <ref media-type="application/vnd.ibexa.api.ref+xml" href="2"/> + </values> + </limitation> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/2"/> + </RoleAssignment> </RoleAssignmentList> 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. + summary: Assign Role to User + description: Assigns a Role to a user. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: path + - name: userId in: path - description: "" + description: RoleAssignToUserController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: description: The RoleAssignInput schema encoded in XML or JSON format. content: @@ -37721,39 +25250,38 @@ paths: RoleAssignInput: Role: _href: /api/ibexa/v2/user/roles/2 - _media-type: application/vnd.ibexa.api.RoleAssignInput+json + _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+json - - _href: /api/ibexa/v2/content/sections/4 - _media-type: application/vnd.ibexa.api.Section+json + _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"?> <RoleAssignInput> - <Role href="/api/ibexa/v2/user/roles/10" media-type="application/vnd.ibexa.api.RoleAssignInput+xml"/> - <limitation identifier="Section"> - <values> - <ref href="/api/ibexa/v2/content/sections/1" media-type="application/vnd.ibexa.api.Section+xml" /> - <ref href="/api/ibexa/v2/content/sections/4" media-type="application/vnd.ibexa.api.Section+xml" /> - </values> - </limitation> + <Role href="/api/ibexa/v2/user/roles/2" media-type="application/vnd.ibexa.api.RoleAssignInput+xml"/> + <limitation identifier="Section"> + <values> + <ref href="/api/ibexa/v2/content/sections/1" media-type="application/vnd.ibexa.api.Section+xml" /> + <ref href="/api/ibexa/v2/content/sections/2" media-type="application/vnd.ibexa.api.Section+xml" /> + </values> + </limitation> </RoleAssignInput> required: false - deprecated: false - /user/groups/{path}/roles/{roleId}: + /user/users/{userId}/roles/{roleId}: get: - operationId: ibexa.rest.load_role_assignment_for_user_group + operationId: ibexa.rest.load_role_assignment_for_user tags: - - User Group + - User responses: 200: - description: OK - returns a Role assignment of the given User Group. + description: OK - Role assignment to the given User Group. content: application/vnd.ibexa.api.RoleAssignment+json: schema: @@ -37761,50 +25289,56 @@ paths: example: RoleAssignment: _media-type: application/vnd.ibexa.api.RoleAssignment+json - _href: /api/ibexa/v2/user/groups/1/11/12/roles/1 + _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/1 + _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"?> - <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/11/12/roles/1"> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/1"/> + <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/users/113/roles/3"> + <limitation identifier="Section"> + <values> + <ref media-type="application/vnd.ibexa.api.ref+xml" href="6"/> + </values> + </limitation> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/3"/> </RoleAssignment> 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. + summary: Load User Role Assignment + description: Returns a Role assignment to the given User. parameters: - - name: path + - name: userId in: path - description: "" + description: RoleAssignmentForUserLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: roleId in: path - description: "" + description: RoleAssignmentForUserLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false delete: - operationId: ibexa.rest.unassign_role_from_user_group + operationId: ibexa.rest.unassign_role_from_user tags: - - User Group + - User responses: 200: description: If set, the updated Role assignment list is returned in XML @@ -37816,81 +25350,234 @@ paths: example: RoleAssignmentList: _media-type: application/vnd.ibexa.api.RoleAssignmentList+json - _href: /api/ibexa/v2/user/groups/1/57/58/roles + _href: /api/ibexa/v2/user/users/57/roles RoleAssignment: - _media-type: application/vnd.ibexa.api.RoleAssignment+json - _href: /api/ibexa/v2/user/groups/1/57/58/roles/3 - limitation: - _identifier: Section - values: - ref: - - _media-type: application/vnd.ibexa.api.ref+json - _href: "1" + _href: /api/ibexa/v2/user/users/57/roles/1 Role: _media-type: application/vnd.ibexa.api.Role+json - _href: /api/ibexa/v2/user/roles/3 + _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"?> - <RoleAssignmentList media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles"> - <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles/3"> + <RoleAssignmentList href="/user/groups/1/5/65/roles" media-type="application/vnd.ibexa.api.RoleAssignmentList+xml"> + <RoleAssignment href="/user/groups/1/5/65/roles/5" media-type="application/vnd.ibexa.api.RoleAssignment+xml"> + <Role href="/user/roles/5" media-type="application/vnd.ibexa.api.Role+xml"/> + </RoleAssignment> + <RoleAssignment href="/user/groups/1/5/65/roles/11" media-type="application/vnd.ibexa.api.RoleAssignment+xml"> <limitation identifier="Section"> - <values> - <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/> - </values> + <values> + <ref href="/content/sections/1" media-type="application/vnd.ibexa.api.Section+xml" /> + <ref href="/content/sections/4" media-type="application/vnd.ibexa.api.Section+xml" /> + </values> </limitation> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/3"/> - </RoleAssignment> + <Role href="/user/roles/11" media-type="application/vnd.ibexa.api.Role+xml"/> + </RoleAssignment> </RoleAssignmentList> 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. + 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: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: userId + in: path + description: RoleUnassignFromUserController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: roleId + in: path + description: RoleUnassignFromUserController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + /user/users/{userId}/segments: + get: + operationId: ibexa.segmentation.rest.user.segments.view + tags: + - User + responses: + 200: + description: If set, the user's segment list is returned in XML or JSON + format. + 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 + source: cohesivo + lastUpdatedBy: "14" + updatedAt: "2026-06-30T12:00:00+00:00" + 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"?> + <UserSegmentList media-type="application/vnd.ibexa.api.UserSegmentList+xml" href="/api/ibexa/v2/user/users/14/segments"> + <UserSegment media-type="application/vnd.ibexa.api.UserSegment+xml"> + <id>1</id> + <identifier>corporate_account</identifier> + <name>Corporate Account</name> + <source>cohesivo</source> + <lastUpdatedBy>14</lastUpdatedBy> + <updatedAt>2026-06-30T12:00:00+00:00</updatedAt> + <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts"/> + <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/1234"/> + </UserSegment> + </UserSegmentList> + 404: + description: Error - the user doesn't exist. + summary: View user segments + description: Return user's segment list. + parameters: + - name: userId + in: path + description: UserSegmentListController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + post: + operationId: ibexa.segmentation.rest.user.segments.assign + 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: X-CSRF-Token + in: header + description: The CSRF token. Used for POST, PATCH and DELETE requests. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: userId + in: path + description: UserSegmentAssignController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + requestBody: + description: The UserSegmentAssignInput schema encoded in XML or JSON format. + 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> + <segments>corporate_account</segments> + </UserSegmentAssignInput> + required: false + /user/users/{userId}/segments/{segmentIdentifier}: + delete: + operationId: ibexa.segmentation.rest.user.segments.unnassign + 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: X-CSRF-Token in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + description: The CSRF token. Used for POST, PATCH and DELETE requests. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: path + - name: userId in: path - description: "" + description: UserSegmentUnassignController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: roleId + - name: segmentIdentifier in: path - description: "" + description: UserSegmentUnassignController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - /user/groups/{path}/subgroups: + /user/groups: get: - operationId: api_usergroups_pathsubgroups_get + operationId: api_usergroups_get tags: - User Group responses: 200: - description: OK - list of the subgroups. + description: OK - list of User Groups. content: application/vnd.ibexa.api.UserGroupList+json: schema: @@ -38132,43 +25819,39 @@ paths: </UserGroupRefList> 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. + 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 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: "" + 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: [] + /user/groups/subgroups: post: - operationId: api_usergroups_pathsubgroups_post + operationId: api_usergroupssubgroups_post tags: - User Group responses: 201: - description: "201" + description: Created - the User Group has been created content: application/vnd.ibexa.api.UserGroup+json: schema: @@ -38331,43 +26014,28 @@ paths: 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'. + 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 - - 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: @@ -38408,128 +26076,281 @@ paths: </fields> </UserGroupCreate> required: false - deprecated: false - /user/groups/{path}/users: + /user/groups/{path}: get: - operationId: api_usergroups_pathusers_get + operationId: api_usergroups_path_get tags: - User Group responses: 200: - description: OK - the Users of the Group with the given ID. + description: OK - loads User Groups. 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: + application/vnd.ibexa.api.UserGroup+json: schema: - $ref: '#/components/schemas/UserRefListWrapper' + $ref: '#/components/schemas/UserGroupWrapper' 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 + 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 - application/vnd.ibexa.api.UserRefList+xml: + 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: ~ + height: ~ + 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/UserRefList' + $ref: '#/components/schemas/UserGroup' example: | <?xml version="1.0" encoding="UTF-8"?> - <UserRefList media-type="application/vnd.ibexa.api.UserRefList+xml" href="/api/ibexa/v2/user/users"> - <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - </UserRefList> + <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/79" id="85" remoteId="remoteId-qwert098"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/3"/> + <name>UserGroup2</name> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/85/versions"/> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> + <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/79"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/85/locations"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <publishDate>2021-08-09T09:03:35+00:00</publishDate> + <lastModificationDate>2021-08-09T09:03:35+00:00</lastModificationDate> + <mainLanguageCode>eng-GB</mainLanguageCode> + <alwaysAvailable>true</alwaysAvailable> + <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/85/versions/1"> + <VersionInfo> + <id>576</id> + <versionNo>1</versionNo> + <status>PUBLISHED</status> + <modificationDate>2021-08-09T09:03:35+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <creationDate>2021-08-09T09:03:35+00:00</creationDate> + <initialLanguageCode>eng-GB</initialLanguageCode> + <languageCodes>eng-GB</languageCodes> + <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> + <Language> + <languageCode>eng-GB</languageCode> + </Language> + </VersionTranslationInfo> + <names> + <value languageCode="eng-GB">UserGroup2</value> + </names> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/85"/> + </VersionInfo> + <Fields> + <field> + <id>380</id> + <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue>UserGroup2</fieldValue> + </field> + <field> + <id>381</id> + <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue>This is the description of the user group</fieldValue> + </field> + </Fields> + <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/85/versions/1/relations"/> + <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> + <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user_group</resource> + <width></width> + <height></height> + <mimeType>image/svg+xml</mimeType> + </Thumbnail> + </Version> + <ParentUserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5"/> + <Subgroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/groups/1/5/79/subgroups"/> + <Users media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/groups/1/5/79/users"/> + <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/79/roles"/> + </UserGroup> 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. + summary: Load User Group + description: Loads User Groups for the given {path}. 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. + description: If set, the new User Group is returned in XML or JSON format. + required: true + deprecated: false + schema: + type: string + style: simple + explode: 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: "" + description: UserGroupLoadByPathController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - post: - operationId: api_usergroups_pathusers_post + delete: + operationId: api_usergroups_path_delete tags: - User Group responses: - 201: - description: "201" + 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: UserGroupDeleteController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + patch: + operationId: api_usergroups_path_patch + tags: + - User Group + responses: + 200: + description: OK - updated User Group. content: - application/vnd.ibexa.api.User+json: + application/vnd.ibexa.api.UserGroup+json: schema: - $ref: '#/components/schemas/UserWrapper' + $ref: '#/components/schemas/UserGroupWrapper' example: - User: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/79 - _id: 79 - _remoteId: bcf0764b417f05af21852a1f03fb1f13 + 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/4 - name: Jose Vargas + _href: /api/ibexa/v2/content/types/3 + name: UserGroup2 Versions: _media-type: application/vnd.ibexa.api.VersionList+json - _href: /api/ibexa/v2/content/objects/79/versions + _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/12/79 + _href: /api/ibexa/v2/content/locations/1/5/81 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 + _href: /api/ibexa/v2/content/objects/87/locations 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" + _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/79/versions/11 + _href: /api/ibexa/v2/content/objects/87/versions/1 VersionInfo: - id: 614 - versionNo: 11 + id: 578 + versionNo: 1 status: PUBLISHED - modificationDate: "2021-07-29T12:00:24+00:00" + 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-07-29T12:00:24+00:00" + creationDate: "2021-08-09T09:06:49+00:00" initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: @@ -38539,90 +26360,69 @@ paths: names: value: - _languageCode: eng-GB - '#text': Jose Vargas + '#text': UserGroup2 Content: _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/79 + _href: /api/ibexa/v2/content/objects/87 Fields: field: - - id: 342 - fieldDefinitionIdentifier: first_name + - id: 384 + fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string - fieldValue: Jose - - id: 343 - fieldDefinitionIdentifier: last_name + fieldValue: UserGroup2 + - id: 385 + fieldDefinitionIdentifier: description 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: ~ - enabled: false - maxLogin: 0 - plainPassword: ~ - - id: 345 - fieldDefinitionIdentifier: signature - languageCode: eng-GB - fieldTypeIdentifier: ibexa_text - fieldValue: ~ - - id: 346 - fieldDefinitionIdentifier: image - languageCode: eng-GB - fieldTypeIdentifier: ibexa_image - fieldValue: ~ + fieldValue: This is the description of the user group Relations: _media-type: application/vnd.ibexa.api.RelationList+json - _href: /api/ibexa/v2/content/objects/79/versions/11/relations + _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 + resource: /bundles/ezplatformadminui/img/ez-icons.svg#user_group width: ~ height: ~ mimeType: image/svg+xml - login: josevargas - email: aa@bb.cc - enabled: false - UserGroups: + 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/users/79/groups + _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/users/79/roles - application/vnd.ibexa.api.User+xml: + _href: /api/ibexa/v2/user/groups/1/5/81/roles + application/vnd.ibexa.api.UserGroup+xml: schema: - $ref: '#/components/schemas/User' + $ref: '#/components/schemas/UserGroup' example: | <?xml version="1.0" encoding="UTF-8"?> - <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/79" id="79" remoteId="bcf0764b417f05af21852a1f03fb1f13"> - <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/> - <name>Jose Vargas</name> - <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/79/versions"/> + <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/79" id="85" remoteId="remoteId-qwert098"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/3"/> + <name>UserGroup2</name> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/85/versions"/> <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> - <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/12/79"/> - <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/79/locations"/> - <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/79/groups"/> - <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> - <publishDate>2021-06-29T08:23:42+00:00</publishDate> - <lastModificationDate>2021-07-29T11:45:07+00:00</lastModificationDate> + <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/79"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/85/locations"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <publishDate>2021-08-09T09:03:35+00:00</publishDate> + <lastModificationDate>2021-08-09T09:03:35+00:00</lastModificationDate> <mainLanguageCode>eng-GB</mainLanguageCode> <alwaysAvailable>true</alwaysAvailable> - <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/79/versions/6"> + <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/85/versions/1"> <VersionInfo> - <id>609</id> - <versionNo>6</versionNo> + <id>576</id> + <versionNo>1</versionNo> <status>PUBLISHED</status> - <modificationDate>2021-07-29T11:45:07+00:00</modificationDate> + <modificationDate>2021-08-09T09:03:35+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - <creationDate>2021-07-29T11:45:07+00:00</creationDate> + <creationDate>2021-08-09T09:03:35+00:00</creationDate> <initialLanguageCode>eng-GB</initialLanguageCode> <languageCodes>eng-GB</languageCodes> <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> @@ -38631,926 +26431,1290 @@ paths: </Language> </VersionTranslationInfo> <names> - <value languageCode="eng-GB">Jose Vargas</value> + <value languageCode="eng-GB">UserGroup2</value> </names> - <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/79"/> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/85"/> </VersionInfo> <Fields> <field> - <id>342</id> - <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> + <id>380</id> + <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Jose</fieldValue> + <fieldValue>UserGroup2</fieldValue> </field> <field> - <id>343</id> - <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> + <id>381</id> + <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> - <fieldValue>Vargas</fieldValue> - </field> - <field> - <id>344</id> - <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> - <fieldValue> - <value key="hasStoredLogin">true</value> - <value key="contentId">79</value> - <value key="login">josevargas</value> - <value key="email">aa@bb.cc</value> - <value key="passwordUpdatedAt"/> - <value key="enabled">false</value> - <value key="maxLogin">0</value> - <value key="plainPassword"/> - </fieldValue> - </field> - <field> - <id>345</id> - <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier> - <fieldValue/> - </field> - <field> - <id>346</id> - <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier> - <fieldValue/> + <fieldValue>This is the description of the user group</fieldValue> </field> </Fields> - <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/79/versions/6/relations"/> + <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/85/versions/1/relations"/> <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> - <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource> + <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user_group</resource> <width></width> <height></height> <mimeType>image/svg+xml</mimeType> </Thumbnail> </Version> - <login>josevargas</login> - <email>aa@bb.cc</email> - <enabled>false</enabled> - <UserGroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/users/79/groups"/> - <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/79/roles"/> - </User> + <ParentUserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5"/> + <Subgroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/groups/1/5/79/subgroups"/> + <Users media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/groups/1/5/79/users"/> + <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/79/roles"/> + </UserGroup> 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. + 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 is returned in XML or JSON format. + 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 UserCreate schema encoded in XML or JSON format. + description: The UserGroupUpdate schema encoded in XML or JSON format. + required: true + deprecated: false + schema: + type: string + style: simple + explode: 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: "" + description: UserGroupUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The new UserCreateController resource + description: The updated UserGroupUpdateController resource content: - application/vnd.ibexa.api.UserCreate+json: + application/vnd.ibexa.api.UserGroupUpdate+json: schema: - $ref: '#/components/schemas/UserCreateWrapper' + $ref: '#/components/schemas/UserGroupUpdateWrapper' 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: + UserGroupUpdate: + Section: + _href: /api/ibexa/v2/content/sections/2 + application/vnd.ibexa.api.UserGroupUpdate+xml: schema: - $ref: '#/components/schemas/UserCreate' - example: | - <?xml version="1.0" encoding="UTF-8"?> - <UserCreate> - <mainLanguageCode>eng-GB</mainLanguageCode> - <remoteId>remoteId-23456789</remoteId> - <login>johnsmith</login> - <email>example@example.com</email> - <password>Secrepassword5!</password> - <fields> - <field> - <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldValue>John</fieldValue> - </field> - <field> - <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldValue>Smith</fieldValue> - </field> - <field> - <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> - <languageCode>eng-GB</languageCode> - <fieldValue> - <value key="hasStoredLogin">true</value> - <value key="contentId">14</value> - <value key="login">johnsmith</value> - <value key="email">example@example.com</value> - <value key="enabled">true</value> - <value key="maxLogin">10</value> - </fieldValue> - </field> - </fields> - </UserCreate> + $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/policies: - get: - operationId: ibexa.rest.list_policies_for_user - 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/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"?> - <PolicyList media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/policies"> - <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/349"> - <id>349</id> - <module>content</module> - <function>read</function> - <limitations> - <limitation identifier="Section"> - <values> - <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/> - <ref media-type="application/vnd.ibexa.api.ref+xml" href="3"/> - <ref media-type="application/vnd.ibexa.api.ref+xml" href="6"/> - </values> - </limitation> - </limitations> - </Policy> - <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/350"> - <id>350</id> - <module>user</module> - <function>login</function> - <limitations> - <limitation identifier="SiteAccess"> - <values> - <ref media-type="application/vnd.ibexa.api.ref+xml" href="2282622326"/> - <ref media-type="application/vnd.ibexa.api.ref+xml" href="1766001124"/> - </values> - </limitation> - </limitations> - </Policy> - <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/351"> - <id>351</id> - <module>content</module> - <function>view_embed</function> - <limitations> - <limitation identifier="Class"> - <values> - <ref media-type="application/vnd.ibexa.api.ref+xml" href="5"/> - <ref media-type="application/vnd.ibexa.api.ref+xml" href="12"/> - </values> - </limitation> - </limitations> - </Policy> - <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/352"> - <id>352</id> - <module>user</module> - <function>register</function> - </Policy> - <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/353"> - <id>353</id> - <module>user</module> - <function>password</function> - </Policy> - </PolicyList> - 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: [] - deprecated: false - /user/roles: + /user/groups/{path}/roles: get: - operationId: ibexa.rest.list_roles + operationId: ibexa.rest.load_role_assignments_for_user_group tags: - - User Role + - User Group responses: 200: - description: OK - list of all Roles. + description: If set, the Role assignment list is returned in XML or JSON + format. content: - application/vnd.ibexa.api.RoleList+json: + application/vnd.ibexa.api.RoleAssignmentList+json: schema: - $ref: '#/components/schemas/RoleListWrapper' + $ref: '#/components/schemas/RoleAssignmentListWrapper' example: - RoleList: - _media-type: application/vnd.ibexa.api.RoleList+json - _href: /api/ibexa/v2/user/roles + RoleAssignment: + _media-type: application/vnd.ibexa.api.RoleAssignment+json + _href: /api/ibexa/v2/user/groups/1/42/44/roles/1 Role: - - _media-type: application/vnd.ibexa.api.Role+json + _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: + application/vnd.ibexa.api.RoleAssignmentList+xml: schema: - $ref: '#/components/schemas/RoleList' + $ref: '#/components/schemas/RoleAssignmentList' example: | <?xml version="1.0" encoding="UTF-8"?> - <RoleList media-type="application/vnd.ibexa.api.RoleList+xml" href="/api/ibexa/v2/user/roles"> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/1"> - <identifier>Anonymous</identifier> - <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/1/policies"/> - </Role> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/2"> - <identifier>Administrator</identifier> - <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/2/policies"/> - </Role> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/3"> - <identifier>Editor</identifier> - <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/3/policies"/> - </Role> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/4"> - <identifier>Member</identifier> - <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/4/policies"/> - </Role> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/10"> - <identifier>NewRole</identifier> - <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/10/policies"/> - </Role> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/14"> - <identifier>NewRole5</identifier> - <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/14/policies"/> - </Role> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/15"> - <identifier>NewRole7</identifier> - <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/15/policies"/> - </Role> - </RoleList> - 401: + <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/42/44/roles/1"> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/1"/> + </RoleAssignment> + 400: description: Error - the user has no permission to read Roles. - summary: Load Roles - description: Returns a list of all Roles. - parameters: [] - deprecated: false + summary: Load Roles for User Group + description: Returns a list of all Roles assigned to the given User Group. + parameters: + - name: path + in: path + description: RoleAssignmentForUserGroupListController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false post: - operationId: ibexa.rest.create_role + operationId: ibexa.rest.assign_role_to_user_group tags: - - User Role + - User Group responses: - 201: - description: If set, the new user is returned in XML or JSON format. + 200: + description: If set, the updated Role assignment list is returned in XML + or JSON format. content: - application/vnd.ibexa.api.Role+json: + application/vnd.ibexa.api.RoleAssignmentList+json: schema: - $ref: '#/components/schemas/RoleWrapper' + $ref: '#/components/schemas/RoleAssignmentListWrapper' example: - Role: - _media-type: application/vnd.ibexa.api.Role+json - _href: /api/ibexa/v2/user/roles/21 - identifier: NewRole - Policies: - _media-type: application/vnd.ibexa.api.PolicyList+json - _href: /api/ibexa/v2/user/roles/21/policies - application/vnd.ibexa.api.Role+xml: + RoleAssignmentList: + _media-type: application/vnd.ibexa.api.RoleAssignmentList+json + _href: /api/ibexa/v2/user/groups/1/12/2/roles + RoleAssignment: + - _media-type: application/vnd.ibexa.api.RoleAssignment+json + _href: /api/ibexa/v2/user/groups/1/12/2/roles/2 + Role: + _media-type: application/vnd.ibexa.api.Role+json + _href: /api/ibexa/v2/user/roles/2 + application/vnd.ibexa.api.RoleAssignmentList+xml: schema: - $ref: '#/components/schemas/Role' + $ref: '#/components/schemas/RoleAssignmentList' example: | <?xml version="1.0" encoding="UTF-8"?> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/19"> - <identifier>NewRole</identifier> - <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/19/policies"/> - </Role> + <RoleAssignmentList media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles"> + <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles/3"> + <limitation identifier="Section"> + <values> + <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/> + </values> + </limitation> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/3"/> + </RoleAssignment> + <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles/10"> + <limitation identifier="Section"> + <values> + <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/> + </values> + </limitation> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/10"/> + </RoleAssignment> + <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles/10"> + <limitation identifier="Section"> + <values> + <ref media-type="application/vnd.ibexa.api.ref+xml" href="4"/> + </values> + </limitation> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/10"/> + </RoleAssignment> + </RoleAssignmentList> 400: - description: Error - the input does not match the input schema definition. + description: Error - validation of limitation in RoleAssignInput fails. 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. + 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: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false + - name: path + in: path + description: RoleAssignToUserGroupController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false requestBody: - description: The RoleInput schema encoded in XML or JSON. + description: The RoleAssignInput schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.RoleInput+json: + application/vnd.ibexa.api.RoleAssignInput+json: schema: - $ref: '#/components/schemas/RoleInputWrapper' + $ref: '#/components/schemas/RoleAssignInputWrapper' example: - RoleInput: - identifier: NewRole - application/vnd.ibexa.api.RoleInput+xml: + RoleAssignInput: + Role: + _href: /api/ibexa/v2/user/roles/2 + _media-type: application/vnd.ibexa.api.RoleAssignInput+json + limitation: + _identifier: Section + values: + ref: + - _href: /api/ibexa/v2/content/sections/1 + _media-type: application/vnd.ibexa.api.Section+json + - _href: /api/ibexa/v2/content/sections/4 + _media-type: application/vnd.ibexa.api.Section+json + application/vnd.ibexa.api.RoleAssignInput+xml: schema: - $ref: '#/components/schemas/RoleInput' - example: |- + $ref: '#/components/schemas/RoleAssignInput' + example: | <?xml version="1.0" encoding="UTF-8"?> - <RoleInput> - <identifier>NewRole</identifier> - </RoleInput> + <RoleAssignInput> + <Role href="/api/ibexa/v2/user/roles/10" media-type="application/vnd.ibexa.api.RoleAssignInput+xml"/> + <limitation identifier="Section"> + <values> + <ref href="/api/ibexa/v2/content/sections/1" media-type="application/vnd.ibexa.api.Section+xml" /> + <ref href="/api/ibexa/v2/content/sections/4" media-type="application/vnd.ibexa.api.Section+xml" /> + </values> + </limitation> + </RoleAssignInput> required: false - deprecated: false - /user/roles/{id}: + /user/groups/{path}/roles/{roleId}: get: - operationId: ibexa.rest.load_role + operationId: ibexa.rest.load_role_assignment_for_user_group tags: - - User Role + - User Group responses: 200: - description: OK - Role for the given ID. + description: OK - returns a Role assignment of the given User Group. content: - application/vnd.ibexa.api.Role+json: + application/vnd.ibexa.api.RoleAssignment+json: schema: - $ref: '#/components/schemas/RoleWrapper' + $ref: '#/components/schemas/RoleAssignmentWrapper' example: - Role: - _media-type: application/vnd.ibexa.api.Role+json - _href: /api/ibexa/v2/user/roles/21 - identifier: NewRole - Policies: - _media-type: application/vnd.ibexa.api.PolicyList+json - _href: /api/ibexa/v2/user/roles/21/policies - application/vnd.ibexa.api.Role+xml: + RoleAssignment: + _media-type: application/vnd.ibexa.api.RoleAssignment+json + _href: /api/ibexa/v2/user/groups/1/11/12/roles/1 + Role: + _media-type: application/vnd.ibexa.api.Role+json + _href: /api/ibexa/v2/user/roles/1 + application/vnd.ibexa.api.RoleAssignment+xml: schema: - $ref: '#/components/schemas/Role' + $ref: '#/components/schemas/RoleAssignment' example: | <?xml version="1.0" encoding="UTF-8"?> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/21"> - <identifier>NewRole</identifier> - <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/21/policies"/> - </Role> + <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/11/12/roles/1"> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/1"/> + </RoleAssignment> 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. + summary: Load User Group Role Assignment + description: Returns a Role assignment of the given User Group. parameters: - - name: If-None-Match - in: header - description: ETag - required: false + - name: path + in: path + description: RoleAssignmentForUserGroupLoadByIdController identifier + required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: id + - name: roleId in: path - description: "" + description: RoleAssignmentForUserGroupLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - post: - operationId: ibexa.rest.create_role_draft + delete: + operationId: ibexa.rest.unassign_role_from_user_group tags: - - User Role + - User Group responses: - 201: - description: If set, the new user is returned in XML or JSON format. + 200: + description: If set, the updated Role assignment list is returned in XML + or JSON format. 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: Editor - Policies: - _media-type: application/vnd.ibexa.api.PolicyList+json - _href: /api/ibexa/v2/user/roles/6/policies - application/vnd.ibexa.api.RoleDraft+xml: + application/vnd.ibexa.api.RoleAssignmentList+json: schema: - $ref: '#/components/schemas/RoleDraft' + $ref: '#/components/schemas/RoleAssignmentListWrapper' + example: + RoleAssignmentList: + _media-type: application/vnd.ibexa.api.RoleAssignmentList+json + _href: /api/ibexa/v2/user/groups/1/57/58/roles + RoleAssignment: + - _media-type: application/vnd.ibexa.api.RoleAssignment+json + _href: /api/ibexa/v2/user/groups/1/57/58/roles/3 + limitation: + _identifier: Section + values: + ref: + - _media-type: application/vnd.ibexa.api.ref+json + _href: "1" + Role: + _media-type: application/vnd.ibexa.api.Role+json + _href: /api/ibexa/v2/user/roles/3 + application/vnd.ibexa.api.RoleAssignmentList+xml: + schema: + $ref: '#/components/schemas/RoleAssignmentList' example: | <?xml version="1.0" encoding="UTF-8"?> - <Role href="/user/roles/11" media-type="application/vnd.ibexa.api.RoleDraft+xml"> - <identifier>MyRole</identifier> - <Policies href="/user/roles/11/policies" media-type="application/vnd.ibexa.api.PolicyList+xml"/> - </Role> + <RoleAssignmentList media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles"> + <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles/3"> + <limitation identifier="Section"> + <values> + <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/> + </values> + </limitation> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/3"/> + </RoleAssignment> + </RoleAssignmentList> 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. + 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: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: id + - name: path in: path - description: "" + description: RoleUnassignFromUserGroupController identifier 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 - delete: - operationId: ibexa.rest.delete_role + - name: roleId + in: path + description: RoleUnassignFromUserGroupController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + /user/groups/{path}/subgroups: + get: + operationId: api_usergroups_pathsubgroups_get tags: - - User Role + - User Group responses: - 204: - description: No Content. + 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: ~ + enabled: true + maxLogin: 10 + plainPassword: ~ + - id: 178 + fieldDefinitionIdentifier: signature + languageCode: eng-GB + fieldTypeIdentifier: ibexa_text + fieldValue: ~ + - id: 180 + fieldDefinitionIdentifier: image + languageCode: eng-GB + fieldTypeIdentifier: ibexa_image + fieldValue: ~ + 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: ~ + height: ~ + 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"?> + <UserGroupList media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/groups"> + <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13/15" id="14" remoteId="1bb4fe25487f05527efa8bfd394cecc7"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/> + <name>Administrator User</name> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/14/versions"/> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> + <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/13/15"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/14/locations"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <publishDate>2002-10-06T16:13:50+00:00</publishDate> + <lastModificationDate>2011-03-25T14:07:04+00:00</lastModificationDate> + <mainLanguageCode>eng-GB</mainLanguageCode> + <alwaysAvailable>true</alwaysAvailable> + <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/14/versions/3"> + <VersionInfo> + <id>499</id> + <versionNo>3</versionNo> + <status>PUBLISHED</status> + <modificationDate>2011-03-25T14:07:04+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <creationDate>2011-03-25T14:03:03+00:00</creationDate> + <initialLanguageCode>eng-GB</initialLanguageCode> + <languageCodes>eng-GB</languageCodes> + <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> + <Language> + <languageCode>eng-GB</languageCode> + </Language> + </VersionTranslationInfo> + <names> + <value languageCode="eng-GB">Administrator User</value> + </names> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/14"/> + </VersionInfo> + <Fields> + <field> + <id>28</id> + <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue>Administrator</fieldValue> + </field> + <field> + <id>29</id> + <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue>User</fieldValue> + </field> + <field> + <id>30</id> + <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> + <fieldValue> + <value key="hasStoredLogin">true</value> + <value key="contentId">14</value> + <value key="login">admin</value> + <value key="email">admin@link.invalid</value> + <value key="passwordUpdatedAt"/> + <value key="enabled">true</value> + <value key="maxLogin">10</value> + <value key="plainPassword"/> + </fieldValue> + </field> + <field> + <id>178</id> + <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier> + <fieldValue/> + </field> + <field> + <id>180</id> + <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier> + <fieldValue/> + </field> + </Fields> + <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/14/versions/3/relations"/> + <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> + <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource> + <width></width> + <height></height> + <mimeType>image/svg+xml</mimeType> + </Thumbnail> + </Version> + <ParentUserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13"/> + <Subgroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/groups/1/5/13/15/subgroups"/> + <Users media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/groups/1/5/13/15/users"/> + <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/13/15/roles"/> + </UserGroup> + </UserGroupList> + 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"?> + <UserGroupRefList media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/115/groups"> + <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/12"> + <unassign href="/api/ibexa/v2/user/users/79/groups/12" method="DELETE"/> + </UserGroup> + <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13"> + <unassign href="/api/ibexa/v2/user/users/115/groups/13" method="DELETE"/> + </UserGroup> + </UserGroupRefList> 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. + 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: X-CSRF-Token + - name: Accept in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + 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: id + - name: path in: path - description: "" + description: UserSubGroupListController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - patch: - operationId: ibexa.rest.update_role + post: + operationId: api_usergroups_pathsubgroups_post tags: - - User Role + - User Group responses: - 200: - description: OK - Role updated + 201: + description: Created - the User Group has been created. content: - application/vnd.ibexa.api.Role+json: + application/vnd.ibexa.api.UserGroup+json: schema: - $ref: '#/components/schemas/RoleWrapper' + $ref: '#/components/schemas/UserGroupWrapper' example: - Role: - _media-type: application/vnd.ibexa.api.Role+json - _href: /api/ibexa/v2/user/roles/21 - identifier: NewIdentifier - Policies: - _media-type: application/vnd.ibexa.api.PolicyList+json - _href: /api/ibexa/v2/user/roles/21/policies - application/vnd.ibexa.api.Role+xml: + 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: ~ + height: ~ + 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/Role' + $ref: '#/components/schemas/UserGroup' example: | <?xml version="1.0" encoding="UTF-8"?> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/5"> - <identifier>NewIdentifier</identifier> - <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/5/policies"/> - </Role> - 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 + <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/79" id="85" remoteId="remoteId-qwert098"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/3"/> + <name>UserGroup2</name> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/85/versions"/> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> + <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/79"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/85/locations"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <publishDate>2021-08-09T09:03:35+00:00</publishDate> + <lastModificationDate>2021-08-09T09:03:35+00:00</lastModificationDate> + <mainLanguageCode>eng-GB</mainLanguageCode> + <alwaysAvailable>true</alwaysAvailable> + <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/85/versions/1"> + <VersionInfo> + <id>576</id> + <versionNo>1</versionNo> + <status>PUBLISHED</status> + <modificationDate>2021-08-09T09:03:35+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <creationDate>2021-08-09T09:03:35+00:00</creationDate> + <initialLanguageCode>eng-GB</initialLanguageCode> + <languageCodes>eng-GB</languageCodes> + <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> + <Language> + <languageCode>eng-GB</languageCode> + </Language> + </VersionTranslationInfo> + <names> + <value languageCode="eng-GB">UserGroup2</value> + </names> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/85"/> + </VersionInfo> + <Fields> + <field> + <id>380</id> + <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue>UserGroup2</fieldValue> + </field> + <field> + <id>381</id> + <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue>This is the description of the user group</fieldValue> + </field> + </Fields> + <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/85/versions/1/relations"/> + <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> + <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user_group</resource> + <width></width> + <height></height> + <mimeType>image/svg+xml</mimeType> + </Thumbnail> + </Version> + <ParentUserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5"/> + <Subgroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/groups/1/5/79/subgroups"/> + <Users media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/groups/1/5/79/users"/> + <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/79/roles"/> + </UserGroup> + 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: X-CSRF-Token + - name: Accept in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + 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-Match + - name: Content-Type in: header - description: ETag Causes to patch only if the specified ETag is the current - one. Otherwise a 412 is returned. + 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: id + - name: path in: path - description: "" + description: UserGroupCreateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The RoleInput schema encoded in XML or JSON format. + description: The new UserGroupCreateController resource content: - application/vnd.ibexa.api.RoleInput+json: + application/vnd.ibexa.api.UserGroupCreate+json: schema: - $ref: '#/components/schemas/RoleInputWrapper' + $ref: '#/components/schemas/UserGroupCreateWrapper' example: - RoleInput: - identifier: NewIdentifier - application/vnd.ibexa.api.RoleInput+xml: + 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/RoleInput' - example: | + $ref: '#/components/schemas/UserGroupCreate' + example: |- <?xml version="1.0" encoding="UTF-8"?> - <RoleInput> - <identifier>NewIdentifier</identifier> - </RoleInput> + <UserGroupCreate> + <mainLanguageCode>eng-GB</mainLanguageCode> + <remoteId>remoteId-qwert098</remoteId> + <fields> + <field> + <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldValue>UserGroup</fieldValue> + </field> + <field> + <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldValue>This is the description of the user group</fieldValue> + </field> + </fields> + </UserGroupCreate> required: false - deprecated: false - /user/roles/{id}/draft: + /user/groups/{path}/users: get: - operationId: ibexa.rest.load_role_draft + operationId: api_usergroups_pathusers_get tags: - - User Role + - User Group responses: 200: - description: OK - Role draft by original Role ID. + description: OK - the Users of the Group with the given ID. content: - application/vnd.ibexa.api.Role+json: + application/vnd.ibexa.api.UserList+json: schema: - $ref: '#/components/schemas/RoleWrapper' + $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: - Role: - _media-type: application/vnd.ibexa.api.Role+json - _href: /api/ibexa/v2/user/roles/27 - identifier: Anonymous - Policies: - _media-type: application/vnd.ibexa.api.PolicyList+json - _href: /api/ibexa/v2/user/roles/27/policies - application/vnd.ibexa.api.Role+xml: + 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/Role' + $ref: '#/components/schemas/UserRefList' example: | <?xml version="1.0" encoding="UTF-8"?> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/27"> - <identifier>Anonymous</identifier> - <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/27/policies"/> - </Role> + <UserRefList media-type="application/vnd.ibexa.api.UserRefList+xml" href="/api/ibexa/v2/user/users"> + <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + </UserRefList> 401: - description: Error - the user has no permission to read Roles. + description: Error - the user has no permission to read User Groups. 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: If-None-Match - in: header - description: ETag - required: false - 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: ibexa.rest.delete_role_draft - 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. + 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: X-CSRF-Token + - name: Accept in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + 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: id + - name: path in: path - description: "" + description: UserGroupUsersListController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - patch: - operationId: ibexa.rest.update_role_draft + post: + operationId: api_usergroups_pathusers_post tags: - - User Role + - User Group responses: - 200: - description: OK - Role draft updated. + 201: + description: Created - the User has been created. content: - application/vnd.ibexa.api.Role+json: + application/vnd.ibexa.api.User+json: schema: - $ref: '#/components/schemas/RoleWrapper' + $ref: '#/components/schemas/UserWrapper' 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: + 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: ~ + enabled: false + maxLogin: 0 + plainPassword: ~ + - id: 345 + fieldDefinitionIdentifier: signature + languageCode: eng-GB + fieldTypeIdentifier: ibexa_text + fieldValue: ~ + - id: 346 + fieldDefinitionIdentifier: image + languageCode: eng-GB + fieldTypeIdentifier: ibexa_image + fieldValue: ~ + 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: ~ + height: ~ + 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/Role' + $ref: '#/components/schemas/User' example: | <?xml version="1.0" encoding="UTF-8"?> - <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/9"> - <identifier>UpdatedIdentifier</identifier> - <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/9/policies"/> - </Role> + <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/79" id="79" remoteId="bcf0764b417f05af21852a1f03fb1f13"> + <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/> + <name>Jose Vargas</name> + <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/79/versions"/> + <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> + <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/12/79"/> + <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/79/locations"/> + <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/79/groups"/> + <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> + <publishDate>2021-06-29T08:23:42+00:00</publishDate> + <lastModificationDate>2021-07-29T11:45:07+00:00</lastModificationDate> + <mainLanguageCode>eng-GB</mainLanguageCode> + <alwaysAvailable>true</alwaysAvailable> + <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/79/versions/6"> + <VersionInfo> + <id>609</id> + <versionNo>6</versionNo> + <status>PUBLISHED</status> + <modificationDate>2021-07-29T11:45:07+00:00</modificationDate> + <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + <creationDate>2021-07-29T11:45:07+00:00</creationDate> + <initialLanguageCode>eng-GB</initialLanguageCode> + <languageCodes>eng-GB</languageCodes> + <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> + <Language> + <languageCode>eng-GB</languageCode> + </Language> + </VersionTranslationInfo> + <names> + <value languageCode="eng-GB">Jose Vargas</value> + </names> + <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/79"/> + </VersionInfo> + <Fields> + <field> + <id>342</id> + <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue>Jose</fieldValue> + </field> + <field> + <id>343</id> + <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> + <fieldValue>Vargas</fieldValue> + </field> + <field> + <id>344</id> + <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> + <fieldValue> + <value key="hasStoredLogin">true</value> + <value key="contentId">79</value> + <value key="login">josevargas</value> + <value key="email">aa@bb.cc</value> + <value key="passwordUpdatedAt"/> + <value key="enabled">false</value> + <value key="maxLogin">0</value> + <value key="plainPassword"/> + </fieldValue> + </field> + <field> + <id>345</id> + <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier> + <fieldValue/> + </field> + <field> + <id>346</id> + <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier> + <fieldValue/> + </field> + </Fields> + <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/79/versions/6/relations"/> + <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> + <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource> + <width></width> + <height></height> + <mimeType>image/svg+xml</mimeType> + </Thumbnail> + </Version> + <login>josevargas</login> + <email>aa@bb.cc</email> + <enabled>false</enabled> + <UserGroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/users/79/groups"/> + <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/79/roles"/> + </User> 400: description: Error - the input does not match the input schema definition. 401: - description: Error - the user is not authorized to update the Role. + 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 - 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. + 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: X-CSRF-Token + - name: Accept in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + 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: If-Match + - name: Content-Type in: header - description: Performs a PATCH only if the specified ETag is the current one. - Otherwise a 412 is returned. + 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: id + - name: path in: path - description: "" + description: UserCreateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The RoleInput schema encoded in XML or JSON format. + description: The new UserCreateController resource content: - application/vnd.ibexa.api.RoleInput+json: + application/vnd.ibexa.api.UserCreate+json: schema: - $ref: '#/components/schemas/RoleInputWrapper' + $ref: '#/components/schemas/UserCreateWrapper' example: - RoleInput: - identifier: UpdatedIdentifier - application/vnd.ibexa.api.RoleInput+xml: + 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/RoleInput' + $ref: '#/components/schemas/UserCreate' example: | <?xml version="1.0" encoding="UTF-8"?> - <RoleInput> - <identifier>UpdatedIdentifier</identifier> - </RoleInput> + <UserCreate> + <mainLanguageCode>eng-GB</mainLanguageCode> + <remoteId>remoteId-23456789</remoteId> + <login>johnsmith</login> + <email>example@example.com</email> + <password>Secrepassword5!</password> + <fields> + <field> + <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldValue>John</fieldValue> + </field> + <field> + <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldValue>Smith</fieldValue> + </field> + <field> + <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> + <languageCode>eng-GB</languageCode> + <fieldValue> + <value key="hasStoredLogin">true</value> + <value key="contentId">14</value> + <value key="login">johnsmith</value> + <value key="email">example@example.com</value> + <value key="enabled">true</value> + <value key="maxLogin">10</value> + </fieldValue> + </field> + </fields> + </UserCreate> required: false - deprecated: false - /user/roles/{id}/policies: + /user/policies: get: - operationId: ibexa.rest.load_policies + operationId: ibexa.rest.list_policies_for_user tags: - - User Role + - User Policy responses: 200: - description: If set, the Policy list is returned in XML or JSON format. + description: OK - Policies which are applied to a given User. content: application/vnd.ibexa.api.PolicyList+json: schema: @@ -39558,7 +27722,7 @@ paths: example: PolicyList: _media-type: application/vnd.ibexa.api.PolicyList+json - _href: /api/ibexa/v2/user/roles/1/policies + _href: /api/ibexa/v2/user/policies Policy: - _media-type: application/vnd.ibexa.api.Policy+json _href: /api/ibexa/v2/user/roles/1/policies/349 @@ -39619,7 +27783,7 @@ paths: $ref: '#/components/schemas/PolicyList' example: | <?xml version="1.0" encoding="UTF-8"?> - <PolicyList media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/1/policies"> + <PolicyList media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/policies"> <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/349"> <id>349</id> <module>content</module> @@ -39673,3104 +27837,2581 @@ paths: </PolicyList> 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: id - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false + summary: List Policies for User + description: Search all Policies which are applied to a given User. + parameters: [] + /user/roles: + get: + operationId: ibexa.rest.list_roles + 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"?> + <RoleList media-type="application/vnd.ibexa.api.RoleList+xml" href="/api/ibexa/v2/user/roles"> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/1"> + <identifier>Anonymous</identifier> + <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/1/policies"/> + </Role> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/2"> + <identifier>Administrator</identifier> + <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/2/policies"/> + </Role> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/3"> + <identifier>Editor</identifier> + <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/3/policies"/> + </Role> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/4"> + <identifier>Member</identifier> + <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/4/policies"/> + </Role> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/10"> + <identifier>NewRole</identifier> + <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/10/policies"/> + </Role> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/14"> + <identifier>NewRole5</identifier> + <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/14/policies"/> + </Role> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/15"> + <identifier>NewRole7</identifier> + <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/15/policies"/> + </Role> + </RoleList> + 401: + description: Error - the user has no permission to read Roles. + summary: Load Roles + description: Returns a list of all Roles. + parameters: [] post: - operationId: ibexa.rest.add_policy + operationId: ibexa.rest.create_role tags: - User Role responses: 201: - description: If set, the updated Policy is returned in XML or JSON format. + description: If set, the new user is returned in XML or JSON format. content: - application/vnd.ibexa.api.Policy+json: + application/vnd.ibexa.api.Role+json: schema: - $ref: '#/components/schemas/PolicyWrapper' + $ref: '#/components/schemas/RoleWrapper' 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: + Role: + _media-type: application/vnd.ibexa.api.Role+json + _href: /api/ibexa/v2/user/roles/21 + identifier: NewRole + Policies: + _media-type: application/vnd.ibexa.api.PolicyList+json + _href: /api/ibexa/v2/user/roles/21/policies + application/vnd.ibexa.api.Role+xml: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Role' example: | - <Policy href="/user/roles/11/policies/55" media-type="application/vnd.ibexa.api.Policy+xml"> - <id>55</id> - <module>content</module> - <function>create</function> - <limitations> - <limitation identifier="Class"> - <values> - <ref href="/content/types/13"/> - </values> - </limitation> - <limitation identifier="ParentClass"> - <values> - <ref href="/content/types/12"/> - </values> - </limitation> - </limitations> - </Policy> + <?xml version="1.0" encoding="UTF-8"?> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/19"> + <identifier>NewRole</identifier> + <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/19/policies"/> + </Role> 400: - description: Error - the input does not match the input schema definition - or validation of limitation in PolicyCreate fails. + description: Error - the input does not match the input schema definition. 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 + 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: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. 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: If set, the updated Policy is returned in XML or JSON format. + description: The RoleInput schema encoded in XML or JSON. content: - application/vnd.ibexa.api.PolicyCreate+json: + application/vnd.ibexa.api.RoleInput+json: schema: - $ref: '#/components/schemas/PolicyCreateWrapper' - application/vnd.ibexa.api.PolicyCreate+xml: + $ref: '#/components/schemas/RoleInputWrapper' + example: + RoleInput: + identifier: NewRole + application/vnd.ibexa.api.RoleInput+xml: schema: - $ref: '#/components/schemas/PolicyCreate' - example: | + $ref: '#/components/schemas/RoleInput' + example: |- <?xml version="1.0" encoding="UTF-8"?> - <PolicyCreate> - <module>content</module> - <function>create</function> - <limitations> - <limitation identifier="Class"> - <values> - <ref href="2"/> - </values> - </limitation> - <limitation identifier="ParentClass"> - <values> - <ref href="1"/> - </values> - </limitation> - </limitations> - </PolicyCreate> + <RoleInput> + <identifier>NewRole</identifier> + </RoleInput> required: false - deprecated: false - delete: - operationId: ibexa.rest.delete_policies - 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. - 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 - /user/roles/{roleId}/policies/{policyId}: + /user/roles/{id}: get: - operationId: ibexa.rest.load_policy + operationId: ibexa.rest.load_role tags: - User Role responses: 200: - description: If set, the Policy is returned in XML or JSON format. + description: OK - Role for the given ID. content: - application/vnd.ibexa.api.Policy+json: + application/vnd.ibexa.api.Role+json: schema: - $ref: '#/components/schemas/PolicyWrapper' + $ref: '#/components/schemas/RoleWrapper' 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: + Role: + _media-type: application/vnd.ibexa.api.Role+json + _href: /api/ibexa/v2/user/roles/21 + identifier: NewRole + Policies: + _media-type: application/vnd.ibexa.api.PolicyList+json + _href: /api/ibexa/v2/user/roles/21/policies + application/vnd.ibexa.api.Role+xml: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Role' example: | - <Policy href="/user/roles/11/policies/45" media-type="application/vnd.ibexa.api.Policy+xml"> - <id>45</id> - <module>content</module> - <function>create</function> - <limitations> - <limitation identifier="Class"> - <values> - <ref href="/content/types/10" media-type="application/vnd.ibexa.api.ContentType+xml" /> - <ref href="/content/types/11" media-type="application/vnd.ibexa.api.ContentType+xml" /> - <ref href="/content/types/12" media-type="application/vnd.ibexa.api.ContentType+xml" /> - </values> - </limitation> - <limitation identifier="ParentClass"> - <values> - <ref href="/content/types/4" media-type="application/vnd.ibexa.api.ContentType+xml" /> - </values> - </limitation> - </limitations> - </Policy> + <?xml version="1.0" encoding="UTF-8"?> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/21"> + <identifier>NewRole</identifier> + <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/21/policies"/> + </Role> 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. + description: Error - the Role does not exist. + summary: Load Role + description: Loads a Role for the given ID. parameters: - name: If-None-Match in: header description: ETag required: false 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 + - name: id in: path - description: RolePolicyLoadByIdController identifier + description: RoleLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - delete: - operationId: ibexa.rest.delete_policy + post: + operationId: ibexa.rest.create_role_draft tags: - User Role responses: - 204: - description: No Content - the given Policy is deleted. + 201: + description: If set, the new user is returned in XML or JSON format. + 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: Editor + 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"?> + <Role href="/user/roles/11" media-type="application/vnd.ibexa.api.RoleDraft+xml"> + <identifier>MyRole</identifier> + <Policies href="/user/roles/11/policies" media-type="application/vnd.ibexa.api.PolicyList+xml"/> + </Role> 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. + 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: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. 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 + - name: id in: path - description: RolePolicyDeleteController identifier + description: RoleDraftCreateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - patch: - operationId: ibexa.rest.update_policy + requestBody: + description: No payload required + content: [] + required: false + delete: + operationId: ibexa.rest.delete_role tags: - User Role responses: - 200: - description: If set, the updated Policy is returned in XML or JSON format. - 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"> - <id>55</id> - <module>content</module> - <function>create</function> - <limitations> - <limitation identifier="Class"> - <values> - <ref href="/content/types/14"/> - </values> - </limitation> - <limitation identifier="ParentClass"> - <values> - <ref href="/content/types/10"/> - </values> - </limitation> - </limitations> - </Policy> - 400: - description: Error - the input does not match the input schema definition - or validation of limitation in PolicyUpdate fails. + 204: + description: No Content. 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. + 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: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. 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 + - name: id in: path - description: RolePolicyUpdateController identifier + description: RoleDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - requestBody: - description: If set, the updated Policy is returned in XML or JSON format. - 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"?> - <PolicyUpdate> - <limitations> - <limitation identifier="Class"> - <values> - <ref href="2"/> - </values> - </limitation> - <limitation identifier="ParentClass"> - <values> - <ref href="1"/> - </values> - </limitation> - </limitations> - </PolicyUpdate> - required: false - deprecated: false - /user/sessions: - post: - operationId: api_usersessions_post + patch: + operationId: ibexa.rest.update_role tags: - - User Session + - User Role 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"?> - <Session media-type="application/vnd.ibexa.api.Session+xml" href="/api/ibexa/v2/user/sessions/ABCDEFGHIJKLMNOPQRSTUVWXYZ"> - <name>IBX_SESSION_ID0123456789ABCDEFGHIJKLMNOPQRSTUV</name> - <identifier>ABCDEFGHIJKLMNOPQRSTUVWXYZ</identifier> - <csrfToken>0123456789ABCDEF.GHIJKLMNOP_QRSTUVWXYZabcdefghijklmnopqrstuv.wxyz0123456-789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopq</csrfToken> - <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - </Session> - 201: - description: Session is created. + description: OK - Role updated content: - application/vnd.ibexa.api.Session+json: + application/vnd.ibexa.api.Role+json: schema: - $ref: '#/components/schemas/SessionWrapper' + $ref: '#/components/schemas/RoleWrapper' 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: + Role: + _media-type: application/vnd.ibexa.api.Role+json + _href: /api/ibexa/v2/user/roles/21 + identifier: NewIdentifier + Policies: + _media-type: application/vnd.ibexa.api.PolicyList+json + _href: /api/ibexa/v2/user/roles/21/policies + application/vnd.ibexa.api.Role+xml: schema: - $ref: '#/components/schemas/Session' + $ref: '#/components/schemas/Role' example: | <?xml version="1.0" encoding="UTF-8"?> - <Session media-type="application/vnd.ibexa.api.Session+xml" href="/api/ibexa/v2/user/sessions/ABCDEFGHIJKLMNOPQRSTUVWXYZ"> - <name>IBX_SESSION_ID0123456789ABCDEFGHIJKLMNOPQRSTUV</name> - <identifier>ABCDEFGHIJKLMNOPQRSTUVWXYZ</identifier> - <csrfToken>0123456789ABCDEF.GHIJKLMNOP_QRSTUVWXYZabcdefghijklmnopqrstuv.wxyz0123456-789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopq</csrfToken> - <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - </Session> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/5"> + <identifier>NewIdentifier</identifier> + <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/5/policies"/> + </Role> 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. + 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 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 + - name: X-CSRF-Token in: header - description: The SessionInput schema encoded in XML or JSON format. + description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: Cookie + - name: If-Match in: header - description: Only needed for session's checking {sessionName}={sessionID}. + 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: X-CSRF-Token - in: header - description: Only needed for session's checking. The {csrfToken} needed on - all unsafe HTTP methods with session. + - name: id + in: path + description: RoleUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The new SessionCreateController resource + description: The RoleInput schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.SessionInput+json: + application/vnd.ibexa.api.RoleInput+json: schema: - $ref: '#/components/schemas/SessionInputWrapper' + $ref: '#/components/schemas/RoleInputWrapper' example: - SessionInput: - login: admin - password: secret - application/vnd.ibexa.api.SessionInput+xml: + RoleInput: + identifier: NewIdentifier + application/vnd.ibexa.api.RoleInput+xml: schema: - $ref: '#/components/schemas/SessionInput' + $ref: '#/components/schemas/RoleInput' example: | <?xml version="1.0" encoding="UTF-8"?> - <SessionInput> - <login>admin</login> - <password>secret</password> - </SessionInput> + <RoleInput> + <identifier>NewIdentifier</identifier> + </RoleInput> required: false - deprecated: false - /user/sessions/current: + /user/roles/{id}/draft: get: - operationId: api_usersessionscurrent_get + operationId: ibexa.rest.load_role_draft tags: - - User Session + - User Role responses: 200: - description: User is currently logged in and has a valid session. + description: OK - Role draft by original Role ID. content: - application/vnd.ibexa.api.Session+json: + application/vnd.ibexa.api.Role+json: schema: - $ref: '#/components/schemas/SessionWrapper' + $ref: '#/components/schemas/RoleWrapper' 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: + Role: + _media-type: application/vnd.ibexa.api.Role+json + _href: /api/ibexa/v2/user/roles/27 + identifier: Anonymous + Policies: + _media-type: application/vnd.ibexa.api.PolicyList+json + _href: /api/ibexa/v2/user/roles/27/policies + application/vnd.ibexa.api.Role+xml: schema: - $ref: '#/components/schemas/Session' + $ref: '#/components/schemas/Role' example: | <?xml version="1.0" encoding="UTF-8"?> - <Session media-type="application/vnd.ibexa.api.Session+xml" href="/api/ibexa/v2/user/sessions/ABCDEFGHIJKLMNOPQRSTUVWXYZ"> - <name>IBX_SESSION_ID0123456789ABCDEFGHIJKLMNOPQRSTUV</name> - <identifier>ABCDEFGHIJKLMNOPQRSTUVWXYZ</identifier> - <csrfToken>0123456789ABCDEF.GHIJKLMNOP_QRSTUVWXYZabcdefghijklmnopqrstuv.wxyz0123456-789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopq</csrfToken> - <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - </Session> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/27"> + <identifier>Anonymous</identifier> + <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/27/policies"/> + </Role> + 401: + description: Error - the user has no permission to read Roles. 404: - description: User does not have a valid session, or it has expired. - summary: Get current session - description: Get current user session, if any. + 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: Cookie + - name: If-None-Match in: header - description: Only needed for session's checking {sessionName}={sessionID}. - required: true + description: ETag + required: false 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. + - name: id + in: path + description: RoleDraftLoadByRoleIdController identifier 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 + operationId: ibexa.rest.delete_role_draft tags: - - User Session + - User Role 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. + 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: 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. + description: The CSRF Token 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 + - name: id in: path - description: "" + description: RoleDraftDeleteController identifier 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 + patch: + operationId: ibexa.rest.update_role_draft tags: - - User Session + - User Role responses: 200: - description: "200" + description: OK - Role draft updated. content: - application/vnd.ibexa.api.Session+json: + application/vnd.ibexa.api.Role+json: schema: - $ref: '#/components/schemas/SessionWrapper' + $ref: '#/components/schemas/RoleWrapper' 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: + 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/Session' + $ref: '#/components/schemas/Role' example: | <?xml version="1.0" encoding="UTF-8"?> - <Session media-type="application/vnd.ibexa.api.Session+xml" href="/api/ibexa/v2/user/sessions/ABCDEFGHIJKLMNOPQRSTUVWXYZ"> - <name>IBX_SESSION_ID0123456789ABCDEFGHIJKLMNOPQRSTUV</name> - <identifier>ABCDEFGHIJKLMNOPQRSTUVWXYZ</identifier> - <csrfToken>0123456789ABCDEF.GHIJKLMNOP_QRSTUVWXYZabcdefghijklmnopqrstuv.wxyz0123456-789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopq</csrfToken> - <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> - </Session> + <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/9"> + <identifier>UpdatedIdentifier</identifier> + <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/9/policies"/> + </Role> + 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 - 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. + 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: 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. + description: The CSRF Token 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 + - name: If-Match in: header - description: "" + 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: sessionId + - name: id in: path - description: "" + description: RoleDraftUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The new SessionRefreshController resource - content: [] + description: The RoleInput schema encoded in XML or JSON format. + content: + application/vnd.ibexa.api.RoleInput+json: + schema: + $ref: '#/components/schemas/RoleInputWrapper' + example: + RoleInput: + identifier: UpdatedIdentifier + application/vnd.ibexa.api.RoleInput+xml: + schema: + $ref: '#/components/schemas/RoleInput' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <RoleInput> + <identifier>UpdatedIdentifier</identifier> + </RoleInput> required: false - deprecated: false - /user/token/jwt: - post: - operationId: api_usertokenjwt_post + /user/roles/{id}/policies: + get: + operationId: ibexa.rest.load_policies tags: - - User Token + - User Role responses: 200: - description: OK - returns the JWT in JSON format. + description: If set, the Policy list is returned in XML or JSON format. content: - application/vnd.ibexa.api.JWT+json: + application/vnd.ibexa.api.PolicyList+json: schema: - $ref: '#/components/schemas/JWTWrapper' + $ref: '#/components/schemas/PolicyListWrapper' example: - JWT: - _media-type: application/vnd.ibexa.api.JWT+json - _token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MDI4NDA3ODAsImV4cCI6MTYwMjg0NDM4MCwicm9sZXMiOlsiUk9MRV9VU0VSIl0sInVzZXJuYW1lIjoiYWRtaW4ifQ.0LHa799HwSwwfDBZd2V0q2xHwGt86PpyZamKnXHQyYI - token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MDI4NDA3ODAsImV4cCI6MTYwMjg0NDM4MCwicm9sZXMiOlsiUk9MRV9VU0VSIl0sInVzZXJuYW1lIjoiYWRtaW4ifQ.0LHa799HwSwwfDBZd2V0q2xHwGt86PpyZamKnXHQyYI + 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"?> + <PolicyList media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/1/policies"> + <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/349"> + <id>349</id> + <module>content</module> + <function>read</function> + <limitations> + <limitation identifier="Section"> + <values> + <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/> + <ref media-type="application/vnd.ibexa.api.ref+xml" href="3"/> + <ref media-type="application/vnd.ibexa.api.ref+xml" href="6"/> + </values> + </limitation> + </limitations> + </Policy> + <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/350"> + <id>350</id> + <module>user</module> + <function>login</function> + <limitations> + <limitation identifier="SiteAccess"> + <values> + <ref media-type="application/vnd.ibexa.api.ref+xml" href="2282622326"/> + <ref media-type="application/vnd.ibexa.api.ref+xml" href="1766001124"/> + </values> + </limitation> + </limitations> + </Policy> + <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/351"> + <id>351</id> + <module>content</module> + <function>view_embed</function> + <limitations> + <limitation identifier="Class"> + <values> + <ref media-type="application/vnd.ibexa.api.ref+xml" href="5"/> + <ref media-type="application/vnd.ibexa.api.ref+xml" href="12"/> + </values> + </limitation> + </limitations> + </Policy> + <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/352"> + <id>352</id> + <module>user</module> + <function>register</function> + </Policy> + <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/353"> + <id>353</id> + <module>user</module> + <function>password</function> + </Policy> + </PolicyList> 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: + 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: id + in: path + description: RolePolicyListController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false post: - operationId: ibexa.rest.views.create + operationId: ibexa.rest.add_policy tags: - - Views + - User Role responses: - 200: - description: The view in XML or JSON format. + 201: + description: If set, the updated Policy is returned in XML or JSON format. content: - application/vnd.ibexa.api.View+xml; version=1.1: + application/vnd.ibexa.api.Policy+json: schema: - $ref: '#/components/schemas/View' + $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: | - <?xml version="1.0" encoding="UTF-8"?> - <View href="/views/TitleView" media-type="application/vnd.ibexa.api.View+xml; version=1.1"> - <identifier>TitleView</identifier> - <User href="/user/users/14" media-type="vnd.ibexa.api.User+xml"/> - <public>false</public> - <LocationQuery> - <Filter> - <ParentLocationIdCriterion>2</ParentLocationIdCriterion> - </Filter> - <limit>10</limit> - <offset>0</offset> - <SortClauses> - <ContentName>ascending</ContentName> - </SortClauses> - <FacetBuilders> - <contentTypeFacetBuilder/> - </FacetBuilders> - </LocationQuery> - <Result href="/content/views/view1234/results" - media-type="application/vnd.ibexa.api.ViewResult+xml" count="34" time="31" maxScore="1.0"> - <searchHits> - <searchHit score="1.0" index="installid1234567890"> - <hightlight/> - <value> - <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2"> - <id>2</id> - <priority>0</priority> - <hidden>false</hidden> - <invisible>false</invisible> - <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1"/> - <pathString>/1/2/</pathString> - <depth>1</depth> - <childCount>8</childCount> - <remoteId>f3e90596361e31d496d4026eb624c983</remoteId> - <Children media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/2/children"/> - <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/57"/> - <sortField>PRIORITY</sortField> - <sortOrder>ASC</sortOrder> - <UrlAliases media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/urlaliases"/> - </Location> - - </value> - </searchHit> - <!-- ... --> - </searchHits> - <facets> - <contentTypeFacet> - <contentTypeFacetEntry> - <contentType href="/content/types/1" media-type="application/vnd.ibexa.api.ContentType+xml"/> - <count>3</count> - </contentTypeFacetEntry> - <contentTypeFacetEntry> - <contentType href="/content/types/7" media-type="application/vnd.ibexa.api.ContentType+xml"/> - <count>9</count> - </contentTypeFacetEntry> - <contentTypeFacetEntry> - <contentType href="/content/types/11" media-type="application/vnd.ibexa.api.ContentType+xml"/> - <count>1</count> - </contentTypeFacetEntry> - <contentTypeFacetEntry> - <contentType href="/content/types/15" media-type="application/vnd.ibexa.api.ContentType+xml"/> - <count>8</count> - </contentTypeFacetEntry> - </contentTypeFacet> - </facets> - </Result> - </View> + <Policy href="/user/roles/11/policies/55" media-type="application/vnd.ibexa.api.Policy+xml"> + <id>55</id> + <module>content</module> + <function>create</function> + <limitations> + <limitation identifier="Class"> + <values> + <ref href="/content/types/13"/> + </values> + </limitation> + <limitation identifier="ParentClass"> + <values> + <ref href="/content/types/12"/> + </values> + </limitation> + </limitations> + </Policy> 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. - View input reflects the criteria model of the public PHP API. - Refer to [Search Criteria Reference](/en/latest/search/criteria_reference/search_criteria_reference/) + 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: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false + - name: id + in: path + description: RolePolicyCreateController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false requestBody: - description: The view input in XML or JSON format. + description: If set, the updated Policy is returned in XML or JSON format. content: - application/vnd.ibexa.api.ViewInput+json: + application/vnd.ibexa.api.PolicyCreate+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: + $ref: '#/components/schemas/PolicyCreateWrapper' + application/vnd.ibexa.api.PolicyCreate+xml: schema: - $ref: '#/components/schemas/ViewInput' + $ref: '#/components/schemas/PolicyCreate' example: | <?xml version="1.0" encoding="UTF-8"?> - <ViewInput> - <identifier>TitleView</identifier> - <Query> - <Filter> - <ContentTypeIdentifierCriterion>image</ContentTypeIdentifierCriterion> - <SectionIdentifierCriterion>media</SectionIdentifierCriterion> - <DateMetadataCriterion> - <Target>modified</Target> - <Value>1675681020</Value> - <Operator>gte</Operator> - </DateMetadataCriterion> - </Filter> - <limit>10</limit> - <offset>0</offset> - <SortClauses> - <ContentName>ascending</ContentName> - </SortClauses> - <Aggregations> - <Aggregation> - <ContentTypeTermAggregation> - <name>some name</name> - </ContentTypeTermAggregation> - </Aggregation> - </Aggregations> - </Query> - </ViewInput> + <PolicyCreate> + <module>content</module> + <function>create</function> + <limitations> + <limitation identifier="Class"> + <values> + <ref href="2"/> + </values> + </limitation> + <limitation identifier="ParentClass"> + <values> + <ref href="1"/> + </values> + </limitation> + </limitations> + </PolicyCreate> 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: + delete: + operationId: ibexa.rest.delete_policies + 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: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: 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: + style: simple + explode: false + - name: id + in: path + description: RolePolicyDeleteAllFromRoleController identifier + required: true + deprecated: false + schema: 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. + style: simple + explode: false + /user/roles/{roleId}/policies/{policyId}: + get: + operationId: ibexa.rest.load_policy + tags: + - User Role + responses: + 200: + description: If set, the Policy is returned in XML or JSON format. + 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/45" media-type="application/vnd.ibexa.api.Policy+xml"> + <id>45</id> + <module>content</module> + <function>create</function> + <limitations> + <limitation identifier="Class"> + <values> + <ref href="/content/types/10" media-type="application/vnd.ibexa.api.ContentType+xml" /> + <ref href="/content/types/11" media-type="application/vnd.ibexa.api.ContentType+xml" /> + <ref href="/content/types/12" media-type="application/vnd.ibexa.api.ContentType+xml" /> + </values> + </limitation> + <limitation identifier="ParentClass"> + <values> + <ref href="/content/types/4" media-type="application/vnd.ibexa.api.ContentType+xml" /> + </values> + </limitation> + </limitations> + </Policy> + 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: If-None-Match + in: header + description: ETag + required: false + deprecated: false + schema: type: string - remoteId: - description: If set the Location gets a new remoteId. Needs to be a unique - Location->remoteId string value. + style: simple + explode: false + - name: policyId + in: path + description: RolePolicyLoadByIdController identifier + required: true + deprecated: false + schema: 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 + style: simple + explode: false + - name: roleId + in: path + description: RolePolicyLoadByIdController identifier + required: true + deprecated: false + schema: 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 + style: simple + explode: false + delete: + operationId: ibexa.rest.delete_policy + 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: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: 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. + style: simple + explode: false + - name: policyId + in: path + description: RolePolicyDeleteController identifier + required: true + deprecated: false + schema: type: string - remoteId: - description: Remote identifier used as a custom identifier for the content - item. Needs to be a unique Content->remoteId string value. + style: simple + explode: false + - name: roleId + in: path + description: RolePolicyDeleteController identifier + required: true + deprecated: false + schema: 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. + style: simple + explode: false + patch: + operationId: ibexa.rest.update_policy + tags: + - User Role + responses: + 200: + description: If set, the updated Policy is returned in XML or JSON format. + 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"> + <id>55</id> + <module>content</module> + <function>create</function> + <limitations> + <limitation identifier="Class"> + <values> + <ref href="/content/types/14"/> + </values> + </limitation> + <limitation identifier="ParentClass"> + <values> + <ref href="/content/types/10"/> + </values> + </limitation> + </limitations> + </Policy> + 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: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: type: string - modificationDate: - description: Modification date. If not given, the current integer is used. + style: simple + explode: 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 + schema: 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: + style: simple + explode: false + - name: policyId + in: path + description: RolePolicyUpdateController identifier + required: true + deprecated: false + schema: type: string - Section: - $ref: '#/components/schemas/Section' - MainLocation: - $ref: '#/components/schemas/Location' - Owner: - $ref: '#/components/schemas/User' - alwaysAvailable: - type: boolean - remoteId: + style: simple + explode: false + - name: roleId + in: path + description: RolePolicyUpdateController identifier + required: true + deprecated: false + schema: 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: + style: simple + explode: false + requestBody: + description: If set, the updated Policy is returned in XML or JSON format. + 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"?> + <PolicyUpdate> + <limitations> + <limitation identifier="Class"> + <values> + <ref href="2"/> + </values> + </limitation> + <limitation identifier="ParentClass"> + <values> + <ref href="1"/> + </values> + </limitation> + </limitations> + </PolicyUpdate> + required: 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"?> + <Session media-type="application/vnd.ibexa.api.Session+xml" href="/api/ibexa/v2/user/sessions/ABCDEFGHIJKLMNOPQRSTUVWXYZ"> + <name>IBX_SESSION_ID0123456789ABCDEFGHIJKLMNOPQRSTUV</name> + <identifier>ABCDEFGHIJKLMNOPQRSTUVWXYZ</identifier> + <csrfToken>0123456789ABCDEF.GHIJKLMNOP_QRSTUVWXYZabcdefghijklmnopqrstuv.wxyz0123456-789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopq</csrfToken> + <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + </Session> + 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"?> + <Session media-type="application/vnd.ibexa.api.Session+xml" href="/api/ibexa/v2/user/sessions/ABCDEFGHIJKLMNOPQRSTUVWXYZ"> + <name>IBX_SESSION_ID0123456789ABCDEFGHIJKLMNOPQRSTUV</name> + <identifier>ABCDEFGHIJKLMNOPQRSTUVWXYZ</identifier> + <csrfToken>0123456789ABCDEF.GHIJKLMNOP_QRSTUVWXYZabcdefghijklmnopqrstuv.wxyz0123456-789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopq</csrfToken> + <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + </Session> + 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 + schema: type: string - format: date-time - modificationDate: + style: simple + explode: false + - name: Content-Type + in: header + description: The SessionInput schema encoded in XML or JSON format. + required: true + deprecated: false + schema: type: string - format: date-time - mainLanguageCode: + style: simple + explode: false + - name: Cookie + in: header + description: Only needed for session's checking {sessionName}={sessionID}. + required: true + deprecated: false + schema: type: string - alwaysAvailable: - type: boolean - remoteId: + style: simple + explode: 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 + schema: type: string - mainLocationId: - type: [] - name: + style: simple + explode: 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"?> + <SessionInput> + <login>admin</login> + <password>secret</password> + </SessionInput> + required: 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"?> + <Session media-type="application/vnd.ibexa.api.Session+xml" href="/api/ibexa/v2/user/sessions/ABCDEFGHIJKLMNOPQRSTUVWXYZ"> + <name>IBX_SESSION_ID0123456789ABCDEFGHIJKLMNOPQRSTUV</name> + <identifier>ABCDEFGHIJKLMNOPQRSTUVWXYZ</identifier> + <csrfToken>0123456789ABCDEF.GHIJKLMNOP_QRSTUVWXYZabcdefghijklmnopqrstuv.wxyz0123456-789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopq</csrfToken> + <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + </Session> + 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 + schema: type: string - ContentCreateContentType: - type: object - required: - - _href - - FieldDefinitions - properties: - _href: - xml: - attribute: true - name: href + style: simple + explode: false + - name: Accept + in: header + description: If set, the session is returned in XML or JSON format. + required: true + deprecated: false + schema: 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 + style: simple + explode: 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 + schema: type: string - modificationDate: - description: The last modified date of this version. + style: simple + explode: false + - name: X-CSRF-Token + in: header + description: The {csrfToken} needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: 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. + style: simple + explode: false + - name: sessionId + in: path + description: SessionDeleteController identifier + required: true + deprecated: false + schema: type: string - format: date-time - initialLanguageCode: - description: The language code which is used for labeling a translation. + style: simple + explode: false + /user/sessions/{sessionId}/refresh: + post: + operationId: api_usersessions_sessionIdrefresh_post + tags: + - User Session + responses: + 200: + description: OK - session refreshed. + 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"?> + <Session media-type="application/vnd.ibexa.api.Session+xml" href="/api/ibexa/v2/user/sessions/ABCDEFGHIJKLMNOPQRSTUVWXYZ"> + <name>IBX_SESSION_ID0123456789ABCDEFGHIJKLMNOPQRSTUV</name> + <identifier>ABCDEFGHIJKLMNOPQRSTUVWXYZ</identifier> + <csrfToken>0123456789ABCDEF.GHIJKLMNOP_QRSTUVWXYZabcdefghijklmnopqrstuv.wxyz0123456-789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopq</csrfToken> + <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> + </Session> + 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 + schema: type: string - languageCodes: - description: List of languages in this version. Reflects which languages - fields exists in for this version. + style: simple + explode: false + - name: X-CSRF-Token + in: header + description: The {csrfToken} needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: 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. + style: simple + explode: false + - name: Accept + in: header + description: "" + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: sessionId + in: path + description: SessionRefreshController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + requestBody: + description: The new SessionRefreshController resource + content: [] + required: 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 + /views: + post: + operationId: ibexa.rest.views.create + tags: + - Views + responses: + 200: + description: The view in XML or JSON format. + content: + application/vnd.ibexa.api.View+xml; version=1.1: + schema: + $ref: '#/components/schemas/View' + example: | + <?xml version="1.0" encoding="UTF-8"?> + <View href="/views/TitleView" media-type="application/vnd.ibexa.api.View+xml; version=1.1"> + <identifier>TitleView</identifier> + <User href="/user/users/14" media-type="vnd.ibexa.api.User+xml"/> + <public>false</public> + <LocationQuery> + <Filter> + <ParentLocationIdCriterion>2</ParentLocationIdCriterion> + </Filter> + <limit>10</limit> + <offset>0</offset> + <SortClauses> + <ContentName>ascending</ContentName> + </SortClauses> + <FacetBuilders> + <contentTypeFacetBuilder/> + </FacetBuilders> + </LocationQuery> + <Result href="/content/views/view1234/results" + media-type="application/vnd.ibexa.api.ViewResult+xml" count="34" time="31" maxScore="1.0"> + <searchHits> + <searchHit score="1.0" index="installid1234567890"> + <hightlight/> + <value> + <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2"> + <id>2</id> + <priority>0</priority> + <hidden>false</hidden> + <invisible>false</invisible> + <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1"/> + <pathString>/1/2/</pathString> + <depth>1</depth> + <childCount>8</childCount> + <remoteId>f3e90596361e31d496d4026eb624c983</remoteId> + <Children media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/2/children"/> + <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/57"/> + <sortField>PRIORITY</sortField> + <sortOrder>ASC</sortOrder> + <UrlAliases media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/urlaliases"/> + </Location> + + </value> + </searchHit> + <!-- ... --> + </searchHits> + <facets> + <contentTypeFacet> + <contentTypeFacetEntry> + <contentType href="/content/types/1" media-type="application/vnd.ibexa.api.ContentType+xml"/> + <count>3</count> + </contentTypeFacetEntry> + <contentTypeFacetEntry> + <contentType href="/content/types/7" media-type="application/vnd.ibexa.api.ContentType+xml"/> + <count>9</count> + </contentTypeFacetEntry> + <contentTypeFacetEntry> + <contentType href="/content/types/11" media-type="application/vnd.ibexa.api.ContentType+xml"/> + <count>1</count> + </contentTypeFacetEntry> + <contentTypeFacetEntry> + <contentType href="/content/types/15" media-type="application/vnd.ibexa.api.ContentType+xml"/> + <count>8</count> + </contentTypeFacetEntry> + </contentTypeFacet> + </facets> + </Result> + </View> + 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. + View input reflects the criteria model of the public PHP API. + Refer to [Search Criteria Reference](/en/latest/search/criteria_reference/search_criteria_reference/) + parameters: + - name: X-CSRF-Token + in: header + description: The CSRF Token needed on all unsafe HTTP methods with session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + requestBody: + description: The view input in XML or JSON format. + 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"?> + <ViewInput> + <identifier>TitleView</identifier> + <Query> + <Filter> + <ContentTypeIdentifierCriterion>image</ContentTypeIdentifierCriterion> + <SectionIdentifierCriterion>media</SectionIdentifierCriterion> + <DateMetadataCriterion> + <Target>modified</Target> + <Value>1675681020</Value> + <Operator>gte</Operator> + </DateMetadataCriterion> + </Filter> + <limit>10</limit> + <offset>0</offset> + <SortClauses> + <ContentName>ascending</ContentName> + </SortClauses> + <Aggregations> + <Aggregation> + <ContentTypeTermAggregation> + <name>some name</name> + </ContentTypeTermAggregation> + </Aggregation> + </Aggregations> + </Query> + </ViewInput> + required: false +components: + schemas: + BaseObject: type: object required: - _media-type - - Language properties: _media-type: + xml: + attribute: true + name: media-type type: string - Language: - type: array - items: - $ref: '#/components/schemas/LanguageCode' - LanguageCode: - description: Language code. - type: object - required: - - languageCode - properties: - languageCode: + _href: + xml: + attribute: true + name: href 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: + Ref: + $ref: '#/components/schemas/BaseObject' + UnixTimestamp: + type: integer + Href: type: object required: - - identifier - - name + - _href properties: - identifier: - type: string - name: + _href: + xml: + attribute: true + name: href 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: + Target: + description: Struct that stores extra target information for a SortClause object. type: object - required: - - ContentType - properties: - ContentType: - $ref: '#/components/schemas/ContentType' - ContentTypeCreate: - description: This class is used to create a content type. + SortClause: + description: This class is the base for SortClause classes, used to set sorting + of content queries. type: object required: - - identifier - - mainLanguageCode - - remoteId - - urlAliasSchema - - nameSchema - - isContainer - - defaultSortField - - defaultSortOrder - - defaultAlwaysAvailable - - names - - descriptions + - direction + - target + - targetData properties: - identifier: - type: string - mainLanguageCode: + direction: + description: Sort direction. One of Query::SORT_ASC or Query::SORT_DESC. type: string - remoteId: + target: + description: 'Sort target, high level: section_identifier, attribute_value, + etc.' type: string - urlAliasSchema: + 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 - nameSchema: + errorDescription: 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: + Value: + description: Struct that stores extra value information for a Criterion object. + type: object + required: + - _languageCode + - '#text' + properties: + _languageCode: + description: Language code. type: string - format: date-time - ContentTypeCreateWrapper: + '#text': + description: Content type description. + type: + - string + - "null" + ValueObject: type: object required: - - ContentTypeCreate + - value properties: - ContentTypeCreate: - $ref: '#/components/schemas/ContentTypeCreate' - ContentTypeUpdateStruct: - description: This class is used for updating a content type. + value: + type: array + items: + $ref: '#/components/schemas/Value' + ValueArray: type: object + required: + - value 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: + value: + type: array + items: + $ref: '#/components/schemas/Value' + MultilingualValue: + description: Object that represents a multilingual (translated) value. type: object required: - - ContentTypeUpdate + - _languageCode + - '#text' 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: + _languageCode: + description: Language code. + type: string + '#text': + description: Translation contents. + type: + - string + - "null" + KeyValue: + description: Key-value structure type: object required: - - ContentTypeList + - _key + - '#text' properties: - ContentTypeList: - $ref: '#/components/schemas/ContentTypeList' - ContentTypeInfo: + _key: + type: string + '#text': + type: + - string + - "null" + DateRange: allOf: - $ref: '#/components/schemas/BaseObject' - - description: This class stores content type information. + - description: Representation of date range. type: object required: - - id - - status - - identifier - - names - - descriptions - - creationDate - - modificationDate - - Creator - - Modifier - - Groups - - Draft - - remoteId - - urlAliasSchema - - nameSchema - - isContainer - - mainLanguageCode - - defaultAlwaysAvailable - - defaultSortField - - defaultSortOrder + - startDate + - endDate 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 + startDate: 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 + endDate: type: string - ContentTypeInfoWrapper: + BookmarkList: + description: List of bookmarked Locations. type: object required: - - ContentTypeInfo + - count + - items 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: + 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: - - ContentTypeList - properties: - ContentTypeList: - $ref: '#/components/schemas/ContentTypeInfoList' - ContentTypeQuery: - description: This class represents a content type query. - type: object + - BookmarkList 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 + BookmarkList: + $ref: '#/components/schemas/BookmarkList' + SummaryEntry: type: object required: - identifier - - ContentTypeQuery + - id + - names + - quantity + - Price + - PriceInclVat + - SubtotalPrice + - SubtotalPriceInclVat + - VatCategory + - Product 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: + 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 Field definition. + - description: This class represents a Location in the Repository. type: object required: - id - - identifier - - fieldType - - fieldGroup - - position - - isTranslatable - - isRequired - - isInfoCollector - - defaultValue - - isSearchable - - names - - descriptions - - fieldSettings - - validatorConfiguration + - priority + - hidden + - invisible + - remoteId + - ContentInfo + - ParentLocation + - pathString + - depth + - childCount + - sortField + - sortOrder + - Content properties: id: - description: The unique ID of this Field definition. + description: The ID of the Location. 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. + priority: + description: Location priority. Position of the Location among its siblings + when sorted using priority sort order. 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. + hidden: + description: Indicates that the Location entity has been explicitly marked + as hidden. type: boolean - defaultValue: - description: Default value of the field. - isSearchable: - description: Indicates if th the content is searchable by this attribute. + invisible: + description: Indicates that the Location is implicitly marked as hidden + by a parent Location. 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: + 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: - - FieldDefinitionUpdate + - Location properties: - FieldDefinitionUpdate: - $ref: '#/components/schemas/FieldDefinitionUpdate' - FieldDefinitions: + 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: - - FieldDefinition + - LocationCreate properties: - FieldDefinition: - type: array - items: - $ref: '#/components/schemas/FieldDefinition' - FieldDefinitionsWrapper: + LocationCreate: + $ref: '#/components/schemas/LocationCreate' + LocationUpdateStruct: + description: This class is used for updating Location meta data. type: object required: - - FieldDefinitions + - priority + - remoteId + - hidden + - sortField + - sortOrder properties: - FieldDefinitions: - $ref: '#/components/schemas/FieldDefinitions' - StringLengthValidator: - description: Validator for checking min. and max. length of strings. + 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: - - maxStringLength - - minStringLength + - LocationUpdate properties: - maxStringLength: - description: Maximum length of strings. - type: - - integer - - "null" - minStringLength: - description: Minimum length of strings. - type: - - integer - - "null" - StringLengthValidatorWrapper: + 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: - - StringLengthValidator + - LocationList properties: - StringLengthValidator: - $ref: '#/components/schemas/StringLengthValidator' - UrlAlias: + LocationList: + $ref: '#/components/schemas/LocationList' + Content: allOf: - $ref: '#/components/schemas/BaseObject' - - description: This class represents a URL alias in the Repository. + - description: Content ID matcher class. type: object required: + - _remoteId - _id - - _type - - resource - - path - - languageCodes + - ContentType + - Name + - Versions + - CurrentVersion + - Section + - Locations + - Owner + - mainLanguageCode + - currentVersionNo - alwaysAvailable - - isHistory - - forward - - custom + - status + - ObjectStates properties: - _id: - description: A unique identifier for the alias. + _remoteId: + description: Remote ID of the content type. xml: attribute: true - name: id + name: remoteId 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 + _id: + description: Unique ID of the content type. xml: attribute: true - name: type + 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 - 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. + 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 - languageCodes: - description: The languageCodes for which this path is valid. + 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: 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. + description: Indicates if the content item is shown in the main language + if it's not present in an other requested language. type: boolean - UrlAliasWrapper: + 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: - - UrlAlias + - _href + - FieldDefinitions properties: - UrlAlias: - $ref: '#/components/schemas/UrlAlias' - UrlAliasCreate: + _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: - - _type + - ObjectState properties: - _type: + 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 - location: - $ref: '#/components/schemas/Href' - resource: + modificationDate: + description: The last modified date of this version. type: string - languageCode: + 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 - alwaysAvailable: - type: - - string - - boolean - forward: - type: - - string - - boolean - UrlAliasCreateWrapper: + 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: - - UrlAliasCreate + - Version properties: - UrlAliasCreate: - $ref: '#/components/schemas/UrlAliasCreate' - UrlAliasRefList: + Version: + $ref: '#/components/schemas/Version' + VersionUpdate: allOf: - $ref: '#/components/schemas/BaseObject' - - description: List of URL alias in the Repository. + - description: This class is used to update a content version. type: object required: - - UrlAlias + - modificationDate + - initialLanguageCode + - fields properties: - UrlAlias: + modificationDate: + type: string + format: date-time + initialLanguageCode: + type: string + fields: type: array items: - $ref: '#/components/schemas/Ref' - UrlAliasRefListWrapper: + $ref: '#/components/schemas/Field' + VersionUpdateWrapper: type: object required: - - UrlAliasRefList + - VersionUpdate properties: - UrlAliasRefList: - $ref: '#/components/schemas/UrlAliasRefList' - UrlWildcard: + VersionUpdate: + $ref: '#/components/schemas/VersionUpdate' + VersionList: allOf: - $ref: '#/components/schemas/BaseObject' - - description: This class represents a URL alias in the Repository. + - description: List of all versions of the content. type: object required: - - _id - - sourceUrl - - destinationUrl - - forward + - VersionItem 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: + VersionItem: + type: array + items: + $ref: '#/components/schemas/VersionItem' + VersionListWrapper: type: object required: - - UrlWildcard + - VersionList properties: - UrlWildcard: - $ref: '#/components/schemas/UrlWildcard' - UrlWildcardCreate: - description: Creates a new URL wildcard. + VersionList: + $ref: '#/components/schemas/VersionList' + VersionItem: + description: Version of content. type: object required: - - sourceUrl - - destinationUrl - - forward + - Version + - VersionInfo properties: - sourceUrl: - type: string - destinationUrl: - type: string - forward: - type: - - string - - boolean - UrlWildcardCreateWrapper: + Version: + description: Returns the VersionInfo for this version. + $ref: '#/components/schemas/BaseObject' + VersionInfo: + $ref: '#/components/schemas/VersionInfo' + VersionTranslationInfo: + description: Translation information. type: object required: - - URLWildcardCreate + - _media-type + - Language 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: + _media-type: + type: string + Language: + type: array + items: + $ref: '#/components/schemas/LanguageCode' + LanguageCode: + description: Language code. type: object required: - - UrlWildcardList + - languageCode properties: - UrlWildcardList: - $ref: '#/components/schemas/UrlWildcardList' - Language: + languageCode: + type: string + Relation: allOf: - $ref: '#/components/schemas/BaseObject' - - description: This class represents a language in the Repository. + - description: Class representing a relation between content. type: object required: - - languageId - - languageCode - - name + - SourceContent + - DestinationContent + - RelationType 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. + 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 - LanguageWrapper: + RelationWrapper: type: object required: - - Language + - Relation properties: - Language: - $ref: '#/components/schemas/Language' - LanguageList: + 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: List of languages. + - description: Class representing a list of relations between content. type: object required: - - Language + - Relation properties: - Language: + Relation: type: array items: - $ref: '#/components/schemas/Language' - LanguageListWrapper: + $ref: '#/components/schemas/Relation' + RelationListWrapper: type: object required: - - LanguageList + - Relations properties: - LanguageList: - $ref: '#/components/schemas/LanguageList' - ObjectState: + 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 Object state value. + - description: This class represents a Section. type: object required: - - id + - sectionId - identifier - - priority - - ObjectStateGroup - - languageCodes - - names - - descriptions + - name properties: - id: - description: Primary key. + sectionId: + description: ID of the Section. type: integer identifier: - description: Readable string identifier of the Object state. + description: Unique identifier of the Section. 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. + name: + description: Name of the Section. type: string - names: - description: Names. - descriptions: - description: Descriptions. - ObjectStateWrapper: + SectionWrapper: type: object required: - - ObjectState + - Section properties: - ObjectState: - $ref: '#/components/schemas/ObjectState' - ObjectStateCreate: - description: This class represents a value for creating Object states. + Section: + $ref: '#/components/schemas/Section' + SectionInput: type: object required: - identifier - - priority - - defaultLanguageCode - - languageCodes - - names - - descriptions + - name 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. + name: 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: + SectionInputWrapper: type: object required: - - ObjectStateCreate - properties: - ObjectStateCreate: - $ref: '#/components/schemas/ObjectStateCreate' - ObjectStateUpdate: - description: This class represents a value for updating Object states. - type: object + - SectionInput 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: + 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: - - ObjectStateUpdate + - SectionList properties: - ObjectStateUpdate: - $ref: '#/components/schemas/ObjectStateUpdate' - ObjectStateList: + SectionList: + $ref: '#/components/schemas/SectionList' + Trash: allOf: - $ref: '#/components/schemas/BaseObject' - - description: List of Object states. - type: object + - type: object required: - - ObjectState + - TrashItem properties: - ObjectState: + TrashItem: type: array items: - $ref: '#/components/schemas/ObjectState' - ObjectStateListWrapper: + $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: - - ObjectStateList + - TrashItem properties: - ObjectStateList: - $ref: '#/components/schemas/ObjectStateList' - ObjectStateGroup: + TrashItem: + $ref: '#/components/schemas/TrashItem' + ContentTypeGroup: allOf: - $ref: '#/components/schemas/BaseObject' - - description: This class represents an Object state group value. + - description: This class represents a content type group value. type: object required: - id - identifier - - defaultLanguageCode - - languageCodes - - ObjectStates - - names - - descriptions + - created + - modified + - Creator + - Modifier + - ContentTypes properties: id: description: Primary key. @@ -42778,5081 +30419,5295 @@ components: identifier: description: Readable string identifier of a group. type: string - defaultLanguageCode: - description: The default language code. + created: + description: Created date (integer). type: string - languageCodes: - description: The available language codes for names an descriptions. + format: date-time + modified: + description: Modified date (integer). type: string - ObjectStates: - description: Object States. + format: date-time + Creator: + description: Creator User ID. $ref: '#/components/schemas/BaseObject' - names: - description: List of names. - descriptions: - description: List of descriptions. - ObjectStateGroupWrapper: + Modifier: + description: Modifier User ID. + $ref: '#/components/schemas/BaseObject' + ContentTypes: + description: Content types. + $ref: '#/components/schemas/BaseObject' + ContentTypeGroupWrapper: type: object required: - - ObjectStateGroup + - ContentTypeGroup properties: - ObjectStateGroup: - $ref: '#/components/schemas/ObjectStateGroup' - ObjectStateGroupCreate: - description: This class represents a value for creating Object state groups. + ContentTypeGroup: + $ref: '#/components/schemas/ContentTypeGroup' + ContentTypeGroupInput: 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: + ContentTypeGroupInputWrapper: type: object required: - - ObjectStateGroupCreate - properties: - ObjectStateGroupCreate: - $ref: '#/components/schemas/ObjectStateGroupCreate' - ObjectStateGroupUpdate: - description: This class represents a value for updating Object state groups. - type: object + - ContentTypeGroupInput 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: + ContentTypeGroupInput: + $ref: '#/components/schemas/ContentTypeGroupInput' + ContentTypeGroupListWrapper: type: object required: - - ObjectStateGroupUpdate + - ContentTypeGroupList properties: - ObjectStateGroupUpdate: - $ref: '#/components/schemas/ObjectStateGroupUpdate' - ObjectStateGroupList: + 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 Object state groups. + - description: List of content type groups references. type: object required: - - ObjectStateGroup + - ContentTypeGroupRef 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: + ContentTypeGroupRef: + $ref: '#/components/schemas/ContentTypeGroupRef' + ContentTypeGroupList: allOf: - $ref: '#/components/schemas/BaseObject' - - description: This class is representing an ISO-3166 formatted list of world - countries. + - description: List of content type groups. type: object required: - - Country + - ContentTypeGroup properties: - Country: + ContentTypeGroup: type: array items: - $ref: '#/components/schemas/Country' - Country: + $ref: '#/components/schemas/ContentTypeGroup' + ContentTypeGroupRefListWrapper: + type: object + required: + - ContentTypeGroupRefList + properties: + ContentTypeGroupRefList: + $ref: '#/components/schemas/ContentTypeGroupRefList' + ContentType: allOf: - $ref: '#/components/schemas/BaseObject' - - description: This class is representing a country. + - description: This class represents a content type. type: object required: - - _id - - name - - Alpha2 - - Alpha3 - - IDC + - id + - status + - identifier + - names + - descriptions + - creationDate + - modificationDate + - Creator + - Modifier + - Groups + - Draft + - remoteId + - urlAliasSchema + - nameSchema + - isContainer + - defaultAlwaysAvailable + - defaultSortField + - defaultSortOrder + - FieldDefinitions properties: - _id: - description: ID that represents a country name. - xml: - attribute: true - name: id + 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 - name: - description: Name of the country. + identifier: + description: String identifier of a content type. type: string - Alpha2: - description: Two-letter code that represents a country name. + names: + description: Name of a content type. + descriptions: + description: Description of a content type. + creationDate: + description: Creation date of the content type. type: string - Alpha3: - description: Three-letter code that represents a country name. + format: date-time + modificationDate: + description: Modification date of the content type. type: string - IDC: - description: IDC - type: integer - CountryListWrapper: + 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: - - CountryList + - ContentType properties: - CountryList: - $ref: '#/components/schemas/CountryList' - View: - description: View. + ContentType: + $ref: '#/components/schemas/ContentType' + ContentTypeCreate: + description: This class is used to create a content type. type: object required: - identifier - - User - - public - - LocationQuery - - Result + - mainLanguageCode + - remoteId + - urlAliasSchema + - nameSchema + - isContainer + - defaultSortField + - defaultSortOrder + - defaultAlwaysAvailable + - names + - descriptions 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. + mainLanguageCode: type: string - languageCode: + remoteId: type: string - useAlwaysAvailable: + urlAliasSchema: type: string - Query: - $ref: '#/components/schemas/Query' - ViewInputWrapper: + 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: - - ViewInput - properties: - ViewInput: - $ref: '#/components/schemas/ViewInput' - Query: - description: This class is used to perform a Content query. - type: object + - ContentTypeCreate 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. + ContentTypeCreate: + $ref: '#/components/schemas/ContentTypeCreate' + ContentTypeUpdateStruct: + description: This class is used for updating a content type. type: object properties: - operator: - description: The operator used by the Criterion. + identifier: + description: If set the unique identifier of a type is changed to this value. 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...). + remoteId: + description: If set the remote ID is changed to this value. 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. + urlAliasSchema: + description: If set the URL alias schema is changed to this value. type: string - global: - description: If true the facet runs in a global mode not restricted by the - query. + 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 - 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. + mainLanguageCode: + description: If set the main language is changed to this value. type: string - valueFormat: - description: Format supported for the Criterion value, either {@see self::FORMAT_SINGLE} - for single or {@see self::FORMAT_ARRAY} for multiple. + 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 - 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}. + 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 - Role: + 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 represents a role. + - description: This class is used to update a content type. 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: + 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: - - RoleInput + - ContentTypeUpdate properties: - RoleInput: - $ref: '#/components/schemas/RoleInput' - RoleList: + ContentTypeUpdate: + $ref: '#/components/schemas/ContentTypeUpdate' + ContentTypeList: allOf: - $ref: '#/components/schemas/BaseObject' - - description: This class represents a list roles. + - description: List of content types. type: object required: - - Role + - ContentType properties: - Role: + ContentType: type: array items: - $ref: '#/components/schemas/Role' - RoleListWrapper: + $ref: '#/components/schemas/ContentType' + ContentTypeListWrapper: type: object required: - - RoleList + - ContentTypeList properties: - RoleList: - $ref: '#/components/schemas/RoleList' - Policy: + ContentTypeList: + $ref: '#/components/schemas/ContentTypeList' + ContentTypeInfo: allOf: - $ref: '#/components/schemas/BaseObject' - - description: This class represents a policy value. + - description: This class stores content type information. type: object required: - id - - module - - function + - status + - identifier + - names + - descriptions + - creationDate + - modificationDate + - Creator + - Modifier + - Groups + - Draft + - remoteId + - urlAliasSchema + - nameSchema + - isContainer + - mainLanguageCode + - defaultAlwaysAvailable + - defaultSortField + - defaultSortOrder properties: id: - description: ID of the policy. + description: Content type ID. type: integer - module: - description: Name of module, associated with the Policy e.g. content. + 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 - function: - description: Name of the module function Or all functions with '*' e.g. - read. + identifier: + description: String identifier of a content type. 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. + 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: - - _identifier - - values + - ContentTypeInfo 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: + ContentTypeInfo: + $ref: '#/components/schemas/ContentTypeInfo' + ContentTypeInfoList: allOf: - $ref: '#/components/schemas/BaseObject' - - description: List of policies. + - description: List of content type information. type: object required: - - Policy + - ContentType properties: - Policy: + ContentType: + description: This class stores content type information. type: array items: - $ref: '#/components/schemas/Policy' - PolicyListWrapper: + $ref: '#/components/schemas/ContentTypeInfo' + ContentTypeInfoListWrapper: type: object required: - - PolicyList + - ContentTypeList properties: - PolicyList: - $ref: '#/components/schemas/PolicyList' - PolicyCreate: + 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 is used to create a Policy. + - description: This class represents a Field definition. type: object required: - - module - - function - - Limitations + - id + - identifier + - fieldType + - fieldGroup + - position + - isTranslatable + - isRequired + - isInfoCollector + - defaultValue + - isSearchable + - names + - descriptions + - fieldSettings + - validatorConfiguration properties: - module: - description: Name of module associated with the Policy. For example, content. + id: + description: The unique ID of this Field definition. + type: integer + identifier: + description: Readable string identifier of a Field definition. type: string - function: - description: Name of the module function, or all functions with ''*''. - For example, read. + fieldType: + description: String identifier of the field type. type: string - Limitations: - type: array - items: - $ref: '#/components/schemas/Limitation' - PolicyCreateWrapper: + 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: - - PolicyCreate + - FieldDefinition 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: + FieldDefinition: + $ref: '#/components/schemas/FieldDefinition' + FieldDefinitionCreate: + $ref: '#/components/schemas/BaseObject' + FieldDefinitionCreateWrapper: type: object required: - - PolicyUpdate + - FieldDefinitionCreate 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: + FieldDefinitionCreate: + $ref: '#/components/schemas/FieldDefinitionCreate' + FieldDefinitionUpdate: + $ref: '#/components/schemas/BaseObject' + FieldDefinitionUpdateWrapper: type: object required: - - RoleAssignment + - FieldDefinitionUpdate properties: - RoleAssignment: - $ref: '#/components/schemas/RoleAssignment' - RoleAssignInput: - description: This class represents a Role assign input. + FieldDefinitionUpdate: + $ref: '#/components/schemas/FieldDefinitionUpdate' + FieldDefinitions: type: object required: - - Role - - limitation + - FieldDefinition 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: + FieldDefinition: + type: array + items: + $ref: '#/components/schemas/FieldDefinition' + FieldDefinitionsWrapper: type: object required: - - RoleAssignInput + - FieldDefinitions 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: + FieldDefinitions: + $ref: '#/components/schemas/FieldDefinitions' + StringLengthValidator: + description: Validator for checking min. and max. length of strings. type: object required: - - RoleAssignmentList + - maxStringLength + - minStringLength 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: + maxStringLength: + description: Maximum length of strings. + type: + - integer + - "null" + minStringLength: + description: Minimum length of strings. + type: + - integer + - "null" + StringLengthValidatorWrapper: type: object required: - - Session + - StringLengthValidator properties: - Session: - $ref: '#/components/schemas/Session' - SessionInput: + StringLengthValidator: + $ref: '#/components/schemas/StringLengthValidator' + UrlAlias: allOf: - $ref: '#/components/schemas/BaseObject' - - description: This class represents a session input. + - description: This class represents a URL alias in the Repository. type: object required: - - login - - password + - _id + - _type + - resource + - path + - languageCodes + - alwaysAvailable + - isHistory + - forward + - custom properties: - login: + _id: + description: A unique identifier for the alias. + xml: + attribute: true + name: id type: string - password: + _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 - SessionInputWrapper: + 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: - - SessionInput + - UrlAlias properties: - SessionInput: - $ref: '#/components/schemas/SessionInput' - JWT: - description: This class represents the JWT authentication token + UrlAlias: + $ref: '#/components/schemas/UrlAlias' + UrlAliasCreate: type: object required: - - token + - _type properties: - token: - description: JWT authentication token + _type: type: string - JWTWrapper: + location: + $ref: '#/components/schemas/Href' + resource: + type: string + languageCode: + type: string + alwaysAvailable: + type: + - string + - boolean + forward: + type: + - string + - boolean + UrlAliasCreateWrapper: type: object required: - - JWT + - UrlAliasCreate properties: - JWT: - $ref: '#/components/schemas/JWT' - JWTInput: + UrlAliasCreate: + $ref: '#/components/schemas/UrlAliasCreate' + UrlAliasRefList: allOf: - $ref: '#/components/schemas/BaseObject' - - description: This class represents the input for a JWT authentication token + - description: List of URL alias in the Repository. type: object required: - - username - - password + - UrlAlias properties: - username: - description: User name - type: string - password: - description: User password - type: string - JWTInputWrapper: + UrlAlias: + type: array + items: + $ref: '#/components/schemas/Ref' + UrlAliasRefListWrapper: type: object required: - - JWTInput + - UrlAliasRefList properties: - JWTInput: - $ref: '#/components/schemas/JWTInput' - UserGroup: + UrlAliasRefList: + $ref: '#/components/schemas/UrlAliasRefList' + UrlWildcard: allOf: - $ref: '#/components/schemas/BaseObject' - - description: Content ID matcher class. + - description: This class represents a URL alias in the Repository. type: object required: - - _remoteId - _id - - ContentType - - name - - Versions - - Section - - MainLocation - - Locations - - Owner - - lastModificationDate - - mainLanguageCode - - alwaysAvailable - - Version - - ParentUserGroup - - Subgroups - - Users - - Roles + - sourceUrl + - destinationUrl + - forward properties: - _remoteId: - description: Remote ID of the content type. - xml: - attribute: true - name: remoteId - type: string _id: - description: Unique ID of the content type. + description: The unique ID. 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. + sourceUrl: + description: The source URL. type: string - format: date-time - mainLanguageCode: - description: The main language code of the content item. + destinationUrl: + description: The destination URL containing placeholders e.g. /destination/{1}. type: string - alwaysAvailable: + forward: + description: Indicates if the URL is redirected or not. 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: + UrlWildcardWrapper: type: object required: - - UserGroup + - UrlWildcard properties: - UserGroup: - $ref: '#/components/schemas/UserGroup' - UserGroupList: - description: This class represents a User Group list. - $ref: '#/components/schemas/BaseObject' - UserGroupListWrapper: + UrlWildcard: + $ref: '#/components/schemas/UrlWildcard' + UrlWildcardCreate: + description: Creates a new URL wildcard. type: object required: - - UserGroupList + - sourceUrl + - destinationUrl + - forward properties: - UserGroupList: - $ref: '#/components/schemas/UserGroupList' - UserGroupRefList: + 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: Returns a list of the sub groups. + - description: List of URL alias in the Repository. type: object required: - - UserGroup + - UrlWildcard properties: - UserGroup: - description: This class represents a User group. + UrlWildcard: type: array items: - $ref: '#/components/schemas/Ref' - UserGroupRefListWrapper: + $ref: '#/components/schemas/UrlWildcard' + UrlWildcardListWrapper: type: object required: - - UserGroupRefList + - UrlWildcardList properties: - UserGroupRefList: - $ref: '#/components/schemas/UserGroupRefList' - UserGroupCreate: - description: This class is used to create a User Group. + 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: - - mainLanguageCode - - remoteId - - fields + - Language properties: - mainLanguageCode: - type: string - remoteId: - type: string - fields: - $ref: '#/components/schemas/Fields' - UserGroupCreateWrapper: + 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: - - UserGroupCreate + - LanguageList properties: - UserGroupCreate: - $ref: '#/components/schemas/UserGroupCreate' - UserGroupUpdate: - description: This class is used to update a User group in the Repository. + 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: - - Section + - ObjectState properties: - Section: - type: object - required: - - _href - properties: - _href: - xml: - attribute: true - name: href - type: string - UserGroupUpdateWrapper: + ObjectState: + $ref: '#/components/schemas/ObjectState' + ObjectStateCreate: + description: This class represents a value for creating Object states. type: object required: - - UserGroupUpdate + - identifier + - priority + - defaultLanguageCode + - languageCodes + - names + - descriptions 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. + 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: - - _href - - _method + - ObjectStateCreate properties: - _href: - type: string - _method: - enum: - - DELETE - type: string - User: + ObjectStateCreate: + $ref: '#/components/schemas/ObjectStateCreate' + ObjectStateUpdate: + description: This class represents a value for updating Object states. type: object - description: Reference to a registered user account properties: - _media-type: + identifier: + description: Readable unique string identifier of a group. type: string - description: Media type identifier for the user reference - _href: + defaultLanguageCode: + description: The default language code. type: string - description: REST API URL reference to the user resource - format: uri - required: - - _media-type - - _href - additionalProperties: false - UserWrapper: + names: + description: An array of names with languageCode keys. + descriptions: + description: An array of descriptions with languageCode keys. + ObjectStateUpdateWrapper: type: object required: - - User + - ObjectStateUpdate properties: - User: - $ref: '#/components/schemas/User' - UserList: + ObjectStateUpdate: + $ref: '#/components/schemas/ObjectStateUpdate' + ObjectStateList: allOf: - $ref: '#/components/schemas/BaseObject' - - description: This class represents a list of users. + - description: List of Object states. type: object required: - - User + - ObjectState properties: - User: + ObjectState: type: array items: - $ref: '#/components/schemas/User' - UserListWrapper: + $ref: '#/components/schemas/ObjectState' + ObjectStateListWrapper: type: object required: - - UserList + - ObjectStateList properties: - UserList: - $ref: '#/components/schemas/UserList' - UserRefList: + ObjectStateList: + $ref: '#/components/schemas/ObjectStateList' + ObjectStateGroup: allOf: - $ref: '#/components/schemas/BaseObject' - - description: Returns a list of the users. + - description: This class represents an Object state group value. type: object required: - - User + - id + - identifier + - defaultLanguageCode + - languageCodes + - ObjectStates + - names + - descriptions properties: - User: - description: This class represents a User. - type: array - items: - $ref: '#/components/schemas/BaseObject' - UserRefListWrapper: + 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: - - UserRefList + - ObjectStateGroup properties: - UserRefList: - $ref: '#/components/schemas/UserRefList' - UserUpdate: - description: This class is used to update a User. + ObjectStateGroup: + $ref: '#/components/schemas/ObjectStateGroup' + ObjectStateGroupCreate: + description: This class represents a value for creating Object state groups. type: object required: - - login + - identifier + - defaultLanguageCode + - names + - descriptions properties: - login: - type: string - email: + identifier: + description: Readable unique string identifier of a group. type: string - password: + defaultLanguageCode: + description: The default language code. 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: + 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: - - UserUpdate + - ObjectStateGroupCreate properties: - UserUpdate: - $ref: '#/components/schemas/UserUpdate' - UserCreate: - description: This class is used to create a User. + ObjectStateGroupCreate: + $ref: '#/components/schemas/ObjectStateGroupCreate' + ObjectStateGroupUpdate: + description: This class represents a value for updating Object state groups. type: object - required: - - mainLanguageCode - - remoteId - - login - - email - - password properties: - mainLanguageCode: - type: string - remoteId: - type: string - login: - type: string - email: + identifier: + description: Readable unique string identifier of a group. type: string - password: + defaultLanguageCode: + description: The default language code. type: string - enabled: - type: boolean - UserCreateWrapper: + names: + description: An array of names with languageCode keys. + descriptions: + description: An array of descriptions with languageCode keys. + ObjectStateGroupUpdateWrapper: type: object required: - - UserCreate + - ObjectStateGroupUpdate properties: - UserCreate: - $ref: '#/components/schemas/UserCreate' - Event: + ObjectStateGroupUpdate: + $ref: '#/components/schemas/ObjectStateGroupUpdate' + ObjectStateGroupList: allOf: - $ref: '#/components/schemas/BaseObject' - - description: Calendar event. + - description: List of Object state groups. type: object required: - - id - - datetime - - type - - name - - attributes + - ObjectStateGroup 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. + ObjectStateGroup: + description: This class represents an Object state group value. type: array items: - $ref: '#/components/schemas/EventAttribute' - EventAttribute: + $ref: '#/components/schemas/ObjectStateGroup' + ObjectStateGroupListWrapper: type: object required: - - label - - value + - ObjectStateGroupList properties: - label: - description: Label of the attribute. - type: string - value: - description: Value of the attribute. - type: string - EventList: + ObjectStateGroupList: + $ref: '#/components/schemas/ObjectStateGroupList' + CountryList: allOf: - $ref: '#/components/schemas/BaseObject' - - description: List of calendar events. + - description: This class is representing an ISO-3166 formatted list of world + countries. type: object required: - - _currentPage - - totalCount - - events + - Country 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: + Country: type: array items: - $ref: '#/components/schemas/Event' - EventListWrapper: - type: object - required: - - EventList - properties: - EventList: - $ref: '#/components/schemas/EventList' - EventGroup: + $ref: '#/components/schemas/Country' + Country: allOf: - $ref: '#/components/schemas/BaseObject' - - description: Event group. + - description: This class is representing a country. type: object required: - - _currentPage - - totalCount - - events + - _id + - name + - Alpha2 + - Alpha3 + - IDC properties: - _currentPage: - description: Current page representation. + _id: + description: ID that represents a country name. xml: attribute: true - name: currentPage + name: id type: string - nextPage: - description: Next page representation. + name: + description: Name of the country. type: string - groupKey: - $ref: '#/components/schemas/DateRange' - totalCount: - description: Total count of events. + 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 - 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: + CountryListWrapper: type: object required: - - EventGroupList + - CountryList properties: - EventGroupList: - $ref: '#/components/schemas/EventGroupList' - RescheduleAction: - description: This class represents events to reschedule + CountryList: + $ref: '#/components/schemas/CountryList' + View: + description: View. type: object required: - - events - - dateTime + - identifier + - User + - public + - LocationQuery + - Result properties: - events: - description: list of events + 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: - type: string - dateTime: - description: timestamp to reschedule events to + $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 - RescheduleActionWrapper: + 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: - - RescheduleAction + - name + - global + - filter + - limit + - minCount properties: - RescheduleAction: - $ref: '#/components/schemas/RescheduleAction' - UnscheduleAction: - description: This class represents events to unschedule + 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: - - events + - Role properties: - events: - description: list of events - type: array - items: - type: string - UnscheduleActionWrapper: + 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: - - UnscheduleAction + - Role properties: - UnscheduleAction: - $ref: '#/components/schemas/UnscheduleAction' - AttributeGroup: - description: This class represents an attribute group. + Role: + $ref: '#/components/schemas/RoleDraft' + RoleInput: + description: This class represents a Role input. type: object required: - - name - identifier - - position properties: - name: - type: string identifier: type: string - position: - type: integer - AttributeGroupWrapper: + RoleInputWrapper: type: object required: - - AttributeGroup + - RoleInput properties: - AttributeGroup: - $ref: '#/components/schemas/AttributeGroup' - AttributeGroupCreate: - description: This class is used to create an attribute group. + 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: - - identifier - - names - - position + - RoleList properties: - identifier: - type: string - names: - type: object - position: - type: integer - AttributeGroupCreateWrapper: + 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: - - AttributeGroupCreate + - Policy properties: - AttributeGroupCreate: - $ref: '#/components/schemas/AttributeGroupCreate' - AttributeGroupUpdate: - description: This class is used to update an attribute group. + Policy: + $ref: '#/components/schemas/Policy' + Limitation: + description: This class represents a Limitation applied to a policy. type: object required: - - identifier - - names - - position + - _identifier + - values properties: - identifier: + _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 - names: + 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 - position: - type: integer - AttributeGroupUpdateWrapper: + 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: - - AttributeGroupUpdate + - PolicyList properties: - AttributeGroupUpdate: - $ref: '#/components/schemas/AttributeGroupUpdate' - AttributeGroupList: + PolicyList: + $ref: '#/components/schemas/PolicyList' + PolicyCreate: allOf: - $ref: '#/components/schemas/BaseObject' - - description: This class represents an attribute group list. + - description: This class is used to create a Policy. type: object required: - - AttributeGroup + - module + - function + - Limitations properties: - AttributeGroup: + 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/AttributeGroup' - AttributeGroupListWrapper: + $ref: '#/components/schemas/Limitation' + PolicyCreateWrapper: type: object required: - - AttributeGroupList + - PolicyCreate properties: - AttributeGroupList: - $ref: '#/components/schemas/AttributeGroupList' - AttributeGroupListGet: - description: This class represents an attribute group list request. + 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: - - prefix - - offset - - limit + - PolicyUpdate properties: - prefix: - type: string - offset: - type: integer - limit: - type: integer - AttributeGroupListGetWrapper: + 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: - - AttributeGroupListGet + - RoleAssignment properties: - AttributeGroupListGet: - $ref: '#/components/schemas/AttributeGroupListGet' - AttributeGroupGet: - description: This class represents an attribute group query. + RoleAssignment: + $ref: '#/components/schemas/RoleAssignment' + RoleAssignInput: + description: This class represents a Role assign input. type: object required: - - languages + - Role + - limitation properties: - languages: - type: array - items: - type: string - AttributeGroupGetWrapper: + 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: - - AttributeGroupGet + - RoleAssignInput properties: - AttributeGroupGet: - $ref: '#/components/schemas/AttributeGroupGet' - AttributeGroupListResult: + RoleAssignInput: + $ref: '#/components/schemas/RoleAssignInput' + RoleAssignmentList: allOf: - $ref: '#/components/schemas/BaseObject' - - type: object + - description: This value object represents a list of assignments of a User + or User group to a role including a limitation. + type: object required: - - count - - AttributeGroupList + - RoleAssignment properties: - count: - type: integer - AttributeGroupList: - $ref: '#/components/schemas/AttributeGroupList' - AttributeGroupView: + 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: This class represents an attribute group view. + - description: Value for session. type: object required: + - name - identifier - - Result + - csrfToken + - User properties: + name: + description: Name. + type: string identifier: + description: 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 + csrfToken: + description: csrfToken. + type: string + User: + description: User. + $ref: '#/components/schemas/BaseObject' + SessionWrapper: type: object required: - - identifier - - AttributeGroupQuery + - Session properties: - identifier: - type: string - AttributeGroupQuery: - type: object - required: - - limit - - offset - - name_prefix - properties: - limit: - type: string - offset: - type: string - name_prefix: - type: string - AttributeGroupViewInputWrapper: + 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: - - ViewInput + - SessionInput properties: - ViewInput: - $ref: '#/components/schemas/AttributeGroupViewInput' - AttributeType: - description: This class represents an attribute type. + SessionInput: + $ref: '#/components/schemas/SessionInput' + JWT: + description: This class represents the JWT authentication token type: object required: - - identifier - - name + - token properties: - identifier: - type: string - name: + token: + description: JWT authentication token 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. + JWTWrapper: type: object required: - - name - - identifier - - description - - type - - type_identifier - - value - - group - - position - - options + - JWT 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: + 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: - - Attribute + - JWTInput properties: - Attribute: - $ref: '#/components/schemas/Attribute' - AttributeCreate: - description: This class is used to create an attribute. + 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: - - identifier - - type - - group - - names - - descriptions - - position - - options + - UserGroup properties: - identifier: - type: string - type: - type: string - group: - type: string - names: - type: object - descriptions: - type: object - position: - type: integer - options: - type: - - object - - array - AttributeCreateWrapper: + UserGroup: + $ref: '#/components/schemas/UserGroup' + UserGroupList: + description: This class represents a User Group list. + $ref: '#/components/schemas/BaseObject' + UserGroupListWrapper: type: object required: - - AttributeCreate + - UserGroupList properties: - AttributeCreate: - $ref: '#/components/schemas/AttributeCreate' - AttributeUpdate: - description: This class is used to update an attribute. + 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: - - identifier - - names - - descriptions - - position - - options + - UserGroupRefList properties: - identifier: - type: string - names: - type: object - descriptions: - type: object - position: - type: integer - options: - type: object - AttributeUpdateWrapper: + UserGroupRefList: + $ref: '#/components/schemas/UserGroupRefList' + UserGroupCreate: + description: This class is used to create a User Group. type: object required: - - AttributeUpdate - properties: - AttributeUpdate: - $ref: '#/components/schemas/AttributeUpdate' - AttributeListGet: - description: This class represents an attribute list query - type: object + - mainLanguageCode + - remoteId + - fields properties: - group_name_prefix: + mainLanguageCode: type: string - name_prefix: + remoteId: type: string - offset: - type: integer - limit: - type: integer - AttributeListGetWrapper: + fields: + $ref: '#/components/schemas/Fields' + UserGroupCreateWrapper: type: object required: - - AttributeListGet + - UserGroupCreate properties: - AttributeListGet: - $ref: '#/components/schemas/AttributeListGet' - AttributeList: - description: This class represents an attribute list. + UserGroupCreate: + $ref: '#/components/schemas/UserGroupCreate' + UserGroupUpdate: + description: This class is used to update a User group in the Repository. type: object required: - - Attribute + - Section properties: - Attribute: - type: array - items: - $ref: '#/components/schemas/Attribute' - AttributeListWrapper: + Section: + type: object + required: + - _href + properties: + _href: + xml: + attribute: true + name: href + type: string + UserGroupUpdateWrapper: type: object required: - - AttributeList + - UserGroupUpdate properties: - AttributeList: - $ref: '#/components/schemas/AttributeList' - AttributeView: - description: This class represents an attribute view. + 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: - - identifier - - AttributeQuery - - Result + - _href + - _method properties: - identifier: + _href: type: string - AttributeQuery: - type: object - Result: - type: object - AttributeViewWrapper: + _method: + enum: + - DELETE + type: string + User: type: object - required: - - AttributeView + description: Reference to a registered user account properties: - AttributeView: - $ref: '#/components/schemas/AttributeView' - AttributeViewInput: - description: This class represents an attribute view input. - xml: - name: ViewInput + _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: - - identifier - - AttributeQuery + - User properties: - identifier: - type: string - AttributeQuery: - type: object - AttributeViewInputWrapper: + 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: - - ViewInput + - UserList properties: - ViewInput: - $ref: '#/components/schemas/AttributeViewInput' - AttributeAssignment: + 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: - - is_required - - is_discriminator - - Attribute + - UserRefList properties: - is_required: - type: boolean - is_discriminator: - type: boolean - Attribute: - $ref: '#/components/schemas/Attribute' - Catalog: - description: This class represents a catalog. + UserRefList: + $ref: '#/components/schemas/UserRefList' + UserUpdate: + description: This class is used to update a User. type: object required: - - identifier - - name - - description - - created - - modified - - status - - User - - Criteria + - login properties: - identifier: + login: type: string - name: + email: type: string - description: + password: type: string - created: - type: integer - modified: + enabled: + type: boolean + maxLogin: type: integer - status: - type: string - User: - $ref: '#/components/schemas/Ref' - Criteria: - type: array - items: - $ref: '#/components/schemas/Criterion' - CatalogWrapper: + ContentUpdate: + description: The update structure for the profile content. + ContentMetadataUpdate: + description: The update structure for the profile metadata. + UserUpdateWrapper: type: object required: - - Catalog + - UserUpdate properties: - Catalog: - $ref: '#/components/schemas/Catalog' - CatalogCreate: - description: This class is used to create a catalog. + UserUpdate: + $ref: '#/components/schemas/UserUpdate' + UserCreate: + description: This class is used to create a User. type: object required: - - identifier - - criteria - - names - - status + - mainLanguageCode + - remoteId + - login + - email + - password properties: - identifier: + mainLanguageCode: type: string - criteria: - $ref: '#/components/schemas/Criterion' - names: - type: object - descriptions: - type: object - status: + remoteId: 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: + login: type: string - transition: + email: 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: + password: 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. + enabled: + type: boolean + UserCreateWrapper: type: object required: - - Catalog + - UserCreate properties: - Catalog: - type: array - items: - $ref: '#/components/schemas/Catalog' - CatalogListViewResult: + UserCreate: + $ref: '#/components/schemas/UserCreate' + Event: allOf: - $ref: '#/components/schemas/BaseObject' - - type: object + - description: Calendar event. + type: object required: - - CatalogList + - id + - datetime + - type + - name + - attributes properties: - CatalogList: - $ref: '#/components/schemas/CatalogList' - CatalogView: + 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' - - type: object + - description: List of calendar events. + type: object required: - - identifier - - CatalogQuery - - Result + - _currentPage + - totalCount + - events properties: - identifier: + _currentPage: + description: Current page representation. + xml: + attribute: true + name: currentPage 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: + 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: - - ViewInput + - EventList properties: - ViewInput: - $ref: '#/components/schemas/CatalogViewInput' - Currency: + EventList: + $ref: '#/components/schemas/EventList' + EventGroup: allOf: - $ref: '#/components/schemas/BaseObject' - - description: This class represents currency. + - description: Event group. type: object required: - - id - - code - - subunits - - enabled + - _currentPage + - totalCount + - events properties: - id: - type: integer - code: + _currentPage: + description: Current page representation. + xml: + attribute: true + name: currentPage type: string - subunits: + nextPage: + description: Next page representation. + type: string + groupKey: + $ref: '#/components/schemas/DateRange' + totalCount: + description: Total count of events. 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: + 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: - - CurrencyCreate + - EventGroupList properties: - CurrencyCreate: - $ref: '#/components/schemas/CurrencyCreate' - CurrencyUpdate: - description: This class is used to update currency. + EventGroupList: + $ref: '#/components/schemas/EventGroupList' + RescheduleAction: + description: This class represents events to reschedule type: object required: - - subunits - - enabled + - events + - dateTime properties: - subunits: + events: + description: list of events + type: array + items: + type: string + dateTime: + description: timestamp to reschedule events to 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: + RescheduleActionWrapper: type: object required: - - ViewInput + - RescheduleAction properties: - ViewInput: - $ref: '#/components/schemas/CurrencyViewInput' - CurrencyList: - description: This class represents a currency list. + RescheduleAction: + $ref: '#/components/schemas/RescheduleAction' + UnscheduleAction: + description: This class represents events to unschedule type: object required: - - Currency + - events properties: - Currency: + events: + description: list of events type: array items: - $ref: '#/components/schemas/Currency' - CurrencyListWrapper: + type: string + UnscheduleActionWrapper: type: object required: - - CurrencyList + - UnscheduleAction properties: - CurrencyList: - $ref: '#/components/schemas/CurrencyList' - CustomerGroup: - description: This class represents a customer group. + UnscheduleAction: + $ref: '#/components/schemas/UnscheduleAction' + AttributeGroup: + description: This class represents an attribute group. type: object required: - - id - name - identifier - - description - - users - - global_price_rate + - position 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: + position: + type: integer + AttributeGroupWrapper: type: object required: - - CustomerGroup + - AttributeGroup properties: - CustomerGroup: - $ref: '#/components/schemas/CustomerGroup' - CustomerGroupCreate: - description: This class is used to create a customer group. + AttributeGroup: + $ref: '#/components/schemas/AttributeGroup' + AttributeGroupCreate: + description: This class is used to create an attribute group. type: object required: - identifier - names - - descriptions - - global_price_rate + - position properties: identifier: type: string names: type: object - descriptions: - type: object - global_price_rate: - description: numeric-string - type: string - CustomerGroupCreateWrapper: + position: + type: integer + AttributeGroupCreateWrapper: type: object required: - - CustomerGroupCreate + - AttributeGroupCreate properties: - CustomerGroupCreate: - $ref: '#/components/schemas/CustomerGroupCreate' - CustomerGroupUpdate: - description: This class is used to update a customer group. + AttributeGroupCreate: + $ref: '#/components/schemas/AttributeGroupCreate' + AttributeGroupUpdate: + description: This class is used to update an attribute group. type: object required: - - names - identifier - - global_price_rate + - names + - position 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: + names: + type: object + position: + type: integer + AttributeGroupUpdateWrapper: type: object required: - - CustomerGroupList + - AttributeGroupUpdate properties: - CustomerGroupList: - $ref: '#/components/schemas/CustomerGroupList' - CustomerGroupListResult: + AttributeGroupUpdate: + $ref: '#/components/schemas/AttributeGroupUpdate' + AttributeGroupList: allOf: - $ref: '#/components/schemas/BaseObject' - - type: object + - description: This class represents an attribute group list. + type: object required: - - CustomerGroupList + - AttributeGroup 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: + AttributeGroup: + type: array + items: + $ref: '#/components/schemas/AttributeGroup' + AttributeGroupListWrapper: type: object required: - - CustomerGroupView + - AttributeGroupList properties: - CustomerGroupView: - $ref: '#/components/schemas/CustomerGroupView' - Region: - description: This class represents a region. + AttributeGroupList: + $ref: '#/components/schemas/AttributeGroupList' + AttributeGroupListGet: + description: This class represents an attribute group list request. type: object required: - - identifier + - prefix + - offset + - limit properties: - identifier: + prefix: type: string - RegionWrapper: + offset: + type: integer + limit: + type: integer + AttributeGroupListGetWrapper: type: object required: - - Region + - AttributeGroupListGet properties: - Region: - $ref: '#/components/schemas/Region' - RegionList: - description: This class represents a region list. + AttributeGroupListGet: + $ref: '#/components/schemas/AttributeGroupListGet' + AttributeGroupGet: + description: This class represents an attribute group query. type: object required: - - Region + - languages properties: - Region: + languages: 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: string + AttributeGroupGetWrapper: type: object required: - - identifier - - RegionQuery - - Result + - AttributeGroupGet properties: - identifier: - type: string - RegionQuery: - type: object - Result: - type: object - RegionViewWrapper: + 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: - - RegionView + - AttributeGroupView properties: - RegionView: - $ref: '#/components/schemas/RegionView' - RegionViewInput: - description: This class represents a region view input. + AttributeGroupView: + $ref: '#/components/schemas/AttributeGroupView' + AttributeGroupViewInput: + description: This class represents an attribute group view input. xml: name: ViewInput type: object required: - - RegionQuery + - identifier + - AttributeGroupQuery properties: - RegionQuery: + identifier: + type: string + AttributeGroupQuery: type: object - RegionViewInputWrapper: + 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/RegionViewInput' - ProductType: - description: This class represents a product type. + $ref: '#/components/schemas/AttributeGroupViewInput' + AttributeType: + description: This class represents an attribute type. type: object required: - identifier - name - - AttributeAssignmentList properties: identifier: type: string name: type: string - AttributeAssignmentList: - type: array - items: - $ref: '#/components/schemas/AttributeAssignment' - ProductTypeWrapper: + AttributeTypeWrapper: type: object required: - - ProductType + - AttributeType properties: - ProductType: - $ref: '#/components/schemas/ProductType' - ProductTypeCreate: - description: This class is used to create a product type. + AttributeType: + $ref: '#/components/schemas/AttributeType' + AttributeTypeList: + description: This class represents an attribute type list. type: object required: - - ContentTypeCreateStruct - - main_language_code - - assigned_attributes + - attributeTypes properties: - ContentTypeCreateStruct: - type: object - main_language_code: - type: string - assigned_attributes: + attributeTypes: type: array items: - $ref: '#/components/schemas/ProductTypeAssignedAttribute' - ProductTypeCreateWrapper: + $ref: '#/components/schemas/AttributeType' + AttributeTypeListWrapper: type: object required: - - ProductTypeCreate + - AttributeTypeList properties: - ProductTypeCreate: - $ref: '#/components/schemas/ProductTypeCreate' - ProductTypeUpdate: - description: This class is used to update a product type. + AttributeTypeList: + $ref: '#/components/schemas/AttributeTypeList' + CartList: type: object - required: - - ContentTypeUpdateStruct - - assigned_attributes - properties: - ContentTypeUpdateStruct: - $ref: '#/components/schemas/ContentTypeUpdateStruct' - assigned_attributes: - type: array - items: - $ref: '#/components/schemas/ProductTypeAssignedAttribute' - ProductTypeUpdateWrapper: + Attribute: + description: This class represents an attribute. type: object required: - - ProductTypeUpdate + - name + - identifier + - description + - type + - type_identifier + - value + - group + - position + - options 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: + 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: - - ProductTypeUsage + - Attribute properties: - ProductTypeUsage: - $ref: '#/components/schemas/ProductTypeUsage' - ProductTypeView: - description: This class represents a product type view. + Attribute: + $ref: '#/components/schemas/Attribute' + AttributeCreate: + description: This class is used to create an attribute. type: object required: - identifier - - ProductTypeQuery - - Result + - type + - group + - names + - descriptions + - position + - options properties: identifier: type: string - ProductTypeQuery: + type: + type: string + group: + type: string + names: type: object - Result: + descriptions: type: object - ProductTypeViewWrapper: + position: + type: integer + options: + type: + - object + - array + AttributeCreateWrapper: type: object required: - - ProductTypeView + - AttributeCreate properties: - ProductTypeView: - $ref: '#/components/schemas/ProductTypeView' - ProductTypeList: - description: This class represents a product type list. + AttributeCreate: + $ref: '#/components/schemas/AttributeCreate' + AttributeUpdate: + description: This class is used to update an attribute. type: object required: - - ProductType + - identifier + - names + - descriptions + - position + - options properties: - ProductType: - type: array - items: - $ref: '#/components/schemas/ProductType' - ProductTypeListWrapper: + identifier: + type: string + names: + type: object + descriptions: + type: object + position: + type: integer + options: + type: object + AttributeUpdateWrapper: type: object required: - - ProductTypeList + - AttributeUpdate properties: - ProductTypeList: - $ref: '#/components/schemas/ProductTypeList' - ProductTypeListGet: - description: This class represents a product type list query. + AttributeUpdate: + $ref: '#/components/schemas/AttributeUpdate' + AttributeListGet: + description: This class represents an attribute list query type: object - required: - - name_prefix - - offset - - limit properties: + group_name_prefix: + type: string name_prefix: type: string offset: type: integer limit: type: integer - languages: + AttributeListGetWrapper: + type: object + required: + - AttributeListGet + properties: + AttributeListGet: + $ref: '#/components/schemas/AttributeListGet' + AttributeList: + description: This class represents an attribute list. + type: object + required: + - Attribute + properties: + Attribute: type: array items: - type: string - ProductTypeListGetWrapper: + $ref: '#/components/schemas/Attribute' + AttributeListWrapper: type: object required: - - ProductTypeListGet + - AttributeList properties: - ProductTypeListGet: - $ref: '#/components/schemas/ProductTypeListGet' - ProductTypeViewInput: - description: This class represents a product type view input. + 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: - - ProductTypeQuery + - identifier + - AttributeQuery properties: - ProductTypeQuery: + identifier: + type: string + AttributeQuery: type: object - ProductTypeViewInputWrapper: + AttributeViewInputWrapper: type: object required: - ViewInput properties: ViewInput: - $ref: '#/components/schemas/ProductTypeViewInput' - ProductTypeAssignedAttribute: + $ref: '#/components/schemas/AttributeViewInput' + AttributeAssignment: type: object required: - - identifier - is_required - is_discriminator + - Attribute properties: - identifier: - type: string is_required: type: boolean is_discriminator: type: boolean - ProductVariant: - description: This class represents a product variant. + Attribute: + $ref: '#/components/schemas/Attribute' + Catalog: + description: This class represents a catalog. type: object required: - - code + - identifier - name - - Product - - DiscriminatorAttributesList + - description + - created + - modified + - status + - User + - Criteria properties: - code: + identifier: type: string name: type: string - Product: - $ref: '#/components/schemas/Product' - DiscriminatorAttributesList: + description: + type: string + created: + type: integer + modified: + type: integer + status: + type: string + User: + $ref: '#/components/schemas/Ref' + Criteria: type: array items: - $ref: '#/components/schemas/Attribute' - ProductVariantWrapper: + $ref: '#/components/schemas/Criterion' + CatalogWrapper: type: object required: - - ProductVariant + - Catalog properties: - ProductVariant: - $ref: '#/components/schemas/ProductVariant' - ProductVariantView: - description: This class represents a product variant view. + Catalog: + $ref: '#/components/schemas/Catalog' + CatalogCreate: + description: This class is used to create a catalog. type: object required: - identifier - - ProductVariantQuery - - Result + - criteria + - names + - status properties: identifier: type: string - ProductVariantQuery: - type: object - Result: + criteria: + $ref: '#/components/schemas/Criterion' + names: 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: + descriptions: type: object - ProductVariantViewInputWrapper: + status: + type: string + creator_id: + type: integer + CatalogCreateWrapper: type: object required: - - ViewInput + - CatalogCreate properties: - ViewInput: - $ref: '#/components/schemas/ProductVariantViewInput' - ProductVariantCreate: - description: This class is used to create a product variant. + CatalogCreate: + $ref: '#/components/schemas/CatalogCreate' + CatalogUpdate: + description: This class is used to update a catalog. type: object required: - - code - - attributes + - identifier + - transition + - criteria + - names + - descriptions properties: - code: + identifier: type: string - attributes: - description: array<int|string,mixed> + transition: + type: string + criteria: + $ref: '#/components/schemas/Criterion' + names: type: object - ProductVariantCreateWrapper: + descriptions: + type: object + CatalogUpdateWrapper: type: object required: - - ProductVariantCreate + - CatalogUpdate properties: - ProductVariantCreate: - $ref: '#/components/schemas/ProductVariantCreate' - ProductVariantUpdate: - description: This class is used to update a product variant. + CatalogUpdate: + $ref: '#/components/schemas/CatalogUpdate' + CatalogCopy: + description: This class is used to copy a catalog. type: object required: - - code - - attributes + - identifier + - creator_id properties: - code: + identifier: type: string - attributes: - description: array<int|string,mixed> - type: object - ProductVariantUpdateWrapper: + creator_id: + description: Optional + type: integer + CatalogCopyWrapper: type: object required: - - ProductVariantUpdate + - CatalogCopy properties: - ProductVariantUpdate: - $ref: '#/components/schemas/ProductVariantUpdate' - ProductVariantGenerate: - description: This class is used to generate a product variant. + CatalogCopy: + $ref: '#/components/schemas/CatalogCopy' + CatalogList: + description: This class represents a catalog list. type: object required: - - attributes + - Catalog properties: - attributes: - description: array<int|string,mixed> - type: object - ProductVariantGenerateWrapper: + 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: - - ProductVariantGenerate + - CatalogView properties: - ProductVariantGenerate: - $ref: '#/components/schemas/ProductVariantGenerate' - ProductSortClause: + CatalogView: + $ref: '#/components/schemas/CatalogView' + CatalogViewInput: + description: This class represents a catalog view input. + xml: + name: ViewInput type: object required: - - name + - CatalogQuery properties: - name: - type: string - ProductSortClauseList: - description: This class represents a product sort clause list. + CatalogQuery: + type: object + CatalogViewInputWrapper: type: object required: - - ProductSortClause + - ViewInput properties: - ProductSortClause: - type: array - items: - $ref: '#/components/schemas/ProductSortClause' - ProductSortClauseListWrapper: + 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: - - ProductSortClauseList + - Currency properties: - ProductSortClauseList: - $ref: '#/components/schemas/ProductSortClauseList' - Product: - description: This class represents a product. + Currency: + $ref: '#/components/schemas/Currency' + CurrencyCreate: + description: This class is used to create currency. type: object required: - code - - name - - ProductType - - AttributesList + - subunits + - enabled 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: + subunits: 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. + enabled: + type: boolean + CurrencyCreateWrapper: type: object required: - - ContentUpdate - - code + - CurrencyCreate properties: - ContentUpdate: - $ref: '#/components/schemas/ContentUpdate' - code: - type: string - attributes: - type: array - items: - type: object - ProductUpdateWrapper: + CurrencyCreate: + $ref: '#/components/schemas/CurrencyCreate' + CurrencyUpdate: + description: This class is used to update currency. type: object required: - - ProductUpdate + - subunits + - enabled properties: - ProductUpdate: - $ref: '#/components/schemas/ProductUpdate' - ProductContentUpdate: + subunits: + type: integer + enabled: + type: boolean + CurrencyUpdateWrapper: type: object required: - - __url - - fields + - CurrencyUpdate 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. + CurrencyUpdate: + $ref: '#/components/schemas/CurrencyUpdate' + CurrencyView: + description: This class represents a currency view. type: object required: - identifier - - ProductQuery + - CurrencyQuery - Result properties: identifier: type: string - ProductQuery: + CurrencyQuery: type: object Result: type: object - ProductViewWrapper: + CurrencyViewWrapper: type: object required: - - ProductView + - CurrencyView properties: - ProductView: - $ref: '#/components/schemas/ProductView' - ProductViewInput: - description: This class represents a product view input. + CurrencyView: + $ref: '#/components/schemas/CurrencyView' + CurrencyViewInput: + description: This class represents a currency view input. xml: name: ViewInput type: object required: - - ProductQuery + - CurrencyQuery properties: - ProductQuery: + CurrencyQuery: type: object - ProductViewInputWrapper: + CurrencyViewInputWrapper: type: object required: - ViewInput properties: ViewInput: - $ref: '#/components/schemas/ProductViewInput' - ProductList: - description: This class represents a product list. + $ref: '#/components/schemas/CurrencyViewInput' + CurrencyList: + description: This class represents a currency list. type: object required: - - Product + - Currency properties: - Product: + Currency: type: array items: - $ref: '#/components/schemas/Product' - ProductListWrapper: + $ref: '#/components/schemas/Currency' + CurrencyListWrapper: type: object required: - - ProductList + - CurrencyList properties: - ProductList: - $ref: '#/components/schemas/ProductList' - ProductListGet: - description: This class represents a product list GET. + CurrencyList: + $ref: '#/components/schemas/CurrencyList' + CustomerGroup: + description: This class represents a customer group. type: object required: - - offset - - limit - - languages + - id + - name + - identifier + - description + - users + - global_price_rate properties: - offset: - type: integer - limit: + id: type: integer - languages: + name: + type: string + identifier: + type: string + description: + type: string + users: + description: A list of users attached to the customer group. type: array items: - type: string - ProductListGetWrapper: + $ref: '#/components/schemas/User' + global_price_rate: + description: A numeric string + type: string + CustomerGroupWrapper: type: object required: - - ProductListGet + - CustomerGroup properties: - ProductListGet: - $ref: '#/components/schemas/ProductListGet' - ProductGet: - description: This class represents a product GET. + CustomerGroup: + $ref: '#/components/schemas/CustomerGroup' + CustomerGroupCreate: + description: This class is used to create a customer group. type: object required: - - languages + - identifier + - names + - descriptions + - global_price_rate properties: - languages: - type: array - items: - type: string - ProductGetWrapper: + identifier: + type: string + names: + type: object + descriptions: + type: object + global_price_rate: + description: numeric-string + type: string + CustomerGroupCreateWrapper: type: object required: - - ProductGet + - CustomerGroupCreate properties: - ProductGet: - $ref: '#/components/schemas/ProductGet' - ProductFilter: + CustomerGroupCreate: + $ref: '#/components/schemas/CustomerGroupCreate' + CustomerGroupUpdate: + description: This class is used to update a customer group. type: object required: - - name + - names + - identifier + - global_price_rate properties: - name: + names: + type: object + identifier: type: string - ProductFilterList: - description: This class represents a product filter list. + global_price_rate: + type: string + descriptions: + type: array + items: + type: string + CustomerGroupUpdateWrapper: type: object required: - - ProductFilter + - CustomerGroupUpdate properties: - ProductFilter: + 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/ProductFilter' - ProductFilterListWrapper: + $ref: '#/components/schemas/CustomerGroup' + CustomerGroupListWrapper: type: object required: - - ProductFilterList + - CustomerGroupList properties: - ProductFilterList: - $ref: '#/components/schemas/ProductFilterList' - Price: + CustomerGroupList: + $ref: '#/components/schemas/CustomerGroupList' + CustomerGroupListResult: allOf: - $ref: '#/components/schemas/BaseObject' - - description: This class represents a price. - type: object + - type: object required: - - amount - - Currency + - CustomerGroupList 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. + 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: - - amount - - currency + - CustomerGroupQuery properties: - amount: - type: integer - currency: - type: string - PriceCreateStructWrapper: + CustomerGroupQuery: + type: object + CustomerGroupViewInputWrapper: type: object required: - - PriceCreateStruct + - ViewInput properties: - PriceCreateStruct: - $ref: '#/components/schemas/PriceCreateStruct' - RestPrice: + ViewInput: + $ref: '#/components/schemas/CustomerGroupViewInput' + CustomerGroupView: + description: This class represents a customer group view. type: object required: - - Price - - formatted + - identifier + - CustomerGroupQuery + - Result properties: - Price: - $ref: '#/components/schemas/Price' - formatted: + identifier: 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: + CustomerGroupQuery: + type: object + Result: + $ref: '#/components/schemas/CustomerGroupListResult' + CustomerGroupViewWrapper: type: object required: - - CustomPrice + - CustomerGroupView properties: - CustomPrice: - $ref: '#/components/schemas/CustomPrice' - CustomPriceCreateStruct: - description: This class represents a custom price creation structure. + CustomerGroupView: + $ref: '#/components/schemas/CustomerGroupView' + Region: + description: This class represents a region. type: object required: - - amount - - currency - - customAmount - - customerGroup + - identifier properties: - amount: - type: integer - currency: - type: string - customAmount: - type: integer - customerGroup: + identifier: type: string - CustomPriceCreateStructWrapper: + RegionWrapper: type: object required: - - CustomPriceCreateStruct + - Region properties: - CustomPriceCreateStruct: - $ref: '#/components/schemas/CustomPriceCreateStruct' - CustomPriceUpdateStruct: - description: This class represents a custom price updating structure. + Region: + $ref: '#/components/schemas/Region' + RegionList: + description: This class represents a region list. type: object required: - - amount - - currency - - customAmount + - Region properties: - amount: - type: integer - currency: - type: string - customAmount: - type: integer - CustomPriceUpdateStructWrapper: + Region: + type: array + items: + $ref: '#/components/schemas/Ref' + RegionListWrapper: type: object required: - - CustomPriceUpdateStruct + - RegionList properties: - CustomPriceUpdateStruct: - $ref: '#/components/schemas/CustomPriceUpdateStruct' - PriceUpdateStruct: - description: This class represents a price updating structure. + RegionList: + $ref: '#/components/schemas/RegionList' + RegionView: + description: This class represents a region view. type: object required: - - amount - - currency + - identifier + - RegionQuery + - Result properties: - amount: - type: integer - currency: + identifier: type: string - PriceUpdateStructWrapper: + RegionQuery: + type: object + Result: + type: object + RegionViewWrapper: type: object required: - - PriceUpdateStruct + - RegionView properties: - PriceUpdateStruct: - $ref: '#/components/schemas/PriceUpdateStruct' - PriceList: - description: This class represents a price list. + RegionView: + $ref: '#/components/schemas/RegionView' + RegionViewInput: + description: This class represents a region view input. + xml: + name: ViewInput type: object required: - - prices + - RegionQuery properties: - prices: - type: array - items: - $ref: '#/components/schemas/Price' - PriceListWrapper: + RegionQuery: + type: object + RegionViewInputWrapper: type: object required: - - PriceList + - ViewInput properties: - PriceList: - $ref: '#/components/schemas/PriceList' - Thumbnail: - description: This class represents a thumbnail that can be a target URL or a - Base64 data. + ViewInput: + $ref: '#/components/schemas/RegionViewInput' + ProductType: + description: This class represents a product type. type: object required: - - resource - - width - - height - - mimeType + - identifier + - name + - AttributeAssignmentList properties: - resource: + identifier: type: string - width: - type: - - integer - - "null" - height: - type: - - integer - - "null" - mimeType: + name: type: string - VatCategory: - description: This class represents a VAT category. + AttributeAssignmentList: + type: array + items: + $ref: '#/components/schemas/AttributeAssignment' + ProductTypeWrapper: type: object required: - - identifier - - region - - vatValue + - ProductType properties: - identifier: - type: string - region: + 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 - vatValue: - type: - - number - - "null" - VatCategoryWrapper: + assigned_attributes: + type: array + items: + $ref: '#/components/schemas/ProductTypeAssignedAttribute' + ProductTypeCreateWrapper: type: object required: - - VatCategory + - ProductTypeCreate properties: - VatCategory: - $ref: '#/components/schemas/VatCategory' - VatCategoryList: - description: This class represents a VAT category list. + ProductTypeCreate: + $ref: '#/components/schemas/ProductTypeCreate' + ProductTypeUpdate: + description: This class is used to update a product type. type: object required: - - VatCategory + - ContentTypeUpdateStruct + - assigned_attributes properties: - VatCategory: + ContentTypeUpdateStruct: + $ref: '#/components/schemas/ContentTypeUpdateStruct' + assigned_attributes: type: array items: - $ref: '#/components/schemas/VatCategory' - VatCategoryListWrapper: + $ref: '#/components/schemas/ProductTypeAssignedAttribute' + ProductTypeUpdateWrapper: type: object required: - - VatCategoryList + - ProductTypeUpdate 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: + ProductTypeUpdate: + $ref: '#/components/schemas/ProductTypeUpdate' + ProductTypeUsage: allOf: - $ref: '#/components/schemas/BaseObject' - - description: This class represents a taxonomy entry. + - description: This class represents a product type usage. type: object required: - - id - - identifier - - name - - content - - taxonomy + - is_used properties: - id: - type: integer - identifier: - type: string - name: - type: string - content: - $ref: '#/components/schemas/Ref' - taxonomy: - type: string - TaxonomyEntryWrapper: + 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: - - TaxonomyEntry + - ProductTypeView properties: - TaxonomyEntry: - $ref: '#/components/schemas/TaxonomyEntry' - TaxonomyEntryBulkRemove: - description: This class is used to bulk remove taxonomy entries. + ProductTypeView: + $ref: '#/components/schemas/ProductTypeView' + ProductTypeList: + description: This class represents a product type list. type: object required: - - entries + - ProductType properties: - entries: + ProductType: type: array items: - type: integer - TaxonomyEntryBulkRemoveWrapper: + $ref: '#/components/schemas/ProductType' + ProductTypeListWrapper: type: object required: - - TaxonomyEntryBulkRemove + - ProductTypeList properties: - TaxonomyEntryBulkRemove: - $ref: '#/components/schemas/TaxonomyEntryBulkRemove' - TaxonomyEntryMove: + ProductTypeList: + $ref: '#/components/schemas/ProductTypeList' + ProductTypeListGet: + description: This class represents a product type list query. type: object required: - - entry - - sibling - - position + - name_prefix + - offset + - limit properties: - entry: + name_prefix: + type: string + offset: type: integer - sibling: + limit: type: integer - position: - type: string - TaxonomyEntryBulkMove: - description: This class is used to bulk move taxonomy entries. + languages: + type: array + items: + type: string + ProductTypeListGetWrapper: type: object required: - - entries + - ProductTypeListGet properties: - entries: - type: array - items: - $ref: '#/components/schemas/TaxonomyEntryMove' - TaxonomyEntryBulkMoveWrapper: + ProductTypeListGet: + $ref: '#/components/schemas/ProductTypeListGet' + ProductTypeViewInput: + description: This class represents a product type view input. + xml: + name: ViewInput type: object required: - - TaxonomyEntryBulkMove + - ProductTypeQuery properties: - TaxonomyEntryBulkMove: - $ref: '#/components/schemas/TaxonomyEntryBulkMove' - TaxonomyEntryAssignment: - description: This class represents a taxonomy entry assignment. + ProductTypeQuery: + type: object + ProductTypeViewInputWrapper: type: object required: - - id - - content - - entry + - ViewInput 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: + ViewInput: + $ref: '#/components/schemas/ProductTypeViewInput' + ProductTypeAssignedAttribute: type: object required: - - TaxonomyEntryAssignment + - identifier + - is_required + - is_discriminator properties: - TaxonomyEntryAssignment: - $ref: '#/components/schemas/TaxonomyEntryAssignment' - TaxonomyEntryAssignToContent: - description: This class is used to assign taxonomy entry to content. + identifier: + type: string + is_required: + type: boolean + is_discriminator: + type: boolean + ProductVariant: + description: This class represents a product variant. type: object required: - - content - - entries + - code + - name + - Product + - DiscriminatorAttributesList properties: - content: - type: integer - entries: + code: + type: string + name: + type: string + Product: + $ref: '#/components/schemas/Product' + DiscriminatorAttributesList: type: array items: - type: integer - TaxonomyEntryAssignToContentWrapper: + $ref: '#/components/schemas/Attribute' + ProductVariantWrapper: type: object required: - - TaxonomyEntryAssignToContent + - ProductVariant properties: - TaxonomyEntryAssignToContent: - $ref: '#/components/schemas/TaxonomyEntryAssignToContent' - TaxonomyEntryUnassignFromContent: - description: This class is used to unassign taxonomy entry from content. + ProductVariant: + $ref: '#/components/schemas/ProductVariant' + ProductVariantView: + description: This class represents a product variant view. type: object required: - - content - - entries + - identifier + - ProductVariantQuery + - Result properties: - content: - type: integer - entries: - type: array - items: - type: integer - TaxonomyEntryUnassignFromContentWrapper: + identifier: + type: string + ProductVariantQuery: + type: object + Result: + type: object + ProductVariantViewWrapper: type: object required: - - TaxonomyEntryUnassignFromContent + - ProductVariantView 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: + ProductVariantView: + $ref: '#/components/schemas/ProductVariantView' + ProductVariantViewInput: + description: This class represents a product variant view input. type: object required: - - EntryAssignmentCollection + - ProductVariantQuery properties: - EntryAssignmentCollection: - $ref: '#/components/schemas/EntryAssignmentCollection' - Segment: - allOf: - - $ref: '#/components/schemas/BaseObject' - - description: This class represents a segment. - type: object - required: - - id - - identifier - - name - - source - - SegmentGroup - properties: - id: - type: integer - identifier: - type: string - name: - type: string - source: - type: string - lastUpdatedBy: - type: string - nullable: true - updatedAt: - type: string - format: date-time - nullable: true - SegmentGroup: - $ref: '#/components/schemas/SegmentGroup' - SegmentWrapper: + ProductVariantQuery: + type: object + ProductVariantViewInputWrapper: type: object required: - - Segment + - ViewInput 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: + ViewInput: + $ref: '#/components/schemas/ProductVariantViewInput' + ProductVariantCreate: + description: This class is used to create a product variant. type: object required: - - SegmentList + - code + - attributes 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: + code: + type: string + attributes: + description: array<int|string,mixed> + type: object + ProductVariantCreateWrapper: type: object required: - - SegmentGroup + - ProductVariantCreate 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: + ProductVariantCreate: + $ref: '#/components/schemas/ProductVariantCreate' + ProductVariantUpdate: + description: This class is used to update a product variant. type: object required: - - SegmentGroupList + - code + - attributes properties: - SegmentGroupList: - $ref: '#/components/schemas/SegmentGroupList' - UserSegment: - description: This class represents a segment and a user it's associate to. + code: + type: string + attributes: + description: array<int|string,mixed> + type: object + ProductVariantUpdateWrapper: type: object + required: + - ProductVariantUpdate properties: - id: - type: integer - identifier: - type: string - name: - type: string - source: - type: string - lastUpdatedBy: - type: string - nullable: true - updatedAt: - type: string - format: date-time - nullable: true - 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: + ProductVariantUpdate: + $ref: '#/components/schemas/ProductVariantUpdate' + ProductVariantGenerate: + description: This class is used to generate a product variant. type: object required: - - UserSegmentList + - attributes properties: - UserSegmentList: - $ref: '#/components/schemas/SegmentList' - UserSegmentAssignInput: + attributes: + description: array<int|string,mixed> + type: object + ProductVariantGenerateWrapper: type: object + required: + - ProductVariantGenerate properties: - segments: - type: array - items: - type: string - UserSegmentAssignInputWrapper: + ProductVariantGenerate: + $ref: '#/components/schemas/ProductVariantGenerate' + ProductSortClause: type: object required: - - UserSegmentAssignInput + - name properties: - UserSegmentAssignInput: - $ref: '#/components/schemas/UserSegmentAssignInput' - CorporateAccountRoot: - description: This class represents Corporate Account Root resource information. + name: + type: string + ProductSortClauseList: + description: This class represents a product sort clause list. type: object required: - - links + - ProductSortClause properties: - links: - xml: - wrapped: false + ProductSortClause: type: array items: - $ref: '#/components/schemas/Link' - CorporateAccountRootWrapper: + $ref: '#/components/schemas/ProductSortClause' + ProductSortClauseListWrapper: type: object required: - - CorporateAccountRoot + - ProductSortClauseList 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. + ProductSortClauseList: + $ref: '#/components/schemas/ProductSortClauseList' + Product: + description: This class represents a product. type: object required: - - id + - code - name - - Content - - billingAddress - - contactId - - salesRepresentativeId - - defaultAddressId - - addressBookId - - membersId - - MemberList - - Location - - locationPath - - isActive + - ProductType + - AttributesList properties: - id: - type: integer + isVariant: + type: boolean + isBaseProduct: + type: boolean + code: + type: string name: type: string + ProductType: + $ref: '#/components/schemas/ProductType' 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. + Thumbnail: + $ref: '#/components/schemas/Thumbnail' + created_at: type: integer - membersId: - description: Members Folder Content ID. + updated_at: 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: + AttributesList: + type: array + items: + $ref: '#/components/schemas/Attribute' + ProductWrapper: type: object required: - - CompanyCreate + - Product properties: - CompanyCreate: - $ref: '#/components/schemas/CompanyCreate' - CompanyUpdate: - description: This class is used to update a Company. + Product: + $ref: '#/components/schemas/Product' + ProductCreate: + description: This class is used to create a product. type: object required: - - fields + - ContentCreate + - code + - attributes properties: - fields: + ContentCreate: + $ref: '#/components/schemas/ContentCreate' + code: + type: string + attributes: 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: + ProductCreateWrapper: type: object required: - - CompanyList + - ProductCreate properties: - CompanyList: - $ref: '#/components/schemas/CompanyList' - Member: - description: This class represents a company member. + ProductCreate: + $ref: '#/components/schemas/ProductCreate' + ProductUpdate: + description: This class is used to update a product. type: object required: - - id - - name - - Company - - User - - Role + - ContentUpdate + - code properties: - id: - type: integer - name: + ContentUpdate: + $ref: '#/components/schemas/ContentUpdate' + code: 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: + attributes: + type: array + items: + type: object + ProductUpdateWrapper: type: object required: - - Member + - ProductUpdate properties: - Member: - $ref: '#/components/schemas/Member' - MemberCreate: - description: This class is used to create a member. + ProductUpdate: + $ref: '#/components/schemas/ProductUpdate' + ProductContentUpdate: type: object required: - - login - - email - - password - - Role + - __url - fields properties: - login: - type: string - email: - type: string - password: + __url: + xml: + attribute: true + name: url 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. + ProductView: + description: This class represents a product view. type: object required: - - email - - password - - enabled - - maxLogin - - Role - - fields + - identifier + - ProductQuery + - Result properties: - email: - type: string - password: + identifier: 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: + ProductQuery: type: object - required: - - field - properties: - field: - description: Fields of a Member content item. - type: array - items: - $ref: '#/components/schemas/Field' - MemberUpdateWrapper: + Result: + type: object + ProductViewWrapper: type: object required: - - MemberUpdate + - ProductView properties: - MemberUpdate: - $ref: '#/components/schemas/MemberUpdate' - MemberList: - description: This class represents a list of company members. + ProductView: + $ref: '#/components/schemas/ProductView' + ProductViewInput: + description: This class represents a product view input. + xml: + name: ViewInput type: object required: - - members + - ProductQuery properties: - members: - type: array - items: - $ref: '#/components/schemas/Member' - MemberListWrapper: + ProductQuery: + type: object + ProductViewInputWrapper: type: object required: - - MemberList + - ViewInput 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: + ViewInput: + $ref: '#/components/schemas/ProductViewInput' + ProductList: + description: This class represents a product list. type: object required: - - SalesRepresentativesList + - Product properties: - SalesRepresentativesList: - $ref: '#/components/schemas/SalesRepresentativesList' - BillingAddress: + Product: + type: array + items: + $ref: '#/components/schemas/Product' + ProductListWrapper: type: object required: - - name - - country - - fields + - ProductList 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: + ProductList: + $ref: '#/components/schemas/ProductList' + ProductListGet: + description: This class represents a product list GET. 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 + - offset + - limit + - languages properties: offset: - description: The offset of the first item to return type: integer limit: - description: The maximum number of items to return - default is set by `activity_log.pagination.activity_logs_limit` - which is 25 if not overridden type: integer - criteria: - description: Search criteria for activity log groups - type: array - items: - description: Search criterion for activity log groups - type: object - required: - - type - properties: - type: - description: The type of the search criterion - type: string - enum: - - action - - logged_at - - object_class - - user - value: - description: The value of the search criterion - oneOf: - - type: string - - type: array - operator: - description: The operator of the search criterion - type: string - class: - description: The class of the `object_class` criterion - type: string - sort_clause: - description: Sort clauses for activity log groups + languages: type: array items: - description: Sort clause for activity log groups - type: object - required: - - type - properties: - type: - description: The type of the sort clause - type: string - enum: - - logged_at - direction: - description: The direction of the sort clause - type: string - enum: - - ASC - - DESC - ActivityLogGroupListInputWrapper: + type: string + ProductListGetWrapper: type: object required: - - ActivityLogGroupListInput + - ProductListGet properties: - ActivityLogGroupListInput: - $ref: '#/components/schemas/ActivityLogGroupListInput' - ActivityLogGroupList: - description: This class represents activity log context groups + ProductListGet: + $ref: '#/components/schemas/ProductListGet' + ProductGet: + description: This class represents a product GET. type: object required: - - ActivityLogGroups + - languages properties: - ActivityLogGroups: + languages: type: array items: - $ref: '#/components/schemas/ActivityLogGroup' - ActivityLogGroupListWrapper: + type: string + ProductGetWrapper: type: object required: - - ActivityLogGroupList + - ProductGet properties: - ActivityLogGroupList: - $ref: '#/components/schemas/ActivityLogGroupList' - Cart: - description: This class represents a Cart + ProductGet: + $ref: '#/components/schemas/ProductGet' + ProductFilter: type: object required: - - id - - identifier - - owner - - Currency - - entries + - name properties: - id: - description: Cart ID - type: integer - identifier: - description: Cart unique identifier + name: 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 + ProductFilterList: + description: This class represents a product filter list. type: object required: - - name - - currencyCode + - ProductFilter 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: + ProductFilter: + type: array + items: + $ref: '#/components/schemas/ProductFilter' + ProductFilterListWrapper: type: object required: - - CartCreate + - ProductFilterList properties: - CartCreate: - $ref: '#/components/schemas/CartCreate' - CartProduct: - description: This class represents a cart entry product + 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: - - code + - Price properties: - code: - description: product's code - type: string - CartView: - description: This class represents a cart view. + Price: + $ref: '#/components/schemas/Price' + PriceCreateStruct: + description: This class represents a price creation structure. type: object required: - - identifier - - Result + - amount + - currency properties: - identifier: + amount: + type: integer + currency: type: string - Result: - $ref: '#/components/schemas/CartListViewResult' - CartViewWrapper: + PriceCreateStructWrapper: type: object required: - - CartView + - PriceCreateStruct properties: - CartView: - $ref: '#/components/schemas/CartView' - CartViewInput: - description: This class represents a cart view input. + PriceCreateStruct: + $ref: '#/components/schemas/PriceCreateStruct' + RestPrice: type: object required: - - identifier - - CartQuery + - Price + - formatted properties: - identifier: + Price: + $ref: '#/components/schemas/Price' + formatted: type: string - CartQuery: - $ref: '#/components/schemas/CartViewInput' - CartViewInputWrapper: + 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: - - CartViewInput + - CustomPrice properties: - CartViewInput: - $ref: '#/components/schemas/CartViewInput' - CartQuery: + CustomPrice: + $ref: '#/components/schemas/CustomPrice' + CustomPriceCreateStruct: + description: This class represents a custom price creation structure. type: object required: - - offset - - limit - - ownerId + - amount + - currency + - customAmount + - customerGroup properties: - offset: - type: integer - limit: + amount: type: integer - ownerId: + currency: + type: string + customAmount: type: integer - CartEntry: + customerGroup: + type: string + CustomPriceCreateStructWrapper: type: object required: - - identifier - - id - - names - - quantity - - Price + - CustomPriceCreateStruct 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 + CustomPriceCreateStruct: + $ref: '#/components/schemas/CustomPriceCreateStruct' + CustomPriceUpdateStruct: + description: This class represents a custom price updating structure. type: object required: - - quantity - - Product + - amount + - currency + - customAmount properties: - quantity: - description: the quantity of entry items + amount: type: integer - Product: - description: product data - context: - description: associative array of scalars describing additional, contextual - data attached to the cart entry - type: object - CartEntryAddWrapper: + currency: + type: string + customAmount: + type: integer + CustomPriceUpdateStructWrapper: type: object required: - - CartEntryAdd + - CustomPriceUpdateStruct properties: - CartEntryAdd: - $ref: '#/components/schemas/CartEntryAdd' - CartEntryUpdate: + CustomPriceUpdateStruct: + $ref: '#/components/schemas/CustomPriceUpdateStruct' + PriceUpdateStruct: + description: This class represents a price updating structure. type: object required: - - quantity + - amount + - currency properties: - quantity: + amount: type: integer - context: - description: associative array of scalars describing additional, contextual - data attached to the cart entry - type: object - CartEntryUpdateWrapper: + currency: + type: string + PriceUpdateStructWrapper: type: object required: - - CartEntryUpdate + - PriceUpdateStruct properties: - CartEntryUpdate: - $ref: '#/components/schemas/CartEntryUpdate' - CartMetadataUpdate: - description: This class represents the update of cart metadata. + PriceUpdateStruct: + $ref: '#/components/schemas/PriceUpdateStruct' + PriceList: + description: This class represents a price list. type: object required: - - identifier - - defaultLanguageCode - - names - - descriptions + - prices properties: - identifier: - type: string - defaultLanguageCode: - type: string - names: - type: array - items: - $ref: '#/components/schemas/Value' - descriptions: + prices: type: array items: - $ref: '#/components/schemas/Value' - CartMetadataUpdateWrapper: + $ref: '#/components/schemas/Price' + PriceListWrapper: type: object required: - - CartMetadataUpdate + - PriceList properties: - CartMetadataUpdate: - $ref: '#/components/schemas/CartMetadataUpdate' - CartSummary: - description: This class represents a cart summary. + 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: - - id - - identifier - - name - - createdAt - - updatedAt - - Owner - - SummaryEntryCollection - - TotalPrice - - TotalPriceInclVat - - vatCategorySummary - - Currency + - resource + - width + - height + - mimeType properties: - id: - type: integer - identifier: - type: string - name: - type: string - createdAt: + resource: type: string - format: date-time - updatedAt: + width: + type: + - integer + - "null" + height: + type: + - integer + - "null" + mimeType: 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: + VatCategory: + description: This class represents a VAT category. type: object required: - - CartSummary + - identifier + - region + - vatValue properties: - CartSummary: - $ref: '#/components/schemas/CartSummary' - CartListViewResult: + identifier: + type: string + region: + type: string + vatValue: + type: + - number + - "null" + VatCategoryWrapper: type: object required: - - count - - Result + - VatCategory properties: - count: - type: integer - Result: - $ref: '#/components/schemas/CartList' - SummaryEntryCollection: - description: This class represents a summary entry collection. + VatCategory: + $ref: '#/components/schemas/VatCategory' + VatCategoryList: + description: This class represents a VAT category list. type: object required: - - count - - SummaryEntry + - VatCategory properties: - count: - type: string - SummaryEntry: + VatCategory: type: array items: - $ref: '#/components/schemas/SummaryEntry' - ShoppingListEntryIdentifiers: - description: This class represents a list of shopping list entry identifiers - to add to cart + $ref: '#/components/schemas/VatCategory' + VatCategoryListWrapper: type: object required: - - entries + - VatCategoryList properties: - entries: - description: Array of entry identifiers - type: array - items: - type: object - required: - - identifier - properties: - identifier: - description: Entry identifier - type: string - ShoppingListEntryIdentifiersWrapper: + 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: - - ShoppingListEntryIdentifiers + - TaxonomyEntry properties: - ShoppingListEntryIdentifiers: - $ref: '#/components/schemas/ShoppingListEntryIdentifiers' - CartEntryIdentifiers: - description: This class represents a list of cart entry identifiers + TaxonomyEntry: + $ref: '#/components/schemas/TaxonomyEntry' + TaxonomyEntryBulkRemove: + description: This class is used to bulk remove taxonomy entries. 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: integer + TaxonomyEntryBulkRemoveWrapper: type: object required: - - CartEntryIdentifiers + - TaxonomyEntryBulkRemove properties: - CartEntryIdentifiers: - $ref: '#/components/schemas/CartEntryIdentifiers' - TimezoneDate: + TaxonomyEntryBulkRemove: + $ref: '#/components/schemas/TaxonomyEntryBulkRemove' + TaxonomyEntryMove: type: object required: - - date - - timezone_type - - timezone + - entry + - sibling + - position properties: - date: - type: string - timezone_type: + entry: 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: + sibling: type: integer - identifier: - type: string - created: - $ref: '#/components/schemas/TimezoneDate' - modified: - $ref: '#/components/schemas/TimezoneDate' - status: - type: string - source: + position: 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. + TaxonomyEntryBulkMove: + description: This class is used to bulk move taxonomy entries. type: object required: - - Order + - entries properties: - Order: + entries: 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. + $ref: '#/components/schemas/TaxonomyEntryMove' + TaxonomyEntryBulkMoveWrapper: type: object required: - - id - - name - - email + - TaxonomyEntryBulkMove properties: - id: - type: - - "null" - - integer - name: - type: string - email: - type: string - OrderCurrency: - description: This class represents order currency. + TaxonomyEntryBulkMove: + $ref: '#/components/schemas/TaxonomyEntryBulkMove' + TaxonomyEntryAssignment: + description: This class represents a taxonomy entry assignment. type: object required: - id - - code + - content + - entry properties: id: type: integer - code: - type: string - OrderValue: - description: This class represents order value. + 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: - - vat - - total_gross - - total_net + - TaxonomyEntryAssignment 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. + TaxonomyEntryAssignment: + $ref: '#/components/schemas/TaxonomyEntryAssignment' + TaxonomyEntryAssignToContent: + description: This class is used to assign taxonomy entry to content. type: object required: - - id - - name + - content + - entries properties: - id: + content: type: integer - name: - type: string - OrderPrice: + entries: + type: array + items: + type: integer + TaxonomyEntryAssignToContentWrapper: type: object required: - - amount - - currency + - TaxonomyEntryAssignToContent properties: - amount: - type: string - currency: - type: string - OrderCreate: - description: This class is used to create order. + TaxonomyEntryAssignToContent: + $ref: '#/components/schemas/TaxonomyEntryAssignToContent' + TaxonomyEntryUnassignFromContent: + description: This class is used to unassign taxonomy entry from content. type: object required: - - source - - OrderUser - - OrderCurrency - - OrderValue - - OrderCompany - - items + - content + - entries 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: + content: + type: integer + entries: type: array items: - $ref: '#/components/schemas/OrderItemWrapper' - OrderCreateWrapper: + type: integer + TaxonomyEntryUnassignFromContentWrapper: type: object required: - - OrderCreate + - TaxonomyEntryUnassignFromContent properties: - OrderCreate: - $ref: '#/components/schemas/OrderCreate' - OrderItem: - description: This class represents order item. + 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: - - OrderItemValue - - OrderItemProduct + - EntryAssignmentCollection properties: - OrderItemValue: - $ref: '#/components/schemas/OrderItemValue' - OrderItemProduct: - $ref: '#/components/schemas/OrderItemProduct' - quantity: - type: integer - context: - type: object - OrderItemWrapper: + EntryAssignmentCollection: + $ref: '#/components/schemas/EntryAssignmentCollection' + BulkTranslationSetupSectionInput: type: object - required: - - OrderItem properties: - OrderItem: - $ref: '#/components/schemas/OrderItem' - OrderItemValue: - description: This class represents order item value. + search: + type: string + default: "" + contentType: + type: string + default: "" + page: + type: integer + minimum: 1 + default: 1 + BulkTranslationSetupActionResource: type: object required: - - unit_price_gross - - unit_price_net - - vat_rate - - subtotal_price_gross - - subtotal_price_net + - href + - method + - enabled properties: - unit_price_gross: - oneOf: - - type: string - - $ref: '#/components/schemas/OrderPrice' - unit_price_net: - oneOf: - - type: string - - $ref: '#/components/schemas/OrderPrice' - vat_rate: + href: 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. + method: + type: string + enabled: + type: boolean + BulkTranslationSetupLanguageChoiceResource: 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. + BulkTranslationSetupProviderChoiceResource: type: object required: - - status - - transition + - identifier + - name properties: - status: + identifier: type: string - transition: + name: type: string - OrderUpdateWrapper: + BulkTranslationSetupContentTypeChoiceResource: type: object required: - - OrderUpdate + - identifier + - name properties: - OrderUpdate: - $ref: '#/components/schemas/OrderUpdate' - PaymentMethod: + identifier: + type: string + name: + type: string + BulkTranslationSetupRowResource: type: object required: - id - - identifier - - enabled - name - - description + - contentTypeIdentifier + - contentTypeName + - duplicated properties: id: type: integer - identifier: - type: string - enabled: - type: boolean name: type: string - description: + contentTypeIdentifier: type: string - PaymentMethodWrapper: - type: object - required: - - PaymentMethod - properties: - PaymentMethod: - $ref: '#/components/schemas/PaymentMethod' - PaymentMethodCreateStruct: + contentTypeName: + type: string + duplicated: + type: boolean + BulkTranslationSetupFiltersResource: type: object required: - - identifier - - type - - names + - search + - contentType + - contentTypeChoices properties: - identifier: + search: type: string - type: + contentType: 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. + contentTypeChoices: type: array items: - type: string - enabled: - type: boolean - options: - type: object - PaymentMethodCreateStructWrapper: + $ref: '#/components/schemas/BulkTranslationSetupContentTypeChoiceResource' + BulkTranslationSetupPaginationResource: type: object required: - - PaymentMethodCreateStruct + - page + - pageSize + - totalPages properties: - PaymentMethodCreateStruct: - $ref: '#/components/schemas/PaymentMethodCreateStruct' - PaymentMethodUpdateStruct: + page: + type: integer + pageSize: + type: integer + totalPages: + type: integer + BulkTranslationSetupSectionResource: type: object + required: + - count + - rows + - filters + - pagination 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: + count: + type: integer + rows: type: array items: - type: [] - PaymentMethodUpdateStructWrapper: + $ref: '#/components/schemas/BulkTranslationSetupRowResource' + filters: + $ref: '#/components/schemas/BulkTranslationSetupFiltersResource' + pagination: + $ref: '#/components/schemas/BulkTranslationSetupPaginationResource' + BulkTranslationSetupSectionsResource: type: object required: - - PaymentMethodUpdateStructParser + - duplicates + - items properties: - PaymentMethodUpdateStructParser: - $ref: '#/components/schemas/PaymentMethodUpdateStruct' - PaymentMethodView: + duplicates: + $ref: '#/components/schemas/BulkTranslationSetupSectionResource' + items: + $ref: '#/components/schemas/BulkTranslationSetupSectionResource' + BulkTranslationSetupConfigurationResource: type: object required: - - identifier - - Result + - sourceLanguage + - sourceLanguageChoices + - targetLanguage + - targetLanguageChoices + - provider + - providerChoices properties: - identifier: + sourceLanguage: type: string - Result: - $ref: '#/components/schemas/PaymentMethodList' - PaymentMethodViewWrapper: + sourceLanguageChoices: + type: array + items: + $ref: '#/components/schemas/BulkTranslationSetupLanguageChoiceResource' + targetLanguage: + type: string + targetLanguageChoices: + type: array + items: + $ref: '#/components/schemas/BulkTranslationSetupLanguageChoiceResource' + provider: + type: string + providerChoices: + type: array + items: + $ref: '#/components/schemas/BulkTranslationSetupProviderChoiceResource' + BulkTranslationSetupSummaryResource: type: object required: - - PaymentMethodView + - totalItems + - duplicates + - itemsToTranslate properties: - PaymentMethodView: - $ref: '#/components/schemas/PaymentMethodView' - PaymentMethodViewInput: + totalItems: + type: integer + duplicates: + type: integer + itemsToTranslate: + type: integer + BulkTranslationSetupSelectionResource: type: object required: - - identifier - - PaymentMethodQuery + - selectedContentIds properties: - identifier: - type: string - PaymentMethodQuery: - type: object - PaymentMethodViewInputWrapper: + selectedContentIds: + type: array + items: + type: integer + BulkTranslationSetupActionsResource: type: object required: - - PaymentMethodViewInput + - start properties: - PaymentMethodViewInput: - $ref: '#/components/schemas/PaymentMethodViewInput' - PaymentMethodList: + start: + $ref: '#/components/schemas/BulkTranslationSetupActionResource' + BulkTranslationSetupResource: type: object required: - - count - - PaymentMethodList + - configuration + - summary + - sections + - selection + - actions properties: - count: - type: integer - PaymentMethodList: - type: array - items: - $ref: '#/components/schemas/PaymentMethod' - Shipment: - description: This class represents a single shipment. + configuration: + $ref: '#/components/schemas/BulkTranslationSetupConfigurationResource' + summary: + $ref: '#/components/schemas/BulkTranslationSetupSummaryResource' + sections: + $ref: '#/components/schemas/BulkTranslationSetupSectionsResource' + selection: + $ref: '#/components/schemas/BulkTranslationSetupSelectionResource' + actions: + $ref: '#/components/schemas/BulkTranslationSetupActionsResource' + MissingTranslationsRowResource: type: object required: - - id - - identifier - - status - - transitions - - Order - - Amount - - createdAt - - updatedAt - - Owner - - Method + - contentId + - name + - contentTypeIdentifier + - contentTypeName + - missingLanguages properties: - id: + contentId: type: integer - identifier: - type: string - status: + name: 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: + contentTypeIdentifier: type: string - format: date-time - updatedAt: + contentTypeName: type: string - format: date-time - Owner: - $ref: '#/components/schemas/Ref' - Method: - $ref: '#/components/schemas/Ref' - ShipmentWrapper: + missingLanguages: + type: array + items: + type: string + mainLocationId: + type: integer + nullable: true + MissingTranslationsResource: type: object required: - - Shipment + - totalCount + - page + - limit + - rows properties: - Shipment: - $ref: '#/components/schemas/Shipment' - ShipmentRefList: - description: This class represents a list of Shipments + totalCount: + type: integer + page: + type: integer + limit: + type: integer + rows: + type: array + items: + $ref: '#/components/schemas/MissingTranslationsRowResource' + MissingTranslationIdsResource: type: object required: - - shipmentRefList + - ids + - returnedCount + - totalCount + - limited properties: - shipmentRefList: + ids: type: array items: - $ref: '#/components/schemas/Ref' - ShipmentRefListWrapper: + type: integer + returnedCount: + type: integer + totalCount: + type: integer + limited: + type: boolean + BulkTranslationContextResource: type: object required: - - ShipmentRefList + - jobItemId + - jobId + - jobItemStatus + - jobCreatorId properties: - ShipmentRefList: - $ref: '#/components/schemas/ShipmentRefList' - ShipmentUpdate: - description: This class represents the update of a shipment. + jobItemId: + type: integer + jobId: + type: integer + jobItemStatus: + type: string + jobTitle: + type: string + nullable: true + jobCreatorId: + type: integer + jobCreatorName: + type: string + nullable: true + description: Display name of the job creator, or null when that user can + no longer be resolved. + jobCreatorAvatarUrl: + type: string + nullable: true + description: URL of the job creator's avatar (their own photo, or a default), + or null when that user can no longer be resolved. + ReviewItemRowResource: type: object required: - - identifier - - transition - - Owner - - Context + - autoTranslationId + - contentId + - versionNo + - sourceLanguageCode + - targetLanguageCode + - providerIdentifier + - reviewStatus + - origin properties: - identifier: + autoTranslationId: + type: integer + contentId: + type: integer + contentName: type: string - transition: + nullable: true + contentTypeIdentifier: type: string - Owner: - $ref: '#/components/schemas/Ref' - Context: - type: object - ShipmentUpdateWrapper: + nullable: true + versionNo: + type: integer + sourceLanguageCode: + type: string + targetLanguageCode: + type: string + providerIdentifier: + type: string + reviewStatus: + type: string + origin: + type: string + enum: + - bulk + - individual + bulkContext: + nullable: true + allOf: + - $ref: '#/components/schemas/BulkTranslationContextResource' + ForReviewResource: type: object required: - - ShipmentUpdate + - totalCount + - page + - limit + - rows properties: - ShipmentUpdate: - $ref: '#/components/schemas/ShipmentUpdate' - ShipmentCreate: - description: This class represents the creation of a shipment. + totalCount: + type: integer + page: + type: integer + limit: + type: integer + rows: + type: array + items: + $ref: '#/components/schemas/ReviewItemRowResource' + TranslatedResource: type: object required: - - identifier - - ShippingMethod - - Owner - - Context + - totalCount + - page + - limit + - rows properties: - identifier: - type: string - ShippingMethod: - $ref: '#/components/schemas/Ref' - Owner: - $ref: '#/components/schemas/Ref' - Context: - type: object - ShipmentCreateWrapper: + totalCount: + type: integer + page: + type: integer + limit: + type: integer + rows: + type: array + items: + $ref: '#/components/schemas/ReviewItemRowResource' + BulkTranslationStartResource: type: object required: - - ShipmentCreate + - started + - totalItems + - requestedCount + - acceptedCount + - skippedCount properties: - ShipmentCreate: - $ref: '#/components/schemas/ShipmentCreate' - ShippingMethod: - description: This class represents a shipping method. + started: + type: boolean + jobId: + type: integer + nullable: true + totalItems: + type: integer + requestedCount: + type: integer + acceptedCount: + type: integer + skippedCount: + type: integer + HistoryRowResource: type: object required: - - identifier - - name - - names - - description - - descriptions - - enabled - - options - - regions - - type + - id + - title + - createdAt + - targetLanguageCodes + - creatorId + - status + - totalItems + - successfulItems + - reviewItems + - failedItems properties: - identifier: - type: string - name: + id: + type: integer + title: type: string - names: - type: object - required: - - value - properties: - value: - type: array - items: - $ref: '#/components/schemas/MultilingualValue' - description: + description: The job title, or a "#<id>" label when the job was created + without one. + createdAt: 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. + format: date-time + targetLanguageCodes: + type: array + items: + type: string + creatorId: + type: integer + creatorName: + type: string + nullable: true + description: Display name of the job creator, or null when that user can + no longer be resolved. + status: + type: string + enum: + - pending + - in_progress + - completed + - failed + - cancelled + totalItems: + type: integer + successfulItems: + type: integer + reviewItems: + type: integer + failedItems: + type: integer + HistoryCreatorChoiceResource: type: object required: - - identifier + - id - name properties: - identifier: - type: string + id: + type: integer 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. + HistoryResource: type: object required: - - ShippingMethodTypes + - totalCount + - page + - limit + - rows + - creatorChoices properties: - ShippingMethodTypes: + totalCount: + type: integer + page: + type: integer + limit: + type: integer + rows: 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: + $ref: '#/components/schemas/HistoryRowResource' + creatorChoices: type: array + description: Distinct job creators, for the Creator filter dropdown. Unresolved + users are omitted. items: - $ref: '#/components/schemas/Ref' - ShippingMethodRefListWrapper: + $ref: '#/components/schemas/HistoryCreatorChoiceResource' + PageStructure: + description: Catalogue of the layouts and blocks available for building Pages. type: object required: - - ShippingMethodRefList - properties: - ShippingMethodRefList: - $ref: '#/components/schemas/ShippingMethodRefList' - ExampleSessionCreate: - type: object - description: Schema for creating a new collaboration session + - _media-type + - layouts + - blocks 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: + _media-type: + type: string + layouts: + description: Page layouts available for building Pages. + type: array + items: + $ref: '#/components/schemas/PageStructureLayout' + blocks: + description: Page blocks available for placing in the zones of a layout. + type: array + items: + $ref: '#/components/schemas/PageStructureBlock' + PageStructureWrapper: 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 + - PageStructure 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: + PageStructure: + $ref: '#/components/schemas/PageStructure' + PageStructureLayout: + description: Page layout, together with the zones it is divided into. 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 + - _media-type + - identifier + - name + - description + - zones 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: + _media-type: + type: string + identifier: + description: Unique layout identifier, as used in configuration. + type: string + name: + description: Human-readable layout name. + type: string + description: + description: Human-readable layout description. Empty string when the layout + declares no description. + type: string + zones: + description: Zones the layout is divided into. Blocks are placed in zones. + type: array + items: + $ref: '#/components/schemas/PageStructureZone' + PageStructureZone: + description: Zone of a Page layout. 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 + - _media-type + - identifier + - name + - description 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: + identifier: + description: Unique zone identifier within its layout. type: string - description: Permission scope for the participant - enum: - - view - - edit - - admin + name: + description: Human-readable zone name. + type: string + description: + description: Human-readable zone description. Empty string when the zone + declares no description. + type: string + PageStructureBlock: + description: Page block, together with its views and attributes. + type: object required: - _media-type - - User - - scope - additionalProperties: false - ExternalParticipantCreate: - type: object - description: Schema for creating an external participant + - identifier + - name + - description + - category + - views + - attributes properties: _media-type: type: string - description: Media type identifier for external participant creation - enum: - - application/vnd.ibexa.api.ExternalParticipantCreate+json - email: + identifier: + description: Unique block identifier, as used in configuration. type: string - description: Email address of the external participant - format: email - scope: + name: + description: Human-readable block name. type: string - description: Permission scope for the participant - enum: - - view - - edit - - admin + description: + description: Human-readable block description. Empty string when the block + declares no description. + type: string + category: + description: Identifier of the category the block is grouped under in the + editor. + type: string + views: + description: Views the block can be rendered with. + type: array + items: + $ref: '#/components/schemas/PageStructureView' + attributes: + description: Attributes the block accepts. + type: array + items: + $ref: '#/components/schemas/PageStructureAttribute' + PageStructureView: + description: View a Page block can be rendered with. + type: object required: - _media-type - - email - - scope - additionalProperties: false - UserReference: - type: object - description: Reference to a user resource + - identifier + - name + - description properties: _media-type: type: string - description: Media type identifier for the user reference - enum: - - application/vnd.ibexa.api.User+json - _href: + identifier: + description: Unique view identifier within its block. 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: + name: + description: Human-readable view name. + type: string + description: + description: Human-readable view description. Empty string when the view + declares no description. + type: string + PageStructureAttribute: + description: Attribute of a Page block. 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 + - _media-type + - identifier + - name + - type + - category + - options properties: _media-type: type: string - description: Media type identifier for the collaboration session - id: - type: integer - description: Unique identifier of the collaboration session - token: + identifier: + description: Unique attribute identifier within its block. 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: + name: + description: Human-readable attribute name. type: string - description: ISO 8601 timestamp when the session was created - format: date-time - updatedAt: + type: + description: Identifier of the attribute type, which determines how the + value is edited and stored. type: string - description: ISO 8601 timestamp when the session was last updated - format: date-time - subject: + category: + description: Identifier of the category the attribute is grouped under in + the block edit form. 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 + options: + description: | + Attribute type specific configuration, passed through from the block definition as-is. Always serialized as a JSON object, empty when the attribute declares no options. + type: object + additionalProperties: true + Segment: + allOf: + - $ref: '#/components/schemas/BaseObject' + - description: This class represents a segment. + type: object + required: + - id + - identifier + - name + - source + - SegmentGroup + properties: + id: + type: integer + identifier: + type: string + name: + type: string + source: + type: string + lastUpdatedBy: + type: string + nullable: true + updatedAt: + type: string + format: date-time + nullable: true + SegmentGroup: + $ref: '#/components/schemas/SegmentGroup' + SegmentWrapper: + type: object required: - - _media-type - - id - - token - - ParticipantList - - Owner - - createdAt - - updatedAt - - subject - additionalProperties: false - Owner: + - 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 - description: Owner of a collaboration session + required: + - SegmentList 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 + SegmentList: + $ref: '#/components/schemas/SegmentList' + SegmentViewPermissions: + description: | + Actions the current user is allowed to perform on segment groups in general. Reflects the role policies of the current user. + type: object required: - - _media-type - - _href - additionalProperties: false - ExternalParticipantWrapper: + - createGroup + properties: + createGroup: + description: Whether the current user is allowed to create segment groups. + type: boolean + SegmentViewGroupPermissions: + description: | + Actions the current user is allowed to perform on a segment group. Reflects the role policies of the current user and the protected segment groups configuration: a protected segment group cannot be updated or removed and no segments can be created in it. type: object - description: Wrapper object containing an external participant + required: + - update + - delete + - createSegment properties: - Participant: - $ref: '#/components/schemas/ExternalParticipant' - description: The external participant object + update: + description: Whether the current user is allowed to update the segment group. + type: boolean + delete: + description: Whether the current user is allowed to remove the segment group. + type: boolean + createSegment: + description: Whether the current user is allowed to create segments in the + segment group. + type: boolean + SegmentViewSegmentPermissions: + description: | + Actions the current user is allowed to perform on a segment. Reflects the role policies of the current user and the protected segment groups configuration: segments of a protected segment group cannot be updated or removed. + type: object required: - - Participant - additionalProperties: false - ExternalParticipant: + - update + - delete + properties: + update: + description: Whether the current user is allowed to update the segment. + type: boolean + delete: + description: Whether the current user is allowed to remove the segment. + type: boolean + SegmentViewGroupInfo: + description: This class represents a segment group within the segment view. type: object - description: An external participant in a collaboration session (not a registered - user) + required: + - id + - identifier + - name + - permissions properties: - _media-type: + id: + type: integer + identifier: type: string - description: Media type identifier for the external participant + name: + type: string + permissions: + $ref: '#/components/schemas/SegmentViewGroupPermissions' + SegmentViewSegment: + description: This class represents a segment within the segment view, together + with the number of targeting blocks using it and its metadata. + type: object + required: + - id + - identifier + - name + - source + - blocksCount + - permissions + properties: id: type: integer - description: Unique identifier of the participant + identifier: + type: string name: type: string - description: Display name of the external participant - scope: + source: type: string - description: Permission scope for the participant (e.g., 'read', 'write', - 'admin') - email: + link: + description: | + Absolute URL of the page where the segment is managed at its source, for example the segment group list in the Back Office or the audience editor of an integration. Omitted when no link is available for the segment source. type: string - description: Email address of the external participant - format: email - createdAt: + nullable: true + lastUpdatedBy: type: string - description: ISO 8601 timestamp when the participant was added - format: date-time + nullable: true 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: + nullable: true + lastUpdatedByLabel: + type: string + nullable: true + blocksCount: + description: Number of published targeting blocks using the segment. + type: integer + metadata: + description: | + Additional metadata attached to the segment by its producer, for example an integration. Keys are metadata identifiers, values are always lists of strings, even for single-valued identifiers. Empty when no metadata is stored. + type: object + additionalProperties: + type: array + items: + type: string + permissions: + $ref: '#/components/schemas/SegmentViewSegmentPermissions' + SegmentViewGroupSegments: + description: This class represents a segment group together with its segments. 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: + - group + - segments + properties: + group: + $ref: '#/components/schemas/SegmentViewGroupInfo' + segments: + type: array + items: + $ref: '#/components/schemas/SegmentViewSegment' + SegmentViewGroupFilterOption: + description: This class represents a segment group filter value with its segment + count. type: object - description: An internal participant in a collaboration session (registered - user) + required: + - id + - identifier + - name + - count 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: + identifier: 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: + name: type: string - description: ISO 8601 timestamp when the participant was added - format: date-time - updatedAt: + count: + type: integer + SegmentViewSourceFilterOption: + description: This class represents a segment source filter value with its segment + count. + type: object + required: + - value + - count + properties: + value: 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: + count: + type: integer + SegmentViewMetadataFilterOption: + description: This class represents a segment metadata value with its segment + count. type: object - description: Wrapper object containing a list of participants + required: + - value + - count properties: - ParticipantList: - $ref: '#/components/schemas/ParticipantListObject' - description: The participant list object + value: + type: string + count: + type: integer + SegmentViewFilters: + description: This class represents the available filter options of the segment + view. + type: object required: - - ParticipantList - additionalProperties: false - ParticipantListObject: + - groups + - source + - metadata + properties: + groups: + type: array + items: + $ref: '#/components/schemas/SegmentViewGroupFilterOption' + source: + type: array + items: + $ref: '#/components/schemas/SegmentViewSourceFilterOption' + metadata: + description: | + Metadata values segments can be filtered by, keyed by metadata identifier. Contains only the identifiers declared as filterable by their producer, counted against the remaining filters. Empty when none are declared. + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/SegmentViewMetadataFilterOption' + SegmentView: + description: This class lists segments grouped by their segment groups, with + available filter values. type: object - description: A list of participants in a collaboration session + required: + - totalCount + - permissions + - filters + - groups properties: - _media-type: - type: string - description: Media type identifier for the participant list - Participants: + totalCount: + type: integer + permissions: + $ref: '#/components/schemas/SegmentViewPermissions' + filters: + $ref: '#/components/schemas/SegmentViewFilters' + groups: type: array - description: Array of participants in the collaboration session items: - $ref: '#/components/schemas/ParticipantItem' + $ref: '#/components/schemas/SegmentViewGroupSegments' + 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: - - _media-type - - Participants - additionalProperties: false - ParticipantItem: + - 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 - 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: + identifier: type: string - description: Display name of the participant - scope: + name: 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: + source: type: string - description: Email address of the participant (for external participants - only) - format: email - createdAt: + lastUpdatedBy: type: string - description: ISO 8601 timestamp when the participant was added - format: date-time + nullable: true updatedAt: type: string - description: ISO 8601 timestamp when the participant was last updated format: date-time + nullable: true + 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: - - _media-type - - id - - name - - scope - - createdAt - - updatedAt - additionalProperties: false - InvitationWrapper: + - UserSegmentList + properties: + UserSegmentList: + $ref: '#/components/schemas/SegmentList' + UserSegmentAssignInput: type: object - description: Wrapper object containing an invitation properties: - Invitation: - $ref: '#/components/schemas/Invitation' - description: The invitation object + segments: + type: array + items: + type: string + UserSegmentAssignInputWrapper: + type: object required: - - Invitation - additionalProperties: false - Invitation: + - UserSegmentAssignInput + properties: + UserSegmentAssignInput: + $ref: '#/components/schemas/UserSegmentAssignInput' + ActivityLog: + description: This class represents an activity log entry. type: object - description: An invitation to join a collaboration session + ActivityLogGroup: + type: object + required: + - user_id + - logged_at + - ActivityLogEntries properties: - _media-type: - type: string - description: Media type identifier for the invitation - id: + user_id: + description: The ID of the user performing the logged actions 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 + 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 + properties: + offset: + description: The offset of the first item to return + type: integer + limit: + description: The maximum number of items to return - default is set by `activity_log.pagination.activity_logs_limit` + which is 25 if not overridden + type: integer + criteria: + description: Search criteria for activity log groups + type: array + items: + description: Search criterion for activity log groups + type: object + required: + - type + properties: + type: + description: The type of the search criterion + type: string + enum: + - action + - logged_at + - object_class + - user + value: + description: The value of the search criterion + oneOf: + - type: string + - type: array + operator: + description: The operator of the search criterion + type: string + class: + description: The class of the `object_class` criterion + type: string + sort_clause: + description: Sort clauses for activity log groups + type: array + items: + description: Sort clause for activity log groups + type: object + required: + - type + properties: + type: + description: The type of the sort clause + type: string + enum: + - logged_at + direction: + description: The direction of the sort clause + type: string + enum: + - ASC + - DESC + ActivityLogGroupListInputWrapper: + type: object required: - - _media-type - - id - - status - - createdAt - - updatedAt - - context - - Sender - additionalProperties: false - Sender: + - ActivityLogGroupListInput + properties: + ActivityLogGroupListInput: + $ref: '#/components/schemas/ActivityLogGroupListInput' + ActivityLogGroupList: + description: This class represents activity log context groups type: object - description: Reference to the sender of an invitation + required: + - ActivityLogGroups 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 + ActivityLogGroups: + type: array + items: + $ref: '#/components/schemas/ActivityLogGroup' + ActivityLogGroupListWrapper: + type: object required: - - _media-type - - _href - additionalProperties: false + - ActivityLogGroupList + properties: + ActivityLogGroupList: + $ref: '#/components/schemas/ActivityLogGroupList' ActionType: type: object required: @@ -48044,548 +35899,532 @@ components: _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 + - 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 + 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 - - Discount + - 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.DiscountList+json - Discount: - type: array - items: - oneOf: - - $ref: '#/components/schemas/Discount' - Discount: + - 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: - - id - - identifier - - name - - type - - priority - - isEnabled - - createdAt - - updatedAt - - startDate - - DiscountRule - - DiscountExpressionAware - - DiscountConditions - - DiscountTranslations + - CollaborationSession + additionalProperties: false + CollaborationSession: + type: object + description: A collaboration session representing a shared workspace for participants properties: _media-type: type: string - enum: - - application/vnd.ibexa.api.Discount+json + description: Media type identifier for the collaboration session id: type: integer - identifier: - type: string - name: - type: string - type: - type: string - label: - type: string - labelDescription: + description: Unique identifier of the collaboration session + token: type: string - priority: - type: integer - isEnabled: - type: boolean + 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 - startDate: - type: string - format: date-time - endDate: + subject: 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 + 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 - - type - - expressionValues + - id + - token + - ParticipantList + - Owner + - createdAt + - updatedAt + - subject + additionalProperties: false + Owner: + type: object + description: Owner of a collaboration session properties: _media-type: type: string - type: + description: Media type identifier for the owner + _href: type: string - expressionValues: - type: object - additionalProperties: true - DiscountExpressionAware: - type: object + description: REST API URL reference to the owner resource + format: uri required: - _media-type - - expressionValues - properties: - _media-type: - type: string - enum: - - application/vnd.ibexa.api.DiscountExpressionAware+json - expressionValues: - type: object - additionalProperties: true - DiscountCondition: + - _href + additionalProperties: false + ExternalParticipantWrapper: type: object - required: - - _media-type - - identifier - - expressionValues + description: Wrapper object containing an external participant properties: - _media-type: - type: string - identifier: - type: string - expressionValues: - type: object - additionalProperties: true - DiscountTranslation: - type: object + Participant: + $ref: '#/components/schemas/ExternalParticipant' + description: The external participant object required: - - _media-type - - languageCode - - name + - Participant + additionalProperties: false + ExternalParticipant: + type: object + description: An external participant in a collaboration session (not a registered + user) properties: _media-type: type: string - enum: - - application/vnd.ibexa.api.DiscountTranslation+json - languageCode: - $ref: '#/components/schemas/Language' + description: Media type identifier for the external participant + id: + type: integer + description: Unique identifier of the participant name: type: string - description: - type: object - label: + 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 - labelDescription: + description: ISO 8601 timestamp when the participant was added + format: date-time + updatedAt: type: string - DiscountCreate: + 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: - - identifier - - type - - priority - - isEnabled - - userId - - rule - - translations + - Participant + additionalProperties: false + InternalParticipant: + type: object + description: An internal participant in a collaboration session (registered + user) properties: - identifier: - type: string - minLength: 1 - type: + _media-type: type: string - enum: - - cart - - catalog - priority: - type: integer - minimum: 1 - maximum: 10 - isEnabled: - type: boolean - userId: + description: Media type identifier for the internal participant + id: 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: + description: Unique identifier of the participant + name: type: string - format: date-time - endDate: + description: Display name of the internal participant + scope: type: string - format: date-time + 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 - 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: + 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: - - identifier + - ParticipantList + additionalProperties: false + ParticipantListObject: + type: object + description: A list of participants in a collaboration session properties: - identifier: + _media-type: 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: + description: Media type identifier for the participant list + Participants: type: array + description: Array of participants in the collaboration session 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: + $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 - format: date-time - endDate: + description: Media type identifier for the participant + id: + type: integer + description: Unique identifier of the participant + name: type: string - format: date-time + 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 - 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: + - _media-type + - id + - name + - scope + - createdAt + - updatedAt + additionalProperties: false + InvitationWrapper: type: object - required: - - DiscountCode + description: Wrapper object containing an invitation 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 - 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 + Invitation: + $ref: '#/components/schemas/Invitation' + description: The invitation object required: - - ShoppingList - properties: - ShoppingList: - $ref: '#/components/schemas/ShoppingList' - ShoppingListEntry: - description: This class represents an entry in a shopping list. + - Invitation + additionalProperties: false + Invitation: type: object - required: - - identifier - - product - - addedAt + description: An invitation to join a collaboration session properties: - identifier: - description: The unique identifier (UUID) of the entry. + _media-type: 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. + 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 - ShoppingListCreate: - description: Creates a new shopping list. - type: object - required: - - name - properties: - name: - description: The name of the shopping list (required). + updatedAt: type: string - ShoppingListCreateWrapper: - type: object + 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: - - ShoppingListCreate - properties: - ShoppingListCreate: - $ref: '#/components/schemas/ShoppingListCreate' - ShoppingListUpdate: - description: Updates an existing shopping list. + - _media-type + - id + - status + - createdAt + - updatedAt + - context + - Sender + additionalProperties: false + Sender: type: object - required: - - name + description: Reference to the sender of an invitation properties: - name: - description: The name of the shopping list (required). + _media-type: 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). + description: Media type identifier for the sender reference + _href: 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 + description: REST API URL reference to the sender resource + format: uri required: - - ShoppingListCollection - properties: - ShoppingListCollection: - $ref: '#/components/schemas/ShoppingListCollection' + - _media-type + - _href + additionalProperties: false responses: [] parameters: [] examples: [] @@ -48595,47 +36434,76 @@ components: security: [] tags: - name: Section + description: Resource 'Section' operations. - name: Objects + description: Resource 'Objects' operations. - name: Type Groups + description: Resource 'Type Groups' operations. - name: Type + description: Resource 'Type' operations. - name: User + description: Resource 'User' operations. - name: User Group + description: Resource 'User Group' operations. - name: User Role + description: Resource 'User Role' operations. - name: User Policy + description: Resource 'User Policy' operations. - name: Language + description: Resource 'Language' operations. - name: Location + description: Resource 'Location' operations. - name: Object State Groups + description: Resource 'Object State Groups' operations. - name: Trash + description: Resource 'Trash' operations. - name: Url Wildcard + description: Resource 'Url Wildcard' operations. - name: Url Alias + description: Resource 'Url Alias' operations. - name: Views description: Controller for Repository Views (Search, mostly). - name: User Session + description: Resource 'User Session' operations. - name: Bookmark + description: Resource 'Bookmark' operations. - name: User Token + description: Resource 'User Token' operations. - name: Calendar + description: Resource 'Calendar' operations. - name: Product Attribute + description: Resource 'Product Attribute' operations. - name: Product Attribute Type + description: Resource 'Product Attribute Type' operations. - name: Product Attribute Group + description: Resource 'Product Attribute Group' operations. - name: Product Catalog + description: Resource 'Product Catalog' operations. - name: Product Currency + description: Resource 'Product Currency' operations. - name: Product Customer Group + description: Resource 'Product Customer Group' operations. - name: Product + description: Resource 'Product' operations. - name: Product Type + description: Resource 'Product Type' operations. - name: Product Variant + description: Resource 'Product Variant' operations. - name: Product Region + description: Resource 'Product Region' operations. - name: Product Vat + description: Resource 'Product Vat' operations. - name: Taxonomy + description: Resource 'Taxonomy' operations. +- name: Page + description: Resource 'Page' operations. - name: Segmentation -- name: Corporate Account + description: Resource 'Segmentation' operations. - name: Activity Log -- name: Cart -- name: Shopping List -- name: Orders -- name: Payments -- name: Shipping -- name: Collaboration Sessions + description: Resource 'Activity Log' operations. - name: Connector AI -- name: Discounts + description: Resource 'Connector AI' operations. +- name: Collaboration Sessions + description: Resource 'Collaboration Sessions' operations. webhooks: [] ... diff --git a/docs/api/rest_api/rest_api_reference/rest_api_reference.html b/docs/api/rest_api/rest_api_reference/rest_api_reference.html index 0e5f7c928c..a141cb9032 100644 --- a/docs/api/rest_api/rest_api_reference/rest_api_reference.html +++ b/docs/api/rest_api/rest_api_reference/rest_api_reference.html @@ -3,17 +3,65 @@ <head> <meta charset="utf8" /> - <title>Ibexa DXP REST API + Cohesivo SaaS REST API - + - - -
logo
API docs by Redocly
logo
API docs by Redocly

Ibexa DXP REST API (6.0.0)

Download OpenAPI specification:Download as YAMLDownload as JSON

Section

Get Sections

Returns a list of all Sections.

-
header Parameters
If-None-Match
string

ETag

-

Responses

Response samples

Content type
{
  • "SectionList": {
    }
}

Create new Section

Creates a new Section.

-
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

The Section input schema encoded in XML or JSON format.

-
required
object (SectionInput)

Responses

Request samples

Content type
{
  • "SectionInput": {
    }
}

Response samples

Content type
{
  • "Section": {
    }
}

Get Section

Returns the Section by given Section ID.

-
path Parameters
sectionId
required
string
header Parameters
If-None-match
string

ETag

-

Responses

Response samples

Content type
{
  • "Section": {
    }
}

Delete Section

The given Section is deleted.

-
path Parameters
sectionId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Update a Section

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

-
path Parameters
sectionId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
If-Match
required
string

ETag

-
Request Body schema:
optional

The Section input schema encoded in XML or JSON.

-
required
object (SectionInput)

Responses

Request samples

Content type
{
  • "SectionInput": {
    }
}

Response samples

Content type
{
  • "Section": {
    }
}

Objects

Load content by remote ID

Loads content item for a given remote ID.

-
query Parameters
remoteId
required
string

Remote ID of the content item.

-

Responses

Create content item

Creates a draft assigned to the authenticated user. If a different user ID is given in the input, the draft is assigned to the given user but this action requires special permissions for the authenticated user (this is useful for content staging where the transfer process does not have to authenticate with the user who created the content item in the source server). The user needs to publish the content item if it should be visible.

-
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

The ContentCreate schema encoded in XML or JSON format.

-
required
object (ContentCreate)

This class is used for creating a new content item.

-

Responses

Request samples

Content type
{
  • "ContentCreate": {
    }
}

Response samples

Content type
{
  • "Content": {
    }
}

Load content

Cohesivo SaaS REST API

Download OpenAPI specification:Download as YAMLDownload as JSON

Section

Resource 'Section' operations.

+

Get Sections

Returns a list of all Sections.

+
header Parameters
If-None-Match
string

ETag

+

Responses

Response samples

Content type
{
  • "SectionList": {
    }
}

Create new Section

Creates a new Section.

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

The Section input schema encoded in XML or JSON format.

+
required
object (SectionInput)

Responses

Request samples

Content type
{
  • "SectionInput": {
    }
}

Response samples

Content type
{
  • "Section": {
    }
}

Get Section

Returns the Section by given Section ID.

+
path Parameters
sectionId
required
string

SectionLoadByIdController identifier

+
header Parameters
If-None-match
string

ETag

+

Responses

Response samples

Content type
{
  • "Section": {
    }
}

Delete Section

The given Section is deleted.

+
path Parameters
sectionId
required
string

SectionDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Update a Section

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

+
path Parameters
sectionId
required
string

SectionUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
If-Match
required
string

ETag

+
Request Body schema:
optional

The Section input schema encoded in XML or JSON.

+
required
object (SectionInput)

Responses

Request samples

Content type
{
  • "SectionInput": {
    }
}

Response samples

Content type
{
  • "Section": {
    }
}

Objects

Resource 'Objects' operations.

+

Load content by remote ID

Loads content item for a given remote ID.

+
query Parameters
remoteId
required
string

Remote ID of the content item.

+

Responses

Create content item

Creates a draft assigned to the authenticated user. If a different user ID is given in the input, the draft is assigned to the given user but this action requires special permissions for the authenticated user (this is useful for content staging where the transfer process does not have to authenticate with the user who created the content item in the source server). The user needs to publish the content item if it should be visible.

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

The ContentCreate schema encoded in XML or JSON format.

+
required
object (ContentCreate)

This class is used for creating a new content item.

+

Responses

Request samples

Content type
{
  • "ContentCreate": {
    }
}

Response samples

Content type
{
  • "Content": {
    }
}

Load content

Loads the content item for the given ID. Depending on the Accept header the current version is embedded (i.e. the current published version or if it does not exist, the draft of the authenticated user).

+" class="sc-iJSMbW sc-cBEgGa fiNpIH fqphcX">

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

  • 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.
-
path Parameters
contentId
required
integer
header Parameters
If-None-Match
string

If the provided ETag matches the current ETag then a "304 Not Modified" is returned. The ETag changes if the meta data has changed, this happens also if there is a new published version.

-

Responses

Response samples

Content type
{
  • "Content": {
    }
}

Delete Content

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

-
path Parameters
contentId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Update content

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

-
path Parameters
contentId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
If-match
required
string

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

-
Request Body schema:
optional

The ContentUpdate schema encoded in XML or JSON format.

-
required
object (ContentInfo)

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

-

Responses

Request samples

Content type
{
  • "ContentInfo": {
    }
}

Response samples

Content type
{
  • "ContentInfo": {
    }
}

Get current version

Redirects to the current version of the content item.

-
path Parameters
contentId
required
string

Responses

Response samples

Content type
{
  • "Version": {
    }
}

Create a draft from current version

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

-
path Parameters
contentId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Response samples

Content type
{
  • "Version": {
    }
}

Hide content item

Makes or keep the content item invisible

-
path Parameters
contentId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Get Locations for content item

Loads all Locations for the given content item.

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

ETag

-

Responses

Response samples

Content type
{
  • "LocationList": {
    }
}

Create new Location for content item

Creates a new Location for the given content item.

-
path Parameters
contentId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

The LocationCreate schema encoded in XML or JSON format.

-
required
object (LocationCreate)

Responses

Request samples

Content type
{
  • "LocationCreate": {
    }
}

Response samples

Content type
{
  • "Location": {
    }
}

Get Object states of content item

Returns the Object states of a content item

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

ETag

-

Responses

Response samples

Content type
{
  • "ContentObjectStates": {
    }
}

Set Object states of content item

Updates Object states of a content item. An Object state in the input overrides the state of the Object state group. PATCH or POST with header X-HTTP-Method-Override PATCH.

-
path Parameters
contentId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
If-Match
required
string

ETag

-
Request Body schema:
optional

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

-
required
object (ContentObjectStates)

Represents a list of object states.

-

Responses

Request samples

Content type
{
  • "ContentObjectStates": {
    }
}

Response samples

Content type
{
  • "ContentObjectStates": {
    }
}

Load Relations of content item

Redirects to the Relations of the current version.

-
path Parameters
contentId
required
string

Responses

Reveal content item

Makes or keep the content item visible

-
path Parameters
contentId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Delete translation (permanently)

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

-
path Parameters
contentId
required
string
languageCode
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

List versions

Returns a list of all versions of the content item. This method does not include fields and relations in the version elements of the response.

-
path Parameters
contentId
required
string

Responses

Response samples

Content type
{
  • "VersionList": {
    }
}

Load version

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

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

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

-

Responses

Response samples

Content type
{
  • "Version": {
    }
}

Create a draft from a version

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

-
path Parameters
contentId
required
string
versionNo
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Response samples

Content type
{
  • "Version": {
    }
}

Delete content version

Deletes the content version.

-
path Parameters
contentId
required
string
versionNo
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Update version

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

-
path Parameters
contentId
required
string
versionNo
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
If-match
required
string

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

-
Request Body schema:
optional

The VersionUpdate schema encoded in XML or JSON format.

-
required
object (VersionUpdate)

This class is used to update a content version.

-

Responses

Request samples

Content type
{
  • "VersionUpdate": {
    }
}

Response samples

Content type
{
  • "Version": {
    }
}

Load Relations of content item version

Loads the Relations of the given version.

-
path Parameters
contentId
required
string
versionNo
required
string

Responses

Response samples

Content type
{
  • "Relations": {
    }
}

Create new Relation

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

-
path Parameters
contentId
required
string
versionNo
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

The RelationCreate schema encoded in XML or JSON format.

-
required
object (RelationCreate)

Responses

Request samples

Content type
{
  • "RelationCreate": {
    }
}

Response samples

Content type
{
  • "Relation": {
    }
}

Load Relation

Loads a Relation for the given content item.

-
path Parameters
contentId
required
string
versionNo
required
string
relationId
required
string

Responses

Response samples

Content type
{
  • "Relation": {
    }
}

Delete Relation

Deletes a Relation of the given draft.

-
path Parameters
contentId
required
string
versionNo
required
string
relationId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Delete translation from version draft

Removes a translation from a version draft.

-
path Parameters
contentId
required
string
versionNo
required
string
languageCode
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Type Groups

Get content type groups

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

-

Responses

Response samples

Content type
{
  • "ContentTypeGroupList": {
    }
}

Create content type group

Creates a new content type group.

-
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

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

-
ContentTypeGroupInput
required
object (ContentTypeGroupInput)

Responses

Request samples

Content type
{
  • "ContentTypeGroupInput": {
    }
}

Response samples

Content type
{
  • "ContentTypeGroup": {
    }
}

Get content type group

Returns the content type group with provided ID.

-
path Parameters
contentTypeGroupId
required
string
header Parameters
If-None-Match
string

ETag

-

Responses

Response samples

Content type
{
  • "ContentTypeList": {
    }
}

Delete content type group

Deletes the provided content type group.

-
path Parameters
contentTypeGroupId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Update content type group

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

-
path Parameters
contentTypeGroupId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
If-Match
required
string

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

-
Request Body schema:
optional

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

-
ContentTypeGroupInput
required
object (ContentTypeGroupInput)

Responses

Request samples

Content type
{
  • "ContentTypeGroupInput": {
    }
}

Response samples

Content type
{
  • "ContentTypeGroup": {
    }
}

List content types for group

Returns a list of content types in the provided group.

-
path Parameters
contentTypeGroupId
required
string

Responses

Response samples

Content type
{
  • "ContentTypeList": {
    }
}

Create content type

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

-
path Parameters
contentTypeGroupId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

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

-
required
object (ContentTypeCreate)

This class is used to create a content type.

-

Responses

Request samples

Content type
{
  • "ContentTypeCreate": {
    }
}

Response samples

Content type
{
  • "ContentType": {
    }
}

Type

List content types

Returns a list of content types.

-

Responses

Response samples

Content type
{
  • "ContentTypeList": {
    }
}

Filter content types

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

-
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

The view input in XML or JSON format.

-
required
object (ContentTypeViewInput)

This class represents a content type view input.

-

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "ContentTypeList": {
    }
}

Get content type

Returns the content type with the provided ID.

-
path Parameters
contentTypeId
required
string
header Parameters
If-None-Match
string

ETag

-

Responses

Response samples

Content type
{
  • "ContentType": {
    }
}

Create Draft

Creates a draft and updates it with the given data.

-
path Parameters
contentTypeId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

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

-
required
object (ContentTypeUpdate)

This class is used to update a content type.

-

Responses

Request samples

Content type
{
  • "ContentTypeUpdate": {
    }
}

Response samples

Content type
{
  • "ContentTypeInfo": {
    }
}

Delete content type

Deletes the provided content type.

-
path Parameters
contentTypeId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Get content type draft

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

-
path Parameters
contentTypeId
required
string

Responses

Response samples

Content type
{
  • "ContentType": {
    }
}

Delete content type draft

Deletes the provided content type draft.

-
path Parameters
contentTypeId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Update content type draft

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

-
path Parameters
contentTypeId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

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

-
required
object (ContentTypeUpdate)

This class is used to update a content type.

-

Responses

Request samples

Content type
{
  • "ContentTypeUpdate": {
    }
}

Response samples

Content type
{
  • "ContentTypeInfo": {
    }
}

Get Draft Field definition list

Returns all Field definitions of the provided content type Draft.

-
path Parameters
contentTypeId
required
string

Responses

Response samples

Content type
{
  • "FieldDefinitions": {
    }
}

Add content type Draft Field definition

Creates a new Field definition for the given content type.

-
path Parameters
contentTypeId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

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

-
required
object (FieldDefinitionCreate)

Responses

Request samples

Content type
{
  • "FieldDefinitionCreate": {
    }
}

Response samples

Content type
{
  • "FieldDefinition": {
    }
}

Get content type Draft Field definition

Returns the Field definition by the given ID.

-
path Parameters
contentTypeId
required
string
fieldDefinitionId
required
string

Responses

Response samples

Content type
{
  • "FieldDefinition": {
    }
}

Delete content type Draft Field definition

Deletes the provided Field definition.

-
path Parameters
contentTypeId
required
string
fieldDefinitionId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Update content type Draft Field definition

Updates the attributes of a Field definition.

-
path Parameters
contentTypeId
required
string
fieldDefinitionId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

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

-
required
object (FieldDefinitionUpdate)

Responses

Request samples

Content type
{
  • "FieldDefinitionUpdate": {
    }
}

Response samples

Content type
{
  • "FieldDefinition": {
    }
}

Get Field definition list

Returns all Field definitions of the provided content type.

-
path Parameters
contentTypeId
required
string

Responses

Response samples

Content type
{
  • "FieldDefinitions": {
    }
}

Get Field definition

Returns the Field definition by the given ID.

-
path Parameters
contentTypeId
required
string
fieldDefinitionId
required
string

Responses

Response samples

Content type
{
  • "FieldDefinition": {
    }
}

Get groups of content type

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

-
path Parameters
contentTypeId
required
string

Responses

Response samples

Content type
{
  • "ContentTypeGroupRefList": {
    }
}

Link group to content type

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

-
path Parameters
contentTypeId
required
string
query Parameters
group
required
string

Destination content type group URI; for example with content type group 4: ?group=/api/ibexa/v2/content/typegroups/4

-
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Response samples

Content type
{
  • "ContentTypeGroupRefList": {
    }
}

Unlink group from content type

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

-
path Parameters
contentTypeId
required
string
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Response samples

Content type
{
  • "ContentTypeGroupRefList": {
    }
}

User

Load current User

Loads the current user.

-
header Parameters
Accept
required
string

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

-

Responses

Response samples

Content type
{
  • "UserList": {
    }
}

List Users

Load Users either for a given remote ID or Role.

-
header Parameters
Accept
required
string

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

-

Responses

Response samples

Content type
{
  • "UserList": {
    }
}

Verify Users

Verifies if there are Users matching given filter.

-

Responses

Load User

Loads User with the given ID.

-
path Parameters
userId
required
string
header Parameters
Accept
required
string

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

-
If-None-Match
required
string

ETag

-

Responses

Response samples

Content type
{
  • "UserList": {
    }
}

Delete User

Deletes the given User.

-
path Parameters
userId
required
string

Responses

Update User

Updates a User.

-
path Parameters
userId
required
string
header Parameters
Accept
required
string

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

-
Content-Type
required
string

The UserUpdate schema encoded in XML or JSON format.

-
If-Match
required
string

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

-
Request Body schema:
optional

The updated UserUpdateController resource

-
required
object (UserUpdate)

This class is used to update a User.

-

Responses

Request samples

Content type
{
  • "UserUpdate": {
    }
}

Response samples

Content type
{
  • "User": {
    }
}

Load user drafts

Loads user's drafts

-
path Parameters
userId
required
string
header Parameters
Accept
required
string

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

-

Responses

Response samples

Content type
{
  • "VersionList": {
    }
}

Load Groups of User

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

-
path Parameters
userId
required
string
header Parameters
Accept
required
string

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

-

Responses

Response samples

Content type
{
  • "UserGroupRefList": {
    }
}

Assign User Group

Assigns the User to a User Group.

-
path Parameters
userId
required
string
header Parameters
Accept
required
string

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

-

Responses

Response samples

Content type
{
  • "UserGroupRefList": {
    }
}

Unassign User Group

Unassigns the User from a User Group.

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

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

-

Responses

Response samples

Content type
{
  • "UserGroupRefList": {
    }
}

Load Roles for User

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

-
path Parameters
userId
required
string

Responses

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

Assign Role to User

Assigns a Role to a user.

-
path Parameters
userId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

The RoleAssignInput schema encoded in XML or JSON format.

-
required
object (RoleAssignInput)

This class represents a Role assign input.

-

Responses

Request samples

Content type
{
  • "RoleAssignInput": {
    }
}

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

Load User Role Assignment

Returns a Role assignment to the given User.

-
path Parameters
userId
required
string
roleId
required
string

Responses

Response samples

Content type
{
  • "RoleAssignment": {
    }
}

Unassign Role from User

The given Role is removed from the user.

-
path Parameters
userId
required
string
roleId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

View user segments

Return user's segment list.

-
path Parameters
userId
required
string

Responses

Response samples

Content type
{
  • "UserSegmentList": {
    }
}

Assign Segments to User

Assigns Segments from payload to User given by ID.

-
path Parameters
userId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token. Used for POST, PATCH and DELETE requests.

-
Request Body schema:
optional

The UserSegmentAssignInput schema encoded in XML or JSON format.

-
required
object (UserSegmentAssignInput)

Responses

Request samples

Content type
{
  • "UserSegmentAssignInput": {
    }
}

Unassign Segment from User

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

-
path Parameters
userId
required
string
segmentIdentifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token. Used for POST, PATCH and DELETE requests.

-

Responses

User Group

Load User Groups

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

-
header Parameters
Accept
required
string

UserGroupList - If set, the User Group List is returned in XML or JSON format. UserGroupRefList - If set, the link list of User Group is returned in XML or JSON format.

-

Responses

Response samples

Content type
{
  • "UserGroupList": {
    }
}

Get root User Group

Redirects to the root User Group.

-

Responses

Create a top level User Group

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

-
header Parameters
Accept
required
string

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

-
Content-Type
required
string

The UserGroupCreate schema encoded in XML or JSON format.

-
Request Body schema:
optional

The new UserGroupCreateController resource

-
required
object (UserGroupCreate)

This class is used to create a User Group.

-

Responses

Request samples

Content type
{
  • "UserGroupCreate": {
    }
}

Response samples

Content type
{
  • "UserGroup": {
    }
}

Load User Group

Loads User Groups for the given {path}.

-
path Parameters
path
required
string
header Parameters
Accept
required
string

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

-
If-None-Match
required
string

ETag

-

Responses

Response samples

Content type
{
  • "UserGroup": {
    }
}

Delete User Group

The given User Group is deleted.

-
path Parameters
path
required
string

Responses

Update User Group

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

-
path Parameters
path
required
string
header Parameters
Accept
required
string

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

-
Content-Type
required
string

The UserGroupUpdate schema encoded in XML or JSON format.

-
If-Match
required
string

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

-
Request Body schema:
optional

The updated UserGroupUpdateController resource

-
required
object (UserGroupUpdate)

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

-

Responses

Request samples

Content type
{
  • "UserGroupUpdate": {
    }
}

Response samples

Content type
{
  • "UserGroup": {
    }
}

Load Roles for User Group

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

-
path Parameters
path
required
string

Responses

Response samples

Content type
{
  • "RoleAssignment": {
    }
}

Assign Role to User Group

Assigns a Role to a User Group.

-
path Parameters
path
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

The RoleAssignInput schema encoded in XML or JSON format.

-
required
object (RoleAssignInput)

This class represents a Role assign input.

-

Responses

Request samples

Content type
{
  • "RoleAssignInput": {
    }
}

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

Load User Group Role Assignment

Returns a Role assignment of the given User Group.

-
path Parameters
path
required
string
roleId
required
string

Responses

Response samples

Content type
{
  • "RoleAssignment": {
    }
}

Unassign Role from User Group

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

-
path Parameters
path
required
string
roleId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

Load subgroups

Returns a list of the subgroups.

-
path Parameters
path
required
string
header Parameters
Accept
required
string

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

-

Responses

Response samples

Content type
{
  • "UserGroupList": {
    }
}

Create User Group

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

-
path Parameters
path
required
string
header Parameters
Accept
required
string

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

-
Content-Type
required
string

The UserGroupCreate schema encoded in XML or JSON format.

-
Request Body schema:
optional

The new UserGroupCreateController resource

-
required
object (UserGroupCreate)

This class is used to create a User Group.

-

Responses

Request samples

Content type
{
  • "UserGroupCreate": {
    }
}

Response samples

Content type
{
  • "UserGroup": {
    }
}

Load Users of Group

Loads the Users of the Group with the given ID.

-
path Parameters
path
required
string
header Parameters
Accept
required
string

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

-

Responses

Response samples

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

Create User

Creates a new User in the given Group.

-
path Parameters
path
required
string
header Parameters
Accept
required
string

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

-
Content-Type
required
string

The UserCreate schema encoded in XML or JSON format.

-
Request Body schema:
optional

The new UserCreateController resource

-
required
object (UserCreate)

This class is used to create a User.

-

Responses

Request samples

Content type
{
  • "UserCreate": {
    }
}

Response samples

Content type
{
  • "User": {
    }
}

User Role

Load Roles

Returns a list of all Roles.

-

Responses

Response samples

Content type
{
  • "RoleList": {
    }
}

Create Role or Role draft

Creates a new Role or Role draft.

-
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

The RoleInput schema encoded in XML or JSON.

-
required
object (RoleInput)

This class represents a Role input.

-

Responses

Request samples

Content type
{
  • "RoleInput": {
    }
}

Response samples

Content type
{
  • "Role": {
    }
}

Load Role

Loads a Role for the given ID.

-
path Parameters
id
required
string
header Parameters
If-None-Match
string

ETag

-

Responses

Response samples

Content type
{
  • "Role": {
    }
}

Create Role Draft

Creates a new Role draft from an existing Role.

-
path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Response samples

Content type
{
  • "Role": {
    }
}

Delete Role

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

-
path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Update Role

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

-
path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
If-Match
required
string

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

-
Request Body schema:
optional

The RoleInput schema encoded in XML or JSON format.

-
required
object (RoleInput)

This class represents a Role input.

-

Responses

Request samples

Content type
{
  • "RoleInput": {
    }
}

Response samples

Content type
{
  • "Role": {
    }
}

Load Role draft

Loads a Role draft by original Role ID.

-
path Parameters
id
required
string
header Parameters
If-None-Match
string

ETag

-

Responses

Response samples

Content type
{
  • "Role": {
    }
}

Delete Role draft

The given Role draft is deleted.

-
path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Update Role draft

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

-
path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
If-Match
required
string

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

-
Request Body schema:
optional

The RoleInput schema encoded in XML or JSON format.

-
required
object (RoleInput)

This class represents a Role input.

-

Responses

Request samples

Content type
{
  • "RoleInput": {
    }
}

Response samples

Content type
{
  • "Role": {
    }
}

Load Policies

Loads Policies for the given Role.

-
path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "PolicyList": {
    }
}

Create Policy

Creates a Policy

-
path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

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

-
required
object (PolicyCreate)

This class is used to create a Policy.

-

Responses

Request samples

Content type
{
  • "PolicyCreate": {
    }
}

Response samples

Content type
{
  • "Policy": {
    }
}

Delete Policies

All Policies of the given Role are deleted.

-
path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Load Policy

Loads a Policy for the given module and function.

-
path Parameters
policyId
required
string
roleId
required
string

RolePolicyLoadByIdController identifier

-
header Parameters
If-None-Match
string

ETag

-

Responses

Response samples

Content type
{
  • "Policy": {
    }
}

Delete Policy

Deletes given Policy.

-
path Parameters
policyId
required
string
roleId
required
string

RolePolicyDeleteController identifier

-
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Update Policy

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

-
path Parameters
policyId
required
string
roleId
required
string

RolePolicyUpdateController identifier

-
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
If-Match
required
string

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

-
Request Body schema:
optional

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

-
required
object (PolicyUpdate)

This class is used to update a Policy.

-

Responses

Request samples

Content type
{
  • "PolicyUpdate": {
    }
}

Response samples

Content type
{
  • "Policy": {
    }
}

User Policy

List Policies for User

Search all Policies which are applied to a given User.

-

Responses

Response samples

Content type
{
  • "PolicyList": {
    }
}

Language

Language list

Lists languages

-

Responses

Response samples

Content type
{
  • "LanguageList": {
    }
}

Get language

Retrieves a LanguageLoadByIdController resource.

-
path Parameters
code
required
string

Responses

Response samples

Content type
{
  • "Language": {
    }
}

Location

Load Locations by id/remoteId/urlAlias

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

-

Responses

Response samples

Content type
{
  • "Location": {
    }
}

Load Location

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

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

ETag

-

Responses

Response samples

Content type
{
  • "Location": {
    }
}

Delete subtree

Deletes the complete subtree for the given path. Every content item which does not have any other Location is deleted. Otherwise the deleted Location is removed from the content item. The children are recursively deleted.

-
path Parameters
path
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Update Location

Updates the Location. This method can also be used to hide/reveal a Location via the hidden field in the LocationUpdate. PATCH or POST with header X-HTTP-Method-Override PATCH.

-
path Parameters
path
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
If-Match
required
string

ETag

-
Request Body schema:
optional

The LocationUpdate schema encoded in XML or JSON format.

-
required
object (LocationUpdateStruct)

This class is used for updating Location meta data.

-

Responses

Request samples

Content type
{
  • "LocationUpdate": {
    }
}

Response samples

Content type
{
  • "Location": {
    }
}

Get child Locations.

Loads all child Locations for the given parent Location.

-
path Parameters
path
required
string

Responses

Response samples

Content type
{
  • "LocationList": {
    }
}

List URL aliases for Location

Returns the list of URL aliases for a Location.

-
path Parameters
path
required
string

Responses

Response samples

Content type
{
  • "UrlAliasRefList": {
    }
}

Object State Groups

List Object state groups

Returns a list of all Object state groups.

-
header Parameters
If-None-Match
string

ETag

-

Responses

Response samples

Content type
{
  • "ObjectStateGroupList": {
    }
}

Create Object state group

Creates a new Object state group.

-
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

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

-
required
object (ObjectStateGroupCreate)

This class represents a value for creating Object state groups.

-

Responses

Request samples

Content type
{
  • "ObjectStateGroupCreate": {
    }
}

Response samples

Content type
{
  • "ObjectStateGroup": {
    }
}

Get Object state group

Returns the Object state group with the provided ID.

-
path Parameters
objectStateGroupId
required
string
header Parameters
If-None-Match
string

ETag

-

Responses

Response samples

Content type
{
  • "ObjectStateGroup": {
    }
}

Delete Object state group

Deletes the given Object state group including Object states.

-
path Parameters
objectStateGroupId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Update Object state group

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

-
path Parameters
objectStateGroupId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
If-Match
required
string

ETag

-
Request Body schema:
optional

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

-
required
object (ObjectStateGroupUpdate)

This class represents a value for updating Object state groups.

-

Responses

Request samples

Content type
{
  • "ObjectStateGroupUpdate": {
    }
}

Response samples

Content type
{
  • "ObjectStateGroup": {
    }
}

List Object states

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

-
path Parameters
objectStateGroupId
required
string
header Parameters
If-None-Match
string

ETag

-

Responses

Response samples

Content type
{
  • "ObjectStateList": {
    }
}

Create Object state

Creates a new Object state.

-
path Parameters
objectStateGroupId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

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

-
required
object (ObjectStateCreate)

This class represents a value for creating Object states.

-

Responses

Request samples

Content type
{
  • "ObjectStateCreate": {
    }
}

Response samples

Content type
{
  • "ObjectState": {
    }
}

Get Object state

Returns the Object state.

-
path Parameters
objectStateGroupId
required
string
objectStateId
required
string
header Parameters
If-None-Match
string

ETag

-

Responses

Response samples

Content type
{
  • "ObjectState": {
    }
}

Delete Object state

Deletes provided Object state.

-
path Parameters
objectStateGroupId
required
string
objectStateId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Update Object state

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

-
path Parameters
objectStateGroupId
required
string
objectStateId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
If-Match
required
string

ETag

-
Request Body schema:
optional

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

-
required
object (ObjectStateUpdate)

This class represents a value for updating Object states.

-

Responses

Request samples

Content type
{
  • "ObjectStateUpdate": {
    }
}

Response samples

Content type
{
  • "ObjectState": {
    }
}

Trash

List Trash items

Returns a list of all items in the Trash.

-

Responses

Response samples

Content type
{
  • "Trash": {
    }
}

Empty Trash

Empties the Trash.

-
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Get Trash item

Returns the item in Trash with the provided ID.

-
path Parameters
trashItemid
required
string

Responses

Response samples

Content type
{
  • "TrashItem": {
    }
}

Delete Trash item

Deletes the provided item from Trash.

-
path Parameters
trashItemid
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Url Wildcard

List URL wildcards

Returns a list of URL wildcards.

-

Responses

Response samples

Content type
{
  • "UrlWildcardList": {
    }
}

Create URL wildcard

Creates a new URL wildcard.

-
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

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

-
required
object (UrlWildcardCreate)

Creates a new URL wildcard.

-

Responses

Request samples

Content type
{
  • "URLWildcardCreate": {
    }
}

Response samples

Content type
{
  • "UrlWildcard": {
    }
}

Get URL wildcard

Returns the URL wildcard with the given ID.

-
path Parameters
wildcardId
required
string

Responses

Response samples

Content type
{
  • "UrlWildcard": {
    }
}

Delete URL wildcard

Deletes the given URL wildcard.

-
path Parameters
wildcardId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Url Alias

List global URL aliases

Returns the list of global URL aliases.

-

Responses

Response samples

Content type
{
  • "UrlAliasRefList": {
    }
}

Create URL alias

Creates a URL alias.

-
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

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

-
required
object (UrlAliasCreate)

Responses

Request samples

Content type
{
  • "UrlAliasCreate": {
    }
}

Response samples

Content type
{
  • "UrlAlias": {
    }
}

Get URL alias

Returns the URL alias with the given ID.

-
path Parameters
urlAliasId
required
string

Responses

Response samples

Content type
{
  • "UrlAlias": {
    }
}

Delete URL alias

Deletes the provided URL alias.

-
path Parameters
urlAliasId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Views

path Parameters
contentId
required
integer

ContentLoadByIdController identifier

+
header Parameters
If-None-Match
string

If the provided ETag matches the current ETag then a "304 Not Modified" is returned. The ETag changes if the meta data has changed, this happens also if there is a new published version.

+

Responses

Response samples

Content type
{
  • "Content": {
    }
}

Delete Content

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

+
path Parameters
contentId
required
string

ContentDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Update content

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

+
path Parameters
contentId
required
string

ContentMetadataUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
If-match
required
string

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

+
Request Body schema:
optional

The ContentUpdate schema encoded in XML or JSON format.

+
required
object (ContentInfo)

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

+

Responses

Request samples

Content type
{
  • "ContentInfo": {
    }
}

Response samples

Content type
{
  • "ContentInfo": {
    }
}

Get current version

Redirects to the current version of the content item.

+
path Parameters
contentId
required
string

ContentCurrentVersionRedirectController identifier

+

Responses

Response samples

Content type
{
  • "Version": {
    }
}

Create a draft from current version

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

+
path Parameters
contentId
required
string

ContentDraftCreateFromCurrentVersionController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Response samples

Content type
{
  • "Version": {
    }
}

Hide content item

Makes or keep the content item invisible

+
path Parameters
contentId
required
string

ContentHideController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Get Locations for content item

Loads all Locations for the given content item.

+
path Parameters
contentId
required
string

LocationForContentListController identifier

+
header Parameters
If-None-Match
string

ETag

+

Responses

Response samples

Content type
{
  • "LocationList": {
    }
}

Create new Location for content item

Creates a new Location for the given content item.

+
path Parameters
contentId
required
string

LocationCreateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

The LocationCreate schema encoded in XML or JSON format.

+
required
object (LocationCreate)

Responses

Request samples

Content type
{
  • "LocationCreate": {
    }
}

Response samples

Content type
{
  • "Location": {
    }
}

Get Object states of content item

Returns the Object states of a content item

+
path Parameters
contentId
required
string

ObjectStatesForContentListController identifier

+
header Parameters
If-None-Match
string

ETag

+

Responses

Response samples

Content type
{
  • "ContentObjectStates": {
    }
}

Set Object states of content item

Updates Object states of a content item. An Object state in the input overrides the state of the Object state group. PATCH or POST with header X-HTTP-Method-Override PATCH.

+
path Parameters
contentId
required
string

ObjectStatesForContentUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
If-Match
required
string

ETag

+
Request Body schema:
optional

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

+
required
object (ContentObjectStates)

Represents a list of object states.

+

Responses

Request samples

Content type
{
  • "ContentObjectStates": {
    }
}

Response samples

Content type
{
  • "ContentObjectStates": {
    }
}

Load Relations of content item

Redirects to the Relations of the current version.

+
path Parameters
contentId
required
string

ContentCurrentVersionRelationsRedirectController identifier

+

Responses

Reveal content item

Makes or keep the content item visible

+
path Parameters
contentId
required
string

ContentRevealController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Delete translation (permanently)

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

+
path Parameters
contentId
required
string

ContentTranslationDeleteController identifier

+
languageCode
required
string

ContentTranslationDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

List versions

Returns a list of all versions of the content item. This method does not include fields and relations in the version elements of the response.

+
path Parameters
contentId
required
string

ContentVersionsListController identifier

+

Responses

Response samples

Content type
{
  • "VersionList": {
    }
}

Load version

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

+
path Parameters
contentId
required
string

ContentInVersionLoadController identifier

+
versionNo
required
string

ContentInVersionLoadController identifier

+
header Parameters
If-None-Match
string

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

+

Responses

Response samples

Content type
{
  • "Version": {
    }
}

Create a draft from a version

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

+
path Parameters
contentId
required
string

ContentDraftCreateFromVersionController identifier

+
versionNo
required
string

ContentDraftCreateFromVersionController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Response samples

Content type
{
  • "Version": {
    }
}

Delete content version

Deletes the content version.

+
path Parameters
contentId
required
string

ContentVersionDeleteController identifier

+
versionNo
required
string

ContentVersionDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Update version

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

+
path Parameters
contentId
required
string

ContentVersionUpdateController identifier

+
versionNo
required
string

ContentVersionUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
If-match
required
string

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

+
Request Body schema:
optional

The VersionUpdate schema encoded in XML or JSON format.

+
required
object (VersionUpdate)

This class is used to update a content version.

+

Responses

Request samples

Content type
{
  • "VersionUpdate": {
    }
}

Response samples

Content type
{
  • "Version": {
    }
}

Load Relations of content item version

Loads the Relations of the given version.

+
path Parameters
contentId
required
string

ContentVersionsRelationsListController identifier

+
versionNo
required
string

ContentVersionsRelationsListController identifier

+

Responses

Response samples

Content type
{
  • "Relations": {
    }
}

Create new Relation

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

+
path Parameters
contentId
required
string

ContentRelationCreateController identifier

+
versionNo
required
string

ContentRelationCreateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

The RelationCreate schema encoded in XML or JSON format.

+
required
object (RelationCreate)

Responses

Request samples

Content type
{
  • "RelationCreate": {
    }
}

Response samples

Content type
{
  • "Relation": {
    }
}

Load Relation

Loads a Relation for the given content item.

+
path Parameters
contentId
required
string

ContentVersionRelationLoadByIdController identifier

+
versionNo
required
string

ContentVersionRelationLoadByIdController identifier

+
relationId
required
string

ContentVersionRelationLoadByIdController identifier

+

Responses

Response samples

Content type
{
  • "Relation": {
    }
}

Delete Relation

Deletes a Relation of the given draft.

+
path Parameters
contentId
required
string

ContentVersionRelationDeleteController identifier

+
versionNo
required
string

ContentVersionRelationDeleteController identifier

+
relationId
required
string

ContentVersionRelationDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Delete translation from version draft

Removes a translation from a version draft.

+
path Parameters
contentId
required
string

ContentDraftTranslationDeleteController identifier

+
versionNo
required
string

ContentDraftTranslationDeleteController identifier

+
languageCode
required
string

ContentDraftTranslationDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Type Groups

Resource 'Type Groups' operations.

+

Get content type groups

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

+

Responses

Response samples

Content type
{
  • "ContentTypeGroupList": {
    }
}

Create content type group

Creates a new content type group.

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

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

+
ContentTypeGroupInput
required
object (ContentTypeGroupInput)

Responses

Request samples

Content type
{
  • "ContentTypeGroupInput": {
    }
}

Response samples

Content type
{
  • "ContentTypeGroup": {
    }
}

Get content type group

Returns the content type group with provided ID.

+
path Parameters
contentTypeGroupId
required
string

ContentTypeGroupLoadByIdController identifier

+
header Parameters
If-None-Match
string

ETag

+

Responses

Response samples

Content type
{
  • "ContentTypeList": {
    }
}

Delete content type group

Deletes the provided content type group.

+
path Parameters
contentTypeGroupId
required
string

ContentTypeGroupDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Update content type group

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

+
path Parameters
contentTypeGroupId
required
string

ContentTypeGroupUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
If-Match
required
string

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

+
Request Body schema:
optional

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

+
ContentTypeGroupInput
required
object (ContentTypeGroupInput)

Responses

Request samples

Content type
{
  • "ContentTypeGroupInput": {
    }
}

Response samples

Content type
{
  • "ContentTypeGroup": {
    }
}

List content types for group

Returns a list of content types in the provided group.

+
path Parameters
contentTypeGroupId
required
string

ContentTypeListForGroupController identifier

+

Responses

Response samples

Content type
{
  • "ContentTypeList": {
    }
}

Create content type

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

+
path Parameters
contentTypeGroupId
required
string

ContentTypeCreateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

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

+
required
object (ContentTypeCreate)

This class is used to create a content type.

+

Responses

Request samples

Content type
{
  • "ContentTypeCreate": {
    }
}

Response samples

Content type
{
  • "ContentType": {
    }
}

Type

Resource 'Type' operations.

+

List content types

Returns a list of content types.

+

Responses

Response samples

Content type
{
  • "ContentTypeList": {
    }
}

Filter content types

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

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

The view input in XML or JSON format.

+
required
object (ContentTypeViewInput)

This class represents a content type view input.

+

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "ContentTypeList": {
    }
}

Get content type

Returns the content type with the provided ID.

+
path Parameters
contentTypeId
required
string

ContentTypeLoadByIdController identifier

+
header Parameters
If-None-Match
string

ETag

+

Responses

Response samples

Content type
{
  • "ContentType": {
    }
}

Create Draft

Creates a draft and updates it with the given data.

+
path Parameters
contentTypeId
required
string

ContentTypeDraftCreateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

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

+
required
object (ContentTypeUpdate)

This class is used to update a content type.

+

Responses

Request samples

Content type
{
  • "ContentTypeUpdate": {
    }
}

Response samples

Content type
{
  • "ContentTypeInfo": {
    }
}

Delete content type

Deletes the provided content type.

+
path Parameters
contentTypeId
required
string

ContentTypeDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Get content type draft

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

+
path Parameters
contentTypeId
required
string

ContentTypeDraftLoadController identifier

+

Responses

Response samples

Content type
{
  • "ContentType": {
    }
}

Delete content type draft

Deletes the provided content type draft.

+
path Parameters
contentTypeId
required
string

ContentTypeDraftDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Update content type draft

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

+
path Parameters
contentTypeId
required
string

ContentTypeDraftUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

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

+
required
object (ContentTypeUpdate)

This class is used to update a content type.

+

Responses

Request samples

Content type
{
  • "ContentTypeUpdate": {
    }
}

Response samples

Content type
{
  • "ContentTypeInfo": {
    }
}

Get Draft Field definition list

Returns all Field definitions of the provided content type Draft.

+
path Parameters
contentTypeId
required
string

ContentTypeDraftFieldDefinitionListController identifier

+

Responses

Response samples

Content type
{
  • "FieldDefinitions": {
    }
}

Add content type Draft Field definition

Creates a new Field definition for the given content type.

+
path Parameters
contentTypeId
required
string

ContentTypeDraftFieldDefinitionAddController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

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

+
required
object (FieldDefinitionCreate)

Responses

Request samples

Content type
{
  • "FieldDefinitionCreate": {
    }
}

Response samples

Content type
{
  • "FieldDefinition": {
    }
}

Get content type Draft Field definition

Returns the Field definition by the given ID.

+
path Parameters
contentTypeId
required
string

ContentTypeDraftFieldDefinitionLoadByIdController identifier

+
fieldDefinitionId
required
string

ContentTypeDraftFieldDefinitionLoadByIdController identifier

+

Responses

Response samples

Content type
{
  • "FieldDefinition": {
    }
}

Delete content type Draft Field definition

Deletes the provided Field definition.

+
path Parameters
contentTypeId
required
string

ContentTypeDraftFieldDefinitionDeleteController identifier

+
fieldDefinitionId
required
string

ContentTypeDraftFieldDefinitionDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Update content type Draft Field definition

Updates the attributes of a Field definition.

+
path Parameters
contentTypeId
required
string

ContentTypeDraftFieldDefinitionUpdateController identifier

+
fieldDefinitionId
required
string

ContentTypeDraftFieldDefinitionUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

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

+
required
object (FieldDefinitionUpdate)

Responses

Request samples

Content type
{
  • "FieldDefinitionUpdate": {
    }
}

Response samples

Content type
{
  • "FieldDefinition": {
    }
}

Get Field definition list

Returns all Field definitions of the provided content type.

+
path Parameters
contentTypeId
required
string

ContentTypeFieldDefinitionListController identifier

+

Responses

Response samples

Content type
{
  • "FieldDefinitions": {
    }
}

Get Field definition

Returns the Field definition by the given ID.

+
path Parameters
contentTypeId
required
string

ContentTypeFieldDefinitionLoadByIdController identifier

+
fieldDefinitionId
required
string

ContentTypeFieldDefinitionLoadByIdController identifier

+

Responses

Response samples

Content type
{
  • "FieldDefinition": {
    }
}

Get groups of content type

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

+
path Parameters
contentTypeId
required
string

ContentTypeGroupListController identifier

+

Responses

Response samples

Content type
{
  • "ContentTypeGroupRefList": {
    }
}

Link group to content type

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

+
path Parameters
contentTypeId
required
string

ContentTypeLinkToGroupController identifier

+
query Parameters
group
required
string

Destination content type group URI; for example with content type group 4: ?group=/api/ibexa/v2/content/typegroups/4

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Response samples

Content type
{
  • "ContentTypeGroupRefList": {
    }
}

Unlink group from content type

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

+
path Parameters
contentTypeId
required
string

ContentTypeUnlinkFromGroupController identifier

+
id
required
string

ContentTypeUnlinkFromGroupController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Response samples

Content type
{
  • "ContentTypeGroupRefList": {
    }
}

User

Resource 'User' operations.

+

Load current User

Loads the current user.

+
header Parameters
Accept
required
string

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

+

Responses

Response samples

Content type
{
  • "UserList": {
    }
}

List Users

Load Users either for a given remote ID or Role.

+
header Parameters
Accept
required
string

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

+

Responses

Response samples

Content type
{
  • "UserList": {
    }
}

Verify Users

Verifies if there are Users matching given filter.

+

Responses

Load User

Loads User with the given ID.

+
path Parameters
userId
required
string

UserLoadByIdController identifier

+
header Parameters
Accept
required
string

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

+
If-None-Match
required
string

ETag

+

Responses

Response samples

Content type
{
  • "UserList": {
    }
}

Delete User

Deletes the given User.

+
path Parameters
userId
required
string

UserDeleteController identifier

+

Responses

Update User

Updates a User.

+
path Parameters
userId
required
string

UserUpdateController identifier

+
header Parameters
Accept
required
string

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

+
Content-Type
required
string

The UserUpdate schema encoded in XML or JSON format.

+
If-Match
required
string

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

+
Request Body schema:
optional

The updated UserUpdateController resource

+
required
object (UserUpdate)

This class is used to update a User.

+

Responses

Request samples

Content type
{
  • "UserUpdate": {
    }
}

Response samples

Content type
{
  • "User": {
    }
}

Load user drafts

Loads user's drafts

+
path Parameters
userId
required
string

UserDraftListController identifier

+
header Parameters
Accept
required
string

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

+

Responses

Response samples

Content type
{
  • "VersionList": {
    }
}

Load Groups of User

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

+
path Parameters
userId
required
string

UserGroupsOfUserListController identifier

+
header Parameters
Accept
required
string

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

+

Responses

Response samples

Content type
{
  • "UserGroupRefList": {
    }
}

Assign User Group

Assigns the User to a User Group.

+
path Parameters
userId
required
string

UserAssignToUserGroupController identifier

+
header Parameters
Accept
required
string

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

+

Responses

Response samples

Content type
{
  • "UserGroupRefList": {
    }
}

Unassign User Group

Unassigns the User from a User Group.

+
path Parameters
userId
required
string

UserUnassignFromUserGroupController identifier

+
groupId
required
string

UserUnassignFromUserGroupController identifier

+
header Parameters
Accept
required
string

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

+

Responses

Response samples

Content type
{
  • "UserGroupRefList": {
    }
}

Load Roles for User

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

+
path Parameters
userId
required
string

RoleAssignmentForUserListController identifier

+

Responses

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

Assign Role to User

Assigns a Role to a user.

+
path Parameters
userId
required
string

RoleAssignToUserController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

The RoleAssignInput schema encoded in XML or JSON format.

+
required
object (RoleAssignInput)

This class represents a Role assign input.

+

Responses

Request samples

Content type
{
  • "RoleAssignInput": {
    }
}

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

Load User Role Assignment

Returns a Role assignment to the given User.

+
path Parameters
userId
required
string

RoleAssignmentForUserLoadByIdController identifier

+
roleId
required
string

RoleAssignmentForUserLoadByIdController identifier

+

Responses

Response samples

Content type
{
  • "RoleAssignment": {
    }
}

Unassign Role from User

The given Role is removed from the user.

+
path Parameters
userId
required
string

RoleUnassignFromUserController identifier

+
roleId
required
string

RoleUnassignFromUserController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

View user segments

Return user's segment list.

+
path Parameters
userId
required
string

UserSegmentListController identifier

+

Responses

Response samples

Content type
{
  • "UserSegmentList": {
    }
}

Assign Segments to User

Assigns Segments from payload to User given by ID.

+
path Parameters
userId
required
string

UserSegmentAssignController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token. Used for POST, PATCH and DELETE requests.

+
Request Body schema:
optional

The UserSegmentAssignInput schema encoded in XML or JSON format.

+
required
object (UserSegmentAssignInput)

Responses

Request samples

Content type
{
  • "UserSegmentAssignInput": {
    }
}

Unassign Segment from User

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

+
path Parameters
userId
required
string

UserSegmentUnassignController identifier

+
segmentIdentifier
required
string

UserSegmentUnassignController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token. Used for POST, PATCH and DELETE requests.

+

Responses

User Group

Resource 'User Group' operations.

+

Load User Groups

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

+
header Parameters
Accept
required
string

UserGroupList - If set, the User Group List is returned in XML or JSON format. UserGroupRefList - If set, the link list of User Group is returned in XML or JSON format.

+

Responses

Response samples

Content type
{
  • "UserGroupList": {
    }
}

Get root User Group

Redirects to the root User Group.

+

Responses

Create a top level User Group

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

+
header Parameters
Accept
required
string

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

+
Content-Type
required
string

The UserGroupCreate schema encoded in XML or JSON format.

+
Request Body schema:
optional

The new UserGroupCreateController resource

+
required
object (UserGroupCreate)

This class is used to create a User Group.

+

Responses

Request samples

Content type
{
  • "UserGroupCreate": {
    }
}

Response samples

Content type
{
  • "UserGroup": {
    }
}

Load User Group

Loads User Groups for the given {path}.

+
path Parameters
path
required
string

UserGroupLoadByPathController identifier

+
header Parameters
Accept
required
string

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

+
If-None-Match
required
string

ETag

+

Responses

Response samples

Content type
{
  • "UserGroup": {
    }
}

Delete User Group

The given User Group is deleted.

+
path Parameters
path
required
string

UserGroupDeleteController identifier

+

Responses

Update User Group

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

+
path Parameters
path
required
string

UserGroupUpdateController identifier

+
header Parameters
Accept
required
string

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

+
Content-Type
required
string

The UserGroupUpdate schema encoded in XML or JSON format.

+
If-Match
required
string

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

+
Request Body schema:
optional

The updated UserGroupUpdateController resource

+
required
object (UserGroupUpdate)

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

+

Responses

Request samples

Content type
{
  • "UserGroupUpdate": {
    }
}

Response samples

Content type
{
  • "UserGroup": {
    }
}

Load Roles for User Group

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

+
path Parameters
path
required
string

RoleAssignmentForUserGroupListController identifier

+

Responses

Response samples

Content type
{
  • "RoleAssignment": {
    }
}

Assign Role to User Group

Assigns a Role to a User Group.

+
path Parameters
path
required
string

RoleAssignToUserGroupController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

The RoleAssignInput schema encoded in XML or JSON format.

+
required
object (RoleAssignInput)

This class represents a Role assign input.

+

Responses

Request samples

Content type
{
  • "RoleAssignInput": {
    }
}

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

Load User Group Role Assignment

Returns a Role assignment of the given User Group.

+
path Parameters
path
required
string

RoleAssignmentForUserGroupLoadByIdController identifier

+
roleId
required
string

RoleAssignmentForUserGroupLoadByIdController identifier

+

Responses

Response samples

Content type
{
  • "RoleAssignment": {
    }
}

Unassign Role from User Group

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

+
path Parameters
path
required
string

RoleUnassignFromUserGroupController identifier

+
roleId
required
string

RoleUnassignFromUserGroupController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Response samples

Content type
{
  • "RoleAssignmentList": {
    }
}

Load subgroups

Returns a list of the subgroups.

+
path Parameters
path
required
string

UserSubGroupListController identifier

+
header Parameters
Accept
required
string

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

+

Responses

Response samples

Content type
{
  • "UserGroupList": {
    }
}

Create User Group

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

+
path Parameters
path
required
string

UserGroupCreateController identifier

+
header Parameters
Accept
required
string

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

+
Content-Type
required
string

The UserGroupCreate schema encoded in XML or JSON format.

+
Request Body schema:
optional

The new UserGroupCreateController resource

+
required
object (UserGroupCreate)

This class is used to create a User Group.

+

Responses

Request samples

Content type
{
  • "UserGroupCreate": {
    }
}

Response samples

Content type
{
  • "UserGroup": {
    }
}

Load Users of Group

Loads the Users of the Group with the given ID.

+
path Parameters
path
required
string

UserGroupUsersListController identifier

+
header Parameters
Accept
required
string

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

+

Responses

Response samples

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

Create User

Creates a new User in the given Group.

+
path Parameters
path
required
string

UserCreateController identifier

+
header Parameters
Accept
required
string

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

+
Content-Type
required
string

The UserCreate schema encoded in XML or JSON format.

+
Request Body schema:
optional

The new UserCreateController resource

+
required
object (UserCreate)

This class is used to create a User.

+

Responses

Request samples

Content type
{
  • "UserCreate": {
    }
}

Response samples

Content type
{
  • "User": {
    }
}

User Role

Resource 'User Role' operations.

+

Load Roles

Returns a list of all Roles.

+

Responses

Response samples

Content type
{
  • "RoleList": {
    }
}

Create Role or Role draft

Creates a new Role or Role draft.

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

The RoleInput schema encoded in XML or JSON.

+
required
object (RoleInput)

This class represents a Role input.

+

Responses

Request samples

Content type
{
  • "RoleInput": {
    }
}

Response samples

Content type
{
  • "Role": {
    }
}

Load Role

Loads a Role for the given ID.

+
path Parameters
id
required
string

RoleLoadByIdController identifier

+
header Parameters
If-None-Match
string

ETag

+

Responses

Response samples

Content type
{
  • "Role": {
    }
}

Create Role Draft

Creates a new Role draft from an existing Role.

+
path Parameters
id
required
string

RoleDraftCreateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Response samples

Content type
{
  • "Role": {
    }
}

Delete Role

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

+
path Parameters
id
required
string

RoleDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Update Role

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

+
path Parameters
id
required
string

RoleUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
If-Match
required
string

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

+
Request Body schema:
optional

The RoleInput schema encoded in XML or JSON format.

+
required
object (RoleInput)

This class represents a Role input.

+

Responses

Request samples

Content type
{
  • "RoleInput": {
    }
}

Response samples

Content type
{
  • "Role": {
    }
}

Load Role draft

Loads a Role draft by original Role ID.

+
path Parameters
id
required
string

RoleDraftLoadByRoleIdController identifier

+
header Parameters
If-None-Match
string

ETag

+

Responses

Response samples

Content type
{
  • "Role": {
    }
}

Delete Role draft

The given Role draft is deleted.

+
path Parameters
id
required
string

RoleDraftDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Update Role draft

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

+
path Parameters
id
required
string

RoleDraftUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
If-Match
required
string

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

+
Request Body schema:
optional

The RoleInput schema encoded in XML or JSON format.

+
required
object (RoleInput)

This class represents a Role input.

+

Responses

Request samples

Content type
{
  • "RoleInput": {
    }
}

Response samples

Content type
{
  • "Role": {
    }
}

Load Policies

Loads Policies for the given Role.

+
path Parameters
id
required
string

RolePolicyListController identifier

+

Responses

Response samples

Content type
{
  • "PolicyList": {
    }
}

Create Policy

Creates a Policy

+
path Parameters
id
required
string

RolePolicyCreateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

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

+
required
object (PolicyCreate)

This class is used to create a Policy.

+

Responses

Request samples

Content type
{
  • "PolicyCreate": {
    }
}

Response samples

Content type
{
  • "Policy": {
    }
}

Delete Policies

All Policies of the given Role are deleted.

+
path Parameters
id
required
string

RolePolicyDeleteAllFromRoleController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Load Policy

Loads a Policy for the given module and function.

+
path Parameters
policyId
required
string

RolePolicyLoadByIdController identifier

+
roleId
required
string

RolePolicyLoadByIdController identifier

+
header Parameters
If-None-Match
string

ETag

+

Responses

Response samples

Content type
{
  • "Policy": {
    }
}

Delete Policy

Deletes given Policy.

+
path Parameters
policyId
required
string

RolePolicyDeleteController identifier

+
roleId
required
string

RolePolicyDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Update Policy

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

+
path Parameters
policyId
required
string

RolePolicyUpdateController identifier

+
roleId
required
string

RolePolicyUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
If-Match
required
string

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

+
Request Body schema:
optional

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

+
required
object (PolicyUpdate)

This class is used to update a Policy.

+

Responses

Request samples

Content type
{
  • "PolicyUpdate": {
    }
}

Response samples

Content type
{
  • "Policy": {
    }
}

User Policy

Resource 'User Policy' operations.

+

List Policies for User

Search all Policies which are applied to a given User.

+

Responses

Response samples

Content type
{
  • "PolicyList": {
    }
}

Language

Resource 'Language' operations.

+

Language list

Lists languages

+

Responses

Response samples

Content type
{
  • "LanguageList": {
    }
}

Get language

Retrieves a LanguageLoadByIdController resource.

+
path Parameters
code
required
string

LanguageLoadByIdController identifier

+

Responses

Response samples

Content type
{
  • "Language": {
    }
}

Location

Resource 'Location' operations.

+

Load Locations by id/remoteId/urlAlias

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

+

Responses

Response samples

Content type
{
  • "Location": {
    }
}

Load Location

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

+
path Parameters
path
required
string

LocationLoadByPathController identifier

+
header Parameters
If-None-Match
string

ETag

+

Responses

Response samples

Content type
{
  • "Location": {
    }
}

Delete subtree

Deletes the complete subtree for the given path. Every content item which does not have any other Location is deleted. Otherwise the deleted Location is removed from the content item. The children are recursively deleted.

+
path Parameters
path
required
string

LocationSubtreeDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Update Location

Updates the Location. This method can also be used to hide/reveal a Location via the hidden field in the LocationUpdate. PATCH or POST with header X-HTTP-Method-Override PATCH.

+
path Parameters
path
required
string

LocationUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
If-Match
required
string

ETag

+
Request Body schema:
optional

The LocationUpdate schema encoded in XML or JSON format.

+
required
object (LocationUpdateStruct)

This class is used for updating Location meta data.

+

Responses

Request samples

Content type
{
  • "LocationUpdate": {
    }
}

Response samples

Content type
{
  • "Location": {
    }
}

Get child Locations.

Loads all child Locations for the given parent Location.

+
path Parameters
path
required
string

LocationChildrenListController identifier

+

Responses

Response samples

Content type
{
  • "LocationList": {
    }
}

List URL aliases for Location

Returns the list of URL aliases for a Location.

+
path Parameters
path
required
string

URLAliasListLocationController identifier

+

Responses

Response samples

Content type
{
  • "UrlAliasRefList": {
    }
}

Object State Groups

Resource 'Object State Groups' operations.

+

List Object state groups

Returns a list of all Object state groups.

+
header Parameters
If-None-Match
string

ETag

+

Responses

Response samples

Content type
{
  • "ObjectStateGroupList": {
    }
}

Create Object state group

Creates a new Object state group.

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

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

+
required
object (ObjectStateGroupCreate)

This class represents a value for creating Object state groups.

+

Responses

Request samples

Content type
{
  • "ObjectStateGroupCreate": {
    }
}

Response samples

Content type
{
  • "ObjectStateGroup": {
    }
}

Get Object state group

Returns the Object state group with the provided ID.

+
path Parameters
objectStateGroupId
required
string

ObjectStateGroupLoadByIdController identifier

+
header Parameters
If-None-Match
string

ETag

+

Responses

Response samples

Content type
{
  • "ObjectStateGroup": {
    }
}

Delete Object state group

Deletes the given Object state group including Object states.

+
path Parameters
objectStateGroupId
required
string

ObjectStateGroupDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Update Object state group

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

+
path Parameters
objectStateGroupId
required
string

ObjectStateGroupUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
If-Match
required
string

ETag

+
Request Body schema:
optional

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

+
required
object (ObjectStateGroupUpdate)

This class represents a value for updating Object state groups.

+

Responses

Request samples

Content type
{
  • "ObjectStateGroupUpdate": {
    }
}

Response samples

Content type
{
  • "ObjectStateGroup": {
    }
}

List Object states

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

+
path Parameters
objectStateGroupId
required
string

ObjectStateListController identifier

+
header Parameters
If-None-Match
string

ETag

+

Responses

Response samples

Content type
{
  • "ObjectStateList": {
    }
}

Create Object state

Creates a new Object state.

+
path Parameters
objectStateGroupId
required
string

ObjectStateCreateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

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

+
required
object (ObjectStateCreate)

This class represents a value for creating Object states.

+

Responses

Request samples

Content type
{
  • "ObjectStateCreate": {
    }
}

Response samples

Content type
{
  • "ObjectState": {
    }
}

Get Object state

Returns the Object state.

+
path Parameters
objectStateGroupId
required
string

ObjectStateLoadByIdController identifier

+
objectStateId
required
string

ObjectStateLoadByIdController identifier

+
header Parameters
If-None-Match
string

ETag

+

Responses

Response samples

Content type
{
  • "ObjectState": {
    }
}

Delete Object state

Deletes provided Object state.

+
path Parameters
objectStateGroupId
required
string

ObjectStateDeleteController identifier

+
objectStateId
required
string

ObjectStateDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Update Object state

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

+
path Parameters
objectStateGroupId
required
string

ObjectStateUpdateController identifier

+
objectStateId
required
string

ObjectStateUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
If-Match
required
string

ETag

+
Request Body schema:
optional

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

+
required
object (ObjectStateUpdate)

This class represents a value for updating Object states.

+

Responses

Request samples

Content type
{
  • "ObjectStateUpdate": {
    }
}

Response samples

Content type
{
  • "ObjectState": {
    }
}

Trash

Resource 'Trash' operations.

+

List Trash items

Returns a list of all items in the Trash.

+

Responses

Response samples

Content type
{
  • "Trash": {
    }
}

Empty Trash

Empties the Trash.

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Get Trash item

Returns the item in Trash with the provided ID.

+
path Parameters
trashItemid
required
string

TrashItemLoadByIdController identifier

+

Responses

Response samples

Content type
{
  • "TrashItem": {
    }
}

Delete Trash item

Deletes the provided item from Trash.

+
path Parameters
trashItemid
required
string

TrashItemDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Url Wildcard

Resource 'Url Wildcard' operations.

+

List URL wildcards

Returns a list of URL wildcards.

+

Responses

Response samples

Content type
{
  • "UrlWildcardList": {
    }
}

Create URL wildcard

Creates a new URL wildcard.

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

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

+
required
object (UrlWildcardCreate)

Creates a new URL wildcard.

+

Responses

Request samples

Content type
{
  • "URLWildcardCreate": {
    }
}

Response samples

Content type
{
  • "UrlWildcard": {
    }
}

Get URL wildcard

Returns the URL wildcard with the given ID.

+
path Parameters
wildcardId
required
string

URLWildcardLoadByIdController identifier

+

Responses

Response samples

Content type
{
  • "UrlWildcard": {
    }
}

Delete URL wildcard

Deletes the given URL wildcard.

+
path Parameters
wildcardId
required
string

URLWildcardDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Url Alias

Resource 'Url Alias' operations.

+

List global URL aliases

Returns the list of global URL aliases.

+

Responses

Response samples

Content type
{
  • "UrlAliasRefList": {
    }
}

Create URL alias

Creates a URL alias.

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

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

+
required
object (UrlAliasCreate)

Responses

Request samples

Content type
{
  • "UrlAliasCreate": {
    }
}

Response samples

Content type
{
  • "UrlAlias": {
    }
}

Get URL alias

Returns the URL alias with the given ID.

+
path Parameters
urlAliasId
required
string

URLAliasLoadByIdController identifier

+

Responses

Response samples

Content type
{
  • "UrlAlias": {
    }
}

Delete URL alias

Deletes the provided URL alias.

+
path Parameters
urlAliasId
required
string

URLAliasDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Views

Controller for Repository Views (Search, mostly).

-

Search content

Search content

Executes a query and returns a View including the results. +" class="sc-iJSMbW sc-cBEgGa fiNpIH fqphcX">

Executes a query and returns a View including the results. View input reflects the criteria model of the public PHP API. Refer to Search Criteria Reference

-
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

The view input in XML or JSON format.

-
required
object (ViewInput)

This class represents a View input.

-

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.View+xml; version=1.1
<?xml version="1.0" encoding="UTF-8"?>
+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

The view input in XML or JSON format.

+
required
object (ViewInput)

This class represents a View input.

+

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
application/vnd.ibexa.api.View+xml; version=1.1
<?xml version="1.0" encoding="UTF-8"?>
 <View href="/views/TitleView" media-type="application/vnd.ibexa.api.View+xml; version=1.1">
   <identifier>TitleView</identifier>
   <User href="/user/users/14" media-type="vnd.ibexa.api.User+xml"/>
@@ -2292,2421 +2589,1637 @@
     </facets>
   </Result>
 </View>
-

User Session

Create session (login a User)

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

-
header Parameters
Accept
required
string

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

-
Content-Type
required
string

The SessionInput schema encoded in XML or JSON format.

-
Cookie
required
string

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

-
X-CSRF-Token
required
string

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

-
Request Body schema:
optional

The new SessionCreateController resource

-
required
object (SessionInput)

This class represents a session input.

-

Responses

Request samples

Content type
{
  • "SessionInput": {
    }
}

Response samples

Content type
{
  • "Session": {
    }
}

Get current session

Get current user session, if any.

-
header Parameters
Cookie
required
string

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

-
Accept
required
string

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

-

Responses

Response samples

Content type
{
  • "Session": {
    }
}

Delete session (logout a User)

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

-
path Parameters
sessionId
required
string
header Parameters
Cookie
required
string

{sessionName}={sessionID}

-
X-CSRF-Token
required
string

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

-

Responses

Refresh session (deprecated)

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

-
path Parameters
sessionId
required
string
header Parameters
Cookie
required
string

{sessionName}={sessionID}

-
X-CSRF-Token
required
string

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

-
Accept
required
string

Responses

Response samples

Content type
{
  • "Session": {
    }
}

Bookmark

List of bookmarks

Lists bookmarked Locations for the current user.

-

Responses

Response samples

Content type
{
  • "BookmarkList": {
    }
}

Check if Location is bookmarked

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

-
path Parameters
locationId
required
integer

Responses

Create bookmark

Add given Location to bookmarks of the current user.

-
path Parameters
locationId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Delete bookmark

Deletes the given Location from bookmarks of the current user.

-
path Parameters
locationId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-

Responses

Check if Location is bookmarked

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

-
path Parameters
locationId
required
integer

Responses

User Token

Create JWT token

Creates JWT authentication token.

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

The credentials in JWTInput JSON format.

-
required
object (JWTInput)

This class represents the input for a JWT authentication token

-

Responses

Request samples

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

Response samples

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

Calendar

Calendar list

Calendar event list.

-
query Parameters
start
required
integer (UnixTimestamp)

timestamp (seconds since the Unix Epoch).

-
end
required
integer (UnixTimestamp)

timestamp.

-
count
integer

Maximum number of events returned (10 by default).

-
types
Array of strings
Example: types=future_publication,future_hide,page_block_reveal,page_block_hide

Comma-separated list of type identifiers.

-
languages
Array of strings
Example: languages=eng-GB,fre-FR

comma-separated list of language codes.

-
cursor
string
Example: cursor=MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy

Pagination cursor. It's the representation of the event to start the page afterward, as the concatenation of the timestamp, the event type, and the event identifier with a colon separator ("::"), encoded in base64. For example "1778264040:future_hide:future_hide:2" ("future_hide:2" is the ID) encoded as "MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy"

-

Responses

Response samples

Content type
{
  • "EventList": {
    }
}

Calendar list grouped by day

Calendar event list grouped by day.

-
query Parameters
start
required
integer (UnixTimestamp)

timestamp (seconds since the Unix Epoch).

-
end
required
integer (UnixTimestamp)

timestamp.

-
count
integer

Maximum number of events returned (10 by default).

-
types
Array of strings
Example: types=future_publication,future_hide,page_block_reveal,page_block_hide

Comma-separated list of type identifiers.

-
languages
Array of strings
Example: languages=eng-GB,fre-FR

comma-separated list of language codes.

-
cursor
string
Example: cursor=MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy

Pagination cursor. It's the representation of the event to start the page afterward, as the concatenation of the timestamp, the event type, and the event identifier with a colon separator ("::"), encoded in base64. For example "1778264040:future_hide:future_hide:2" ("future_hide:2" is the ID) encoded as "MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy"

-

Responses

Response samples

Content type
{
  • "EventGroupList": {
    }
}

Calendar action

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

-
path Parameters
eventType
required
string
Enum: "future_publication" "future_hide"

The type of event to execute an action on.

-
Request Body schema:
required

Data for the calendar action to execute

-
required
object (RescheduleAction)

This class represents events to reschedule

-

Responses

Request samples

Content type
{
  • "RescheduleAction": {
    }
}

Product Attribute

Load attributes (deprecated)

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

-
Request Body schema:
optional

Attribute filter

-
required
object (AttributeListGet)

This class represents an attribute list query

-

Responses

Request samples

Content type
{
  • "AttributeListGet": {
    }
}

Response samples

Content type
{
  • "AttributeList": {
    }
}

Create attribute

Creates a new attribute.

-
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The attribute schema encoded in XML or JSON format.

-
required
object (AttributeCreate)

This class is used to create an attribute.

-

Responses

Request samples

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

Response samples

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

Delete attribute translation

The given translation is removed from the attribute.

-
path Parameters
id
required
string
languageCode
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-

Responses

Filter attributes

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

-
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-
Request Body schema:
optional

The view input in XML or JSON format.

-
required
object (AttributeViewInput)

This class represents an attribute view input.

-

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "AttributeView": {
    }
}

Load attribute

Loads given attribute.

-
path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "Attribute": {
    }
}

Delete attribute

The given attribute is removed from the attribute group.

-
path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-

Responses

Update attribute

Updates an attribute.

-
path Parameters
id
required
string
group_id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

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

-
required
object (AttributeUpdate)

This class is used to update an attribute.

-

Responses

Request samples

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

Response samples

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

Product Attribute Type

List Attribute Types

Lists all Attribute Types.

-

Responses

Response samples

Content type
{
  • "AttributeTypeList": {
    }
}

Get Attribute Type

Gets an Attribute Type by its identifier.

-
path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "AttributeType": {
    }
}

Product Attribute Group

Load attribute groups (deprecated)

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

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

The AttributeGroupListGet schema encoded in XML or JSON format.

-
required
object (AttributeGroupListGet)

This class represents an attribute group list request.

-

Responses

Request samples

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

Response samples

Content type
{
  • "AttributeGroupList": {
    }
}

Create attribute group

Creates a new attribute group.

-
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The AttributeGroup schema encoded in XML or JSON format.

-
required
object (AttributeGroupCreate)

This class is used to create an attribute group.

-

Responses

Request samples

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

Response samples

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

Delete attribute group translation

Deletes given translation from attribute group.

-
path Parameters
id
required
string
languageCode
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-

Responses

Filter attribute groups

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

-
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-
Request Body schema:
optional

The view input in XML or JSON format.

-
required
object (AttributeGroupViewInput)

This class represents an attribute group view input.

-

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "AttributeGroupView": {
    }
}

Load attribute group

Returns the given attribute group.

-
path Parameters
id
required
string
Request Body schema:
optional

An optional AttributeGroupGet schema encoded in XML or JSON format.

-
required
object (AttributeGroupGet)

This class represents an attribute group query.

-

Responses

Request samples

Content type
{
  • "AttributeGroupGet": {
    }
}

Response samples

Content type
{
  • "AttributeGroup": {
    }
}

Delete attribute group

Deletes an attribute group.

-
path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-

Responses

Update attribute group

Updates an attribute group.

-
path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-
Request Body schema:
optional

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

-
required
object (AttributeGroupUpdate)

This class is used to update an attribute group.

-

Responses

Request samples

Content type
{
  • "AttributeGroupUpdate": {
    }
}

Response samples

Content type
{
  • "AttributeGroup": {
    }
}

Product Catalog

Create catalog

Creates a new catalog.

-
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The catalog schema encoded in XML or JSON format.

-
required
object (CatalogCreate)

This class is used to create a catalog.

-

Responses

Request samples

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

Response samples

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

Copy catalog

Copies a catalog.

-
path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

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

-
required
object (CatalogCopy)

This class is used to copy a catalog.

-

Responses

Request samples

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

Response samples

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

Load catalog filters

Loads product filters available for catalogs.

-

Responses

Response samples

Content type
{
  • "ProductFilterList": {
    }
}

Load catalog sort clauses

Loads product sort clauses available for catalogs.

-

Responses

Response samples

Content type
{
  • "ProductSortClauseList": {
    }
}

Filter catalogs

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

-
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-
Request Body schema:
optional

The view input in XML or JSON format.

-
required
object (CatalogViewInput)

This class represents a catalog view input.

-

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "CatalogView": {
    }
}

Load catalog

Loads the given catalog.

-
path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "Catalog": {
    }
}

Delete catalog

Deletes the given catalog.

-
path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-

Responses

Update catalog

Updates a catalog.

-
path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

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

-
required
object (CatalogUpdate)

This class is used to update a catalog.

-

Responses

Request samples

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

Response samples

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

Filter catalog products

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

-
path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-
Request Body schema:
optional

The view input in XML or JSON format.

-
required
object (ProductViewInput)

This class represents a product view input.

-

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "ProductView": {
    }
}

Product Currency

Load currencies

Loads the list of currencies.

-

Responses

Response samples

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

Create currency

Creates a new currency.

-
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The Currency schema encoded in XML or JSON format.

-
required
object (CurrencyCreate)

This class is used to create currency.

-

Responses

Request samples

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

Response samples

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

Filter currencies

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

-
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-
Request Body schema:
optional

The view input in XML or JSON format.

-
required
object (CurrencyViewInput)

This class represents a currency view input.

-

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "CurrencyView": {
    }
}

Load currency

Loads a currency.

-
path Parameters
id
required
string

Responses

Response samples

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

Delete currency

Deletes the given currency.

-
path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-

Responses

Update currency

Updates a currency.

-
path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The CurrencyUpdate schema encoded in XML or JSON format.

-
required
object (CurrencyUpdate)

This class is used to update currency.

-

Responses

Request samples

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

Response samples

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

Product Customer Group

Load customer groups

Returns a list of customer groups

-

Responses

Response samples

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

Create customer group

Creates a new customer group.

-
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The CustomerGroupCreate schema encoded in XML or JSON format.

-
required
object (CustomerGroupCreate)

This class is used to create a customer group.

-

Responses

Request samples

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

Response samples

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

Filter customer groups

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

-
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-
Request Body schema:
optional

The view input in XML or JSON format.

-
required
object (CustomerGroupViewInput)

This class represents a customer group view input.

-

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "CustomerGroupView": {
    }
}

Load customer group

Returns a customer group

-
path Parameters
identifier
required
string

Responses

Response samples

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

Delete customer group

Deletes the given customer group.

-
path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-

Responses

Update customer group

Updates the given customer group.

-
path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The CustomerGroupUpdate schema encoded in XML or JSON format.

-
required
object (CustomerGroupUpdate)

This class is used to update a customer group.

-

Responses

Request samples

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

Response samples

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

Load customer group

Returns a customer group

-
path Parameters
id
required
integer

Responses

Response samples

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

Product

Load products list (deprecated)

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

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

The product list schema encoded in XML or JSON format.

-
required
object (ProductListGet)

This class represents a product list GET.

-

Responses

Request samples

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

Response samples

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

Filter products

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

-
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-
Request Body schema:
optional

The view input in XML or JSON format.

-
required
object (ProductViewInput)

This class represents a product view input.

-

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "ProductView": {
    }
}

Load the given product

Loads the given product.

-
path Parameters
code
required
string
Request Body schema: application/vnd.ibexa.api.ProductGet+json
optional

An optional product schema encoded in XML or JSON format.

-
required
object (ProductGet)

This class represents a product GET.

-

Responses

Request samples

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

Response samples

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

Update product

Updates product.

-
path Parameters
code
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

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

-
required
object (ProductUpdate)

This class is used to update a product.

-

Responses

Request samples

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

Response samples

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

Load the list of product prices

Loads the list of product prices.

-
path Parameters
code
required
string

Responses

Response samples

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

Create product price or custom price

Create product price or custom price.

-
path Parameters
code
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-
Request Body schema:
optional

The product price schema encoded in JSON format.

-
required
object (CustomPriceCreateStruct)

This class represents a custom price creation structure.

-

Responses

Request samples

Content type
{
  • "CustomPriceCreateStruct": {
    }
}

Response samples

Content type
{
  • "CustomPrice": {
    }
}

Get price in given currency

Get price in given currency.

-
path Parameters
code
required
string
currencyCode
required
string

Responses

Response samples

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

Get price in given currency and customer group

Get price in given currency and customer group.

-
path Parameters
code
required
string
currencyCode
required
string
customerGroupIdentifier
required
string

Responses

Response samples

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

Delete product price

Deletes product price.

-
path Parameters
code
required
string
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-

Responses

Update product price

Updates product price.

-
path Parameters
code
required
string
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-
Request Body schema:
optional

Update price or custom price for given currency.

-
required
object (CustomPriceUpdateStruct)

This class represents a custom price updating structure.

-

Responses

Request samples

Content type
{
  • "CustomPriceUpdateStruct": {
    }
}

Response samples

Content type
{
  • "CustomPrice": {
    }
}

Delete product

Deletes the given product.

-
path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-

Responses

Create product

Creates a new product.

-
path Parameters
productTypeIdentifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The product schema encoded in XML or JSON format.

-
required
object (ProductCreate)

This class is used to create a product.

-

Responses

Request samples

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

Response samples

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

Product Type

Load product types (deprecated)

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

-
Request Body schema:
optional

The ProductTypeList schema encoded in XML or JSON format.

-
required
object (ProductTypeListGet)

This class represents a product type list query.

-

Responses

Request samples

Content type
{
  • "ProductTypeListGet": {
    }
}

Response samples

Content type
{
  • "ProductTypeList": {
    }
}

Create product type

Creates a new product type.

-
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The ProductType schema encoded in XML or JSON format.

-
required
object (ProductTypeCreate)

This class is used to create a product type.

-

Responses

Request samples

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

Response samples

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

Check product type usage

Checks whether the product type is in use.

-
path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "ProductTypeUsage": {
    }
}

Filter product types

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

-
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-
Request Body schema:
optional

The view input in XML or JSON format.

-
required
object (ProductTypeViewInput)

This class represents a product type view input.

-

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "ProductTypeView": {
    }
}

Load product type

Returns the given product type.

-
path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "ProductType": {
    }
}

Delete product type

Deletes the given product type.

-
path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-

Responses

Update product type

Updates product type.

-
path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

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

-
required
object (ProductTypeUpdate)

This class is used to update a product type.

-

Responses

Request samples

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

Response samples

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

Product Variant

Load product variant

Loads the given product variant.

-
path Parameters
code
required
string

Responses

Response samples

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

Generate product variants

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

-
path Parameters
baseProductCode
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The product variant schema encoded in XML or JSON format.

-
required
object (ProductVariantGenerate)

This class is used to generate a product variant.

-

Responses

Request samples

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

Filter product variants

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

-
path Parameters
baseProductCode
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-
Request Body schema:
optional

The view input in XML or JSON format.

-
required
object (ProductVariantViewInput)

This class represents a product variant view input.

-

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "ProductVariantView": {
    }
}

Create product variant

Creates a new product variant.

-
path Parameters
baseProductCode
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The product variant schema encoded in XML or JSON format.

-
required
object (ProductVariantCreate)

This class is used to create a product variant.

-

Responses

Request samples

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

Delete product variant

Deletes the given product variant.

-
path Parameters
code
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-

Responses

Update product variant

Updates product variant.

-
path Parameters
code
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

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

-
required
object (ProductVariantUpdate)

This class is used to update a product variant.

-

Responses

Request samples

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

Response samples

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

Product Region

Load regions

Loads the list of regions.

-

Responses

Response samples

Content type
{
  • "RegionList": {
    }
}

Filter regions

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

-
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

-
Request Body schema:
optional

The view input in XML or JSON format.

-
required
object (RegionViewInput)

This class represents a region view input.

-

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "RegionView": {
    }
}

Load region

Loads a region by its identifier

-
path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "Region": {
    }
}

Product Vat

Load VAT region

Loads a VAT category for the given region.

-
path Parameters
region
required
string

Responses

Response samples

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

Load VAT specific region

Loads a VAT category for the given identifier.

-
path Parameters
region
required
string
identifier
required
string

Responses

Response samples

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

Taxonomy

Delete Entries

Bulk removes several taxonomy entries.

-
path Parameters
taxonomyName
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

-
Request Body schema:
optional

TaxonomyEntryBulkRemove schema encoded in XML or JSON format.

-
required
object (TaxonomyEntryBulkRemove)

This class is used to bulk remove taxonomy entries.

-

Responses

Request samples

Content type
{
  • "TaxonomyEntryBulkRemove": {
    }
}

Move Entries

Bulk move several taxonomy entries relative to sibling.

-
path Parameters
taxonomyName
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

-
Request Body schema:
optional

The TaxonomyEntryBulkMove schema encoded in XML or JSON format.

-
required
object (TaxonomyEntryBulkMove)

This class is used to bulk move taxonomy entries.

-

Responses

Request samples

Content type
{
  • "TaxonomyEntryBulkMove": {
    }
}

Get Assignment by ID

Gets taxonomy entry Assignment by its ID.

-
path Parameters
taxonomyName
required
string
id
required
string

Responses

Response samples

Content type
{
  • "TaxonomyEntryAssignment": {
    }
}

Assign entry

Assigns taxonomy entry to a content item.

-
path Parameters
taxonomyName
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

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

TaxonomyEntryAssignToContent schema encoded in JSON format.

-
required
object (TaxonomyEntryAssignToContent)

This class is used to assign taxonomy entry to content.

-

Responses

Request samples

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

Get Assignments to a Content

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

-
path Parameters
taxonomyName
required
string
contentId
required
string

Responses

Response samples

Content type
{
  • "EntryAssignmentCollection": {
    }
}

Unassign entry

Unassigns taxonomy entry from a content item.

-
path Parameters
taxonomyName
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

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

TaxonomyEntryUnassignFromContent schema encoded in JSON format.

-
required
object (TaxonomyEntryUnassignFromContent)

This class is used to unassign taxonomy entry from content.

-

Responses

Request samples

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

Get Entry by Content ID

Loads taxonomy Entry by its Content ID.

-
path Parameters
taxonomyName
required
string
contentId
required
string

Responses

Response samples

Content type
{
  • "TaxonomyEntry": {
    }
}

Get Entry by identifier

Loads taxonomy Entry by its Entry identifier.

-
path Parameters
taxonomyName
required
string
identifier
required
string

Responses

Response samples

Content type
{
  • "TaxonomyEntry": {
    }
}

Get Entry by ID

Loads taxonomy Entry by its Entry ID.

-
path Parameters
taxonomyName
required
string
id
required
string

Responses

Response samples

Content type
{
  • "TaxonomyEntry": {
    }
}

Segmentation

List segment groups ExperienceCommerce

Lists segment groups.

-

Responses

Response samples

Content type
{
  • "SegmentGroupList": {
    }
}

Load segment group ExperienceCommerce

Loads segment group.

-
path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "SegmentGroup": {
    }
}

List segment group's segments ExperienceCommerce

Lists segment group's segments.

-
path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "SegmentList": {
    }
}

Load segment ExperienceCommerce

Loads the identified segment.

-
path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "Segment": {
    }
}

Corporate Account

Root Resource ExperienceCommerce

Provides basic information about Corporate Account endpoints and configuration.

-

Responses

Response samples

Content type
{
  • "CorporateAccountRoot": {
    }
}

Read list of companies ExperienceCommerce

Returns paginated list of available companies.

-

Responses

Response samples

Content type
{
  • "CompanyList": {
    }
}

Create a company ExperienceCommerce

Creates a CompanyCreateController resource.

-
header Parameters
X-CSRF-Token
required
string

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

-
Request Body schema:
optional

The CompanyCreate schema encoded in XML or JSON format.

-
required
object (CompanyCreate)

This class is used to create a company.

-

Responses

Request samples

Content type
{
  • "CompanyCreate": {
    }
}

Response samples

Content type
{
  • "Company": {
    }
}

Get company ExperienceCommerce

Returns the company by given company ID.

-
path Parameters
companyId
required
string
header Parameters
If-None-match
string

ETag

-

Responses

Response samples

Content type
{
  • "Company": {
    }
}

Delete company ExperienceCommerce

The given company is deleted.

-
path Parameters
companyId
required
string
header Parameters
X-CSRF-Token
required
string

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

-

Responses

Update a company ExperienceCommerce

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

-
path Parameters
companyId
required
string
header Parameters
X-CSRF-Token
required
string

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

-
If-Match
required
string

ETag

-
Request Body schema:
optional

The company input schema encoded in XML or JSON.

-
required
object (CompanyUpdate)

This class is used to update a Company.

-

Responses

Request samples

Content type
{
  • "CompanyUpdate": {
    }
}

Response samples

Content type
{
  • "Company": {
    }
}

Read list of company members ExperienceCommerce

Returns paginated list of a given company members.

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

DateTime as a UNIX timestamp

-
sort[ContentName]
string
Enum: "ascending" "descending"
sort[DatePublished]
string
Enum: "ascending" "descending"
sort[DateModified]
string
Enum: "ascending" "descending"
offset
integer
limit
integer

Responses

Response samples

Content type
{
  • "MemberList": {
    }
}

Create a company member ExperienceCommerce

Creates a company member.

-
path Parameters
companyId
required
string
header Parameters
X-CSRF-Token
required
string

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

-
Request Body schema:
optional

The MemberCreate schema encoded in XML or JSON format.

-
required
object (MemberCreate)

This class is used to create a member.

-

Responses

Request samples

Content type
{
  • "MemberCreate": {
    }
}

Response samples

Content type
{
  • "Member": {
    }
}

Get company member ExperienceCommerce

Returns the company member by given member ID.

-
path Parameters
companyId
required
string
memberId
required
string

Responses

Response samples

Content type
{
  • "Member": {
    }
}

Delete company member ExperienceCommerce

The given company member is deleted.

-
path Parameters
companyId
required
string
memberId
required
string
header Parameters
X-CSRF-Token
required
string

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

-

Responses

Update a company member ExperienceCommerce

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

-
path Parameters
companyId
required
string
memberId
required
string
header Parameters
X-CSRF-Token
required
string

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

-
If-Match
required
string

ETag

-
Request Body schema:
optional

The company input schema encoded in XML or JSON.

-
required
object (MemberUpdate)

This class is used to update a member.

-

Responses

Request samples

Content type
{
  • "MemberUpdate": {
    }
}

Response samples

Content type
{
  • "Member": {
    }
}

Read list of sales representatives ExperienceCommerce

Returns paginated list of available sales representatives.

-

Responses

Response samples

Content type
{
  • "SalesRepresentativesList": {
    }
}

Activity Log

List of activity log groups ExperienceCommerce

Lists last activity log groups and their entries.

-

Responses

Response samples

Content type
{
  • "ActivityLogGroupList": {
    }
}

List of activity log groups ExperienceCommerce

Lists last activity log groups and their entries.

-
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

-
Request Body schema:
optional

The query to filter activity log groups.

-
required
object (ActivityLogGroupListInput)

This class represents the activity log group search query's criteria and sort clauses.

-

Responses

Request samples

Content type
{
  • "ActivityLogGroupListInput": {
    }
}

Response samples

Content type
{
  • "ActivityLogGroupList": {
    }
}

Cart

Create Cart Commerce

Creates Cart from payload.

-
header Parameters
X-CSRF-Token
required
string

The CSRF token.

-
Request Body schema:
optional

The CartCreate schema encoded in XML or JSON format.

-
required
object (CartCreate)

This class represents a new Cart to create

-

Responses

Request samples

Content type
{
  • "CartCreate": {
    }
}

Response samples

Content type
{
  • "Cart": {
    }
}

Filter carts Commerce

Executes a query and returns a View including the results.

-
header Parameters
X-CSRF-Token
required
string

The CSRF token.

-
Request Body schema:
optional

The CartViewInput schema is posted in XML or JSON format.

-
required
object (CartViewInput)

This class represents a cart view input.

-

Responses

Request samples

Content type
{
  • "CartViewInput": {
    }
}

Response samples

Content type
{
  • "CartView": {
    }
}

Get Cart Commerce

Gets Cart by its identifier.

-
path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "Cart": {
    }
}

Delete Cart Commerce

Deletes Cart by its identifier.

-
path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

-

Responses

Update Cart's metadata Commerce

Updates identified Cart's metadata from payload.

-
path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

-
Request Body schema:
optional

The CartMetadataUpdate schema encoded in XML or JSON format.

-
required
object (CartMetadataUpdate)

This class represents the update of cart metadata.

-

Responses

Request samples

Content type
{
  • "CartMetadataUpdate": {
    }
}

Response samples

Content type
{
  • "Cart": {
    }
}

Empty Cart Commerce

Empties the given Cart.

-
path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

-

Responses

Add Entry to Cart Commerce

Adds an entry to the cart referenced by its identifier

-
path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

-
Request Body schema:
optional

The CartEntryAdd schema encoded in XML or JSON format.

-
required
object (CartEntryAdd)

This class represents a cart entry

-

Responses

Request samples

Content type
{
  • "CartEntryAdd": {
    }
}

Response samples

Content type
{
  • "Cart": {
    }
}

Remove Entry from Cart Commerce

Removes the given entry from the given Cart.

-
path Parameters
identifier
required
string
entryId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

-

Responses

Response samples

Content type
{
  • "Cart": {
    }
}

Update Entry from Cart Commerce

Updates the given entry from the given Cart.

-
path Parameters
identifier
required
string
entryId
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

-
Request Body schema:
optional

The CartEntryUpdate schema encoded in XML or JSON format.

-
required
object (CartEntryUpdate)

Responses

Request samples

Content type
{
  • "CartEntryUpdate": {
    }
}

Response samples

Content type
{
  • "Cart": {
    }
}

Move Selected Cart Entries to Default Shopping List Commerce

Moves selected entries from the given Cart to the default Shopping List (save for later). After moving, selected entries are removed from the cart.

-
path Parameters
identifier
required
string

The Cart identifier

-
header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

-
Request Body schema:
optional

The CartEntryIdentifiers schema encoded in XML or JSON format.

-
required
object (CartEntryIdentifiers)

This class represents a list of cart entry identifiers

-

Responses

Request samples

Content type
{
  • "CartEntryIdentifiers": {
    }
}

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Move Selected Cart Entries to Specific Shopping List Commerce

Moves selected entries from the given Cart to the specified Shopping List (save for later). After moving, selected entries are removed from the cart.

-
path Parameters
identifier
required
string

The Cart identifier

-
shoppingListIdentifier
required
string

The Shopping List identifier

-
header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

-
Request Body schema:
optional

The CartEntryIdentifiers schema encoded in XML or JSON format.

-
required
object (CartEntryIdentifiers)

This class represents a list of cart entry identifiers

-

Responses

Request samples

Content type
{
  • "CartEntryIdentifiers": {
    }
}

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Move Cart to Default Shopping List Commerce

Moves all entries from the given Cart to the default Shopping List (save for later). After moving, entries are removed from the cart.

-
path Parameters
identifier
required
string

The Cart identifier

-
header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

-

Responses

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Move Cart to Specific Shopping List Commerce

Moves all entries from the given Cart to the specified Shopping List (save for later). After moving, entries are removed from the cart.

-
path Parameters
identifier
required
string

The Cart identifier

-
shoppingListIdentifier
required
string

The Shopping List identifier

-
header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

-

Responses

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Cart Summary Commerce

Gets a summary of the given Cart.

-
path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "CartSummary": {
    }
}

Shopping List

List shopping lists CommerceLTS Update

Returns a list of shopping lists owned by the current user.

-
query Parameters
limit
integer
Default: 25

The maximum number of shopping lists to return. Default is 25.

-
offset
integer
Default: 0

The offset for pagination. Default is 0.

-
name
string

Filter shopping lists by name (partial match).

-
createdFrom
string <date-time>

Filter shopping lists created on or after this date (ISO 8601 format).

-
createdTo
string <date-time>

Filter shopping lists created on or before this date (ISO 8601 format).

-
updatedFrom
string <date-time>

Filter shopping lists updated on or after this date (ISO 8601 format).

-
updatedTo
string <date-time>

Filter shopping lists updated on or before this date (ISO 8601 format).

-
isDefault
string
Enum: "true" "false"

Filter shopping lists by default flag. Use "true" for default lists only, "false" for non-default lists only.

-
ownerId
integer

Filter shopping lists by owner user ID.

-
sort
string
Enum: "name" "is_default" "created_at" "updated_at"

Sort shopping lists by field. Available fields: name, is_default, created_at, updated_at.

-
order
string
Default: "asc"
Enum: "asc" "desc"

Sort direction. Default is "asc".

-

Responses

Response samples

Content type
{
  • "ShoppingListCollection": {
    }
}

Create shopping list CommerceLTS Update

Creates a new shopping list for the current user. The list will be owned by the authenticated user.

-
header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

-
Request Body schema:
optional

Shopping list to create

-
required
object (ShoppingListCreate)

Creates a new shopping list.

-

Responses

Request samples

Content type
{
  • "ShoppingListCreate": {
    }
}

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Add entries to default shopping list CommerceLTS Update

Adds one or more product entries to the default shopping list. If the default shopping list does not exist, it will be created automatically.

-
header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

-
Request Body schema:
optional

Entries to add to the default shopping list

-
required
object (ShoppingListEntriesAdd)

Adds one or more product entries to an existing shopping list.

-

Responses

Request samples

Content type
{
  • "ShoppingListEntriesAdd": {
    }
}

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Get shopping list CommerceLTS Update

Gets a shopping list by its identifier.

-
path Parameters
identifier
required
string

The shopping list identifier (UUID)

-

Responses

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Delete shopping list CommerceLTS Update

Deletes a shopping list by its identifier. The default shopping list cannot be deleted.

-
path Parameters
identifier
required
string

The shopping list identifier (UUID).

-
header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

-

Responses

Update shopping list CommerceLTS Update

Updates an existing shopping list. Only the name can be updated.

-
path Parameters
identifier
required
string

The shopping list identifier (UUID).

-
header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

-
Request Body schema:
optional

Shopping list metadata to update

-
required
object (ShoppingListUpdate)

Updates an existing shopping list.

-

Responses

Request samples

Content type
{
  • "ShoppingListUpdate": {
    }
}

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Add Selected Entries from Shopping List to Default Cart CommerceLTS Update

Adds selected entries from the given Shopping List to the default Cart (creates a new Cart if not found).

-
path Parameters
identifier
required
string

The Shopping List identifier

-
header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

-
Request Body schema:
optional

The ShoppingListEntryIdentifiers schema encoded in XML or JSON format.

-
required
object (ShoppingListEntryIdentifiers)

This class represents a list of shopping list entry identifiers to add to cart

-

Responses

Request samples

Content type
{
  • "ShoppingListEntryIdentifiers": {
    }
}

Response samples

Content type
{
  • "Cart": {
    }
}

Add Selected Entries from Shopping List to Specific Cart CommerceLTS Update

Adds selected entries from the given Shopping List to the specified Cart.

-
path Parameters
identifier
required
string

The Shopping List identifier

-
cartIdentifier
required
string

The Cart identifier

-
header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

-
Request Body schema:
optional

The ShoppingListEntryIdentifiers schema encoded in XML or JSON format.

-
required
object (ShoppingListEntryIdentifiers)

This class represents a list of shopping list entry identifiers to add to cart

-

Responses

Request samples

Content type
{
  • "ShoppingListEntryIdentifiers": {
    }
}

Response samples

Content type
{
  • "Cart": {
    }
}

Add Shopping List to Default Cart CommerceLTS Update

Adds all entries from the given Shopping List to the default Cart (creates a new Cart if not found).

-
path Parameters
identifier
required
string

The Shopping List identifier

-
header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

-

Responses

Response samples

Content type
{
  • "Cart": {
    }
}

Add Shopping List to Specific Cart CommerceLTS Update

Adds all entries from the given Shopping List to the specified Cart.

-
path Parameters
identifier
required
string

The Shopping List identifier

-
cartIdentifier
required
string

The Cart identifier

-
header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

-

Responses

Response samples

Content type
{
  • "Cart": {
    }
}

Clear shopping list CommerceLTS Update

Removes all entries from a shopping list while keeping the list itself.

-
path Parameters
identifier
required
string

The unique identifier (UUID) of the shopping list.

-
header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

-

Responses

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Add entries to shopping list CommerceLTS Update

Adds one or more product entries to an existing shopping list.

-
path Parameters
identifier
required
string

The unique identifier (UUID) of the shopping list.

-
header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

-
Request Body schema:
optional

Entries to add to the shopping list

-
required
object (ShoppingListEntriesAdd)

Adds one or more product entries to an existing shopping list.

-

Responses

Request samples

Content type
{
  • "ShoppingListEntriesAdd": {
    }
}

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Remove entries from shopping list CommerceLTS Update

Removes one or more product entries from an existing shopping list by their identifiers.

-
path Parameters
identifier
required
string

The unique identifier (UUID) of the shopping list.

-
header Parameters
X-CSRF-Token
required
string

CSRF Token is needed to execute this unsafe request.

-
Request Body schema:
optional

Entries to remove from shopping list

-
required
object (ShoppingListEntriesRemove)

Removes one or more entries from a shopping list by their identifiers.

-

Responses

Request samples

Content type
{
  • "ShoppingListEntriesRemove": {
    }
}

Response samples

Content type
{
  • "ShoppingList": {
    }
}

Orders

Cancel order Commerce

Cancels the given order.

-
path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

-

Responses

Load order by identifier Commerce

Loads an order by its identifier (UUID).

-
path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "Order": {
    }
}

Load order by ID Commerce

Loads an order by its numerical ID.

-
path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "Order": {
    }
}

Update order Commerce

Updates an order.

-
path Parameters
id
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

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

The OrderUpdate schema encoded in XML or JSON format.

-
required
object (OrderUpdate)

This class is used to update order.

-

Responses

Request samples

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

Response samples

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

Load orders Commerce

Loads a list of orders.

-

Responses

Response samples

Content type
{
  • "OrderList": {
    }
}

Create order Commerce

Creates a new order.

-
header Parameters
X-CSRF-Token
required
string

The CSRF token.

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

The Order schema encoded in XML or JSON format.

-
required
object (OrderCreate)

This class is used to create order.

-

Responses

Request samples

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

Response samples

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

Payments

Create payment method Commerce

Creates a PaymentMethodCreateController resource.

-
header Parameters
X-CSRF-Token
required
string

The CSRF token.

-
Request Body schema:
optional

The Payment Method input schema encoded in XML or JSON.

-
required
object (PaymentMethodCreateStruct)

Responses

Request samples

Content type
{
  • "PaymentMethodCreateStruct": {
    }
}

Response samples

Content type
{
  • "PaymentMethod": {
    }
}

List payment methods Commerce

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

-
header Parameters
X-CSRF-Token
required
string

The CSRF token.

-
Request Body schema:
optional

The view input in XML or JSON format.

-
required
object (PaymentMethodViewInput)

Responses

Request samples

Content type
{
  • "PaymentMethodViewInput": {
    }
}

Response samples

Content type
{
  • "PaymentMethodView": {
    }
}

Load payment method by identifier Commerce

Loads an payment method by its identifier.

-
path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "PaymentMethod": {
    }
}

Delete payment method Commerce

Removes the PaymentMethodDeleteController resource.

-
path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

-

Responses

Update payment method Commerce

Updates the PaymentMethodUpdateController resource.

-
path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

-
Request Body schema:
optional

The Payment Method input schema encoded in XML or JSON.

-
required
object (PaymentMethodUpdateStruct)

Responses

Request samples

Content type
{
  • "PaymentMethodUpdateStructParser": {
    }
}

Response samples

Content type
{
  • "PaymentMethod": {
    }
}

Load payment method by id Commerce

Loads an payment method by its id.

-
path Parameters
id
required
string

Responses

Response samples

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

Shipping

Create shipment Commerce

Creates a shipment.

-
path Parameters
orderIdentifier
required
string

The order's identifier to create a shipment for.

-
header Parameters
X-CSRF-Token
required
string

The CSRF token.

-
Request Body schema:
optional

The shipment to create.

-
required
object (ShipmentCreate)

This class represents the creation of a shipment.

-

Responses

Request samples

Content type
{
  • "ShipmentCreate": {
    }
}

Response samples

Content type
{
  • "Shipment": {
    }
}

Load shipments Commerce

Loads a list of shipments.

-

Responses

Response samples

Content type
{
  • "ShipmentRefList": {
    }
}

Load a single shipment based on its identifier Commerce

Loads a single shipment based on its identifier.

-
path Parameters
identifier
required
string

The shipment identifier.

-

Responses

Response samples

Content type
{
  • "Shipment": {
    }
}

Delete shipment Commerce

Deletes a shipment.

-
path Parameters
identifier
required
string
header Parameters
X-CSRF-Token
required
string

The CSRF token.

-

Responses

Update shipment Commerce

Updates a shipment.

-
path Parameters
identifier
required
string

The shipment identifier.

-
header Parameters
X-CSRF-Token
required
string

The CSRF token.

-
Request Body schema:
optional

The ShipmentUpdate schema encoded in XML or JSON format.

-
required
object (ShipmentUpdate)

This class represents the update of a shipment.

-

Responses

Request samples

Content type
{
  • "ShipmentUpdate": {
    }
}

Response samples

Content type
{
  • "Shipment": {
    }
}

Load shipping methods types Commerce

Loads shipping methods types.

-

Responses

Response samples

Content type
{
  • "ShippingMethodTypesList": {
    }
}

Load shipping method type based on its identifier Commerce

Loads shipping methods type based on their identifiers.

-
path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "ShippingMethodType": {
    }
}

Load shipping methods Commerce

Loads shipping methods.

-

Responses

Response samples

Content type
{
  • "ShippingMethodRefList": {
    }
}

Load shipping method based on its identifier Commerce

Loads shipping method based on its identifier.

-
path Parameters
identifier
required
string

Responses

Response samples

Content type
{
  • "ShippingMethod": {
    }
}

Collaboration Sessions

Create collaboration session

Creates a new collaboration session with participants and returns the session details.

-
Request Body schema:
optional

Session creation payload

-
required
object

Responses

Request samples

Content type
{
  • "ExampleSessionCreate": {
    }
}

Response samples

Content type
{
  • "CollaborationSession": {
    }
}

Get collaboration session

Retrieves a collaboration session by its token.

-
path Parameters
sessionToken
required
string

The session token to retrieve.

-

Responses

Response samples

Content type
{
  • "CollaborationSession": {
    }
}

Delete collaboration session

Deletes a collaboration session and removes all associated data.

-
path Parameters
sessionToken
required
string

The session token to delete.

-

Responses

Update collaboration session

Updates collaboration session properties.

-
path Parameters
sessionToken
required
string

The session token to update.

-
Request Body schema:
optional

Session update payload

-
required
object

Responses

Request samples

Content type
{
  • "ExampleSessionUpdate": {
    }
}

Response samples

Content type
{
  • "CollaborationSession": {
    }
}

Create invitation in collaboration session

Creates an invitation for a participant to join a collaboration session.

-
path Parameters
sessionToken
required
string

The session token.

-
Request Body schema:
optional

Invitation creation payload

-
required
object

Responses

Request samples

Content type
{
  • "InvitationCreate": {
    }
}

Response samples

Content type
{
  • "Invitation": {
    }
}

List collaboration session participants

Retrieves a list of all participants in a collaboration session.

-
path Parameters
sessionToken
required
string

The session token.

-

Responses

Response samples

Content type
{
  • "ParticipantList": {
    }
}

Add participants to collaboration session

Adds new participants to an existing collaboration session.

-
path Parameters
sessionToken
required
string

The session token.

-
Request Body schema:
optional

Participant list creation payload

-
required
object

Responses

Request samples

Content type
{
  • "ParticipantListCreate": {
    }
}

Response samples

Content type
{
  • "ParticipantList": {
    }
}

Remove participant from collaboration session

Removes a participant from a collaboration session.

-
path Parameters
sessionToken
required
string

The session token.

-
participantId
required
integer

The participant ID to remove.

-

Responses

Update participant in collaboration session

Updates properties of a participant in a collaboration session.

-
path Parameters
sessionToken
required
string

The session token.

-
participantId
required
integer

The participant ID to update.

-
Request Body schema:
optional

Participant update payload

-
required
object

Responses

Request samples

Content type
{
  • "ExternalParticipantUpdate": {
    }
}

Response samples

Content type
{
  • "Participant": {
    }
}

Connector AI

Get action types list.

Returns action types list.

-

Responses

Response samples

Content type
{
  • "ActionTypeList": {
    }
}

Get an action type by its unique identifier.

Returns an action type by its unique string identifier.

-
path Parameters
identifier
required
string
Example: generate_alt_text

Responses

Response samples

Content type
{
  • "ActionType": {
    }
}

Get action configuration list.

Returns action configuration list.

-

Responses

Response samples

Content type
{
  • "ActionConfigurationList": {
    }
}

Query action configuration list.

Returns action configuration list based on the given query.

-
header Parameters
X-CSRF-Token
required
string

CSRF token obtained during the authentication.

-
Request Body schema:
optional

Query action configuration search criteria

-
query
string
action_type_identifier
string
enabled
boolean
limit
integer
page
integer

Responses

Request samples

Content type
{
  • "ActionConfigurationListInput": {
    }
}

Response samples

Content type
{
  • "ActionConfigurationList": {
    }
}

Execute the given AI action

Executes the given AI Action using configured ActionConfiguration or ActionHandler, if passed. Might consume AI agent resources.

-
path Parameters
actionConfigurationIdentifier
required
string
Examples:
  • rewrite_with_friendly_tone -
  • rewrite_with_professional_tone -
  • summarize_text -
  • expand_text -
  • shorten_text -
  • proofread -
  • improve_readability -
  • gen_alt_text -

Configured action name (obtain by listing the configured actions via GET /api/ibexa/v2/ai/actions endpoint).

-
header Parameters
X-CSRF-Token
required
string

CSRF token obtained during the authentication.

-
Request Body schema:
optional

Input to execute the action. An Input type must match the action type.

-
required
object
required
object (RuntimeContext)

Responses

Request samples

Content type
{
  • "GenerateAltText": {
    }
}

Response samples

Content type
{
  • "AltText": {
    }
}

Get an action configuration by its unique identifier.

Returns an action configuration by its unique string identifier.

-
path Parameters
identifier
required
string
Example: rewrite_with_friendly_tone

Responses

Response samples

Content type
{
  • "ActionConfiguration": {
    }
}

Discounts

Get discounts Commerce

Returns a list of all defined discounts

-
query Parameters
offset
integer
limit
integer
Example: limit=25

Responses

Response samples

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

Create a discount Commerce

Creates a new discount

-
header Parameters
X-CSRF-Token
required
string

CSRF token obtained during the authentication.

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

The DiscountCreate schema

-
identifier
required
string non-empty
type
required
string
Enum: "cart" "catalog"
priority
required
integer [ 1 .. 10 ]
isEnabled
required
boolean
userId
required
integer
required
object
Array of objects
startDate
string <date-time>
endDate
string <date-time>
createdAt
string <date-time>
updatedAt
string <date-time>
required
Array of objects non-empty
object

Responses

Request samples

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

Response samples

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

Get a discount item by its unique identifier. Commerce

Returns a discount item by its unique string identifier.

-
path Parameters
identifier
required
string
Example: my_discount_identifier

Responses

Response samples

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

Delete a discount item Commerce

Deletes an existing discount item by its unique identifier

-
path Parameters
identifier
required
string
Example: my_discount_identifier
header Parameters
X-CSRF-Token
required
string

CSRF token obtained during the authentication.

-

Responses

Update a discount Commerce

Updates a new discount

-
path Parameters
identifier
required
string
Example: my_discount_identifier
header Parameters
X-CSRF-Token
required
string

CSRF token obtained during the authentication.

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

The DiscountUpdate schema

-
identifier
required
string non-empty
priority
integer [ 1 .. 10 ]
isEnabled
boolean
userId
integer
lastContributorId
integer
object
Array of objects
startDate
string <date-time>
endDate
string <date-time>
createdAt
string <date-time>
updatedAt
string <date-time>
Array of objects non-empty
object

Responses

Request samples

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

Response samples

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

Disables a discount Commerce

Disables a discount item by its unique identifier

-
path Parameters
identifier
required
string
Example: my_discount_identifier
header Parameters
X-CSRF-Token
required
string

CSRF token obtained during the authentication.

-

Responses

Enables a discount Commerce

Enables a discount item by its unique identifier

-
path Parameters
identifier
required
string
Example: my_discount_identifier
header Parameters
X-CSRF-Token
required
string

CSRF token obtained during the authentication.

-

Responses

Get a discount item Commerce

Returns a discount item by its ID.

-
path Parameters
id
required
integer
Example: 1

Responses

Response samples

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

Apply discount code Commerce

Apply a discount code on a cart given by its identifier.

-
path Parameters
cartIdentifier
required
string
header Parameters
X-CSRF-Token
required
string
Request Body schema: application/vnd.ibexa.api.DiscountCode+json
optional

The discount code to apply

-
required
object (DiscountCode)

Responses

Request samples

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

Response samples

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

Drop discount code Commerce

Unapply a discount code from a cart given by its identifier.

-
path Parameters
cartIdentifier
required
string
header Parameters
X-CSRF-Token
required
string
Request Body schema: application/vnd.ibexa.api.DiscountCode+json
optional

The discount code to drop

-
required
object (DiscountCode)

Responses

Request samples

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

User Session

Resource 'User Session' operations.

+

Create session (login a User)

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

+
header Parameters
Accept
required
string

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

+
Content-Type
required
string

The SessionInput schema encoded in XML or JSON format.

+
Cookie
required
string

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

+
X-CSRF-Token
required
string

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

+
Request Body schema:
optional

The new SessionCreateController resource

+
required
object (SessionInput)

This class represents a session input.

+

Responses

Request samples

Content type
{
  • "SessionInput": {
    }
}

Response samples

Content type
{
  • "Session": {
    }
}

Get current session

Get current user session, if any.

+
header Parameters
Cookie
required
string

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

+
Accept
required
string

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

+

Responses

Response samples

Content type
{
  • "Session": {
    }
}

Delete session (logout a User)

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

+
path Parameters
sessionId
required
string

SessionDeleteController identifier

+
header Parameters
Cookie
required
string

{sessionName}={sessionID}

+
X-CSRF-Token
required
string

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

+

Responses

Refresh session (deprecated)

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

+
path Parameters
sessionId
required
string

SessionRefreshController identifier

+
header Parameters
Cookie
required
string

{sessionName}={sessionID}

+
X-CSRF-Token
required
string

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

+
Accept
required
string

Responses

Response samples

Content type
{
  • "Session": {
    }
}

Bookmark

Resource 'Bookmark' operations.

+

List of bookmarks

Lists bookmarked Locations for the current user.

+

Responses

Response samples

Content type
{
  • "BookmarkList": {
    }
}

Check if Location is bookmarked

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

+
path Parameters
locationId
required
integer

BookmarkIsBookmarkedController identifier

+

Responses

Create bookmark

Add given Location to bookmarks of the current user.

+
path Parameters
locationId
required
string

BookmarkCreateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Delete bookmark

Deletes the given Location from bookmarks of the current user.

+
path Parameters
locationId
required
string

BookmarkDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+

Responses

Check if Location is bookmarked

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

+
path Parameters
locationId
required
integer

BookmarkIsBookmarkedController identifier

+

Responses

User Token

Resource 'User Token' operations.

+

Create JWT token

Creates JWT authentication token.

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

The credentials in JWTInput JSON format.

+
required
object (JWTInput)

This class represents the input for a JWT authentication token

+

Responses

Request samples

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

Response samples

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

Calendar

Resource 'Calendar' operations.

+

Calendar list

Calendar event list.

+
query Parameters
start
required
integer (UnixTimestamp)

timestamp (seconds since the Unix Epoch).

+
end
required
integer (UnixTimestamp)

timestamp.

+
count
integer

Maximum number of events returned (10 by default).

+
types
Array of strings
Example: types=future_publication,future_hide,page_block_reveal,page_block_hide

Comma-separated list of type identifiers.

+
languages
Array of strings
Example: languages=eng-GB,fre-FR

comma-separated list of language codes.

+
cursor
string
Example: cursor=MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy

Pagination cursor. It's the representation of the event to start the page afterward, as the concatenation of the timestamp, the event type, and the event identifier with a colon separator ("::"), encoded in base64. For example "1778264040:future_hide:future_hide:2" ("future_hide:2" is the ID) encoded as "MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy"

+

Responses

Response samples

Content type
{
  • "EventList": {
    }
}

Calendar list grouped by day

Calendar event list grouped by day.

+
query Parameters
start
required
integer (UnixTimestamp)

timestamp (seconds since the Unix Epoch).

+
end
required
integer (UnixTimestamp)

timestamp.

+
count
integer

Maximum number of events returned (10 by default).

+
types
Array of strings
Example: types=future_publication,future_hide,page_block_reveal,page_block_hide

Comma-separated list of type identifiers.

+
languages
Array of strings
Example: languages=eng-GB,fre-FR

comma-separated list of language codes.

+
cursor
string
Example: cursor=MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy

Pagination cursor. It's the representation of the event to start the page afterward, as the concatenation of the timestamp, the event type, and the event identifier with a colon separator ("::"), encoded in base64. For example "1778264040:future_hide:future_hide:2" ("future_hide:2" is the ID) encoded as "MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy"

+

Responses

Response samples

Content type
{
  • "EventGroupList": {
    }
}

Calendar action

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

+
path Parameters
eventType
required
string
Enum: "future_publication" "future_hide"

The type of event to execute an action on.

+
Request Body schema:
required

Data for the calendar action to execute

+
required
object (RescheduleAction)

This class represents events to reschedule

+

Responses

Request samples

Content type
{
  • "RescheduleAction": {
    }
}

Product Attribute

Resource 'Product Attribute' operations.

+

Load attributes (deprecated)

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

+
Request Body schema:
optional

Attribute filter

+
required
object (AttributeListGet)

This class represents an attribute list query

+

Responses

Request samples

Content type
{
  • "AttributeListGet": {
    }
}

Response samples

Content type
{
  • "AttributeList": {
    }
}

Create attribute

Creates a new attribute.

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The attribute schema encoded in XML or JSON format.

+
required
object (AttributeCreate)

This class is used to create an attribute.

+

Responses

Request samples

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

Response samples

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

Delete attribute translation

The given translation is removed from the attribute.

+
path Parameters
id
required
string

AttributeTranslationDeleteController identifier

+
languageCode
required
string

AttributeTranslationDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+

Responses

Filter attributes

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

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+
Request Body schema:
optional

The view input in XML or JSON format.

+
required
object (AttributeViewInput)

This class represents an attribute view input.

+

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "AttributeView": {
    }
}

Load attribute

Loads given attribute.

+
path Parameters
id
required
string

AttributeLoadByIdentifierController identifier

+

Responses

Response samples

Content type
{
  • "Attribute": {
    }
}

Delete attribute

The given attribute is removed from the attribute group.

+
path Parameters
id
required
string

AttributeDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+

Responses

Update attribute

Updates an attribute.

+
path Parameters
id
required
string

AttributeUpdateController identifier

+
group_id
required
string

AttributeUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

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

+
required
object (AttributeUpdate)

This class is used to update an attribute.

+

Responses

Request samples

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

Response samples

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

Product Attribute Type

Resource 'Product Attribute Type' operations.

+

List Attribute Types

Lists all Attribute Types.

+

Responses

Response samples

Content type
{
  • "AttributeTypeList": {
    }
}

Get Attribute Type

Gets an Attribute Type by its identifier.

+
path Parameters
identifier
required
string

AttributeTypeLoadByIdentifierController identifier

+

Responses

Response samples

Content type
{
  • "AttributeType": {
    }
}

Product Attribute Group

Resource 'Product Attribute Group' operations.

+

Load attribute groups (deprecated)

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

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

The AttributeGroupListGet schema encoded in XML or JSON format.

+
required
object (AttributeGroupListGet)

This class represents an attribute group list request.

+

Responses

Request samples

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

Response samples

Content type
{
  • "AttributeGroupList": {
    }
}

Create attribute group

Creates a new attribute group.

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The AttributeGroup schema encoded in XML or JSON format.

+
required
object (AttributeGroupCreate)

This class is used to create an attribute group.

+

Responses

Request samples

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

Response samples

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

Delete attribute group translation

Deletes given translation from attribute group.

+
path Parameters
id
required
string

AttributeGroupTranslationDeleteController identifier

+
languageCode
required
string

AttributeGroupTranslationDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+

Responses

Filter attribute groups

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

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+
Request Body schema:
optional

The view input in XML or JSON format.

+
required
object (AttributeGroupViewInput)

This class represents an attribute group view input.

+

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "AttributeGroupView": {
    }
}

Load attribute group

Returns the given attribute group.

+
path Parameters
id
required
string

AttributeGroupLoadByIdentifierController identifier

+
Request Body schema:
optional

An optional AttributeGroupGet schema encoded in XML or JSON format.

+
required
object (AttributeGroupGet)

This class represents an attribute group query.

+

Responses

Request samples

Content type
{
  • "AttributeGroupGet": {
    }
}

Response samples

Content type
{
  • "AttributeGroup": {
    }
}

Delete attribute group

Deletes an attribute group.

+
path Parameters
id
required
string

AttributeGroupDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+

Responses

Update attribute group

Updates an attribute group.

+
path Parameters
id
required
string

AttributeGroupUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+
Request Body schema:
optional

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

+
required
object (AttributeGroupUpdate)

This class is used to update an attribute group.

+

Responses

Request samples

Content type
{
  • "AttributeGroupUpdate": {
    }
}

Response samples

Content type
{
  • "AttributeGroup": {
    }
}

Product Catalog

Resource 'Product Catalog' operations.

+

Create catalog

Creates a new catalog.

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The catalog schema encoded in XML or JSON format.

+
required
object (CatalogCreate)

This class is used to create a catalog.

+

Responses

Request samples

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

Response samples

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

Copy catalog

Copies a catalog.

+
path Parameters
identifier
required
string

CatalogCopyController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

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

+
required
object (CatalogCopy)

This class is used to copy a catalog.

+

Responses

Request samples

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

Response samples

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

Load catalog filters

Loads product filters available for catalogs.

+

Responses

Response samples

Content type
{
  • "ProductFilterList": {
    }
}

Load catalog sort clauses

Loads product sort clauses available for catalogs.

+

Responses

Response samples

Content type
{
  • "ProductSortClauseList": {
    }
}

Filter catalogs

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

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+
Request Body schema:
optional

The view input in XML or JSON format.

+
required
object (CatalogViewInput)

This class represents a catalog view input.

+

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "CatalogView": {
    }
}

Load catalog

Loads the given catalog.

+
path Parameters
identifier
required
string

CatalogLoadByIdentifierController identifier

+

Responses

Response samples

Content type
{
  • "Catalog": {
    }
}

Delete catalog

Deletes the given catalog.

+
path Parameters
identifier
required
string

CatalogDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+

Responses

Update catalog

Updates a catalog.

+
path Parameters
identifier
required
string

CatalogUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

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

+
required
object (CatalogUpdate)

This class is used to update a catalog.

+

Responses

Request samples

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

Response samples

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

Filter catalog products

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

+
path Parameters
identifier
required
string

CatalogProductsViewController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+
Request Body schema:
optional

The view input in XML or JSON format.

+
required
object (ProductViewInput)

This class represents a product view input.

+

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "ProductView": {
    }
}

Product Currency

Resource 'Product Currency' operations.

+

Load currencies

Loads the list of currencies.

+

Responses

Response samples

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

Create currency

Creates a new currency.

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The Currency schema encoded in XML or JSON format.

+
required
object (CurrencyCreate)

This class is used to create currency.

+

Responses

Request samples

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

Response samples

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

Filter currencies

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

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+
Request Body schema:
optional

The view input in XML or JSON format.

+
required
object (CurrencyViewInput)

This class represents a currency view input.

+

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "CurrencyView": {
    }
}

Load currency

Loads a currency.

+
path Parameters
id
required
string

CurrencyLoadByIdController identifier

+

Responses

Response samples

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

Delete currency

Deletes the given currency.

+
path Parameters
id
required
string

CurrencyDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+

Responses

Update currency

Updates a currency.

+
path Parameters
id
required
string

CurrencyUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The CurrencyUpdate schema encoded in XML or JSON format.

+
required
object (CurrencyUpdate)

This class is used to update currency.

+

Responses

Request samples

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

Response samples

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

Product Customer Group

Resource 'Product Customer Group' operations.

+

Load customer groups

Returns a list of customer groups

+

Responses

Response samples

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

Create customer group

Creates a new customer group.

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The CustomerGroupCreate schema encoded in XML or JSON format.

+
required
object (CustomerGroupCreate)

This class is used to create a customer group.

+

Responses

Request samples

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

Response samples

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

Filter customer groups

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

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+
Request Body schema:
optional

The view input in XML or JSON format.

+
required
object (CustomerGroupViewInput)

This class represents a customer group view input.

+

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "CustomerGroupView": {
    }
}

Load customer group

Returns a customer group

+
path Parameters
identifier
required
string

CustomerGroupLoadByIdentifierController identifier

+

Responses

Response samples

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

Delete customer group

Deletes the given customer group.

+
path Parameters
identifier
required
string

CustomerGroupDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+

Responses

Update customer group

Updates the given customer group.

+
path Parameters
identifier
required
string

CustomerGroupUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The CustomerGroupUpdate schema encoded in XML or JSON format.

+
required
object (CustomerGroupUpdate)

This class is used to update a customer group.

+

Responses

Request samples

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

Response samples

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

Load customer group

Returns a customer group

+
path Parameters
id
required
integer

CustomerGroupLoadByIdController identifier

+

Responses

Response samples

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

Product

Resource 'Product' operations.

+

Load products list (deprecated)

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

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

The product list schema encoded in XML or JSON format.

+
required
object (ProductListGet)

This class represents a product list GET.

+

Responses

Request samples

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

Response samples

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

Filter products

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

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+
Request Body schema:
optional

The view input in XML or JSON format.

+
required
object (ProductViewInput)

This class represents a product view input.

+

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "ProductView": {
    }
}

Load the given product

Loads the given product.

+
path Parameters
code
required
string

ProductLoadByCodeController identifier

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

An optional product schema encoded in XML or JSON format.

+
required
object (ProductGet)

This class represents a product GET.

+

Responses

Request samples

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

Response samples

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

Update product

Updates product.

+
path Parameters
code
required
string

ProductUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

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

+
required
object (ProductUpdate)

This class is used to update a product.

+

Responses

Request samples

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

Response samples

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

Load the list of product prices

Loads the list of product prices.

+
path Parameters
code
required
string

PriceLoadAllController identifier

+

Responses

Response samples

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

Create product price or custom price

Create product price or custom price.

+
path Parameters
code
required
string

PriceCreateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+
Request Body schema:
optional

The product price schema encoded in JSON format.

+
required
object (CustomPriceCreateStruct)

This class represents a custom price creation structure.

+

Responses

Request samples

Content type
{
  • "CustomPriceCreateStruct": {
    }
}

Response samples

Content type
{
  • "CustomPrice": {
    }
}

Get price in given currency

Get price in given currency.

+
path Parameters
code
required
string

PriceLoadByProductCodeController identifier

+
currencyCode
required
string

PriceLoadByProductCodeController identifier

+

Responses

Response samples

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

Get price in given currency and customer group

Get price in given currency and customer group.

+
path Parameters
code
required
string

PriceLoadByProductCodeController identifier

+
currencyCode
required
string

PriceLoadByProductCodeController identifier

+
customerGroupIdentifier
required
string

PriceLoadByProductCodeController identifier

+

Responses

Response samples

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

Delete product price

Deletes product price.

+
path Parameters
code
required
string

PriceDeleteController identifier

+
id
required
string

PriceDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+

Responses

Update product price

Updates product price.

+
path Parameters
code
required
string

PriceUpdateController identifier

+
id
required
string

PriceUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+
Request Body schema:
optional

Update price or custom price for given currency.

+
required
object (CustomPriceUpdateStruct)

This class represents a custom price updating structure.

+

Responses

Request samples

Content type
{
  • "CustomPriceUpdateStruct": {
    }
}

Response samples

Content type
{
  • "CustomPrice": {
    }
}

Delete product

Deletes the given product.

+
path Parameters
identifier
required
string

ProductDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+

Responses

Create product

Creates a new product.

+
path Parameters
productTypeIdentifier
required
string

ProductCreateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The product schema encoded in XML or JSON format.

+
required
object (ProductCreate)

This class is used to create a product.

+

Responses

Request samples

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

Response samples

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

Product Type

Resource 'Product Type' operations.

+

Load product types (deprecated)

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

+
Request Body schema:
optional

The ProductTypeList schema encoded in XML or JSON format.

+
required
object (ProductTypeListGet)

This class represents a product type list query.

+

Responses

Request samples

Content type
{
  • "ProductTypeListGet": {
    }
}

Response samples

Content type
{
  • "ProductTypeList": {
    }
}

Create product type

Creates a new product type.

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The ProductType schema encoded in XML or JSON format.

+
required
object (ProductTypeCreate)

This class is used to create a product type.

+

Responses

Request samples

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

Response samples

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

Check product type usage

Checks whether the product type is in use.

+
path Parameters
identifier
required
string

ProductTypeIsUsedController identifier

+

Responses

Response samples

Content type
{
  • "ProductTypeUsage": {
    }
}

Filter product types

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

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+
Request Body schema:
optional

The view input in XML or JSON format.

+
required
object (ProductTypeViewInput)

This class represents a product type view input.

+

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "ProductTypeView": {
    }
}

Load product type

Returns the given product type.

+
path Parameters
identifier
required
string

ProductTypeLoadByIdentifierController identifier

+

Responses

Response samples

Content type
{
  • "ProductType": {
    }
}

Delete product type

Deletes the given product type.

+
path Parameters
id
required
string

ProductTypeDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+

Responses

Update product type

Updates product type.

+
path Parameters
id
required
string

ProductTypeUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

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

+
required
object (ProductTypeUpdate)

This class is used to update a product type.

+

Responses

Request samples

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

Response samples

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

Product Variant

Resource 'Product Variant' operations.

+

Load product variant

Loads the given product variant.

+
path Parameters
code
required
string

ProductVariantLoadByCodeController identifier

+

Responses

Response samples

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

Generate product variants

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

+
path Parameters
baseProductCode
required
string

ProductVariantGenereateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The product variant schema encoded in XML or JSON format.

+
required
object (ProductVariantGenerate)

This class is used to generate a product variant.

+

Responses

Request samples

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

Filter product variants

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

+
path Parameters
baseProductCode
required
string

ProductVariantViewController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+
Request Body schema:
optional

The view input in XML or JSON format.

+
required
object (ProductVariantViewInput)

This class represents a product variant view input.

+

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "ProductVariantView": {
    }
}

Create product variant

Creates a new product variant.

+
path Parameters
baseProductCode
required
string

ProductVariantCreateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

The product variant schema encoded in XML or JSON format.

+
required
object (ProductVariantCreate)

This class is used to create a product variant.

+

Responses

Request samples

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

Delete product variant

Deletes the given product variant.

+
path Parameters
code
required
string

ProductVariantDeleteController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+

Responses

Update product variant

Updates product variant.

+
path Parameters
code
required
string

ProductVariantUpdateController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

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

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

+
required
object (ProductVariantUpdate)

This class is used to update a product variant.

+

Responses

Request samples

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

Response samples

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

Product Region

Resource 'Product Region' operations.

+

Load regions

Loads the list of regions.

+

Responses

Response samples

Content type
{
  • "RegionList": {
    }
}

Filter regions

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

+
header Parameters
X-CSRF-Token
required
string

The CSRF token is required when passing user session.

+
Request Body schema:
optional

The view input in XML or JSON format.

+
required
object (RegionViewInput)

This class represents a region view input.

+

Responses

Request samples

Content type
{
  • "ViewInput": {
    }
}

Response samples

Content type
{
  • "RegionView": {
    }
}

Load region

Loads a region by its identifier

+
path Parameters
identifier
required
string

RegionLoadByIdentifierController identifier

+

Responses

Response samples

Content type
{
  • "Region": {
    }
}

Product Vat

Resource 'Product Vat' operations.

+

Load VAT region

Loads a VAT category for the given region.

+
path Parameters
region
required
string

VatCategoriesListController identifier

+

Responses

Response samples

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

Load VAT specific region

Loads a VAT category for the given identifier.

+
path Parameters
region
required
string

VatCategoryLoadByIdentifierController identifier

+
identifier
required
string

VatCategoryLoadByIdentifierController identifier

+

Responses

Response samples

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

Taxonomy

Resource 'Taxonomy' operations.

+

Delete Entries

Bulk removes several taxonomy entries.

+
path Parameters
taxonomyName
required
string

TaxonomyEntryBulkRemoveController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token.

+
Request Body schema:
optional

TaxonomyEntryBulkRemove schema encoded in XML or JSON format.

+
required
object (TaxonomyEntryBulkRemove)

This class is used to bulk remove taxonomy entries.

+

Responses

Request samples

Content type
{
  • "TaxonomyEntryBulkRemove": {
    }
}

Move Entries

Bulk move several taxonomy entries relative to sibling.

+
path Parameters
taxonomyName
required
string

TaxonomyEntryBulkMoveController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token.

+
Request Body schema:
optional

The TaxonomyEntryBulkMove schema encoded in XML or JSON format.

+
required
object (TaxonomyEntryBulkMove)

This class is used to bulk move taxonomy entries.

+

Responses

Request samples

Content type
{
  • "TaxonomyEntryBulkMove": {
    }
}

Get Assignment by ID

Gets taxonomy entry Assignment by its ID.

+
path Parameters
taxonomyName
required
string

TaxonomyEntryAssignmentLoadByIdController identifier

+
id
required
string

TaxonomyEntryAssignmentLoadByIdController identifier

+

Responses

Response samples

Content type
{
  • "TaxonomyEntryAssignment": {
    }
}

Assign entry

Assigns taxonomy entry to a content item.

+
path Parameters
taxonomyName
required
string

TaxonomyEntryAssignmentAssignController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token.

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

TaxonomyEntryAssignToContent schema encoded in JSON format.

+
required
object (TaxonomyEntryAssignToContent)

This class is used to assign taxonomy entry to content.

+

Responses

Request samples

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

Get Assignments to a Content

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

+
path Parameters
taxonomyName
required
string

TaxonomyEntryAssignmentLoadController identifier

+
contentId
required
string

TaxonomyEntryAssignmentLoadController identifier

+

Responses

Response samples

Content type
{
  • "EntryAssignmentCollection": {
    }
}

Unassign entry

Unassigns taxonomy entry from a content item.

+
path Parameters
taxonomyName
required
string

TaxonomyEntryAssignmentUnassignController identifier

+
header Parameters
X-CSRF-Token
required
string

The CSRF token.

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

TaxonomyEntryUnassignFromContent schema encoded in JSON format.

+
required
object (TaxonomyEntryUnassignFromContent)

This class is used to unassign taxonomy entry from content.

+

Responses

Request samples

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

Get Entry by Content ID

Loads taxonomy Entry by its Content ID.

+
path Parameters
taxonomyName
required
string

TaxonomyEntryLoadByContentIdController identifier

+
contentId
required
string

TaxonomyEntryLoadByContentIdController identifier

+

Responses

Response samples

Content type
{
  • "TaxonomyEntry": {
    }
}

Get Entry by identifier

Loads taxonomy Entry by its Entry identifier.

+
path Parameters
taxonomyName
required
string

TaxonomyEntryLoadByIdentifierController identifier

+
identifier
required
string

TaxonomyEntryLoadByIdentifierController identifier

+

Responses

Response samples

Content type
{
  • "TaxonomyEntry": {
    }
}

Get Entry by ID

Loads taxonomy Entry by its Entry ID.

+
path Parameters
taxonomyName
required
string

TaxonomyEntryLoadByIdController identifier

+
id
required
string

TaxonomyEntryLoadByIdController identifier

+

Responses

Response samples

Content type
{
  • "TaxonomyEntry": {
    }
}

Page

Resource 'Page' operations.

+

Page structure

Lists the layouts and blocks available for building Pages, with the zones of every layout and the views and attributes of every block.

+
query Parameters
contentTypeIdentifier
string
Example: contentTypeIdentifier=landing_page

Identifier of a content type holding a Page. When given, only the layouts and blocks allowed for that content type are returned. When omitted or empty, the whole catalogue is returned.

+

Responses

Response samples

Content type
{
  • "PageStructure": {
    }
}

Segmentation

Resource 'Segmentation' operations.

+

List segment groups

Lists segment groups.

+

Responses

Response samples

Content type
{
  • "SegmentGroupList": {
    }
}

Load segment group

Loads segment group.

+
path Parameters
identifier
required
string

SegmentGroupViewController identifier

+

Responses

Response samples

Content type
{
  • "SegmentGroup": {
    }
}

List segment group's segments

Lists segment group's segments.

+
path Parameters
identifier
required
string

SegmentListController identifier

+

Responses

Response samples

Content type
{
  • "SegmentList": {
    }
}

Load segment

Loads the identified segment.

+
path Parameters
identifier
required
string

SegmentViewController identifier

+

Responses

Response samples

Content type
{
  • "Segment": {
    }
}

Activity Log

Resource 'Activity Log' operations.

+

List of activity log groups

Lists last activity log groups and their entries.

+

Responses

Response samples

Content type
{
  • "ActivityLogGroupList": {
    }
}

List of activity log groups

Lists last activity log groups and their entries.

+
header Parameters
X-CSRF-Token
required
string

The CSRF Token needed on all unsafe HTTP methods with session.

+
Request Body schema:
optional

The query to filter activity log groups.

+
required
object (ActivityLogGroupListInput)

This class represents the activity log group search query's criteria and sort clauses.

+

Responses

Request samples

Content type
{
  • "ActivityLogGroupListInput": {
    }
}

Response samples

Content type
{
  • "ActivityLogGroupList": {
    }
}

Connector AI

Resource 'Connector AI' operations.

+

Get action types list.

Returns action types list.

+

Responses

Response samples

Content type
{
  • "ActionTypeList": {
    }
}

Get an action type by its unique identifier.

Returns an action type by its unique string identifier.

+
path Parameters
identifier
required
string
Example: generate_alt_text

ActionTypeLoadByIdentifierController identifier

+

Responses

Response samples

Content type
{
  • "ActionType": {
    }
}

Get action configuration list.

Returns action configuration list.

+

Responses

Response samples

Content type
{
  • "ActionConfigurationList": {
    }
}

Query action configuration list.

Returns action configuration list based on the given query.

+
header Parameters
X-CSRF-Token
required
string

CSRF token obtained during the authentication.

+
Request Body schema:
optional

Query action configuration search criteria

+
query
string
action_type_identifier
string
enabled
boolean
limit
integer
page
integer

Responses

Request samples

Content type
{
  • "ActionConfigurationListInput": {
    }
}

Response samples

Content type
{
  • "ActionConfigurationList": {
    }
}

Execute the given AI action

Executes the given AI Action using configured ActionConfiguration or ActionHandler, if passed. Might consume AI agent resources.

+
path Parameters
actionConfigurationIdentifier
required
string
Examples:
  • rewrite_with_friendly_tone -
  • rewrite_with_professional_tone -
  • summarize_text -
  • expand_text -
  • shorten_text -
  • proofread -
  • improve_readability -
  • gen_alt_text -

Configured action name (obtain by listing the configured actions via GET /api/ibexa/v2/ai/actions endpoint).

+
header Parameters
X-CSRF-Token
required
string

CSRF token obtained during the authentication.

+
Request Body schema:
optional

Input to execute the action. An Input type must match the action type.

+
required
object
required
object (RuntimeContext)

Responses

Request samples

Content type
{
  • "GenerateAltText": {
    }
}

Response samples

Content type
{
  • "AltText": {
    }
}

Get an action configuration by its unique identifier.

Returns an action configuration by its unique string identifier.

+
path Parameters
identifier
required
string
Example: rewrite_with_friendly_tone

ActionConfigurationLoadByIdentifierController identifier

+

Responses

Response samples

Content type
{
  • "ActionConfiguration": {
    }
}

Collaboration Sessions

Resource 'Collaboration Sessions' operations.

+

Create collaboration session

Creates a new collaboration session with participants and returns the session details.

+
Request Body schema:
optional

Session creation payload

+
required
object

Responses

Request samples

Content type
{
  • "ExampleSessionCreate": {
    }
}

Response samples

Content type
{
  • "CollaborationSession": {
    }
}

Get collaboration session

Retrieves a collaboration session by its token.

+
path Parameters
sessionToken
required
string

The session token to retrieve.

+

Responses

Response samples

Content type
{
  • "CollaborationSession": {
    }
}

Delete collaboration session

Deletes a collaboration session and removes all associated data.

+
path Parameters
sessionToken
required
string

The session token to delete.

+

Responses

Update collaboration session

Updates collaboration session properties.

+
path Parameters
sessionToken
required
string

The session token to update.

+
Request Body schema:
optional

Session update payload

+
required
object

Responses

Request samples

Content type
{
  • "ExampleSessionUpdate": {
    }
}

Response samples

Content type
{
  • "CollaborationSession": {
    }
}

Create invitation in collaboration session

Creates an invitation for a participant to join a collaboration session.

+
path Parameters
sessionToken
required
string

The session token.

+
Request Body schema:
optional

Invitation creation payload

+
required
object

Responses

Request samples

Content type
{
  • "InvitationCreate": {
    }
}

Response samples

Content type
{
  • "Invitation": {
    }
}

List collaboration session participants

Retrieves a list of all participants in a collaboration session.

+
path Parameters
sessionToken
required
string

The session token.

+

Responses

Response samples

Content type
{
  • "ParticipantList": {
    }
}

Add participants to collaboration session

Adds new participants to an existing collaboration session.

+
path Parameters
sessionToken
required
string

The session token.

+
Request Body schema:
optional

Participant list creation payload

+
required
object

Responses

Request samples

Content type
{
  • "ParticipantListCreate": {
    }
}

Response samples

Content type
{
  • "ParticipantList": {
    }
}

Remove participant from collaboration session

Removes a participant from a collaboration session.

+
path Parameters
sessionToken
required
string

The session token.

+
participantId
required
integer

The participant ID to remove.

+

Responses

Update participant in collaboration session

Updates properties of a participant in a collaboration session.

+
path Parameters
sessionToken
required
string

The session token.

+
participantId
required
integer

The participant ID to update.

+
Request Body schema:
optional

Participant update payload

+
required
object

Responses

Request samples

Content type
{
  • "ExternalParticipantUpdate": {
    }
}

Response samples

Content type
{
  • "Participant": {
    }
}