diff --git a/docs/api/rest_api/rest_api_reference/openapi.json b/docs/api/rest_api/rest_api_reference/openapi.json index 8cbd5d4ce6..ec2168b1d9 100644 --- a/docs/api/rest_api/rest_api_reference/openapi.json +++ b/docs/api/rest_api/rest_api_reference/openapi.json @@ -2,7 +2,7 @@ "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", "description": "", @@ -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}": { @@ -557,7 +530,14 @@ ], "responses": { "200": { - "description": "OK - the given Location is bookmarked." + "description": "OK - the given Location is bookmarked.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BookmarkIsBookmarkedController" + } + } + } }, "401": { "description": "Error - the user is not authorized for the given Location." @@ -572,19 +552,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 +591,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 +641,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 +683,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 +739,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 +751,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 +763,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 +775,6 @@ "description": "Comma-separated list of type identifiers.", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "array", "items": { @@ -826,7 +783,6 @@ }, "style": "form", "explode": false, - "allowReserved": false, "example": [ "future_publication", "future_hide", @@ -840,7 +796,6 @@ "description": "comma-separated list of language codes.", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "array", "items": { @@ -849,7 +804,6 @@ }, "style": "form", "explode": false, - "allowReserved": false, "example": [ "eng-GB", "fre-FR" @@ -861,17 +815,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 +1077,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 +1089,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 +1101,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 +1113,6 @@ "description": "Comma-separated list of type identifiers.", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "array", "items": { @@ -1177,7 +1121,6 @@ }, "style": "form", "explode": false, - "allowReserved": false, "example": [ "future_publication", "future_hide", @@ -1191,7 +1134,6 @@ "description": "comma-separated list of language codes.", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "array", "items": { @@ -1200,7 +1142,6 @@ }, "style": "form", "explode": false, - "allowReserved": false, "example": [ "eng-GB", "fre-FR" @@ -1212,17 +1153,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 +1183,6 @@ "description": "The type of event to execute an action on.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string", "enum": [ @@ -1254,8 +1191,7 @@ ] }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { @@ -1298,3693 +1234,3575 @@ } }, "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" - } - } + "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.CartEntryAdd+xml": { + "application/vnd.ibexa.api.InvitationCreate+xml": { "schema": { - "$ref": "#/components/schemas/CartEntryAdd" - } + "$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" + }, + "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 } }, - "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" - } + "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." - } - }, - "summary": "Get collaboration session", - "description": "Retrieves a collaboration session by its token.", - "parameters": [ - { - "name": "sessionToken", - "in": "path", - "description": "The session token to retrieve.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "delete": { - "operationId": "api_collaborationsessions_sessionToken_delete", - "tags": [ - "Collaboration Sessions" - ], - "responses": { - "204": { - "description": "Session deleted" - }, - "404": { - "description": "Error - the session does not exist." - }, - "401": { - "description": "Error - the user is not authorized to delete this session." + "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": "Delete collaboration session", - "description": "Deletes a collaboration session and removes all associated data.", + "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 delete.", + "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 - }, - "patch": { - "operationId": "api_collaborationsessions_sessionToken_patch", - "tags": [ - "Collaboration Sessions" - ], - "responses": { - "200": { - "description": "Updated session", - "content": { - "application/vnd.ibexa.api.ExampleSession+json": { - "schema": { - "$ref": "#/components/schemas/ExampleSessionWrapper" - }, - "example": { - "CollaborationSession": { - "_media-type": "application/vnd.ibexa.api.ExampleSession+json", - "createdAt": "2023-11-15T10:30:00+00:00", - "id": 123, - "token": "abc123def456ghi789", - "updatedAt": "2023-11-15T14:45:00+00:00", - "ParticipantList": { - "_media-type": "application/vnd.ibexa.api.ParticipantList+json", - "Participants": [ - { - "User": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "_media-type": "application/vnd.ibexa.api.InternalParticipant+json", - "createdAt": "2023-11-15T10:30:00+00:00", - "id": 1, - "name": "John Doe", - "scope": "edit", - "updatedAt": "2023-11-15T10:30:00+00:00" - }, - { - "_media-type": "application/vnd.ibexa.api.ExternalParticipant+json", - "createdAt": "2023-11-15T11:00:00+00:00", - "email": "guest@example.com", - "id": 2, - "name": "guest@example.com", - "scope": "view", - "updatedAt": "2023-11-15T11:00:00+00:00" - } - ] - }, - "Owner": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "subject": "Project Collaboration Session", - "isActive": true, - "hasPublicLink": false - } - } + "examples": { + "rewrite_with_friendly_tone": { + "value": "rewrite_with_friendly_tone" }, - "application/vnd.ibexa.api.ExampleSession+xml": { - "schema": { - "$ref": "#/components/schemas/ExampleSessionWrapper" - }, - "example": "\n\n 123\n abc123def456ghi789\n 2023-11-15T10:30:00+00:00\n 2023-11-15T14:45:00+00:00\n \n \n 1\n John Doe\n edit\n \n 2023-11-15T10:30:00+00:00\n 2023-11-15T10:30:00+00:00\n \n \n 2\n guest@example.com\n view\n guest@example.com\n 2023-11-15T11:00:00+00:00\n 2023-11-15T11:00:00+00:00\n \n \n \n Project Collaboration Session\n true\n false\n\n\n" + "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" } } }, - "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.", + "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 } ], "requestBody": { - "description": "Session update payload", + "description": "Input to execute the action. An Input type must match the action type.", "content": { - "application/vnd.ibexa.api.ExampleSessionUpdate+json": { + "application/vnd.ibexa.api.ai.GenerateAltText+json": { "schema": { - "$ref": "#/components/schemas/ExampleSessionUpdate" + "$ref": "#/components/schemas/GenerateAltText" }, "example": { - "ExampleSessionUpdate": { - "hasPublicLink": true + "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.ExampleSessionUpdate+xml": { + "application/vnd.ibexa.api.ai.GenerateAltText+xml": { "schema": { - "$ref": "#/components/schemas/ExampleSessionUpdate" + "$ref": "#/components/schemas/GenerateAltText" }, - "example": "\n\n true\n\n\n" + "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 + } } }, - "/collaboration/sessions/{sessionToken}/invitations": { - "post": { - "operationId": "api_collaborationsessions_sessionTokeninvitations_post", + "/ai/actions/{identifier}": { + "get": { + "operationId": "ibexa.rest.ai.action", "tags": [ - "Collaboration Sessions" + "Connector AI" ], "responses": { - "201": { - "description": "Invitation created", + "200": { + "description": "Action configuration in JSON or XML", "content": { - "application/vnd.ibexa.api.Invitation+json": { + "application/vnd.ibexa.api.ai.ActionConfiguration+json": { "schema": { - "$ref": "#/components/schemas/InvitationWrapper" + "$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.Invitation+xml": { + "application/vnd.ibexa.api.ai.ActionConfiguration+xml": { "schema": { - "$ref": "#/components/schemas/InvitationWrapper" - } + "$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" } } }, - "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 create invitations for this session." + "description": "Error \u2013 the user doesn't have access to the given action configuration" } }, - "summary": "Create invitation in collaboration session", - "description": "Creates an invitation for a participant to join a collaboration session.", + "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.", + "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": "Invitation creation payload", - "content": { - "application/vnd.ibexa.api.InvitationCreate+json": { - "schema": { - "$ref": "#/components/schemas/InvitationCreate" - }, - "example": { - "InvitationCreate": { - "email": "external.user@example.com", - "Sender": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "context": { - "single_value": "value", - "simple_array": [ - "test", - "value1", - "value2", - "value3", - "value4", - "value5" - ], - "extended_array": { - "foo": "foo_value", - "bar": "bar_value", - "baz": "baz_value" - } - } - } - } - }, - "application/vnd.ibexa.api.InvitationCreate+xml": { - "schema": { - "$ref": "#/components/schemas/InvitationCreate" - }, - "example": "\n\n \n \n anonymous@link.invalid\n \n \n test\n value1\n value2\n value3\n value4\n value5\n \n value\n \n bar_value\n baz_value\n foo_value\n \n \n\n\n" - } - }, - "required": false - }, - "deprecated": false - } - }, - "/collaboration/sessions/{sessionToken}/participants": { - "get": { - "operationId": "api_collaborationsessions_sessionTokenparticipants_get", - "tags": [ - "Collaboration Sessions" + ] + } + }, + "/corporate": { + "get": { + "operationId": "ibexa.rest.corporate_account.root", + "tags": [ + "Corporate Account" ], "responses": { "200": { - "description": "Participants list", + "description": "List of Link objects to specific Corporate Account REST resources", "content": { - "application/vnd.ibexa.api.ParticipantList+json": { + "application/vnd.ibexa.api.CorporateAccountRoot+json": { "schema": { - "$ref": "#/components/schemas/ParticipantListWrapper" + "$ref": "#/components/schemas/CorporateAccountRootWrapper" }, "example": { - "ParticipantList": { - "Participants": [ + "CorporateAccountRoot": { + "_media-type": "application/vnd.ibexa.api.CorporateAccountRoot+json", + "links": [ { - "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.CompaniesList+json", + "_rel": "ca-companies", + "_href": "/api/ibexa/v2/corporate/companies" }, { - "_media-type": "application/vnd.ibexa.api.ExternalParticipant+json", - "createdAt": "2023-11-15T11:00:00+00:00", - "email": "guest@example.com", - "id": 2, - "name": "guest@example.com", - "scope": "view", - "updatedAt": "2023-11-15T11:00:00+00:00" - } - ], - "_media-type": "application/vnd.ibexa.api.ParticipantList+json" - } - } - }, - "application/vnd.ibexa.api.ParticipantList+xml": { - "schema": { - "$ref": "#/components/schemas/ParticipantListWrapper" - }, - "example": "\n\n \n 1\n John Doe\n edit\n \n 2023-11-15T10:30:00+00:00\n 2023-11-15T10:30:00+00:00\n \n \n 2\n guest@example.com\n view\n guest@example.com\n 2023-11-15T11:00:00+00:00\n 2023-11-15T11:00:00+00:00\n \n\n\n" - } - } - }, - "404": { - "description": "Error - the session does not exist." - }, - "401": { - "description": "Error - the user is not authorized to access this session." - } - }, - "summary": "List collaboration session participants", - "description": "Retrieves a list of all participants in a collaboration session.", - "parameters": [ - { - "name": "sessionToken", - "in": "path", - "description": "The session token.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "post": { - "operationId": "api_collaborationsessions_sessionTokenparticipants_post", - "tags": [ - "Collaboration Sessions" - ], - "responses": { - "200": { - "description": "Participants list", - "content": { - "application/vnd.ibexa.api.ParticipantList+json": { - "schema": { - "$ref": "#/components/schemas/ParticipantListWrapper" - }, - "example": { - "ParticipantList": { - "Participants": [ + "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json", + "_rel": "ca-types", + "_href": "/api/ibexa/v2/content/typegroups?identifier=corporate_account" + }, { - "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.ContentType+json", + "_rel": "ca-types-company", + "_href": "/api/ibexa/v2/content/types/48" }, { - "_media-type": "application/vnd.ibexa.api.ExternalParticipant+json", - "createdAt": "2023-11-15T11:00:00+00:00", - "email": "guest@example.com", - "id": 2, - "name": "guest@example.com", - "scope": "view", - "updatedAt": "2023-11-15T11:00:00+00:00" - } - ], - "_media-type": "application/vnd.ibexa.api.ParticipantList+json" - } - } - }, - "application/vnd.ibexa.api.ParticipantList+xml": { - "schema": { - "$ref": "#/components/schemas/ParticipantListWrapper" - }, - "example": "\n\n \n 1\n John Doe\n edit\n \n 2023-11-15T10:30:00+00:00\n 2023-11-15T10:30:00+00:00\n \n \n 2\n guest@example.com\n view\n guest@example.com\n 2023-11-15T11:00:00+00:00\n 2023-11-15T11:00:00+00:00\n \n\n\n" - } - } - }, - "400": { - "description": "Error - the input does not match the input schema definition." - }, - "404": { - "description": "Error - the session does not exist." - }, - "401": { - "description": "Error - the user is not authorized to modify this session." - } - }, - "summary": "Add participants to collaboration session", - "description": "Adds new participants to an existing collaboration session.", - "parameters": [ - { - "name": "sessionToken", - "in": "path", - "description": "The session token.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "Participant list creation payload", - "content": { - "application/vnd.ibexa.api.ParticipantListCreate+json": { - "schema": { - "$ref": "#/components/schemas/ParticipantListCreate" - }, - "example": { - "ParticipantListCreate": { - "ParticipantCreate": [ - { - "_media-type": "application/vnd.ibexa.api.InternalParticipantCreate+json", - "User": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_rel": "ca-types-member", + "_href": "/api/ibexa/v2/content/types/47" }, - "scope": "view" - }, - { - "_media-type": "application/vnd.ibexa.api.ExternalParticipantCreate+json", - "email": "user@link.invalid", - "scope": "view" - } - ] - } - } - }, - "application/vnd.ibexa.api.ParticipantListCreate+xml": { - "schema": { - "$ref": "#/components/schemas/ParticipantListCreate" - }, - "example": "\n\n \n view\n \n \n \n \n user@link.invalid\n view\n \n\n\n" - } - }, - "required": false - }, - "deprecated": false - } - }, - "/collaboration/sessions/{sessionToken}/participants/{participantId}": { - "delete": { - "operationId": "api_collaborationsessions_sessionTokenparticipants_participantId_delete", - "tags": [ - "Collaboration Sessions" - ], - "responses": { - "204": { - "description": "Participant removed" - }, - "404": { - "description": "Error - the session or participant does not exist." - }, - "401": { - "description": "Error - the user is not authorized to modify this session." - } - }, - "summary": "Remove participant from collaboration session", - "description": "Removes a participant from a collaboration session.", - "parameters": [ - { - "name": "sessionToken", - "in": "path", - "description": "The session token.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "participantId", - "in": "path", - "description": "The participant ID to remove.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "integer" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false - }, - "patch": { - "operationId": "api_collaborationsessions_sessionTokenparticipants_participantId_patch", - "tags": [ - "Collaboration Sessions" - ], - "responses": { - "200": { - "description": "Updated participant", - "content": { - "application/vnd.ibexa.api.ExternalParticipant+json": { - "schema": { - "$ref": "#/components/schemas/ExternalParticipantWrapper" - } - }, - "application/vnd.ibexa.api.ExternalParticipant+xml": { - "schema": { - "$ref": "#/components/schemas/ExternalParticipantWrapper" - } - }, - "application/vnd.ibexa.api.InternalParticipant+json": { - "schema": { - "$ref": "#/components/schemas/InternalParticipantWrapper" - } - }, - "application/vnd.ibexa.api.InternalParticipant+xml": { - "schema": { - "$ref": "#/components/schemas/InternalParticipantWrapper" - } - } - } - }, - "400": { - "description": "Error - the input does not match the input schema definition." - }, - "404": { - "description": "Error - the session or participant does not exist." - }, - "401": { - "description": "Error - the user is not authorized to modify this session." - } - }, - "summary": "Update participant in collaboration session", - "description": "Updates properties of a participant in a collaboration session.", - "parameters": [ - { - "name": "sessionToken", - "in": "path", - "description": "The session token.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "participantId", - "in": "path", - "description": "The participant ID to update.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "integer" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "Participant update payload", - "content": { - "application/vnd.ibexa.api.ExternalParticipantUpdate+json": { - "schema": { - "$ref": "#/components/schemas/ExternalParticipantUpdate" - }, - "example": { - "ExternalParticipantUpdate": { - "scope": "view" - } - } - }, - "application/vnd.ibexa.api.ExternalParticipantUpdate+xml": { - "schema": { - "$ref": "#/components/schemas/ExternalParticipantUpdate" - }, - "example": "\n\n view\n\n\n" - }, - "application/vnd.ibexa.api.InternalParticipantUpdate+json": { - "schema": { - "$ref": "#/components/schemas/InternalParticipantUpdate" - }, - "example": { - "InternalParticipantUpdate": { - "scope": "view" - } - } - }, - "application/vnd.ibexa.api.InternalParticipantUpdate+xml": { - "schema": { - "$ref": "#/components/schemas/InternalParticipantUpdate" - }, - "example": "\n\n view\n\n\n" - } - }, - "required": false - }, - "deprecated": false - } - }, - "/ai/action-types": { - "get": { - "operationId": "ibexa.rest.ai.action_type.list", - "tags": [ - "Connector AI" - ], - "responses": { - "200": { - "description": "Action type list", - "content": { - "application/vnd.ibexa.api.ai.ActionTypeList+json": { - "schema": { - "$ref": "#/components/schemas/ActionTypeList" - }, - "example": { - "ActionTypeList": { - "_media-type": "application/vnd.ibexa.api.ai.ActionTypeList+json", - "_href": "/api/ibexa/v2/ai/action-types", - "ActionType": [ { - "_media-type": "application/vnd.ibexa.api.ai.ActionType+json", - "identifier": "generate_alt_text", - "name": "Generate alternative text", - "inputIdentifier": "image", - "outputIdentifier": "text", - "options": { - "width": 512, - "height": 512, - "image_quality": 85 - } + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_rel": "ca-types-address", + "_href": "/api/ibexa/v2/content/types/49" }, { - "_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.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.ai.ActionTypeList+xml": { - "schema": { - "$ref": "#/components/schemas/ActionTypeList" - }, - "example": "\n\n \n generate_alt_text\n Generate alternative text\n image\n text\n \n 512\n 512\n 85\n \n \n \n refine_text\n Refine text\n text\n text\n \n \n\n" - } - } - } - }, - "summary": "Get action types list.", - "description": "Returns action types list.", - "parameters": [], - "deprecated": false - } - }, - "/ai/action-types/{identifier}": { - "get": { - "operationId": "ibexa.rest.ai.action_type", - "tags": [ - "Connector AI" - ], - "responses": { - "200": { - "description": "Action type", - "content": { - "application/vnd.ibexa.api.ai.ActionType+json": { - "schema": { - "$ref": "#/components/schemas/ActionType" - }, - "example": { - "ActionType": { - "_media-type": "application/vnd.ibexa.api.ai.ActionType+json", - "identifier": "generate_alt_text", - "name": "Generate alternative text", - "inputIdentifier": "image", - "outputIdentifier": "text", - "options": { - "width": 512, - "height": 512, - "image_quality": 85 - } - } - } - }, - "application/vnd.ibexa.api.ai.ActionType+xml": { + "application/vnd.ibexa.api.CorporateAccountRoot+xml": { "schema": { - "$ref": "#/components/schemas/ActionType" + "$ref": "#/components/schemas/CorporateAccountRoot" }, - "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 \n \n \n \n \n\n" } } - }, - "406": { - "description": "Error - an action type of the given unique identifier is not found." } }, - "summary": "Get an action type by its unique identifier.", - "description": "Returns an action type by its unique string identifier.", - "parameters": [ - { - "name": "identifier", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false, - "example": "generate_alt_text" - } - ], - "deprecated": false + "summary": "Root Resource", + "description": "Provides basic information about Corporate Account endpoints and configuration.", + "parameters": [] } }, - "/ai/actions": { + "/corporate/companies": { "get": { - "operationId": "ibexa.rest.ai.action.list.get", + "operationId": "ibexa.rest.corporate_account.companies.list", "tags": [ - "Connector AI" + "Corporate Account" ], "responses": { "200": { - "description": "Action configuration list is returned in JSON or XML", + "description": "Company list containing Company objects.", "content": { - "application/vnd.ibexa.api.ai.ActionConfigurationList+json": { + "application/vnd.ibexa.api.CompanyList+json": { "schema": { - "$ref": "#/components/schemas/ActionConfigurationList" + "$ref": "#/components/schemas/CompanyListWrapper" }, "example": { - "ActionConfigurationList": { - "_media-type": "application/vnd.ibexa.api.ai.ActionConfigurationList+json", - "_href": "/api/ibexa/v2/ai/actions", - "ActionConfiguration": [ + "CompanyList": { + "_media-type": "application/vnd.ibexa.api.CompanyList+json", + "companies": [ { - "_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": [] + "_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" + } }, - "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" + "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" + } }, - "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": [] + "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" }, - "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" + "Location": { + "_media-type": "application/vnd.ibexa.api.Location+json", + "_href": "/api/ibexa/v2/content/locations/1/65/67" }, - "createdAt": "2025-08-07T13:16:47+02:00", - "updatedAt": "2025-08-07T13:16:47+02:00" + "locationPath": "/1/65/67/", + "isActive": true }, { - "_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" + "_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" + } }, - "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": [] + "billingAddress": { + "name": null, + "country": null, + "fields": [] }, - "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 + "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" }, - "actionHandlerIdentifier": "openai-image-to-text", - "actionHandlerOptions": { - "max_tokens": 4000, - "temperature": 1, - "prompt": "", - "model": "gpt-4-turbo" + "Location": { + "_media-type": "application/vnd.ibexa.api.Location+json", + "_href": "/api/ibexa/v2/content/locations/1/65/76" }, - "createdAt": "2025-08-07T13:16:47+02:00", - "updatedAt": "2025-08-07T13:16:47+02:00" + "locationPath": "/1/65/76/", + "isActive": true } ] } } }, - "application/vnd.ibexa.api.ai.ActionConfigurationList+xml": { + "application/vnd.ibexa.api.CompanyList+xml": { "schema": { - "$ref": "#/components/schemas/ActionConfigurationList" + "$ref": "#/components/schemas/CompanyList" }, - "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 66\n Ibexa AS\n \n \n Ibexa AS\n Ibexa AS\n \n \n \n \n 593\n 1\n PUBLISHED\n 2023-04-03T13:09:40+02:00\n \n 2023-04-03T13:09:40+02:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Ibexa AS\n \n \n \n \n \n 295\n active\n eng-GB\n ibexa_boolean\n true\n \n \n 296\n name\n eng-GB\n ibexa_string\n Ibexa AS\n \n \n 297\n vat\n eng-GB\n ibexa_string\n 123 456 789\n \n \n 298\n website\n eng-GB\n ibexa_string\n https://ibexa.co\n \n \n 299\n customer_group\n eng-GB\n ibexa_customer_group\n \n 1\n \n \n \n 300\n sales_rep\n eng-GB\n ibexa_object_relation\n \n 14\n /api/ibexa/v2/content/objects/14\n \n \n \n 301\n contact\n eng-GB\n ibexa_object_relation\n \n 74\n /api/ibexa/v2/content/objects/74\n \n \n \n 302\n default_address\n eng-GB\n ibexa_object_relation\n \n 69\n /api/ibexa/v2/content/objects/69\n \n \n \n 303\n billing_address\n eng-GB\n ibexa_address\n \n HQ\n PL\n \n Silesia\n Katowice\n Gliwicka 6/5\n 40-079\n company@email.invalid\n +48 000 000 000\n \n \n \n \n 305\n members\n eng-GB\n ibexa_object_relation\n \n 67\n /api/ibexa/v2/content/objects/67\n \n \n \n 304\n address_book\n eng-GB\n ibexa_object_relation\n \n 68\n /api/ibexa/v2/content/objects/68\n \n \n \n \n \n /placeholder\n \n \n image/svg+xml\n \n \n \n
\n \n \n \n 2023-04-03T13:09:40+02:00\n 2023-03-31T14:33:36+02:00\n eng-GB\n 1\n true\n false\n PUBLISHED\n \n \n HQ, Poland\n 74\n 14\n 69\n 68\n 67\n \n \n /1/65/67/\n 1\n \n \n 75\n QNTM Group AB\n \n \n QNTM Group AB\n QNTM Group AB\n \n \n \n \n 546\n 3\n PUBLISHED\n 2023-03-31T15:24:49+02:00\n \n 2023-03-31T15:24:49+02:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n QNTM Group AB\n \n \n \n \n \n 341\n active\n eng-GB\n ibexa_boolean\n true\n \n \n 342\n name\n eng-GB\n ibexa_string\n QNTM Group AB\n \n \n 343\n vat\n eng-GB\n ibexa_string\n 123 456 789\n \n \n 344\n website\n eng-GB\n ibexa_string\n https://ibexa.co\n \n \n 345\n customer_group\n eng-GB\n ibexa_customer_group\n \n 1\n \n \n \n 346\n sales_rep\n eng-GB\n ibexa_object_relation\n \n 14\n /api/ibexa/v2/content/objects/14\n \n \n \n 347\n contact\n eng-GB\n ibexa_object_relation\n \n \n \n \n \n 348\n default_address\n eng-GB\n ibexa_object_relation\n \n \n \n \n \n 349\n billing_address\n eng-GB\n ibexa_address\n \n \n \n \n \n \n \n 351\n members\n eng-GB\n ibexa_object_relation\n \n 76\n /api/ibexa/v2/content/objects/76\n \n \n \n 350\n address_book\n eng-GB\n ibexa_object_relation\n \n 77\n /api/ibexa/v2/content/objects/77\n \n \n \n \n \n /placeholder\n \n \n image/svg+xml\n \n \n \n
\n \n \n \n 2023-03-31T15:24:49+02:00\n 2023-03-31T15:24:48+02:00\n eng-GB\n 3\n true\n false\n PUBLISHED\n \n \n \n \n 14\n \n 77\n 76\n \n \n /1/65/76/\n 1\n \n\n" + } + } + }, + "400": { + "description": "Returned when invalid Criterion or Sort clause is used", + "content": { + "application/vnd.ibexa.api.ErrorMessage": { + "schema": { + "$ref": "#/components/schemas/ErrorMessage" + } } } } }, - "summary": "Get action configuration list.", - "description": "Returns action configuration list.", - "parameters": [], - "deprecated": false + "summary": "Read list of companies", + "description": "Returns paginated list of available companies.", + "parameters": [] }, "post": { - "operationId": "ibexa.rest.ai.action.list.post", + "operationId": "ibexa.rest.corporate_account.companies.create", "tags": [ - "Connector AI" + "Corporate Account" ], "responses": { - "200": { - "description": "Action configuration list is returned in JSON or XML", + "201": { + "description": "If set, the new company is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ai.ActionConfigurationList+json": { + "application/vnd.ibexa.api.Company+json": { "schema": { - "$ref": "#/components/schemas/ActionConfigurationList" + "$ref": "#/components/schemas/CompanyWrapper" }, "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" + "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" }, - { - "_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" + "Name": "Ibexa AS", + "TranslatedName": "Ibexa AS", + "Versions": { + "_media-type": "application/vnd.ibexa.api.VersionList+json", + "_href": "/api/ibexa/v2/content/objects/66/versions" + }, + "CurrentVersion": { + "_media-type": "application/vnd.ibexa.api.Version+json", + "_href": "/api/ibexa/v2/content/objects/66/currentversion", + "Version": { + "_media-type": "application/vnd.ibexa.api.Version+json", + "_href": "/api/ibexa/v2/content/objects/66/versions/1", + "VersionInfo": { + "id": 593, + "versionNo": 1, + "status": "PUBLISHED", + "modificationDate": "2023-04-03T13:09:40+02:00", + "Creator": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "creationDate": "2023-04-03T13:09:40+02:00", + "initialLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "VersionTranslationInfo": { + "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", + "Language": [ + { + "languageCode": "eng-GB" + } + ] + }, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Ibexa AS" + } + ] + }, + "Content": { + "_media-type": "application/vnd.ibexa.api.ContentInfo+json", + "_href": "/api/ibexa/v2/content/objects/66" + } + }, + "Fields": { + "field": [ + { + "id": 295, + "fieldDefinitionIdentifier": "active", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_boolean", + "fieldValue": true + }, + { + "id": 296, + "fieldDefinitionIdentifier": "name", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_string", + "fieldValue": "Ibexa AS" + }, + { + "id": 297, + "fieldDefinitionIdentifier": "vat", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_string", + "fieldValue": "123 456 789" + }, + { + "id": 298, + "fieldDefinitionIdentifier": "website", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_string", + "fieldValue": "https://ibexa.co" + }, + { + "id": 299, + "fieldDefinitionIdentifier": "customer_group", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_customer_group", + "fieldValue": { + "customer_group_id": 1 + } + }, + { + "id": 300, + "fieldDefinitionIdentifier": "sales_rep", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_object_relation", + "fieldValue": { + "destinationContentId": 14, + "destinationContentHref": "/api/ibexa/v2/content/objects/14" + } + }, + { + "id": 301, + "fieldDefinitionIdentifier": "contact", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_object_relation", + "fieldValue": { + "destinationContentId": 74, + "destinationContentHref": "/api/ibexa/v2/content/objects/74" + } + }, + { + "id": 302, + "fieldDefinitionIdentifier": "default_address", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_object_relation", + "fieldValue": { + "destinationContentId": 69, + "destinationContentHref": "/api/ibexa/v2/content/objects/69" + } + }, + { + "id": 303, + "fieldDefinitionIdentifier": "billing_address", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_address", + "fieldValue": { + "name": "Headquarters", + "country": "NO", + "fields": { + "region": "Company HQ location region", + "locality": "Company HQ location city", + "street": "Company HQ location street and building", + "postal_code": "00000", + "email": "company@email.invalid", + "phone_number": "+47 000 000 000" + } + } + }, + { + "id": 305, + "fieldDefinitionIdentifier": "members", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_object_relation", + "fieldValue": { + "destinationContentId": 67, + "destinationContentHref": "/api/ibexa/v2/content/objects/67" + } + }, + { + "id": 304, + "fieldDefinitionIdentifier": "address_book", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_object_relation", + "fieldValue": { + "destinationContentId": 68, + "destinationContentHref": "/api/ibexa/v2/content/objects/68" + } + } + ] + }, + "Relations": { + "_media-type": "application/vnd.ibexa.api.RelationList+json", + "_href": "/api/ibexa/v2/content/objects/66/versions/1/relations", + "Relation": [] + }, + "Thumbnail": { + "_media-type": "application/vnd.ibexa.api.Thumbnail+json", + "resource": "/placeholder", + "width": null, + "height": null, + "mimeType": "image/svg+xml" + } + } + }, + "Section": { + "_media-type": "application/vnd.ibexa.api.Section+json", + "_href": "/api/ibexa/v2/content/sections/10" + }, + "MainLocation": { + "_media-type": "application/vnd.ibexa.api.Location+json", + "_href": "/api/ibexa/v2/content/locations/1/65/67" + }, + "Locations": { + "_media-type": "application/vnd.ibexa.api.LocationList+json", + "_href": "/api/ibexa/v2/content/objects/66/locations" + }, + "Owner": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "lastModificationDate": "2023-04-03T13:09:40+02:00", + "publishedDate": "2023-03-31T14:33:36+02:00", + "mainLanguageCode": "eng-GB", + "currentVersionNo": 1, + "alwaysAvailable": true, + "isHidden": false, + "status": "PUBLISHED", + "ObjectStates": { + "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", + "_href": "/api/ibexa/v2/content/objects/66/objectstates" } - ] + }, + "billingAddress": { + "name": "Headquarters", + "country": "NO", + "fields": { + "region": "Company HQ location region", + "locality": "Company HQ location city", + "street": "Company HQ location street and building", + "postal_code": "00000", + "email": "company@email.invalid", + "phone_number": "+47 000 000 000" + } + }, + "contactId": 74, + "salesRepresentativeId": 80, + "defaultAddressId": 69, + "addressBookId": 68, + "membersId": 67, + "MemberList": { + "_media-type": "application/vnd.ibexa.api.MemberList+json", + "_href": "/api/ibexa/v2/corporate/companies/66/members" + }, + "Location": { + "_media-type": "application/vnd.ibexa.api.Location+json", + "_href": "/api/ibexa/v2/content/locations/1/65/67" + }, + "locationPath": "/1/65/67/", + "isActive": true } } }, - "application/vnd.ibexa.api.ai.ActionConfigurationList+xml": { + "application/vnd.ibexa.api.Company+xml": { "schema": { - "$ref": "#/components/schemas/ActionConfigurationList" + "$ref": "#/components/schemas/Company" }, - "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 66\n Ibexa AS\n \n \n Ibexa AS\n Ibexa AS\n \n \n \n \n 593\n 1\n PUBLISHED\n 2023-04-03T13:09:40+02:00\n \n 2023-04-03T13:09:40+02:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Ibexa AS\n \n \n \n \n \n 295\n active\n eng-GB\n ibexa_boolean\n true\n \n \n 296\n name\n eng-GB\n ibexa_string\n Ibexa AS\n \n \n 297\n vat\n eng-GB\n ibexa_string\n 123 456 789\n \n \n 298\n website\n eng-GB\n ibexa_string\n https://ibexa.co\n \n \n 299\n customer_group\n eng-GB\n ibexa_customer_group\n \n 1\n \n \n \n 300\n sales_rep\n eng-GB\n ibexa_object_relation\n \n 14\n /api/ibexa/v2/content/objects/14\n \n \n \n 301\n contact\n eng-GB\n ibexa_object_relation\n \n 74\n /api/ibexa/v2/content/objects/74\n \n \n \n 302\n default_address\n eng-GB\n ibexa_object_relation\n \n 69\n /api/ibexa/v2/content/objects/69\n \n \n \n 303\n billing_address\n eng-GB\n ibexa_address\n \n HQ\n PL\n \n Silesia\n Katowice\n Gliwicka 6/5\n 40-079\n company@email.invalid\n +48 000 000 000\n \n \n \n \n 305\n members\n eng-GB\n ibexa_object_relation\n \n 67\n /api/ibexa/v2/content/objects/67\n \n \n \n 304\n address_book\n eng-GB\n ibexa_object_relation\n \n 68\n /api/ibexa/v2/content/objects/68\n \n \n \n \n \n /placeholder\n \n \n image/svg+xml\n \n \n \n
\n \n \n \n 2023-04-03T13:09:40+02:00\n 2023-03-31T14:33:36+02:00\n eng-GB\n 1\n true\n false\n PUBLISHED\n \n \n HQ, Poland\n 74\n 80\n 69\n 68\n 67\n \n \n /1/65/67/\n 1\n\n" } } + }, + "400": { + "description": "Error - the input does not match the input schema definition." + }, + "401": { + "description": "Error - the user is not authorized to create this Company." } }, - "summary": "Query action configuration list.", - "description": "Returns action configuration list based on the given query.", + "summary": "Create a company", + "description": "Creates a CompanyCreateController resource.", "parameters": [ { "name": "X-CSRF-Token", "in": "header", - "description": "CSRF token obtained during the authentication.", + "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 + "explode": false } ], "requestBody": { - "description": "Query action configuration search criteria", + "description": "The CompanyCreate schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ai.ActionConfigurationListInput+json": { + "application/vnd.ibexa.api.CompanyCreate+json": { "schema": { - "$ref": "#/components/schemas/ActionConfigurationListInput" + "$ref": "#/components/schemas/CompanyCreateWrapper" }, "example": { - "ActionConfigurationListInput": { - "query": "Rewrite", - "action_type_identifier": "refine_text", - "enabled": true, - "limit": 25, - "page": 1 - } - } - }, - "application/vnd.ibexa.api.ai.ActionConfigurationListInput+xml": { - "schema": { - "$ref": "#/components/schemas/ActionConfigurationListInput" - }, - "example": "\n\n Rewrite\n refine_text\n 1\n 25\n 1\n\n" - } - }, - "required": false - }, - "deprecated": false - } - }, - "/ai/actions/{actionConfigurationIdentifier}/execute": { - "post": { - "operationId": "ibexa.rest.ai.actions.execute", - "tags": [ - "Connector AI" - ], - "responses": { - "200": { - "description": "Reworked text or generated alternative text", - "content": { - "application/vnd.ibexa.api.ai.AltText+json": { - "schema": { - "$ref": "#/components/schemas/AltText" - }, - "example": { - "AltText": { - "_media-type": "application/vnd.ibexa.api.ai.AltText+json", - "Text": { - "_media-type": "application/vnd.ibexa.api.ai.Text+json", - "text": [ - "Blurred image of an open laptop on a desk with paperwork and another laptop in the background." - ] - } - } - } - }, - "application/vnd.ibexa.api.ai.AltText+xml": { - "schema": { - "$ref": "#/components/schemas/AltText" - }, - "example": "\n\n \n Sunlit home office with an open laptop, papers, and a blurred background.\n \n\n" - }, - "application/vnd.ibexa.api.ai.Text+json": { - "schema": { - "$ref": "#/components/schemas/Text" - }, - "example": { - "Text": { - "_media-type": "application/vnd.ibexa.api.ai.Text+json", - "text": [ - "Hello, how have you been spending your day?" + "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.ai.Text+xml": { - "schema": { - "$ref": "#/components/schemas/Text" - }, - "example": "\n\n Hello, I hope you are well. How have you been spending your day?\n\n" - } - } - }, - "400": { - "description": "Error - if the provided input or action configuration is invalid or the given action cannot be performed for any reason.", - "content": { - "application/vnd.ibexa.api.ai.ErrorMessage+json": { - "schema": { - "$ref": "#/components/schemas/ErrorMessage" - } - }, - "application/vnd.ibexa.api.ai.ErrorMessage+xml": { - "schema": { - "$ref": "#/components/schemas/ErrorMessage" - } - } - } - } - }, - "summary": "Execute the given AI action", - "description": "Executes the given AI Action using configured ActionConfiguration or ActionHandler, if passed. Might consume AI agent resources.", - "parameters": [ - { - "name": "actionConfigurationIdentifier", - "in": "path", - "description": "Configured action name (obtain by listing the configured actions via GET `/api/ibexa/v2/ai/actions` endpoint).", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false, - "examples": { - "rewrite_with_friendly_tone": { - "value": "rewrite_with_friendly_tone" - }, - "rewrite_with_professional_tone": { - "value": "rewrite_with_professional_tone" - }, - "summarize_text": { - "value": "summarize_text" - }, - "expand_text": { - "value": "expand_text" - }, - "shorten_text": { - "value": "shorten_text" - }, - "proofread": { - "value": "proofread" - }, - "improve_readability": { - "value": "improve_readability" - }, - "gen_alt_text": { - "value": "gen_alt_text" - } - } - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "CSRF token obtained during the authentication.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "Input to execute the action. An Input type must match the action type.", - "content": { - "application/vnd.ibexa.api.ai.GenerateAltText+json": { - "schema": { - "$ref": "#/components/schemas/GenerateAltText" - }, - "example": { - "GenerateAltText": { - "Image": { - "base64": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wgARCACMANIDAREAAhEBAxEB/8QAGwAAAQUBAQAAAAAAAAAAAAAAAgABAwQFBgf/xAAaAQADAQEBAQAAAAAAAAAAAAAAAQIDBAUG/9oADAMBAAIQAxAAAAGj879HLORzrbyvP6FbydDfkx/Qx6rzu/uu/wAieoCWCoSmQ4nQ4iSrZ642HVm5vNCNvo7z6nbhq57ZvTpO5NpgjoZFcVZto06SueWpFMU2GgQnB5ThymXXyU628pQIrvr5NfXlr56H0qXSHarTpzptK56aucJoFTJiMQYECBwQ3Q0nnS6siKs5ykree/pXT5tp5Q52ukl0iCNPJ33ZWuL3n7TzxKIRimIC0mkJA4JN1UU15LezY06JZndw6fQ+ry5VATS6CS5FPis+/id5y9cO9xfdZyI2ELlNO5QISGhunnTp49u7GFmi1lfW479xv5pqRll1IqTtZ+PR5Ptvibc7Vn7Tw72nKcpy7lOUDNONISrDNOP2rHRnpaPN1eiYnTVyGpZE/bm7EKOL8/nr817OWrcd9z6+ic7Ny7l6lmmEmkCTZVy9aZF203jNZpXrnDehMEk0mn6XI7TS44rMz6PE+zPG2wmF7bwdGoS7lOU0zlgTEiNVwu2kBWeVQT6TDbouLphw6ZpTydd7Hh0MumMoaiKlwWhwnVyg56zLTvsGDmYnSUlSiFEEmuUGW/nXRpnjea1401sdLXF2LLe3FPJ3XvfOZfD2UTXn90CI5UbzuKbrmxUSubdRZcw1AptFDcZk6cxpdN1IVXL6Dn06TC7riQTiCbQCnFNZ7dDSLCkrytExtE5Koo2o6mGlCyNgjrlWIuSalnTTit6QmWHkTWJw+gLoRiMBDUC5zOrk0FnM5JoiVSz9AWnYgYdendTvZ001bl6SbyDNDLx+bujdQUqNRf0x0KjKx2y9cj1ynEmmadJgBqS1fueictLkY8t03TdU6GhjL5Hk9YiIbintjta87NC1dJnFMmhG07SAE4JdWXUmoQu1Ni5ussMJUIylmjhOP0yahqK9RVuWamFbJkcWUpQuwSgwRsEZCZNIYGQLbUSsVlpFma4/DrdyLkakhC0TmUUoics04p0WZcyaBgYcQxBJsN0IcBUDqNujLmAyRcu0Qk07mRowNJNAwWSpWJc8t0xHGANshxmnG6gKjbwanQgmQ7QOTFKKQTUjE4iAk0IKI2C1Yl2s2hiMBsxhwOq7daj/xAAnEAACAgICAgEFAAMBAAAAAAABAgADBBEFEhATIRQVICIwBiMxMv/aAAgBAQABBQKrJVa0yVi5C7+oSPeheq1N51qkYhHusYSg/wCv+N1nWW5aJHzXaM2/HF1/Diai8dTBx9M+30z7fVPtdM+10x+IoM+zUAni03WOq/x5i3qincBm4vy3HJpGmoPG9SzIrQZHM1JOK5L6s/0P/OZs3fXNzcoG2xhpT4Hi8bTLFi2sJh3nFy6rBZX/ADtOkzbO+Wp+O0BnHr2vq+K/A8GctjxhLZ/juZ3r3/PNfrU3dXD7gMScUu/zyq+9eUvptsMxcg4+TjWi2r+XIN+llQaW4021crcEcQuqvyac9jfq5hn+O5nwD/LOb9oZlddLjsBiAVVewT2ie0fgZlVeyvkKfReZjWmi/BvF9P8ABzpcm7dweZGSFlKNY+Ona659QOZ2M2YwaG1hBf8ANmUihc2p5zqewmtp6mnD5j48XLXr9ckpyxaRufMclRVaXljamS2qmPzZeTKadldLMD/3c27Vg8FhLE7yzHPU8Y2xiJQbKjkFeKUReMrlfH0w4eOIuHjiV0VpPiFfA0I+mmX8y7ASyLx/SeixYQRONX9acSlwMGufRVz6Oue2eyB9x9GWVK0+kqBFdaxbli2GMnY9IewBssEN9qg5NkN9hnuslmUSBepgYwWAz/swUDWeoQFlgsnsXxub8Hwy/ASIdTtN+CnYWYlkGDcZ9vun2y0x+MbqnCiyLwipPtw6/QfriYrUj58ECdRO0P8A1n1GyJi1vaGoRF9naW/Uh1fkJ25HW+VmuXnr5Qz6fkJ9DmtBxWWZTxAErrrpX3177E+d+dTUDzvGbcQ0o45OmNyOJYKszCrn11EXKqae9Z71nuWe5Z7hDfDfZGstMastFpKEXXLFyxFvVp2EBEZwIG3N+NxviH9oy6gG4qfIWBYHKwXRTvwTOzTRM9c6a8b8FRB2EF7LGsWyUsFntH46nWDwJqag+ILiItgPnc7eNzfk/MKCEETbxW3+WoPw1Os1AxEW2dgfGvx3DCZuVmL+Ag/gfG4rGA+NeTDCZuf/xAAnEQACAgICAQMEAwEAAAAAAAAAAQIRAxIQEyEUIDAxQEFhBCIyUf/aAAgBAwEBPwHuWosiFkQppjyI2RnmjA/7E34Mq/t8WPHt5YsZqlzneqIMsf8AJ/R6qR6uR6tnq/0eq/R3p/gWSP8Aw7Uybt/Fi8IsviHk/lSEWPirI4ZSFgivqycItXH4LLL5QuLGzH4RnfkXD4xOpErGXTJRp+6/dEvleWPxEyeZPl8IhLaIyRF7Ir4LL4iKRsNmMyOl78M6ZPwSYpaux/GuKPKMZnfj3xP9RGMxytUP4kLhkfBNOTo6mdTOp+xGORkVMZGVP40JmwhGBfVlI1RqhOIsSY8CFjNaZk8ocTVkX+OWyy+ckqYuLEIRi8RQuVFkJ6nanxp+RxNUUPloocRcThYuFyiWecT1kz1sz1uQ6jrHChWUzRmrGyzc2Gy/fYmJm1CyDUZDxnXLiubHxP6/JZZsbc2zZmvNk8up3N8Sx2dR1miNEao1RSLQ3xXvsvhjJ3+DrZpJDjI1kas62dbOtmjNGdZ1nWikUaGrK5RRXFj91cX8FFFcao0Os0NfsaK4r30X9jfw395//8QAJhEAAgIBAwQCAwEBAAAAAAAAAAECERIDEBMgITAxQVEEFCJAYf/aAAgBAgEBPwGehJyJfjsehI4ZEdKVEtOR+LpuzXX8Gmv6I+KcqGOxLbTWUiW1GBxnEcbOJiTj6G5MXYXiasaKKH2R+OvklshF0ch/TO8H5WJEyiiZpKoj2W00RqhEo5KhPyMS7DRRRL2Lskh7LaRHsxETVjTvyVbHEcKGiQlch70LaSId0JEo5Kiq7eOPvdxTJwaIrv1yNJ06FtrQ+fHBbolI9IyMjLdjH2NN2tmrRKNOvFGPYoxGT9Gp9Ds7nccZGbMmJSl6HCXyaXYssnDIwZgxwa6YKz53YzUJ+xj2lqoas9EdfAlruQp0c7OdnLJmbMn9llljZZDUrbMzMltqexQUj9dH6qP1UZmZkWKRyGRgYlFCRSEkYmKMUYDgUNFDVmJ6MzPwJ9S2sssyY7KKHErZ9FGAtKzhQ0Rml7OWByx+jmRzI5v+HM/oWq38Ccn8CW2aLsrpaMUVsiJZ2OxaM0jmic0Tmic0TmRznOczORnIxahmZFl9S2vazIyKsx6O21l9FmRkLUaJTsy6r6LL2xK8llleOyyyjErw0UP/AAteL//EADAQAAECAwUHAwQDAQAAAAAAAAEAAhEhMQMQEiAwBCIyQVFhcROBkTM0gqEjUHKS/9oACAEBAAY/AqX1VVVVuZPmhpSUzErd3Qp3R6mF9FRUVFwqimFIITMlDSEKnK3xHNvOCgzeKcHCDhrBvTIEfjKYJzXuJubaCnNBw56rz3yN7TQzYxf6LzvNpqO8Il2Rx9s5Cc03NtB7oOHPTIukpqSb3noY23+i40ppwv7oQQHQAaBCcOVzXjkmuGkboBYnpgTR755uC4hFRAuosDgYKJKqt2+KpeXFQaouuc7oEe0s0GlEvtCYqI4lhMAuK6gUCqBboF81S7DyUnEKRBXCphR6lR55aLoqrjKjjf8AK4nfKlFUKiRdIqBU1VVUnKDhFSfD/SjD3CrcRCUFK6ejCOXhiv4wSOhVMKo0e6m5qOJ4MOyiXPHkLctnqDnYvKlhCON4LuoGjiMmd0XOfABbk2qNiLMjo5fR2X9qTdlH4qVpYD8F9zZD8FPbB7MU9tf7Bff26nt1v/0o2207RadsUFBoAUAYnsuUNPFbNc7sqOUHxPkI+m3D4aqH4UlRUvopNUg1fUh4C3rRxUbO0cFPC/8AS3mlqkRnnq0U1XNJxW9dXVkp6siq/wBv/8QAJhAAAgEDBAEEAwEAAAAAAAAAAAERITFREEFhcYEgkbHBMKHw0f/aAAgBAQABPyF1qlkKqY3VIo9EG0SNJSqSRYpYe0jY2P1tpaBh49FJ8C4x5aWNkzYXgSaYFhgTgjftG12exgUsKVKJkjuJI7AbG/wMQaGDGIFq3V/2CaqGiVGJoeSel4Cv5bcDYx6Mb9bwxVayRtNpHt24Ka/i0RpQ1ZobQkhJ7siY2S6Oo4WUkobG9G/wSBWqlBALiRnAAWDxI/QWUU2gkkS6Jn5CWiSfwybAZAzLkWlHpOTd2i+RPFidEhECXyH+EE7HK0T9g1eUkkk/h7JQ2Yeq0jollC1Inbyf6+hMkkjVJRNCqtByd64JEL8DdCdfIkVNEcVEhgO5bHA2H7+henVjCnauh7VVOgw2O6oymZQiSfTJMsieKCIliTdNhGyEcnI+J2/vCHtxZDmIEolE1Ye4Mm1AI4XEJyLhkqikeWVPto3SCnaRasZ9G5ReGQ2JPPgXM1bkcGy5MRFBJIRFW+CnokhbNpwMtBbGMbQ818iRCcmeCarUWdSfQJcSWQbXCOBWox4qGthYBr2zSBb+2DR3LgcVF2UPJ8ITfJJsxB3ksUHELnoG6+A3lBTMkZYlQrjFi3cCfn3E3QP7DK4RyRKw5RUJxlFaWPoXUkWKMfRIwhdHa7UUpJOCVQ6lCJNlLjRi+C9OVyYRzEUHEYb0JZFNlSpFccO41IEwnJbGwNk6Lv2YdMmM/Yn7jKOw7yiVLUmk2LoP0DtOT3A3wDq38QnUGb3P0iQhvYKBJeScjG2jgOqrMZKHLWwpInS22hVjgVU2JZOG05FZaGX6Nmj+cktQeRIvazJ8BDaIG5fGCT8LPleHvlin6IQ3O/uWtxVDsF2MtZk6E1pAiZHKGEcGPeAJYi2EuCkZvDR40x33BOswY4+jCwswWJjVsyjcQf6G2Hkv4nzID8yvybUPcIU/dF6QnaBvDYux6E5oKFA4dJDJVBLWqYRRggFVHJlRClMqMVhiW5IaPcLabKolglO4zsjYwyobS3XkW/6OQkuNEIStVGqsNAnohpZ3tYOmnZjkpGG3MkyrRMRXHV1QUQWsiGUaEhSIYYkjfzKIkJjLJGxN6H1jRnGm3oI0WqIEGhMnR6ZjQxoNCGHHEz//2gAMAwEAAgADAAAAEIYi+VZ+Ndf03ptaHA3sA0vGKiAxcf0JgkWk4FIfyv686UM0LT4YtCOWtZiJ+LmoV1aIdpLEfJAVQ1isgFKPHwK+ZjftYRScC3SR1snp8vNuvxJgzsFsNzKOR6K8LGfMhsOMobK/QI2G8+02rSuJ49xArEzFZz1Is55eJrJyJfsqUM2T5P8Ak1kdG38bXJNr5ejJmIkgw7iIOt83GqzfS0wqf/1xs0+xWQw6Oes6WodtgWzgWehQzf8A/8QAJhEBAQEAAgICAQIHAAAAAAAAAQARECExQVFhILHwMHGBkaHB0f/aAAgBAwEBPxDGZPFmvdT3NtzzI6GCHO5BBBH4PBwAMOo9aXYNv6KWHXFTwJ+IvoL6yV7HE+XDukQ3ZQQR+WQ4DFu62U+/0nyLC8Lwxf6GmIeIIjg438BvA1lhlvIHZaE/ffDZzGS3d56jHbfD544IILZZm22ww3lHa3ZcJdEtZaI4Uzxg+8hG6N8nDJllttt4EGWSHmNPVrDXeNTruzhZtvN+G7ctuNZeyWWWWW222GGcdzd8kxOrw/mSTjbeFjL3+ycrtHqUssssttsMM5QyMy34wIep5CeCFk48crs5d7JZZZbbbbYZcDiKut5xOvzn9oT1PwX0THGxkYhpY+YHQwpJpA1LLASJFsSkSh4GU8ji/ffLJU5xjyId9wdgSEiGSsrAzU9Mc8wFvG6wyhhu5kzgdWXOYPcN9z/eI9S8y8S1wTdZjYWcEMcg13JPd4gl9N9Vpsb7gy6mKXYYiWWWXnvjLYeBDF2hL+UBwdIMMlyb4R3bsCETuJ6Tj3Y9tl7/AFn5D/P/AGz4Uf2WMPo4FwMMRbCtyylDNVjsEnzJW/u+2fn/AAaE+7PzAQXgkvmfiyVogjbHvkWeBdnhkmdlq3eAskODLHNlt6s+uBjgsssszLMySWW2xZyZwDjI6iAscFlm2WZnh4yzjYYm8jDDDDwG2WZ4Zmf4BFtvJFvH/8QAJREBAQEAAgIDAAIBBQAAAAAAAQARECExQSBRYXGxoTDR4fDx/9oACAECAQE/EPOrT5iEG+IXhE9Q9JN0lj6lt5yyyzhOhJf22sYGwRu6tlt8sbu/A9TKebyyExYepHPlklnGyyJ08p2P1P7hZCEgdyPUevqQGujKM/HLLLLJLwvfDm79Xc/b/X/vHIxbGz7AlB969DbbzllllkkkOrCbN1nBDYP4D/nkIhpLounDrvht+OWWWWSRgI06k8uA3SS1WeCCTbPsvK4gVSlqI4CyyyyySG7ttLwvUh3ZN+uHgLJhpduhBZuYiCD5N7JJIML0nVuj9yJNmAuuCu7ThiPJk4hHOWWTYRhHhhLE2zBKLNhTQ4SvEox0nQ2YuxdmcfkIGBsZ6jLtm4gslDYdBd3CFkES26QK7nGBdO3ll+XCe5H2WkG+WKG28Tj1dgyF3Yfuz7tPc4zz+F2m2nu19372/dj6jc/qwtpmXfrLd1jPuLhHmvSgcH5R9ZDySPGynmcXiNk8WsEebN3zkcHVuDJZEQPqT7LX6tfUM9Qx6OFL6lD0y182z1KJgXVt5jcQuz1YGrYORGT8L/sy/F/xfk/4/wBrfpcDwH9r0Qk93RIcT9JWWckGF5gXSQ+bJKvMIvynyiw9X5R9XE/XI9Ev0Ssp5j3EPuC+HjlsSb4lzgLPq7R1Grc4k7SPKzJnwbniMzq22WGQ4beAtWvAiI4PtZw7HBo+Z14lnG/6Itvi44IeRjv4EOJDMVd2/B4DkBJyckfEYbbBgk+ORBZf/8QAJhABAAIBBAEFAQADAQAAAAAAAQARITFBUWFxEIGRobHRweHw8f/aAAgBAQABPxBQcu1XMDcftL7RnciVogijUrXYhByZsaua7HJLPB9ccWEIQYMpSJMrtHvnC2FK/ae8XoTVW2FVXlgrH5jL+/UuKxycQQH4oL+EKMfET+MSxNsJaD2iKqnxEo59BAt2lYaCj1BYw9SXET0NjTVZl5VVdWYCOUSBnWDh6r86Pp+pcMctoMQywOiAkTW4XYLHH5hDm4bvlCSyVgLixehfqQhLF1DJwdHa/wCpjGO252RgdEPdhOFFg8D/AHMyMHEEf6wCbRaSKWbJaVFSDBcphgBEPVF9BYS5cGDBhtvaVdYU+2P7KKFoqC8TOM2L2MfdTmJt98/5mREzDUI1MDVJlo2hiK3kj2ZuHMMizSMsLcIJFJcuXBlQ7j9R2F5J2wNqcTLay2ljgFKx2v8AyEOwaHUyJcoII2JcEUahRIWvYhrFuAAG8DbFFeoety5fpcPtSkvMLl1Yuolb5yVQXxEHZXjGPt6Iw9BAVGXEVt/tEVuW3H3CrupxAJHDFfqsWXLlytPBM1cqFlimyWG0iHEYlRFinTvRf4jlEKNSdxAJR6A5hXmyokAQxmjjhDDc3gBQTrHKSkWLLl+jxlDurHDLlERpbwVCN2VptKoCBXgy/kZXVj5Fo+vkm7Y41TswTFs2jtW6pX6jd2I6C3WxLXMN8zBvG6dYpD+JP9NhTZt46QdmzRdJWm4IgZrvAMkSmEGLKYbEscA1mIVHLUV3GTCZ0sojvXTG0yvXnaCQEwJd9eX/AMZYy0C8go/UapE1LYQ2lTLyO0r1TUIXJVraB6mSkyjKyua7m34j+T7JmGC1p5YQuXuQKnHiJPt5LyhEWyNdQUZBFqIloKKbgEvtRYW2XTLwc5wYoFBvnKM30SJg873f0ZaRuYNu4Js0Vy/2C3fv+z/owXXN3BH+MfsqOZn5niCIceUbm/VkoSkvIjfgSCY3mJd3YrpDaIhgOIxbZGqW6OzMEB1slUiOCyZz1GyAe6K/qZcg2/oZWz1z7gs1bn5R/tCwntDEAOyXKibasBZ/jDLsWiqZj/HK+yBWh2Z9ELFSzOsyB1JY9yxqy+ILxg94TinmOzAVNIY3FcwOG/eLieIYmvVRA67XYNUfUkfI18PzO9BF1FYsuvyWC9C/eq/bikeAiPyMs3BRXrNAasJdNjfZz8wOjC11jxtUogDIlrwv6lAZsMiQUwc2qhgpXt13gmagGgp7mrD2nQ/MA4NPC6xGVDe37idTIt/iPFEv6lSvW7F667gMasAARhtpALjusRs/XUKd8ojA8s3/AFQtOFD/AFLJ8EYmhqf9tZX+KD/MTIzkI1BF2pPyMiA/42gtKapnzq+4WEzKbXlZfeKbWdh5rSIhea6kp/Awe5AbyxhlDF9idDBAC2HcmKxuHWNO8OGDdFfaOsCAKYK4IgIuTR+SvodQU7xBbA1uMUOhBEzK8BEbfxEbcoHHyEUwTqIP0pEXXcqf5MWA4A/bmU8047LLcgfkgNEm9P8ACOCrmqfJDjxl0wHb2iGEwi9zT59FSzUOzY5ltRUlEfDNKL7Q1dTvDq4sMuwbSjrDF44YihX3DMOYYZ0mSzZSTJiGfhhOa/MA0zyykreIaw6JUyGTkifEcLZFdrkg4YNKRuBR2ynR+YnmDSt41U5J1SiGZwy9SRvJGOGXaREatSVgLOZSZL9FB5RXoMYYk2xO2aaNTsuAURO4xwW6meedj5gBmPRi2SswsVMymAtxDqXaQDeK9ZbG2gzFkUwkllGuE6kT4YxpLmpADpEXDCRwywYFaynMwcxQuDEGEzGzKrga0mjiZwg1Moh2gwplxKJmELmevoDioiZjl5hBzG9zP//Z" - }, - "RuntimeContext": [] - } - } - }, - "application/vnd.ibexa.api.ai.GenerateAltText+xml": { - "schema": { - "$ref": "#/components/schemas/GenerateAltText" - }, - "example": "\n\n \n data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wgARCACMANIDAREAAhEBAxEB/8QAGwAAAQUBAQAAAAAAAAAAAAAAAgABAwQFBgf/xAAaAQADAQEBAQAAAAAAAAAAAAAAAQIDBAUG/9oADAMBAAIQAxAAAAGj879HLORzrbyvP6FbydDfkx/Qx6rzu/uu/wAieoCWCoSmQ4nQ4iSrZ642HVm5vNCNvo7z6nbhq57ZvTpO5NpgjoZFcVZto06SueWpFMU2GgQnB5ThymXXyU628pQIrvr5NfXlr56H0qXSHarTpzptK56aucJoFTJiMQYECBwQ3Q0nnS6siKs5ykree/pXT5tp5Q52ukl0iCNPJ33ZWuL3n7TzxKIRimIC0mkJA4JN1UU15LezY06JZndw6fQ+ry5VATS6CS5FPis+/id5y9cO9xfdZyI2ELlNO5QISGhunnTp49u7GFmi1lfW479xv5pqRll1IqTtZ+PR5Ptvibc7Vn7Tw72nKcpy7lOUDNONISrDNOP2rHRnpaPN1eiYnTVyGpZE/bm7EKOL8/nr817OWrcd9z6+ic7Ny7l6lmmEmkCTZVy9aZF203jNZpXrnDehMEk0mn6XI7TS44rMz6PE+zPG2wmF7bwdGoS7lOU0zlgTEiNVwu2kBWeVQT6TDbouLphw6ZpTydd7Hh0MumMoaiKlwWhwnVyg56zLTvsGDmYnSUlSiFEEmuUGW/nXRpnjea1401sdLXF2LLe3FPJ3XvfOZfD2UTXn90CI5UbzuKbrmxUSubdRZcw1AptFDcZk6cxpdN1IVXL6Dn06TC7riQTiCbQCnFNZ7dDSLCkrytExtE5Koo2o6mGlCyNgjrlWIuSalnTTit6QmWHkTWJw+gLoRiMBDUC5zOrk0FnM5JoiVSz9AWnYgYdendTvZ001bl6SbyDNDLx+bujdQUqNRf0x0KjKx2y9cj1ynEmmadJgBqS1fueictLkY8t03TdU6GhjL5Hk9YiIbintjta87NC1dJnFMmhG07SAE4JdWXUmoQu1Ni5ussMJUIylmjhOP0yahqK9RVuWamFbJkcWUpQuwSgwRsEZCZNIYGQLbUSsVlpFma4/DrdyLkakhC0TmUUoics04p0WZcyaBgYcQxBJsN0IcBUDqNujLmAyRcu0Qk07mRowNJNAwWSpWJc8t0xHGANshxmnG6gKjbwanQgmQ7QOTFKKQTUjE4iAk0IKI2C1Yl2s2hiMBsxhwOq7daj/xAAnEAACAgICAgEFAAMBAAAAAAABAgADBBEFEhATIRQVICIwBiMxMv/aAAgBAQABBQKrJVa0yVi5C7+oSPeheq1N51qkYhHusYSg/wCv+N1nWW5aJHzXaM2/HF1/Diai8dTBx9M+30z7fVPtdM+10x+IoM+zUAni03WOq/x5i3qincBm4vy3HJpGmoPG9SzIrQZHM1JOK5L6s/0P/OZs3fXNzcoG2xhpT4Hi8bTLFi2sJh3nFy6rBZX/ADtOkzbO+Wp+O0BnHr2vq+K/A8GctjxhLZ/juZ3r3/PNfrU3dXD7gMScUu/zyq+9eUvptsMxcg4+TjWi2r+XIN+llQaW4021crcEcQuqvyac9jfq5hn+O5nwD/LOb9oZlddLjsBiAVVewT2ie0fgZlVeyvkKfReZjWmi/BvF9P8ABzpcm7dweZGSFlKNY+Ona659QOZ2M2YwaG1hBf8ANmUihc2p5zqewmtp6mnD5j48XLXr9ckpyxaRufMclRVaXljamS2qmPzZeTKadldLMD/3c27Vg8FhLE7yzHPU8Y2xiJQbKjkFeKUReMrlfH0w4eOIuHjiV0VpPiFfA0I+mmX8y7ASyLx/SeixYQRONX9acSlwMGufRVz6Oue2eyB9x9GWVK0+kqBFdaxbli2GMnY9IewBssEN9qg5NkN9hnuslmUSBepgYwWAz/swUDWeoQFlgsnsXxub8Hwy/ASIdTtN+CnYWYlkGDcZ9vun2y0x+MbqnCiyLwipPtw6/QfriYrUj58ECdRO0P8A1n1GyJi1vaGoRF9naW/Uh1fkJ25HW+VmuXnr5Qz6fkJ9DmtBxWWZTxAErrrpX3177E+d+dTUDzvGbcQ0o45OmNyOJYKszCrn11EXKqae9Z71nuWe5Z7hDfDfZGstMastFpKEXXLFyxFvVp2EBEZwIG3N+NxviH9oy6gG4qfIWBYHKwXRTvwTOzTRM9c6a8b8FRB2EF7LGsWyUsFntH46nWDwJqag+ILiItgPnc7eNzfk/MKCEETbxW3+WoPw1Os1AxEW2dgfGvx3DCZuVmL+Ag/gfG4rGA+NeTDCZuf/xAAnEQACAgICAQMEAwEAAAAAAAAAAQIRAxIQEyEUIDAxQEFhBCIyUf/aAAgBAwEBPwHuWosiFkQppjyI2RnmjA/7E34Mq/t8WPHt5YsZqlzneqIMsf8AJ/R6qR6uR6tnq/0eq/R3p/gWSP8Aw7Uybt/Fi8IsviHk/lSEWPirI4ZSFgivqycItXH4LLL5QuLGzH4RnfkXD4xOpErGXTJRp+6/dEvleWPxEyeZPl8IhLaIyRF7Ir4LL4iKRsNmMyOl78M6ZPwSYpaux/GuKPKMZnfj3xP9RGMxytUP4kLhkfBNOTo6mdTOp+xGORkVMZGVP40JmwhGBfVlI1RqhOIsSY8CFjNaZk8ocTVkX+OWyy+ckqYuLEIRi8RQuVFkJ6nanxp+RxNUUPloocRcThYuFyiWecT1kz1sz1uQ6jrHChWUzRmrGyzc2Gy/fYmJm1CyDUZDxnXLiubHxP6/JZZsbc2zZmvNk8up3N8Sx2dR1miNEao1RSLQ3xXvsvhjJ3+DrZpJDjI1kas62dbOtmjNGdZ1nWikUaGrK5RRXFj91cX8FFFcao0Os0NfsaK4r30X9jfw395//8QAJhEAAgIBAwQCAwEBAAAAAAAAAAECERIDEBMgITAxQVEEFCJAYf/aAAgBAgEBPwGehJyJfjsehI4ZEdKVEtOR+LpuzXX8Gmv6I+KcqGOxLbTWUiW1GBxnEcbOJiTj6G5MXYXiasaKKH2R+OvklshF0ch/TO8H5WJEyiiZpKoj2W00RqhEo5KhPyMS7DRRRL2Lskh7LaRHsxETVjTvyVbHEcKGiQlch70LaSId0JEo5Kiq7eOPvdxTJwaIrv1yNJ06FtrQ+fHBbolI9IyMjLdjH2NN2tmrRKNOvFGPYoxGT9Gp9Ds7nccZGbMmJSl6HCXyaXYssnDIwZgxwa6YKz53YzUJ+xj2lqoas9EdfAlruQp0c7OdnLJmbMn9llljZZDUrbMzMltqexQUj9dH6qP1UZmZkWKRyGRgYlFCRSEkYmKMUYDgUNFDVmJ6MzPwJ9S2sssyY7KKHErZ9FGAtKzhQ0Rml7OWByx+jmRzI5v+HM/oWq38Ccn8CW2aLsrpaMUVsiJZ2OxaM0jmic0Tmic0TmRznOczORnIxahmZFl9S2vazIyKsx6O21l9FmRkLUaJTsy6r6LL2xK8llleOyyyjErw0UP/AAteL//EADAQAAECAwUHAwQDAQAAAAAAAAEAAhEhMQMQEiAwBCIyQVFhcROBkTM0gqEjUHKS/9oACAEBAAY/AqX1VVVVuZPmhpSUzErd3Qp3R6mF9FRUVFwqimFIITMlDSEKnK3xHNvOCgzeKcHCDhrBvTIEfjKYJzXuJubaCnNBw56rz3yN7TQzYxf6LzvNpqO8Il2Rx9s5Cc03NtB7oOHPTIukpqSb3noY23+i40ppwv7oQQHQAaBCcOVzXjkmuGkboBYnpgTR755uC4hFRAuosDgYKJKqt2+KpeXFQaouuc7oEe0s0GlEvtCYqI4lhMAuK6gUCqBboF81S7DyUnEKRBXCphR6lR55aLoqrjKjjf8AK4nfKlFUKiRdIqBU1VVUnKDhFSfD/SjD3CrcRCUFK6ejCOXhiv4wSOhVMKo0e6m5qOJ4MOyiXPHkLctnqDnYvKlhCON4LuoGjiMmd0XOfABbk2qNiLMjo5fR2X9qTdlH4qVpYD8F9zZD8FPbB7MU9tf7Bff26nt1v/0o2207RadsUFBoAUAYnsuUNPFbNc7sqOUHxPkI+m3D4aqH4UlRUvopNUg1fUh4C3rRxUbO0cFPC/8AS3mlqkRnnq0U1XNJxW9dXVkp6siq/wBv/8QAJhAAAgEDBAEEAwEAAAAAAAAAAAERITFREEFhcYEgkbHBMKHw0f/aAAgBAQABPyF1qlkKqY3VIo9EG0SNJSqSRYpYe0jY2P1tpaBh49FJ8C4x5aWNkzYXgSaYFhgTgjftG12exgUsKVKJkjuJI7AbG/wMQaGDGIFq3V/2CaqGiVGJoeSel4Cv5bcDYx6Mb9bwxVayRtNpHt24Ka/i0RpQ1ZobQkhJ7siY2S6Oo4WUkobG9G/wSBWqlBALiRnAAWDxI/QWUU2gkkS6Jn5CWiSfwybAZAzLkWlHpOTd2i+RPFidEhECXyH+EE7HK0T9g1eUkkk/h7JQ2Yeq0jollC1Inbyf6+hMkkjVJRNCqtByd64JEL8DdCdfIkVNEcVEhgO5bHA2H7+henVjCnauh7VVOgw2O6oymZQiSfTJMsieKCIliTdNhGyEcnI+J2/vCHtxZDmIEolE1Ye4Mm1AI4XEJyLhkqikeWVPto3SCnaRasZ9G5ReGQ2JPPgXM1bkcGy5MRFBJIRFW+CnokhbNpwMtBbGMbQ818iRCcmeCarUWdSfQJcSWQbXCOBWox4qGthYBr2zSBb+2DR3LgcVF2UPJ8ITfJJsxB3ksUHELnoG6+A3lBTMkZYlQrjFi3cCfn3E3QP7DK4RyRKw5RUJxlFaWPoXUkWKMfRIwhdHa7UUpJOCVQ6lCJNlLjRi+C9OVyYRzEUHEYb0JZFNlSpFccO41IEwnJbGwNk6Lv2YdMmM/Yn7jKOw7yiVLUmk2LoP0DtOT3A3wDq38QnUGb3P0iQhvYKBJeScjG2jgOqrMZKHLWwpInS22hVjgVU2JZOG05FZaGX6Nmj+cktQeRIvazJ8BDaIG5fGCT8LPleHvlin6IQ3O/uWtxVDsF2MtZk6E1pAiZHKGEcGPeAJYi2EuCkZvDR40x33BOswY4+jCwswWJjVsyjcQf6G2Hkv4nzID8yvybUPcIU/dF6QnaBvDYux6E5oKFA4dJDJVBLWqYRRggFVHJlRClMqMVhiW5IaPcLabKolglO4zsjYwyobS3XkW/6OQkuNEIStVGqsNAnohpZ3tYOmnZjkpGG3MkyrRMRXHV1QUQWsiGUaEhSIYYkjfzKIkJjLJGxN6H1jRnGm3oI0WqIEGhMnR6ZjQxoNCGHHEz//2gAMAwEAAgADAAAAEIYi+VZ+Ndf03ptaHA3sA0vGKiAxcf0JgkWk4FIfyv686UM0LT4YtCOWtZiJ+LmoV1aIdpLEfJAVQ1isgFKPHwK+ZjftYRScC3SR1snp8vNuvxJgzsFsNzKOR6K8LGfMhsOMobK/QI2G8+02rSuJ49xArEzFZz1Is55eJrJyJfsqUM2T5P8Ak1kdG38bXJNr5ejJmIkgw7iIOt83GqzfS0wqf/1xs0+xWQw6Oes6WodtgWzgWehQzf8A/8QAJhEBAQEAAgICAQIHAAAAAAAAAQARECExQVFhILHwMHGBkaHB0f/aAAgBAwEBPxDGZPFmvdT3NtzzI6GCHO5BBBH4PBwAMOo9aXYNv6KWHXFTwJ+IvoL6yV7HE+XDukQ3ZQQR+WQ4DFu62U+/0nyLC8Lwxf6GmIeIIjg438BvA1lhlvIHZaE/ffDZzGS3d56jHbfD544IILZZm22ww3lHa3ZcJdEtZaI4Uzxg+8hG6N8nDJllttt4EGWSHmNPVrDXeNTruzhZtvN+G7ctuNZeyWWWWW222GGcdzd8kxOrw/mSTjbeFjL3+ycrtHqUssssttsMM5QyMy34wIep5CeCFk48crs5d7JZZZbbbbYZcDiKut5xOvzn9oT1PwX0THGxkYhpY+YHQwpJpA1LLASJFsSkSh4GU8ji/ffLJU5xjyId9wdgSEiGSsrAzU9Mc8wFvG6wyhhu5kzgdWXOYPcN9z/eI9S8y8S1wTdZjYWcEMcg13JPd4gl9N9Vpsb7gy6mKXYYiWWWXnvjLYeBDF2hL+UBwdIMMlyb4R3bsCETuJ6Tj3Y9tl7/AFn5D/P/AGz4Uf2WMPo4FwMMRbCtyylDNVjsEnzJW/u+2fn/AAaE+7PzAQXgkvmfiyVogjbHvkWeBdnhkmdlq3eAskODLHNlt6s+uBjgsssszLMySWW2xZyZwDjI6iAscFlm2WZnh4yzjYYm8jDDDDwG2WZ4Zmf4BFtvJFvH/8QAJREBAQEAAgIDAAIBBQAAAAAAAQARECExQSBRYXGxoTDR4fDx/9oACAECAQE/EPOrT5iEG+IXhE9Q9JN0lj6lt5yyyzhOhJf22sYGwRu6tlt8sbu/A9TKebyyExYepHPlklnGyyJ08p2P1P7hZCEgdyPUevqQGujKM/HLLLLJLwvfDm79Xc/b/X/vHIxbGz7AlB969DbbzllllkkkOrCbN1nBDYP4D/nkIhpLounDrvht+OWWWWSRgI06k8uA3SS1WeCCTbPsvK4gVSlqI4CyyyyySG7ttLwvUh3ZN+uHgLJhpduhBZuYiCD5N7JJIML0nVuj9yJNmAuuCu7ThiPJk4hHOWWTYRhHhhLE2zBKLNhTQ4SvEox0nQ2YuxdmcfkIGBsZ6jLtm4gslDYdBd3CFkES26QK7nGBdO3ll+XCe5H2WkG+WKG28Tj1dgyF3Yfuz7tPc4zz+F2m2nu19372/dj6jc/qwtpmXfrLd1jPuLhHmvSgcH5R9ZDySPGynmcXiNk8WsEebN3zkcHVuDJZEQPqT7LX6tfUM9Qx6OFL6lD0y182z1KJgXVt5jcQuz1YGrYORGT8L/sy/F/xfk/4/wBrfpcDwH9r0Qk93RIcT9JWWckGF5gXSQ+bJKvMIvynyiw9X5R9XE/XI9Ev0Ssp5j3EPuC+HjlsSb4lzgLPq7R1Grc4k7SPKzJnwbniMzq22WGQ4beAtWvAiI4PtZw7HBo+Z14lnG/6Itvi44IeRjv4EOJDMVd2/B4DkBJyckfEYbbBgk+ORBZf/8QAJhABAAIBBAEFAQADAQAAAAAAAQARITFBUWFxEIGRobHRweHw8f/aAAgBAQABPxBQcu1XMDcftL7RnciVogijUrXYhByZsaua7HJLPB9ccWEIQYMpSJMrtHvnC2FK/ae8XoTVW2FVXlgrH5jL+/UuKxycQQH4oL+EKMfET+MSxNsJaD2iKqnxEo59BAt2lYaCj1BYw9SXET0NjTVZl5VVdWYCOUSBnWDh6r86Pp+pcMctoMQywOiAkTW4XYLHH5hDm4bvlCSyVgLixehfqQhLF1DJwdHa/wCpjGO252RgdEPdhOFFg8D/AHMyMHEEf6wCbRaSKWbJaVFSDBcphgBEPVF9BYS5cGDBhtvaVdYU+2P7KKFoqC8TOM2L2MfdTmJt98/5mREzDUI1MDVJlo2hiK3kj2ZuHMMizSMsLcIJFJcuXBlQ7j9R2F5J2wNqcTLay2ljgFKx2v8AyEOwaHUyJcoII2JcEUahRIWvYhrFuAAG8DbFFeoety5fpcPtSkvMLl1Yuolb5yVQXxEHZXjGPt6Iw9BAVGXEVt/tEVuW3H3CrupxAJHDFfqsWXLlytPBM1cqFlimyWG0iHEYlRFinTvRf4jlEKNSdxAJR6A5hXmyokAQxmjjhDDc3gBQTrHKSkWLLl+jxlDurHDLlERpbwVCN2VptKoCBXgy/kZXVj5Fo+vkm7Y41TswTFs2jtW6pX6jd2I6C3WxLXMN8zBvG6dYpD+JP9NhTZt46QdmzRdJWm4IgZrvAMkSmEGLKYbEscA1mIVHLUV3GTCZ0sojvXTG0yvXnaCQEwJd9eX/AMZYy0C8go/UapE1LYQ2lTLyO0r1TUIXJVraB6mSkyjKyua7m34j+T7JmGC1p5YQuXuQKnHiJPt5LyhEWyNdQUZBFqIloKKbgEvtRYW2XTLwc5wYoFBvnKM30SJg873f0ZaRuYNu4Js0Vy/2C3fv+z/owXXN3BH+MfsqOZn5niCIceUbm/VkoSkvIjfgSCY3mJd3YrpDaIhgOIxbZGqW6OzMEB1slUiOCyZz1GyAe6K/qZcg2/oZWz1z7gs1bn5R/tCwntDEAOyXKibasBZ/jDLsWiqZj/HK+yBWh2Z9ELFSzOsyB1JY9yxqy+ILxg94TinmOzAVNIY3FcwOG/eLieIYmvVRA67XYNUfUkfI18PzO9BF1FYsuvyWC9C/eq/bikeAiPyMs3BRXrNAasJdNjfZz8wOjC11jxtUogDIlrwv6lAZsMiQUwc2qhgpXt13gmagGgp7mrD2nQ/MA4NPC6xGVDe37idTIt/iPFEv6lSvW7F667gMasAARhtpALjusRs/XUKd8ojA8s3/AFQtOFD/AFLJ8EYmhqf9tZX+KD/MTIzkI1BF2pPyMiA/42gtKapnzq+4WEzKbXlZfeKbWdh5rSIhea6kp/Awe5AbyxhlDF9idDBAC2HcmKxuHWNO8OGDdFfaOsCAKYK4IgIuTR+SvodQU7xBbA1uMUOhBEzK8BEbfxEbcoHHyEUwTqIP0pEXXcqf5MWA4A/bmU8047LLcgfkgNEm9P8ACOCrmqfJDjxl0wHb2iGEwi9zT59FSzUOzY5ltRUlEfDNKL7Q1dTvDq4sMuwbSjrDF44YihX3DMOYYZ0mSzZSTJiGfhhOa/MA0zyykreIaw6JUyGTkifEcLZFdrkg4YNKRuBR2ynR+YnmDSt41U5J1SiGZwy9SRvJGOGXaREatSVgLOZSZL9FB5RXoMYYk2xO2aaNTsuAURO4xwW6meedj5gBmPRi2SswsVMymAtxDqXaQDeK9ZbG2gzFkUwkllGuE6kT4YxpLmpADpEXDCRwywYFaynMwcxQuDEGEzGzKrga0mjiZwg1Moh2gwplxKJmELmevoDioiZjl5hBzG9zP//Z\n \n \n\n" - }, - "application/vnd.ibexa.api.ai.RefineText+json": { - "schema": { - "$ref": "#/components/schemas/RefineText" - }, - "example": { - "RefineText": { - "Text": { - "text": [ - "Hey, wassup. What you've been doing the whole day?" - ] - }, - "RuntimeContext": [] - } } }, - "application/vnd.ibexa.api.ai.RefineText+xml": { + "application/vnd.ibexa.api.CompanyCreate+xml": { "schema": { - "$ref": "#/components/schemas/RefineText" + "$ref": "#/components/schemas/CompanyCreate" }, - "example": "\n\n \n Hey, wassup. What you've been doing the whole day?\n \n \n\n" + "example": "\n\n \n \n \n active\n true\n \n \n name\n Ibexa Sp. z o. o.\n \n \n vat\n 123 456 789\n \n \n website\n https://ibexa.co\n \n \n customer_group\n \n 1\n \n \n \n sales_rep\n \n 14\n \n \n \n billing_address\n \n HQ\n PL\n \n Silesia\n Katowice\n Gliwicka 6/5\n 40-079\n company@email.invalid\n +48 000 000 000\n \n \n \n \n\n" } }, "required": false - }, - "deprecated": false + } } }, - "/ai/actions/{identifier}": { + "/corporate/companies/{companyId}": { "get": { - "operationId": "ibexa.rest.ai.action", + "operationId": "ibexa.rest.corporate_account.companies.get", "tags": [ - "Connector AI" + "Corporate Account" ], "responses": { "200": { - "description": "Action configuration in JSON or XML", + "description": "If set, the company is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ai.ActionConfiguration+json": { + "application/vnd.ibexa.api.Company+json": { "schema": { - "$ref": "#/components/schemas/ActionConfiguration" + "$ref": "#/components/schemas/CompanyWrapper" }, "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": [] + "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" + } }, - "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" + "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" + } }, - "createdAt": "2025-08-07T13:16:47+02:00", - "updatedAt": "2025-08-07T13:18:00+02:00" + "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.ai.ActionConfiguration+xml": { + "application/vnd.ibexa.api.Company+xml": { "schema": { - "$ref": "#/components/schemas/ActionConfiguration" + "$ref": "#/components/schemas/Company" }, - "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" + "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" } } }, - "404": { - "description": "Error - an action configuration of the given unique identifier is not found." - }, "401": { - "description": "Error \u2013 the user doesn't have access to the given action configuration" + "description": "Error - The user is not authorized to read this company." + }, + "404": { + "description": "Error - The company does not exist." } }, - "summary": "Get an action configuration by its unique identifier.", - "description": "Returns an action configuration by its unique string identifier.", + "summary": "Get company", + "description": "Returns the company by given company ID.", "parameters": [ { - "name": "identifier", + "name": "If-None-match", + "in": "header", + "description": "ETag", + "required": false, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "companyId", "in": "path", - "description": "", + "description": "CompanyLoadByIdController 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", + ] + }, + "delete": { + "operationId": "ibexa.rest.corporate_account.companies.delete", "tags": [ "Corporate Account" ], "responses": { - "200": { - "description": "List of Link objects to specific Corporate Account REST resources", - "content": { - "application/vnd.ibexa.api.CorporateAccountRoot+json": { - "schema": { - "$ref": "#/components/schemas/CorporateAccountRootWrapper" - }, - "example": { - "CorporateAccountRoot": { - "_media-type": "application/vnd.ibexa.api.CorporateAccountRoot+json", - "links": [ - { - "_media-type": "application/vnd.ibexa.api.CompaniesList+json", - "_rel": "ca-companies", - "_href": "/api/ibexa/v2/corporate/companies" - }, - { - "_media-type": "application/vnd.ibexa.api.ContentTypeGroup+json", - "_rel": "ca-types", - "_href": "/api/ibexa/v2/content/typegroups?identifier=corporate_account" - }, - { + "204": { + "description": "No Content - given company is deleted." + }, + "401": { + "description": "Error - the user is not authorized to delete this company." + }, + "404": { + "description": "Error - the company does not exist." + } + }, + "summary": "Delete company", + "description": "The given company is deleted.", + "parameters": [ + { + "name": "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 + }, + { + "name": "companyId", + "in": "path", + "description": "CompanyDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + }, + "patch": { + "operationId": "ibexa.rest.corporate_account.companies.update", + "tags": [ + "Corporate Account" + ], + "responses": { + "200": { + "description": "OK - company updated.", + "content": { + "application/vnd.ibexa.api.Company+json": { + "schema": { + "$ref": "#/components/schemas/CompanyWrapper" + }, + "example": { + "Company": { + "_media-type": "application/vnd.ibexa.api.Company+json", + "id": 66, + "name": "Ibexa AS", + "Content": { + "_media-type": "application/vnd.ibexa.api.Content+json", + "_href": "/api/ibexa/v2/content/objects/66", + "_remoteId": "9f20fb03d0ab0a6aef9930f7e6720377", + "_id": 66, + "ContentType": { "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_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" + "Name": "Ibexa AS", + "TranslatedName": "Ibexa AS", + "Versions": { + "_media-type": "application/vnd.ibexa.api.VersionList+json", + "_href": "/api/ibexa/v2/content/objects/66/versions" }, - { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_rel": "ca-types-address", - "_href": "/api/ibexa/v2/content/types/49" + "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" + } + } }, - { - "_media-type": "application/vnd.ibexa.api.SalesRepresentativesList+json", - "_rel": "ca-sales-representatives", - "_href": "/api/ibexa/v2/corporate/sales-representatives" + "Section": { + "_media-type": "application/vnd.ibexa.api.Section+json", + "_href": "/api/ibexa/v2/content/sections/10" }, - { - "_media-type": "application/vnd.ibexa.api.Role+json", - "_rel": "ca-role-admin", - "_href": "/api/ibexa/v2/user/roles/14" + "MainLocation": { + "_media-type": "application/vnd.ibexa.api.Location+json", + "_href": "/api/ibexa/v2/content/locations/1/65/67" }, - { - "_media-type": "application/vnd.ibexa.api.Role+json", - "_rel": "ca-role-buyer", - "_href": "/api/ibexa/v2/user/roles/15" + "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.CorporateAccountRoot+xml": { + "application/vnd.ibexa.api.Company+xml": { "schema": { - "$ref": "#/components/schemas/CorporateAccountRoot" + "$ref": "#/components/schemas/Company" }, - "example": "\n\n \n \n \n \n \n \n \n \n\n" + "example": "\n\n 66\n Ibexa AS\n \n \n Ibexa AS\n Ibexa AS\n \n \n \n \n 593\n 1\n PUBLISHED\n 2023-04-03T13:09:40+02:00\n \n 2023-04-03T13:09:40+02:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n Ibexa AS\n \n \n \n \n \n 295\n active\n eng-GB\n ibexa_boolean\n true\n \n \n 296\n name\n eng-GB\n ibexa_string\n Ibexa AS\n \n \n 297\n vat\n eng-GB\n ibexa_string\n 123 456 789\n \n \n 298\n website\n eng-GB\n ibexa_string\n https://ibexa.co\n \n \n 299\n customer_group\n eng-GB\n ibexa_customer_group\n \n 1\n \n \n \n 300\n sales_rep\n eng-GB\n ibexa_object_relation\n \n 14\n /api/ibexa/v2/content/objects/14\n \n \n \n 301\n contact\n eng-GB\n ibexa_object_relation\n \n 74\n /api/ibexa/v2/content/objects/74\n \n \n \n 302\n default_address\n eng-GB\n ibexa_object_relation\n \n 69\n /api/ibexa/v2/content/objects/69\n \n \n \n 303\n billing_address\n eng-GB\n ibexa_address\n \n HQ\n PL\n \n Silesia\n Katowice\n Gliwicka 6/5\n 40-079\n company@email.invalid\n +48 000 000 000\n \n \n \n \n 305\n members\n eng-GB\n ibexa_object_relation\n \n 67\n /api/ibexa/v2/content/objects/67\n \n \n \n 304\n address_book\n eng-GB\n ibexa_object_relation\n \n 68\n /api/ibexa/v2/content/objects/68\n \n \n \n \n \n /placeholder\n \n \n image/svg+xml\n \n \n \n
\n \n \n \n 2023-04-03T13:09:40+02:00\n 2023-03-31T14:33:36+02:00\n eng-GB\n 1\n true\n false\n PUBLISHED\n \n \n HQ, Poland\n 74\n 80\n 69\n 68\n 67\n \n \n /1/65/67/\n 1\n\n" } } + }, + "400": { + "description": "Error - the input does not match the input schema definition." + }, + "401": { + "description": "Error - the user is not authorized to create this company." } }, - "summary": "Root Resource", - "description": "Provides basic information about Corporate Account endpoints and configuration.", - "parameters": [], - "deprecated": false, - "x-badges": [ + "summary": "Update a company", + "description": "Updates a company. 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.", + "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": "companyId", + "in": "path", + "description": "CompanyUpdateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } - ] + ], + "requestBody": { + "description": "The company input schema encoded in XML or JSON.", + "content": { + "application/vnd.ibexa.api.CompanyUpdate+json": { + "schema": { + "$ref": "#/components/schemas/CompanyUpdateWrapper" + }, + "example": { + "CompanyUpdate": { + "fields": { + "field": [ + { + "fieldDefinitionIdentifier": "contact", + "fieldValue": { + "destinationContentId": 144 + } + } + ] + } + } + } + }, + "application/vnd.ibexa.api.CompanyUpdate+xml": { + "schema": { + "$ref": "#/components/schemas/CompanyUpdate" + }, + "example": "\n\n \n \n contact\n \n 144\n \n \n \n\n" + } + }, + "required": false + } } }, - "/corporate/companies": { + "/corporate/companies/{companyId}/members": { "get": { - "operationId": "ibexa.rest.corporate_account.companies.list", + "operationId": "ibexa.rest.corporate_account.members.list", "tags": [ "Corporate Account" ], "responses": { "200": { - "description": "Company list containing Company objects.", + "description": "If set, helps to determine response format.", "content": { - "application/vnd.ibexa.api.CompanyList+json": { + "application/vnd.ibexa.api.MemberList+json": { "schema": { - "$ref": "#/components/schemas/CompanyListWrapper" + "$ref": "#/components/schemas/MemberListWrapper" }, "example": { - "CompanyList": { - "_media-type": "application/vnd.ibexa.api.CompanyList+json", - "companies": [ + "MemberList": { + "_media-type": "application/vnd.ibexa.api.MemberList+json", + "_href": "/api/ibexa/v2/corporate/companies/139/members", + "members": [ { - "_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.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/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" - } - ] + "_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" + } }, - "names": { - "value": [ + "Fields": { + "field": [ { - "_languageCode": "eng-GB", - "#text": "Ibexa AS" + "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" + } } ] }, - "Content": { - "_media-type": "application/vnd.ibexa.api.ContentInfo+json", - "_href": "/api/ibexa/v2/content/objects/66" + "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" } - }, - "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/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/67" + "_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/66/locations" + "_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" }, - "lastModificationDate": "2023-04-03T13:09:40+02:00", - "publishedDate": "2023-03-31T14:33:36+02:00", + "publishDate": "2023-04-28T16:10:03+02:00", + "lastModificationDate": "2023-04-28T16:17:07+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": { + "Version": { "_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" + "_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" }, - "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" - } - ] + { + "id": 699, + "fieldDefinitionIdentifier": "last_name", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_string", + "fieldValue": "Kowalski" }, - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "QNTM Group AB" - } - ] + { + "id": 700, + "fieldDefinitionIdentifier": "phone_number", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_string", + "fieldValue": "+48 123 123 456" }, - "Content": { - "_media-type": "application/vnd.ibexa.api.ContentInfo+json", - "_href": "/api/ibexa/v2/content/objects/75" + { + "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 + } } - }, - "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" - } + ] + }, + "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" } }, - "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" + "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" }, - "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" + "Roles": { + "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", + "_href": "/api/ibexa/v2/user/users/144/roles" } }, - "billingAddress": { - "name": null, - "country": null, - "fields": [] - }, - "contactId": null, - "salesRepresentativeId": 14, - "defaultAddressId": null, - "addressBookId": 77, - "membersId": 76, - "MemberList": { - "_media-type": "application/vnd.ibexa.api.MemberList+json", - "_href": "/api/ibexa/v2/corporate/companies/75/members" - }, - "Location": { - "_media-type": "application/vnd.ibexa.api.Location+json", - "_href": "/api/ibexa/v2/content/locations/1/65/76" - }, - "locationPath": "/1/65/76/", - "isActive": true + "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.CompanyList+xml": { + "application/vnd.ibexa.api.MemberList+xml": { "schema": { - "$ref": "#/components/schemas/CompanyList" + "$ref": "#/components/schemas/MemberList" }, - "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 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", + "description": "Returned when invalid Criterion or Sort clause is used.", "content": { "application/vnd.ibexa.api.ErrorMessage": { "schema": { @@ -4992,282 +4810,561 @@ } } } + }, + "404": { + "description": "Error - The identifier do not match any company." } }, - "summary": "Read list of companies", - "description": "Returns paginated list of available companies.", - "parameters": [], - "deprecated": false, - "x-badges": [ + "summary": "Read list of company members", + "description": "Returns paginated list of a given company members.", + "parameters": [ + { + "name": "companyId", + "in": "path", + "description": "MembersLoadByCompanyIdController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "filter[DateMetadataCriterion][Target]", + "in": "query", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "string", + "enum": [ + "created", + "modified", + "published" + ] + }, + "style": "form", + "explode": false + }, + { + "name": "filter[DateMetadataCriterion][Operator]", + "in": "query", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "string", + "enum": [ + "eq", + "gt", + "gte", + "lt", + "lte" + ] + }, + "style": "form", + "explode": false + }, + { + "name": "filter[DateMetadataCriterion][Value]", + "in": "query", + "description": "DateTime as a UNIX timestamp", + "required": false, + "deprecated": false, + "schema": { + "type": "integer" + }, + "style": "form", + "explode": false + }, + { + "name": "sort[ContentName]", + "in": "query", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "string", + "enum": [ + "ascending", + "descending" + ] + }, + "style": "form", + "explode": false + }, + { + "name": "sort[DatePublished]", + "in": "query", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "string", + "enum": [ + "ascending", + "descending" + ] + }, + "style": "form", + "explode": false + }, { - "name": "Experience", - "color": "#D3822B" + "name": "sort[DateModified]", + "in": "query", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "string", + "enum": [ + "ascending", + "descending" + ] + }, + "style": "form", + "explode": false + }, + { + "name": "offset", + "in": "query", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "integer" + }, + "style": "form", + "explode": false }, { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "name": "limit", + "in": "query", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "integer" + }, + "style": "form", + "explode": false } ] }, "post": { - "operationId": "ibexa.rest.corporate_account.companies.create", + "operationId": "ibexa.rest.corporate_account.members.create", "tags": [ "Corporate Account" ], "responses": { "201": { - "description": "If set, the new company is returned in XML or JSON format.", + "description": "OK - company member created and returned.", "content": { - "application/vnd.ibexa.api.Company+json": { + "application/vnd.ibexa.api.Member+json": { "schema": { - "$ref": "#/components/schemas/CompanyWrapper" + "$ref": "#/components/schemas/MemberWrapper" }, "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": { + "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/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" + "_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" + } }, - "creationDate": "2023-04-03T13:09:40+02:00", - "initialLanguageCode": "eng-GB", - "languageCodes": "eng-GB", - "VersionTranslationInfo": { - "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", - "Language": [ + "Fields": { + "field": [ { - "languageCode": "eng-GB" - } - ] - }, - "names": { - "value": [ + "id": 673, + "fieldDefinitionIdentifier": "active", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_boolean", + "fieldValue": true + }, { - "_languageCode": "eng-GB", - "#text": "Ibexa AS" + "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" + } } ] }, - "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" + "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/67" + "_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/66/locations" + "_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" }, - "lastModificationDate": "2023-04-03T13:09:40+02:00", - "publishedDate": "2023-03-31T14:33:36+02:00", + "publishDate": "2023-04-28T16:10:03+02:00", + "lastModificationDate": "2023-04-28T16:17:07+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" + "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" } }, - "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" + "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" } - }, - "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": { + "application/vnd.ibexa.api.Member+xml": { "schema": { - "$ref": "#/components/schemas/Company" + "$ref": "#/components/schemas/Member" }, - "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 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" } } }, @@ -5275,11 +5372,11 @@ "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 a company member." } }, - "summary": "Create a company", - "description": "Creates a CompanyCreateController resource.", + "summary": "Create a company member", + "description": "Creates a company member.", "parameters": [ { "name": "X-CSRF-Token", @@ -5287,356 +5384,485 @@ "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 + "explode": false + }, + { + "name": "companyId", + "in": "path", + "description": "MemberCreateController 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 MemberCreate schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.CompanyCreate+json": { + "application/vnd.ibexa.api.MemberCreate+json": { "schema": { - "$ref": "#/components/schemas/CompanyCreateWrapper" + "$ref": "#/components/schemas/MemberCreateWrapper" }, "example": { - "CompanyCreate": { + "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": "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": "first_name", + "fieldValue": "Jay" }, { - "fieldDefinitionIdentifier": "sales_rep", - "fieldValue": { - "destinationContentId": 14 - } + "fieldDefinitionIdentifier": "last_name", + "fieldValue": "Kowalski" }, { - "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" - } - } + "fieldDefinitionIdentifier": "phone_number", + "fieldValue": "+48 123 123 456" } ] } } } }, - "application/vnd.ibexa.api.CompanyCreate+xml": { + "application/vnd.ibexa.api.MemberCreate+xml": { "schema": { - "$ref": "#/components/schemas/CompanyCreate" + "$ref": "#/components/schemas/MemberCreate" }, - "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 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}": { + "/corporate/companies/{companyId}/members/{memberId}": { "get": { - "operationId": "ibexa.rest.corporate_account.companies.get", + "operationId": "ibexa.rest.corporate_account.members.get", "tags": [ "Corporate Account" ], "responses": { "200": { - "description": "If set, the company is returned in XML or JSON format.", + "description": "If set, the company member is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Company+json": { + "application/vnd.ibexa.api.Member+json": { "schema": { - "$ref": "#/components/schemas/CompanyWrapper" + "$ref": "#/components/schemas/MemberWrapper" }, "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": { + "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/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" + "_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" + } }, - "creationDate": "2023-04-03T13:09:40+02:00", - "initialLanguageCode": "eng-GB", - "languageCodes": "eng-GB", - "VersionTranslationInfo": { - "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", - "Language": [ + "Fields": { + "field": [ { - "languageCode": "eng-GB" - } - ] - }, - "names": { - "value": [ + "id": 673, + "fieldDefinitionIdentifier": "active", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_boolean", + "fieldValue": true + }, { - "_languageCode": "eng-GB", - "#text": "Ibexa AS" + "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" + } } ] }, - "Content": { - "_media-type": "application/vnd.ibexa.api.ContentInfo+json", - "_href": "/api/ibexa/v2/content/objects/66" + "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" } - }, - "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/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/67" + "_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/66/locations" + "_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" }, - "lastModificationDate": "2023-04-03T13:09:40+02:00", - "publishedDate": "2023-03-31T14:33:36+02:00", + "publishDate": "2023-04-28T16:10:03+02:00", + "lastModificationDate": "2023-04-28T16:17:07+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" + "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" } }, - "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" + "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" } - }, - "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": { + "application/vnd.ibexa.api.Member+xml": { "schema": { - "$ref": "#/components/schemas/Company" + "$ref": "#/components/schemas/Member" }, - "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 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" } } }, @@ -5647,69 +5873,53 @@ "description": "Error - The company does not exist." } }, - "summary": "Get company", - "description": "Returns the company by given company ID.", + "summary": "Get company member", + "description": "Returns the company member by given member ID.", "parameters": [ { - "name": "If-None-match", - "in": "header", - "description": "ETag", - "required": false, + "name": "companyId", + "in": "path", + "description": "MemberLoadByIdController identifier", + "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "companyId", + "name": "memberId", "in": "path", - "description": "", + "description": "MemberLoadByIdController 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.companies.delete", + "operationId": "ibexa.rest.corporate_account.members.delete", "tags": [ "Corporate Account" ], "responses": { "204": { - "description": "No Content - given company is deleted." + "description": "No Content - given company member is deleted." }, "401": { - "description": "Error - the user is not authorized to delete this company." + "description": "Error - the user is not authorized to delete this company member." }, "404": { - "description": "Error - the company does not exist." + "description": "Error - the company member does not exist." } }, - "summary": "Delete company", - "description": "The given company is deleted.", + "summary": "Delete company member", + "description": "The given company member is deleted.", "parameters": [ { "name": "X-CSRF-Token", @@ -5717,300 +5927,451 @@ "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 + "explode": false }, { "name": "companyId", "in": "path", - "description": "", + "description": "MemberDeleteController 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": "memberId", + "in": "path", + "description": "MemberDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] }, "patch": { - "operationId": "ibexa.rest.corporate_account.companies.update", + "operationId": "ibexa.rest.corporate_account.members.patch", "tags": [ "Corporate Account" ], "responses": { "200": { - "description": "OK - company updated.", + "description": "OK - company member updated.", "content": { - "application/vnd.ibexa.api.Company+json": { + "application/vnd.ibexa.api.Member+json": { "schema": { - "$ref": "#/components/schemas/CompanyWrapper" + "$ref": "#/components/schemas/MemberWrapper" }, "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": { + "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/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" + "_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" + } }, - "creationDate": "2023-04-03T13:09:40+02:00", - "initialLanguageCode": "eng-GB", - "languageCodes": "eng-GB", - "VersionTranslationInfo": { - "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", - "Language": [ + "Fields": { + "field": [ { - "languageCode": "eng-GB" - } - ] - }, - "names": { - "value": [ + "id": 673, + "fieldDefinitionIdentifier": "active", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_boolean", + "fieldValue": true + }, { - "_languageCode": "eng-GB", - "#text": "Ibexa AS" + "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" + } } ] }, - "Content": { - "_media-type": "application/vnd.ibexa.api.ContentInfo+json", - "_href": "/api/ibexa/v2/content/objects/66" + "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" } - }, - "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/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/67" + "_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/66/locations" + "_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" }, - "lastModificationDate": "2023-04-03T13:09:40+02:00", - "publishedDate": "2023-03-31T14:33:36+02:00", + "publishDate": "2023-04-28T16:10:03+02:00", + "lastModificationDate": "2023-04-28T16:17:07+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" + "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" + } }, - "locationPath": "/1/65/67/", - "isActive": true + "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.Company+xml": { + "application/vnd.ibexa.api.Member+xml": { "schema": { - "$ref": "#/components/schemas/Company" + "$ref": "#/components/schemas/Member" }, - "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 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" } } }, @@ -6018,11 +6379,11 @@ "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 this company member." } }, - "summary": "Update a company", - "description": "Updates a company. PATCH or POST with header X-HTTP-Method-Override PATCH.", + "summary": "Update a company member", + "description": "Updates a company member. PATCH or POST with header X-HTTP-Method-Override PATCH.", "parameters": [ { "name": "X-CSRF-Token", @@ -6030,13 +6391,11 @@ "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 + "explode": false }, { "name": "If-Match", @@ -6044,499 +6403,264 @@ "description": "ETag", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "companyId", "in": "path", - "description": "", + "description": "MemberUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + }, + { + "name": "memberId", + "in": "path", + "description": "MemberUpdateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ], "requestBody": { "description": "The company input schema encoded in XML or JSON.", "content": { - "application/vnd.ibexa.api.CompanyUpdate+json": { + "application/vnd.ibexa.api.MemberUpdate+json": { "schema": { - "$ref": "#/components/schemas/CompanyUpdateWrapper" + "$ref": "#/components/schemas/MemberUpdateWrapper" }, "example": { - "CompanyUpdate": { + "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": "contact", - "fieldValue": { - "destinationContentId": 144 - } + "fieldDefinitionIdentifier": "first_name", + "fieldValue": "Jay" + }, + { + "fieldDefinitionIdentifier": "last_name", + "fieldValue": "Kowalski" + }, + { + "fieldDefinitionIdentifier": "phone_number", + "fieldValue": "+48 123 123 456" } ] } } } }, - "application/vnd.ibexa.api.CompanyUpdate+xml": { + "application/vnd.ibexa.api.MemberUpdate+xml": { "schema": { - "$ref": "#/components/schemas/CompanyUpdate" + "$ref": "#/components/schemas/MemberUpdate" }, - "example": "\n\n \n \n contact\n \n 144\n \n \n \n\n" + "example": "\n\n jay.kowalski@updated.email\n Publish123#\n false\n 5\n \n \n \n first_name\n Jay\n \n \n last_name\n Kowalski\n \n \n phone_number\n +48 123 123 456\n \n \n\n" } }, "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Experience", - "color": "#D3822B" - }, - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] + } } }, - "/corporate/companies/{companyId}/members": { + "/corporate/sales-representatives": { "get": { - "operationId": "ibexa.rest.corporate_account.members.list", + "operationId": "ibexa.rest.corporate_account.sales_representatives.get", "tags": [ "Corporate Account" ], "responses": { "200": { - "description": "If set, helps to determine response format.", + "description": "Sales representatives list containing Company objects.", "content": { - "application/vnd.ibexa.api.MemberList+json": { + "application/vnd.ibexa.api.SalesRepresentativesList+json": { "schema": { - "$ref": "#/components/schemas/MemberListWrapper" + "$ref": "#/components/schemas/SalesRepresentativesListWrapper" }, "example": { - "MemberList": { - "_media-type": "application/vnd.ibexa.api.MemberList+json", - "_href": "/api/ibexa/v2/corporate/companies/139/members", - "members": [ + "SalesRepresentativesList": { + "_media-type": "application/vnd.ibexa.api.SalesRepresentativesList+json", + "users": [ { - "_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" + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/75", + "_id": 75, + "_remoteId": "f262e2fa12ae105b78a1b654e87a0874", + "ContentType": { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/4" + }, + "name": "John Black", + "Versions": { + "_media-type": "application/vnd.ibexa.api.VersionList+json", + "_href": "/api/ibexa/v2/content/objects/75/versions" + }, + "Section": { + "_media-type": "application/vnd.ibexa.api.Section+json", + "_href": "/api/ibexa/v2/content/sections/10" + }, + "MainLocation": { + "_media-type": "application/vnd.ibexa.api.Location+json", + "_href": "/api/ibexa/v2/content/locations/1/5/64/76" + }, + "Locations": { + "_media-type": "application/vnd.ibexa.api.LocationList+json", + "_href": "/api/ibexa/v2/content/objects/75/locations" + }, + "Groups": { + "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", + "_href": "/api/ibexa/v2/user/users/75/groups" + }, + "Owner": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "publishDate": "2023-06-20T07:33:17+00:00", + "lastModificationDate": "2023-06-20T07:33:17+00:00", + "mainLanguageCode": "eng-GB", + "alwaysAvailable": true, + "Version": { + "_media-type": "application/vnd.ibexa.api.Version+json", + "_href": "/api/ibexa/v2/content/objects/75/versions/1", + "VersionInfo": { + "id": 536, + "versionNo": 1, + "status": "PUBLISHED", + "modificationDate": "2023-06-20T07:33:17+00:00", + "Creator": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" }, - "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" + "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" } - } - }, - "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" + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "John Black" + } + ] }, - "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" + "Content": { + "_media-type": "application/vnd.ibexa.api.ContentInfo+json", + "_href": "/api/ibexa/v2/content/objects/75" } }, - "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" + "Fields": { + "field": [ + { + "id": 339, + "fieldDefinitionIdentifier": "first_name", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_string", + "fieldValue": "John" }, - "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" - } - ] + { + "id": 340, + "fieldDefinitionIdentifier": "last_name", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_string", + "fieldValue": "Black" }, - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Jay Kowalski" - } - ] + { + "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 + } }, - "Content": { - "_media-type": "application/vnd.ibexa.api.ContentInfo+json", - "_href": "/api/ibexa/v2/content/objects/144" + { + "id": 342, + "fieldDefinitionIdentifier": "signature", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_text", + "fieldValue": null + }, + { + "id": 343, + "fieldDefinitionIdentifier": "image", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_image", + "fieldValue": null } - }, - "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" + "Relations": { + "_media-type": "application/vnd.ibexa.api.RelationList+json", + "_href": "/api/ibexa/v2/content/objects/75/versions/1/relations", + "Relation": [] }, - "Roles": { - "_media-type": "application/vnd.ibexa.api.RoleAssignmentList+json", - "_href": "/api/ibexa/v2/user/users/144/roles" + "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" } }, - "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" - } + "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.MemberList+xml": { + "application/vnd.ibexa.api.SalesRepresentativesList+xml": { "schema": { - "$ref": "#/components/schemas/MemberList" + "$ref": "#/components/schemas/SalesRepresentativesList" }, - "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" + "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" } } }, - "400": { - "description": "Returned when invalid Criterion or Sort clause is used.", + "401": { + "description": "Error - the user is not authorized to read Sales Representatives List.", "content": { "application/vnd.ibexa.api.ErrorMessage": { "schema": { @@ -6544,1674 +6668,1155 @@ } } } - }, - "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.", + "summary": "Read list of sales representatives", + "description": "Returns paginated list of available sales representatives.", + "parameters": [] + } + }, + "/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": "\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": [] + } + }, + "/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": "\n\n 2\n eng-GB\n English (United Kingdom)\n\n" + } + } + } + }, + "summary": "Get language", + "description": "Retrieves a LanguageLoadByIdController resource.", "parameters": [ { - "name": "companyId", + "name": "code", "in": "path", - "description": "", + "description": "LanguageLoadByIdController identifier", "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", + } + }, + "/content/locations": { + "get": { + "operationId": "ibexa.rest.redirect_location", "tags": [ - "Corporate Account" + "Location" ], "responses": { - "201": { - "description": "OK - company member created and returned.", + "200": { + "description": "OK - returns the LocationList in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Member+json": { + "application/vnd.ibexa.api.LocationList+json": { "schema": { - "$ref": "#/components/schemas/MemberWrapper" + "$ref": "#/components/schemas/LocationWrapper" }, "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.", + "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.Content+json", - "_href": "/api/ibexa/v2/content/objects/139", - "_remoteId": "b16d06d4c5ba7c37b26fa167b551dfc2", - "_id": 139, + "_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/48" + "_href": "/api/ibexa/v2/content/types/1" }, - "Name": "Ibexa Sp. z o. o.", - "TranslatedName": "Ibexa Sp. z o. o.", + "Name": "All Tips", + "TranslatedName": "All Tips", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", - "_href": "/api/ibexa/v2/content/objects/139/versions" + "_href": "/api/ibexa/v2/content/objects/57/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" - } - } + "_href": "/api/ibexa/v2/content/objects/57/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/65/140" + "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", - "_href": "/api/ibexa/v2/content/objects/139/locations" + "_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": "2023-04-28T16:10:13+02:00", - "publishedDate": "2023-04-28T15:44:55+02:00", + "lastModificationDate": "2021-06-28T11:22:52+00:00", + "publishedDate": "2021-06-28T11:22:52+00:00", "mainLanguageCode": "eng-GB", - "currentVersionNo": 6, + "currentVersionNo": 1, "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" + "_href": "/api/ibexa/v2/content/objects/57/objectstates" } - }, - "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 + } + } + } + } + }, + "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" + } + } + }, + "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": [] + } + }, + "/content/locations/{path}": { + "get": { + "operationId": "ibexa.rest.load_location", + "tags": [ + "Location" + ], + "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" }, - "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" - } + "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" }, - "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 - } - } - ] + "Name": "All Tips", + "TranslatedName": "All Tips", + "Versions": { + "_media-type": "application/vnd.ibexa.api.VersionList+json", + "_href": "/api/ibexa/v2/content/objects/57/versions" }, - "Relations": { - "_media-type": "application/vnd.ibexa.api.RelationList+json", - "_href": "/api/ibexa/v2/content/objects/144/versions/6/relations", - "Relation": [] + "CurrentVersion": { + "_media-type": "application/vnd.ibexa.api.Version+json", + "_href": "/api/ibexa/v2/content/objects/57/currentversion" }, - "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" + "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" } - }, - "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": { + "application/vnd.ibexa.api.Location+xml": { "schema": { - "$ref": "#/components/schemas/Member" + "$ref": "#/components/schemas/Location" }, - "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 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" } } }, - "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 Location." + }, + "404": { + "description": "Error - the Location with the given path does not exist." } }, - "summary": "Create a company member", - "description": "Creates a company member.", + "summary": "Load Location", + "description": "Loads the Location for the given path e.g. '/content/locations/1/2/61'.", "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": "ETag", + "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "companyId", + "name": "path", "in": "path", - "description": "", + "description": "LocationLoadByPathController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } + ] + }, + "delete": { + "operationId": "ibexa.rest.delete_subtree", + "tags": [ + "Location" ], - "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" - } + "responses": { + "204": { + "description": "No Content - deleted." }, - "required": false + "401": { + "description": "Error - the user is not authorized to delete this subtree." + }, + "404": { + "description": "Error - the Location with the given ID does not exist." + } }, - "deprecated": false, - "x-badges": [ + "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": "Experience", - "color": "#D3822B" + "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": "Commerce", - "color": "#A32768", - "position": "after" + "name": "path", + "in": "path", + "description": "LocationSubtreeDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] - } - }, - "/corporate/companies/{companyId}/members/{memberId}": { - "get": { - "operationId": "ibexa.rest.corporate_account.members.get", + }, + "patch": { + "operationId": "ibexa.rest.update_location", "tags": [ - "Corporate Account" + "Location" ], "responses": { "200": { - "description": "If set, the company member is returned in XML or JSON format.", + "description": "If set, the Location is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Member+json": { + "application/vnd.ibexa.api.Location+json": { "schema": { - "$ref": "#/components/schemas/MemberWrapper" + "$ref": "#/components/schemas/LocationWrapper" }, "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.", + "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.Content+json", - "_href": "/api/ibexa/v2/content/objects/139", - "_remoteId": "b16d06d4c5ba7c37b26fa167b551dfc2", - "_id": 139, + "_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/48" + "_href": "/api/ibexa/v2/content/types/1" }, - "Name": "Ibexa Sp. z o. o.", - "TranslatedName": "Ibexa Sp. z o. o.", + "Name": "Dog Breed Catalog", + "TranslatedName": "Dog Breed Catalog", "Versions": { "_media-type": "application/vnd.ibexa.api.VersionList+json", - "_href": "/api/ibexa/v2/content/objects/139/versions" + "_href": "/api/ibexa/v2/content/objects/58/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" - } - } + "_href": "/api/ibexa/v2/content/objects/58/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/65/140" + "_href": "/api/ibexa/v2/content/sections/1" }, "Locations": { "_media-type": "application/vnd.ibexa.api.LocationList+json", - "_href": "/api/ibexa/v2/content/objects/139/locations" + "_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": "2023-04-28T16:10:13+02:00", - "publishedDate": "2023-04-28T15:44:55+02:00", + "lastModificationDate": "2021-06-28T11:23:10+00:00", + "publishedDate": "2021-06-28T11:23:10+00:00", "mainLanguageCode": "eng-GB", - "currentVersionNo": 6, + "currentVersionNo": 1, "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" + "_href": "/api/ibexa/v2/content/objects/58/objectstates" } - }, - "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": { + "application/vnd.ibexa.api.Location+xml": { "schema": { - "$ref": "#/components/schemas/Member" + "$ref": "#/components/schemas/Location" }, - "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 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 read this company." + "description": "Error - the user is not authorized to update this Location." }, "404": { - "description": "Error - The company does not exist." + "description": "Error - the Location with the given ID does not exist." } }, - "summary": "Get company member", - "description": "Returns the company member by given member ID.", + "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": "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", - "in": "path", - "description": "", + "name": "If-Match", + "in": "header", + "description": "ETag", "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": "path", + "in": "path", + "description": "LocationUpdateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } - ] - }, - "delete": { - "operationId": "ibexa.rest.corporate_account.members.delete", + ], + "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 + } + } + }, + "/content/locations/{path}/children": { + "get": { + "operationId": "ibexa.rest.load_location_children", "tags": [ - "Corporate Account" + "Location" ], "responses": { - "204": { - "description": "No Content - given company member is deleted." + "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" + } + } }, "401": { - "description": "Error - the user is not authorized to delete this company member." + "description": "Error - the user is not authorized to read this content item." }, "404": { - "description": "Error - the company member does not exist." + "description": "Error - the content item with the given ID does not exist." } }, - "summary": "Delete company member", - "description": "The given company member is deleted.", + "summary": "Get child Locations.", + "description": "Loads all child Locations for the given parent Location.", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session.", + "name": "path", + "in": "path", + "description": "LocationChildrenListController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": 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": "\n\n \n \n\n" + } + } + }, + "400": { + "description": "Error - The user has no permission to read URL aliases." }, + "401": { + "description": "Error - The Location was not found." + } + }, + "summary": "List URL aliases for Location", + "description": "Returns the list of URL aliases for a Location.", + "parameters": [ { - "name": "companyId", + "name": "path", "in": "path", - "description": "", + "description": "URLAliasListLocationController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + } + ] + } + }, + "/content/objectstategroups": { + "get": { + "operationId": "ibexa.rest.load_object_state_groups", + "tags": [ + "Object State Groups" + ], + "responses": { + "200": { + "description": "OK - returns a list of Object state groups.", + "content": { + "application/vnd.ibexa.api.ObjectStateGroupList+json": { + "schema": { + "$ref": "#/components/schemas/ObjectStateGroupListWrapper" + }, + "example": { + "ObjectStateGroupList": { + "_media-type": "application/vnd.ibexa.api.ObjectStateGroupList+json", + "_href": "/api/ibexa/v2/content/objectstategroups", + "ObjectStateGroup": [ + { + "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", + "_href": "/api/ibexa/v2/content/objectstategroups/2", + "id": 2, + "identifier": "ibexa_lock", + "defaultLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "ObjectStates": { + "_media-type": "application/vnd.ibexa.api.ObjectStateList+json", + "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates" + }, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Lock" + } + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "" + } + ] + } + }, + { + "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", + "_href": "/api/ibexa/v2/content/objectstategroups/3", + "id": 3, + "identifier": "accessibility", + "defaultLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "ObjectStates": { + "_media-type": "application/vnd.ibexa.api.ObjectStateList+json", + "_href": "/api/ibexa/v2/content/objectstategroups/3/objectstates" + }, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Accessibility" + } + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "" + } + ] + } + }, + { + "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", + "_href": "/api/ibexa/v2/content/objectstategroups/6", + "id": 6, + "identifier": "custom-states", + "defaultLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "ObjectStates": { + "_media-type": "application/vnd.ibexa.api.ObjectStateList+json", + "_href": "/api/ibexa/v2/content/objectstategroups/6/objectstates" + }, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Custom State" + } + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Custom Object state" + } + ] + } + } + ] + } + } + }, + "application/vnd.ibexa.api.ObjectStateGroupList+xml": { + "schema": { + "$ref": "#/components/schemas/ObjectStateGroupList" + }, + "example": "\n\n \n 2\n ibexa_lock\n eng-GB\n eng-GB\n \n \n Lock\n \n \n \n \n \n \n 3\n accessibility\n eng-GB\n eng-GB\n \n \n Accessibility\n \n \n \n \n \n \n 6\n custom-states\n eng-GB\n eng-GB\n \n \n Custom State\n \n \n Custom Object state\n \n \n\n" + } + } }, + "401": { + "description": "Error - The user has no permission to read Object state groups." + } + }, + "summary": "List Object state groups", + "description": "Returns a list of all Object state groups.", + "parameters": [ { - "name": "memberId", + "name": "If-None-Match", + "in": "header", + "description": "ETag", + "required": false, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": 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": { + "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." + } + }, + "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, + "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.ObjectStateGroupCreate+json": { + "schema": { + "$ref": "#/components/schemas/ObjectStateGroupCreateWrapper" + }, + "example": { + "ObjectStateGroupCreate": { + "identifier": "custom-states", + "defaultLanguageCode": "eng-GB", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Custom State" + } + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Custom Object state" + } + ] + } + } + } + }, + "application/vnd.ibexa.api.ObjectStateGroupCreate+xml": { + "schema": { + "$ref": "#/components/schemas/ObjectStateGroupCreate" + }, + "example": "\n\n custom\n eng-GB\n \n Custom State\n \n \n Custom Object state\n \n" + } + }, + "required": false + } + } + }, + "/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, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "objectStateGroupId", "in": "path", - "description": "", + "description": "ObjectStateGroupLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } + ] + }, + "delete": { + "operationId": "ibexa.rest.delete_object_state_group", + "tags": [ + "Object State Groups" ], - "deprecated": false, - "x-badges": [ + "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": "Experience", - "color": "#D3822B" + "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": "Commerce", - "color": "#A32768", - "position": "after" + "name": "objectStateGroupId", + "in": "path", + "description": "ObjectStateGroupDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] }, "patch": { - "operationId": "ibexa.rest.corporate_account.members.patch", + "operationId": "ibexa.rest.update_object_state_group", "tags": [ - "Corporate Account" + "Object State Groups" ], "responses": { "200": { - "description": "OK - company member updated.", + "description": "OK - Object stated group updated.", "content": { - "application/vnd.ibexa.api.Member+json": { + "application/vnd.ibexa.api.ObjectStateGroup+json": { "schema": { - "$ref": "#/components/schemas/MemberWrapper" + "$ref": "#/components/schemas/ObjectStateGroupWrapper" }, "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 + "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" }, - "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" + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "New Custom State name" } - }, - "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" - } + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Custom Object state" + } + ] } } } }, - "application/vnd.ibexa.api.Member+xml": { + "application/vnd.ibexa.api.ObjectStateGroup+xml": { "schema": { - "$ref": "#/components/schemas/Member" + "$ref": "#/components/schemas/ObjectStateGroup" }, - "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 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." + "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 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 a company member", - "description": "Updates a company member. PATCH or POST with header X-HTTP-Method-Override PATCH.", + "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": "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", @@ -8219,1696 +7824,1207 @@ "description": "ETag", "required": true, "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "companyId", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "memberId", + "name": "objectStateGroupId", "in": "path", - "description": "", + "description": "ObjectStateGroupUpdateController 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.", + "description": "The Object state group input schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.MemberUpdate+json": { + "application/vnd.ibexa.api.ObjectStateGroupUpdate+json": { "schema": { - "$ref": "#/components/schemas/MemberUpdateWrapper" + "$ref": "#/components/schemas/ObjectStateGroupUpdateWrapper" }, "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" - }, + "ObjectStateGroupUpdate": { + "names": { + "value": [ { - "fieldDefinitionIdentifier": "phone_number", - "fieldValue": "+48 123 123 456" + "_languageCode": "eng-GB", + "#text": "New Custom State name" } ] } } } }, - "application/vnd.ibexa.api.MemberUpdate+xml": { + "application/vnd.ibexa.api.ObjectStateGroupUpdate+xml": { "schema": { - "$ref": "#/components/schemas/MemberUpdate" + "$ref": "#/components/schemas/ObjectStateGroupUpdate" }, - "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" + "example": "\n\n \n New Custom State name\n \n\n" } }, "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Experience", - "color": "#D3822B" - }, - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] + } } }, - "/corporate/sales-representatives": { + "/content/objectstategroups/{objectStateGroupId}/objectstates": { "get": { - "operationId": "ibexa.rest.corporate_account.sales_representatives.get", + "operationId": "ibexa.rest.load_object_states", "tags": [ - "Corporate Account" + "Object State Groups" ], "responses": { "200": { - "description": "Sales representatives list containing Company objects.", + "description": "OK - returns a list of Object states.", "content": { - "application/vnd.ibexa.api.SalesRepresentativesList+json": { + "application/vnd.ibexa.api.ObjectStateList+json": { "schema": { - "$ref": "#/components/schemas/SalesRepresentativesListWrapper" + "$ref": "#/components/schemas/ObjectStateListWrapper" }, "example": { - "SalesRepresentativesList": { - "_media-type": "application/vnd.ibexa.api.SalesRepresentativesList+json", - "users": [ + "ObjectStateList": { + "_media-type": "application/vnd.ibexa.api.ObjectStateList+json", + "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates", + "ObjectState": [ { - "_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" + "_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" }, - "Section": { - "_media-type": "application/vnd.ibexa.api.Section+json", - "_href": "/api/ibexa/v2/content/sections/10" - }, - "MainLocation": { - "_media-type": "application/vnd.ibexa.api.Location+json", - "_href": "/api/ibexa/v2/content/locations/1/5/64/76" - }, - "Locations": { - "_media-type": "application/vnd.ibexa.api.LocationList+json", - "_href": "/api/ibexa/v2/content/objects/75/locations" - }, - "Groups": { - "_media-type": "application/vnd.ibexa.api.UserGroupRefList+json", - "_href": "/api/ibexa/v2/user/users/75/groups" - }, - "Owner": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "publishDate": "2023-06-20T07:33:17+00:00", - "lastModificationDate": "2023-06-20T07:33:17+00:00", - "mainLanguageCode": "eng-GB", - "alwaysAvailable": true, - "Version": { - "_media-type": "application/vnd.ibexa.api.Version+json", - "_href": "/api/ibexa/v2/content/objects/75/versions/1", - "VersionInfo": { - "id": 536, - "versionNo": 1, - "status": "PUBLISHED", - "modificationDate": "2023-06-20T07:33:17+00:00", - "Creator": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "creationDate": "2023-06-20T07:33:17+00:00", - "initialLanguageCode": "eng-GB", - "languageCodes": "eng-GB", - "VersionTranslationInfo": { - "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", - "Language": [ - { - "languageCode": "eng-GB" - } - ] - }, - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "John Black" - } - ] - }, - "Content": { - "_media-type": "application/vnd.ibexa.api.ContentInfo+json", - "_href": "/api/ibexa/v2/content/objects/75" + "defaultLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Not locked" } - }, - "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" + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "" + } + ] } - } - ] - } - } - }, - "application/vnd.ibexa.api.SalesRepresentativesList+xml": { - "schema": { - "$ref": "#/components/schemas/SalesRepresentativesList" - }, - "example": "\n\n \n \n John Black\n \n
\n \n \n \n \n 2023-06-20T07:33:17+00:00\n 2023-06-20T07:33:17+00:00\n eng-GB\n true\n \n \n 536\n 1\n PUBLISHED\n 2023-06-20T07:33:17+00:00\n \n 2023-06-20T07:33:17+00:00\n eng-GB\n eng-GB\n \n \n eng-GB\n \n \n \n John Black\n \n \n \n \n \n 339\n first_name\n eng-GB\n ibexa_string\n John\n \n \n 340\n last_name\n eng-GB\n ibexa_string\n Black\n \n \n 341\n user_account\n eng-GB\n ibexa_user\n \n true\n 75\n John Black\n j.black@ibexa.co\n 1687246397\n true\n 0\n \n \n \n \n 342\n signature\n eng-GB\n ibexa_text\n \n \n \n 343\n image\n eng-GB\n ibexa_image\n \n \n \n \n \n /user/default_profile_image/initials.svg?initials=JB#profile_image\n \n \n image/svg+xml\n \n \n John Black\n j.black@ibexa.co\n true\n \n \n \n\n" - } - } - }, - "401": { - "description": "Error - the user is not authorized to read Sales Representatives List.", - "content": { - "application/vnd.ibexa.api.ErrorMessage": { - "schema": { - "$ref": "#/components/schemas/ErrorMessage" - } - } - } - } - }, - "summary": "Read list of sales representatives", - "description": "Returns paginated list of available sales representatives.", - "parameters": [], - "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", + "_media-type": "application/vnd.ibexa.api.ObjectState+json", + "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates/2", "id": 2, - "identifier": "my_discount_identifier", - "name": "My Discount", - "type": "cart", - "label": "My Discount label", - "labelDescription": "My Discount description", + "identifier": "locked", "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" - } + "ObjectStateGroup": { + "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", + "_href": "/api/ibexa/v2/content/objectstategroups/2" }, - "DiscountConditions": [ - { - "_media-type": "application/vnd.ibexa.api.DiscountCondition.IsInCurrency+json", - "identifier": "is_in_currency", - "expressionValues": { - "currency_code": "PLN" + "defaultLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Locked" } - } - ], - "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" + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "" } - } - ], - "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" - } - ] + ] + } } ] } } + }, + "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": "Get discounts", - "description": "Returns a list of all defined discounts", + "summary": "List Object states", + "description": "Returns a list of all Object states of the given group.", "parameters": [ { - "name": "offset", - "in": "query", - "description": "", + "name": "If-None-Match", + "in": "header", + "description": "ETag", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { - "type": "integer" + "type": "string" }, - "style": "form", - "explode": false, - "allowReserved": false, - "example": 0 + "style": "simple", + "explode": false }, { - "name": "limit", - "in": "query", - "description": "", - "required": false, + "name": "objectStateGroupId", + "in": "path", + "description": "ObjectStateListController identifier", + "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" + "style": "simple", + "explode": false } ] }, "post": { - "operationId": "ibexa.discounts.rest.create", + "operationId": "ibexa.rest.create_object_state", "tags": [ - "Discounts" + "Object State Groups" ], "responses": { - "200": { - "description": "The created discount is returned.", + "201": { + "description": "Object state created.", "content": { - "application/vnd.ibexa.api.Discount+json": { + "application/vnd.ibexa.api.ObjectState+json": { "schema": { - "$ref": "#/components/schemas/Discount" + "$ref": "#/components/schemas/ObjectStateWrapper" }, "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" - } + "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" }, - "DiscountConditions": [ - { - "_media-type": "application/vnd.ibexa.api.DiscountCondition.IsInCurrency+json", - "identifier": "is_in_currency", - "expressionValues": { - "currency_code": "PLN" + "defaultLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "New State" } - } - ], - "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" - } - ] + ] + }, + "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 a discount item." + "description": "Error - The user is not authorized to create an Object state." }, - "406": { - "description": "Error - the input data is not valid." + "403": { + "description": "Error - An Object state with the same identifier already exists in the given group." } }, - "summary": "Create a discount", - "description": "Creates a new discount", + "summary": "Create Object state", + "description": "Creates a new Object state.", "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 + }, + { + "name": "objectStateGroupId", + "in": "path", + "description": "ObjectStateCreateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ], "requestBody": { - "description": "The DiscountCreate schema", + "description": "The Object state input schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.DiscountCreate+json": { + "application/vnd.ibexa.api.ObjectStateCreate+json": { "schema": { - "$ref": "#/components/schemas/DiscountCreate" + "$ref": "#/components/schemas/ObjectStateCreateWrapper" }, "example": { - "DiscountCreate": { - "identifier": "my_discount_identifier", - "type": "cart", - "priority": 1, - "isEnabled": true, - "userId": 14, - "rule": { - "type": "fixed_amount", - "amount": "12" + "ObjectStateCreate": { + "identifier": "new-state", + "priority": "1", + "defaultLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "New State" + } + ] }, - "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" + "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, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] + } } }, - "/discounts/{identifier}": { + "/content/objectstategroups/{objectStateGroupId}/objectstates/{objectStateId}": { "get": { - "operationId": "ibexa.discounts.rest.identifier", + "operationId": "ibexa.rest.load_object_state", "tags": [ - "Discounts" + "Object State Groups" ], "responses": { "200": { - "description": "The discount is returned.", + "description": "OK - returns the Object state.", "content": { - "application/vnd.ibexa.api.Discount+json": { + "application/vnd.ibexa.api.ObjectState+json": { "schema": { - "$ref": "#/components/schemas/Discount" + "$ref": "#/components/schemas/ObjectStateWrapper" }, "example": { - "Discount": { - "_media-type": "application/vnd.ibexa.api.Discount+json", + "ObjectState": { + "_media-type": "application/vnd.ibexa.api.ObjectState+json", + "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates/2", "id": 2, - "identifier": "my_discount_identifier", - "name": "My Discount", - "type": "cart", - "label": "My Discount label", - "labelDescription": "My Discount description", + "identifier": "locked", "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" - } + "ObjectStateGroup": { + "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", + "_href": "/api/ibexa/v2/content/objectstategroups/2" }, - "DiscountConditions": [ - { - "_media-type": "application/vnd.ibexa.api.DiscountCondition.IsInCurrency+json", - "identifier": "is_in_currency", - "expressionValues": { - "currency_code": "PLN" + "defaultLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Locked" } - } - ], - "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" - } - ] + ] + }, + "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" } } }, - "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 user is not authorized to read this Object state." + }, + "404": { + "description": "Error - The Object state 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 state", + "description": "Returns the Object state.", "parameters": [ { - "name": "identifier", + "name": "If-None-Match", + "in": "header", + "description": "ETag", + "required": false, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "objectStateGroupId", "in": "path", - "description": "", + "description": "ObjectStateLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false, - "example": "my_discount_identifier" - } - ], - "deprecated": false, - "x-badges": [ + "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.discounts.rest.delete", + "operationId": "ibexa.rest.delete_object_state", "tags": [ - "Discounts" + "Object State Groups" ], "responses": { "204": { - "description": "The discount is deleted." - }, - "404": { - "description": "Error - a discount of the given unique identifier is not found." + "description": "No Content - Object state deleted." }, "401": { - "description": "Error - the user is not authorized to delete a discount item." + "description": "Error - The user is not authorized to delete an Object state." + }, + "404": { + "description": "Error - The Object state does not exist." } }, - "summary": "Delete a discount item", - "description": "Deletes an existing discount item by its unique identifier", + "summary": "Delete Object state", + "description": "Deletes provided Object state.", "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": "objectStateGroupId", + "in": "path", + "description": "ObjectStateDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false, - "x-badges": [ + "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.discounts.rest.update", + "operationId": "ibexa.rest.update_object_state", "tags": [ - "Discounts" + "Object State Groups" ], "responses": { "200": { - "description": "The updated discount is returned.", + "description": "OK - Object State updated", "content": { - "application/vnd.ibexa.api.Discount+json": { + "application/vnd.ibexa.api.ObjectState+json": { "schema": { - "$ref": "#/components/schemas/Discount" + "$ref": "#/components/schemas/ObjectStateWrapper" }, "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", + "ObjectState": { + "_media-type": "application/vnd.ibexa.api.ObjectState+json", + "_href": "/api/ibexa/v2/content/objectstategroups/6/objectstates/9", + "id": 9, + "identifier": "closed", "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" - } + "ObjectStateGroup": { + "_media-type": "application/vnd.ibexa.api.ObjectStateGroup+json", + "_href": "/api/ibexa/v2/content/objectstategroups/6" }, - "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" - } - ] + "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" } } }, - "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 update the Object state." }, - "406": { - "description": "Error - the input data is not valid." + "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 discount", - "description": "Updates a new discount", + "summary": "Update Object state", + "description": "Updates an Object state. 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 - } - ], - "requestBody": { - "description": "The DiscountUpdate schema", - "content": { - "application/vnd.ibexa.api.DiscountUpdate+json": { - "schema": { - "$ref": "#/components/schemas/DiscountUpdate" - }, - "example": { - "DiscountUpdate": { - "identifier": "my_discount_identifier", - "priority": 1, - "isEnabled": true, - "userId": 14, - "lastContributorId": 14, - "rule": { - "type": "fixed_amount", - "amount": "20" - }, - "conditions": [ - { - "class": "\\Ibexa\\Discounts\\Value\\DiscountCondition\\IsInCurrency", - "parameters": [ - "PLN" - ] - } - ], - "startDate": "2025-08-01 00:00:00", - "endDate": "2025-08-31 23:59:59", - "createdAt": "2025-07-31 12:00:00", - "updatedAt": "2025-07-31 12:10:02", - "translations": [ - { - "languageCode": "eng-GB", - "name": "My Discount", - "description": "My Discount description", - "label": "My Discount label", - "labelDescription": "My Discount description" - } - ], - "context": { - "arbitrary_foo_key": "arbitrary_foo_value", - "arbitrary_bar_key": [ - "arbitrary_bar_value1", - "arbitrary_bar_value2" - ] - } - } - } - } - }, - "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] - } - }, - "/discounts/{identifier}/disable": { - "post": { - "operationId": "ibexa.discounts.rest.disable", - "tags": [ - "Discounts" - ], - "responses": { - "204": { - "description": "The discount is disabled." - }, - "404": { - "description": "Error - a discount of the given unique identifier is not found." + "explode": false }, - "401": { - "description": "Error - the user is not authorized to disable a discount item." - } - }, - "summary": "Disables a discount", - "description": "Disables a discount item by its unique identifier", - "parameters": [ { - "name": "identifier", + "name": "objectStateGroupId", "in": "path", - "description": "", + "description": "ObjectStateUpdateController identifier", "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": "objectStateId", + "in": "path", + "description": "ObjectStateUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "No payload required", - "content": [], + "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, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] + } } }, - "/discounts/{identifier}/enable": { - "post": { - "operationId": "ibexa.discounts.rest.enable", + "/content/objects": { + "get": { + "operationId": "ibexa.rest.redirect_content", "tags": [ - "Discounts" + "Objects" ], "responses": { - "204": { - "description": "The discount is enabled." + "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" + } + } + } }, - "404": { - "description": "Error - a discount of the given unique identifier is not found." + "400": { + "description": "Error - the required `remoteId` query parameter is missing." }, - "401": { - "description": "Error - the user is not authorized to enable a discount item." + "404": { + "description": "Error - the content with the given remote ID does not exist." } }, - "summary": "Enables a discount", - "description": "Enables a discount item by its unique identifier", + "summary": "Load content by remote ID", + "description": "Loads content item for a given remote ID.", "parameters": [ { - "name": "identifier", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false, - "example": "my_discount_identifier" - }, - { - "name": "X-CSRF-Token", - "in": "header", - "description": "CSRF token obtained during the authentication.", + "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 - } - ], - "requestBody": { - "description": "No payload required", - "content": [], - "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "style": "form", + "explode": false } ] - } - }, - "/discounts/{id}": { - "get": { - "operationId": "ibexa.discounts.rest.id", + }, + "post": { + "operationId": "ibexa.rest.create_content", "tags": [ - "Discounts" + "Objects" ], "responses": { - "200": { - "description": "The discount is returned.", + "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.Discount+json": { + "application/vnd.ibexa.api.Content+json": { "schema": { - "$ref": "#/components/schemas/Discount" + "$ref": "#/components/schemas/ContentWrapper" }, "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" - } + "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" }, - "DiscountConditions": [ - { - "_media-type": "application/vnd.ibexa.api.DiscountCondition.IsInCurrency+json", - "identifier": "is_in_currency", - "expressionValues": { - "currency_code": "PLN" + "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" } } - ], - "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" - } - ] + }, + "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" + } } } - } - } - }, - "404": { - "description": "Error - a discount of the given ID is not found." - }, - "401": { - "description": "Error - the user is not authorized to read this discount item." - } - }, - "summary": "Get a discount item", - "description": "Returns a discount item by its ID.", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "integer" - }, - "style": "simple", - "explode": false, - "allowReserved": false, - "example": 1 - } - ], - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] - } - }, - "/discounts_codes/{cartIdentifier}/apply": { - "post": { - "operationId": "ibexa.rest.discounts_codes.apply", - "tags": [ - "Discounts" - ], - "responses": { - "200": { - "description": "OK - The discount code has been applied and is returned.", - "content": { - "application/vnd.ibexa.api.DiscountCode+json": { + }, + "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/DiscountCodeWrapper" + "$ref": "#/components/schemas/ContentInfoWrapper" }, "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" + "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" } } }, - "404": { - "description": "Not Found - the cart does not exist, or, the requested discount code has not been found or is already applied." + "400": { + "description": "Error - the input does not match the input schema definition or the validation on a field fails." }, - "429": { - "description": "Too Many Requests - rate limit exceeded, next requests are temporarily blocked as a security measure." + "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": "Apply discount code", - "description": "Apply a discount code on a cart given by its identifier.", + "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": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "cartIdentifier", - "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 } ], "requestBody": { - "description": "The discount code to apply", + "description": "The ContentCreate schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.DiscountCode+json": { + "application/vnd.ibexa.api.ContentCreate+json": { "schema": { - "$ref": "#/components/schemas/DiscountCodeWrapper" + "$ref": "#/components/schemas/ContentCreateWrapper" }, "example": { - "DiscountCode": { - "code": "summer10" - } - } - } - }, - "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] - } - }, - "/discounts_codes/{cartIdentifier}/drop": { - "post": { - "operationId": "ibexa.rest.discounts_codes.drop", - "tags": [ - "Discounts" - ], - "responses": { - "204": { - "description": "No Content - the discount code has been dropped." - }, - "404": { - "description": "Not Found - the cart does not exist." - } - }, - "summary": "Drop discount code", - "description": "Unapply a discount code from a cart given by its identifier.", - "parameters": [ - { - "name": "X-CSRF-Token", - "in": "header", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, - { - "name": "cartIdentifier", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The discount code to drop", - "content": { - "application/vnd.ibexa.api.DiscountCode+json": { - "schema": { - "$ref": "#/components/schemas/DiscountCodeWrapper" - }, - "example": { - "DiscountCode": { - "code": "summer10" - } - } - } - }, - "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] - } - }, - "/languages": { - "get": { - "operationId": "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": [ + "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": [ { - "_media-type": "application/vnd.ibexa.api.Language+json", - "_href": "/api/ibexa/v2/languages/eng-GB", - "languageId": 2, + "fieldDefinitionIdentifier": "title", "languageCode": "eng-GB", - "name": "English (United Kingdom)" + "fieldTypeIdentifier": "ibexa_string", + "fieldValue": "draft article" }, { - "_href": "/api/ibexa/v2/languages/pol-PL", - "_media-type": "application/vnd.ibexa.api.Language+json", - "languageCode": "pol-PL", - "languageId": 4, - "name": "Polish (polski)" + "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.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)" - } - } + }, + "application/vnd.ibexa.api.ContentCreate+xml": { + "schema": { + "$ref": "#/components/schemas/ContentCreate" }, - "application/vnd.ibexa.api.Language+xml": { - "schema": { - "$ref": "#/components/schemas/Language" - }, - "example": "\n\n 2\n eng-GB\n English (United Kingdom)\n\n" - } + "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" } - } - }, - "summary": "Get language", - "description": "Retrieves a LanguageLoadByIdController resource.", - "parameters": [ - { - "name": "code", - "in": "path", - "description": "", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false + }, + "required": false + } } }, - "/content/locations": { + "/content/objects/{contentId}": { "get": { - "operationId": "ibexa.rest.redirect_location", + "operationId": "ibexa.rest.load_content", "tags": [ - "Location" + "Objects" ], "responses": { "200": { - "description": "OK - returns the LocationList in XML or JSON format.", + "description": "OK - returns the Content or ContentInfo in XML or JSON format.", "content": { - "application/vnd.ibexa.api.LocationList+json": { + "application/vnd.ibexa.api.Content+json": { "schema": { - "$ref": "#/components/schemas/LocationWrapper" + "$ref": "#/components/schemas/ContentWrapper" }, "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" + "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" }, - "sortField": "PATH", - "sortOrder": "ASC", - "UrlAliases": { - "_media-type": "application/vnd.ibexa.api.UrlAliasRefList+json", - "_href": "/api/ibexa/v2/content/locations/1/2/58/urlaliases" + "Name": "Forms", + "TranslatedName": "Forms", + "Versions": { + "_media-type": "application/vnd.ibexa.api.VersionList+json", + "_href": "/api/ibexa/v2/content/objects/54/versions" }, - "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" + "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" + } }, - "Locations": { - "_media-type": "application/vnd.ibexa.api.LocationList+json", - "_href": "/api/ibexa/v2/content/objects/57/locations" + "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" + } + } + ] }, - "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/54/versions/1/relations", + "Relation": [] }, - "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" + "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" } } - } - } - } - }, - "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" - } - } - }, - "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}": { - "get": { - "operationId": "ibexa.rest.load_location", - "tags": [ - "Location" - ], - "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": { + }, + "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/2" + "_href": "/api/ibexa/v2/content/locations/1/55" }, - "pathString": "/1/2/58/", - "depth": 2, - "childCount": 3, - "remoteId": "0cfe62f27753448d79aaa8acd8d01699", - "Children": { + "Locations": { "_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" + "_href": "/api/ibexa/v2/content/objects/54/locations" }, - "sortField": "PATH", - "sortOrder": "ASC", - "UrlAliases": { - "_media-type": "application/vnd.ibexa.api.UrlAliasRefList+json", - "_href": "/api/ibexa/v2/content/locations/1/2/58/urlaliases" + "Owner": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" }, - "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" - } - } + "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.Location+xml": { + "application/vnd.ibexa.api.Content+xml": { "schema": { - "$ref": "#/components/schemas/Location" + "$ref": "#/components/schemas/Content" }, - "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 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 Location." + "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 Location with the given path does not exist." + "description": "Error - the ID is not found." } }, - "summary": "Load Location", - "description": "Loads the Location for the given path e.g. '/content/locations/1/2/61'.", + "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": "ETag", + "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": "path", + "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 } - ], - "deprecated": false + ] }, "delete": { - "operationId": "ibexa.rest.delete_subtree", + "operationId": "ibexa.rest.delete_content", "tags": [ - "Location" + "Objects" ], "responses": { "204": { - "description": "No Content - deleted." - }, - "401": { - "description": "Error - the user is not authorized to delete this subtree." + "description": "The content item is deleted." }, "404": { - "description": "Error - the Location with the given ID does not exist." + "description": "Error - content item was not found." + }, + "401": { + "description": "Error - the user is not authorized to delete this content item." } }, - "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": "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", @@ -9916,142 +9032,66 @@ "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": "ContentDeleteController 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_location", + "operationId": "ibexa.rest.update_content_metadata", "tags": [ - "Location" + "Objects" ], "responses": { "200": { - "description": "If set, the Location is returned in XML or JSON format.", + "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.Location+json": { + "application/vnd.ibexa.api.ContentInfo+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" - } - } - } - } + "$ref": "#/components/schemas/ContentInfoWrapper" } }, - "application/vnd.ibexa.api.Location+xml": { + "application/vnd.ibexa.api.ContentInfo+xml": { "schema": { - "$ref": "#/components/schemas/Location" + "$ref": "#/components/schemas/ContentInfo" }, - "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 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 Location." + "description": "Error - the user is not authorized to update this object." }, "404": { - "description": "Error - the Location with the given ID 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": "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": "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", @@ -10059,295 +9099,444 @@ "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", + "name": "If-match", "in": "header", - "description": "ETag", + "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": "path", + "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 } ], "requestBody": { - "description": "The LocationUpdate schema encoded in XML or JSON format.", + "description": "The ContentUpdate schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.LocationUpdate+json": { + "application/vnd.ibexa.api.ContentUpdate+json": { "schema": { - "$ref": "#/components/schemas/LocationUpdateStructWrapper" - }, - "example": { - "LocationUpdate": { - "priority": "3", - "hidden": true, - "remoteId": "remoteId-qwert999", - "sortField": "NAME", - "sortOrder": "DESC" - } + "$ref": "#/components/schemas/ContentInfoWrapper" } }, - "application/vnd.ibexa.api.LocationUpdate+xml": { + "application/vnd.ibexa.api.ContentUpdate+xml": { "schema": { - "$ref": "#/components/schemas/LocationUpdateStruct" + "$ref": "#/components/schemas/ContentInfo" }, - "example": "\n\n 3\n true\n remoteId-qwert999\n CLASS\n DESC\n\n" + "example": "\n\n eng-GB\n
\n \n \n false\n 69848aeb86164c35e5c98202eebe9e05\n\n" } }, "required": false - }, - "deprecated": false + } } }, - "/content/locations/{path}/children": { + "/content/objects/{contentId}/currentversion": { "get": { - "operationId": "ibexa.rest.load_location_children", + "operationId": "ibexa.rest.redirect_current_version", "tags": [ - "Location" + "Objects" ], "responses": { "200": { - "description": "If set, the new Location list is returned in XML or JSON format.", + "description": "OK - returns the Version in XML or JSON format.", "content": { - "application/vnd.ibexa.api.LocationList+json": { + "application/vnd.ibexa.api.Version+json": { "schema": { - "$ref": "#/components/schemas/LocationListWrapper" + "$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.LocationList+xml": { + "application/vnd.ibexa.api.Version+xml": { "schema": { - "$ref": "#/components/schemas/LocationList" + "$ref": "#/components/schemas/Version" }, - "example": "\n\n \n \n \n \n\n" + "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" } } }, - "401": { - "description": "Error - the user is not authorized to read this content item." + "307": { + "description": "Temporary redirect." }, "404": { - "description": "Error - the content item with the given ID does not exist." + "description": "Error - the resource does not exist." } }, - "summary": "Get child Locations.", - "description": "Loads all child Locations for the given parent Location.", + "summary": "Get current version", + "description": "Redirects to the current version of the content item.", "parameters": [ { - "name": "path", + "name": "contentId", "in": "path", - "description": "", + "description": "ContentCurrentVersionRedirectController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false - } - }, - "/content/locations/{path}/urlaliases": { - "get": { - "operationId": "ibexa.rest.list_location_url_aliases", + ] + }, + "post": { + "operationId": "ibexa.rest.content.create_draft_from_current_version", "tags": [ - "Location" + "Objects" ], "responses": { - "200": { - "description": "OK - returns the list of URL aliases.", + "201": { + "description": "Created", "content": { - "application/vnd.ibexa.api.UrlAliasRefList+json": { + "application/vnd.ibexa.api.Version+json": { "schema": { - "$ref": "#/components/schemas/UrlAliasRefListWrapper" + "$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.UrlAliasRefList+xml": { + "application/vnd.ibexa.api.Version+xml": { "schema": { - "$ref": "#/components/schemas/UrlAliasRefList" + "$ref": "#/components/schemas/Version" }, - "example": "\n\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 user has no permission to read URL aliases." + "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, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "contentId", + "in": "path", + "description": "ContentDraftCreateFromCurrentVersionController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "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 Location was not found." + "description": "Error - The user has no permission to change Object item visibility." + }, + "404": { + "description": "Error - The content item was not found." } }, - "summary": "List URL aliases for Location", - "description": "Returns the list of URL aliases for a Location.", + "summary": "Hide content item", + "description": "Makes or keep the content item invisible", "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": "ContentHideController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], - "deprecated": false + "requestBody": { + "description": "No payload required", + "content": [], + "required": false + } } }, - "/content/objectstategroups": { + "/content/objects/{contentId}/locations": { "get": { - "operationId": "ibexa.rest.load_object_state_groups", + "operationId": "ibexa.rest.load_locations_for_content", "tags": [ - "Object State Groups" + "Objects" ], "responses": { "200": { - "description": "OK - returns a list of Object state groups.", + "description": "If set, the Location list is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ObjectStateGroupList+json": { + "application/vnd.ibexa.api.LocationList+json": { "schema": { - "$ref": "#/components/schemas/ObjectStateGroupListWrapper" + "$ref": "#/components/schemas/LocationListWrapper" }, "example": { - "ObjectStateGroupList": { - "_media-type": "application/vnd.ibexa.api.ObjectStateGroupList+json", - "_href": "/api/ibexa/v2/content/objectstategroups", - "ObjectStateGroup": [ + "LocationList": { + "_media-type": "application/vnd.ibexa.api.LocationList+json", + "_href": "/api/ibexa/v2/content/objects/63/locations", + "Location": [ { - "_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" - } - ] - } + "_media-type": "application/vnd.ibexa.api.Location+json", + "_href": "/api/ibexa/v2/content/locations/1/2/57/65" } ] } } }, - "application/vnd.ibexa.api.ObjectStateGroupList+xml": { + "application/vnd.ibexa.api.LocationList+xml": { "schema": { - "$ref": "#/components/schemas/ObjectStateGroupList" + "$ref": "#/components/schemas/LocationList" }, - "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" + "example": "\n\n \n\n" } } }, "401": { - "description": "Error - The user has no permission to read Object state groups." + "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": "List Object state groups", - "description": "Returns a list of all Object state groups.", + "summary": "Get Locations for content item", + "description": "Loads all Locations for the given content item.", "parameters": [ { "name": "If-None-Match", @@ -10355,81 +9544,140 @@ "description": "ETag", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + }, + { + "name": "contentId", + "in": "path", + "description": "LocationForContentListController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } - ], - "deprecated": false + ] }, "post": { - "operationId": "ibexa.rest.create_object_state_group", + "operationId": "ibexa.rest.create_location", "tags": [ - "Object State Groups" + "Objects" ], "responses": { "201": { - "description": "Object state group created.", + "description": "If set, the new Location is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ObjectStateGroup+json": { + "application/vnd.ibexa.api.Location+json": { "schema": { - "$ref": "#/components/schemas/ObjectStateGroupWrapper" + "$ref": "#/components/schemas/LocationWrapper" }, "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" + "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" }, - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Custom State" - } - ] + "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" }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Custom Object state" + "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.ObjectStateGroup+xml": { + "application/vnd.ibexa.api.Location+xml": { "schema": { - "$ref": "#/components/schemas/ObjectStateGroup" + "$ref": "#/components/schemas/Location" }, - "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" + "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." + "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 create this Location." }, "403": { - "description": "Error - An Object state group with the same identifier already exists." + "description": "Error - a Location under the given parent ID already exists." } }, - "summary": "Create Object state group", - "description": "Creates a new Object state group.", + "summary": "Create new Location for content item", + "description": "Creates a new Location for the given content item.", "parameters": [ { "name": "X-CSRF-Token", @@ -10437,119 +9685,108 @@ "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": "contentId", + "in": "path", + "description": "LocationCreateController 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 LocationCreate schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ObjectStateGroupCreate+json": { + "application/vnd.ibexa.api.LocationCreate+json": { "schema": { - "$ref": "#/components/schemas/ObjectStateGroupCreateWrapper" + "$ref": "#/components/schemas/LocationCreateWrapper" }, "example": { - "ObjectStateGroupCreate": { - "identifier": "custom-states", - "defaultLanguageCode": "eng-GB", - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Custom State" - } - ] + "LocationCreate": { + "_media-type": "application/vnd.ibexa.api.LocationCreate", + "ParentLocation": { + "_href": "/api/ibexa/v2/content/locations/1/59" }, - "descriptions": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Custom Object state" - } - ] - } + "priority": "0", + "hidden": false, + "sortField": "PATH", + "sortOrder": "ASC" } } }, - "application/vnd.ibexa.api.ObjectStateGroupCreate+xml": { + "application/vnd.ibexa.api.LocationCreate+xml": { "schema": { - "$ref": "#/components/schemas/ObjectStateGroupCreate" + "$ref": "#/components/schemas/LocationCreate" }, - "example": "\n\n custom\n eng-GB\n \n Custom State\n \n \n Custom Object state\n \n" + "example": "\n\n \n 0\n false\n PATH\n ASC\n\n" } }, "required": false - }, - "deprecated": false + } } }, - "/content/objectstategroups/{objectStateGroupId}": { + "/content/objects/{contentId}/objectstates": { "get": { - "operationId": "ibexa.rest.load_object_state_group", + "operationId": "ibexa.rest.get_object_states_for_content", "tags": [ - "Object State Groups" + "Objects" ], "responses": { "200": { - "description": "OK - returns the Object state group.", + "description": "OK - returns the Object state.", "content": { - "application/vnd.ibexa.api.ObjectStateGroup+json": { + "application/vnd.ibexa.api.ContentObjectStates+json": { "schema": { - "$ref": "#/components/schemas/ObjectStateGroupWrapper" + "$ref": "#/components/schemas/ContentObjectStates" }, "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" - } - ] - } + "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.ObjectStateGroup+xml": { + "application/vnd.ibexa.api.ContentObjectStates+xml": { "schema": { - "$ref": "#/components/schemas/ObjectStateGroup" + "$ref": "#/components/schemas/ContentObjectStates" }, - "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" + "example": "\n\n \n \n \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." + "description": "Error - The content item does not exist." } }, - "summary": "Get Object state group", - "description": "Returns the Object state group with the provided ID.", + "summary": "Get Object states of content item", + "description": "Returns the Object states of a content item", "parameters": [ { "name": "If-None-Match", @@ -10557,130 +9794,56 @@ "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 + "explode": false }, { - "name": "objectStateGroupId", + "name": "contentId", "in": "path", - "description": "", + "description": "ObjectStatesForContentListController 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_object_state_group", + "operationId": "ibexa.rest.set_object_states_for_content", "tags": [ - "Object State Groups" + "Objects" ], "responses": { - "200": { - "description": "OK - Object stated group updated.", + "204": { + "description": "OK - Object state updated.", "content": { - "application/vnd.ibexa.api.ObjectStateGroup+json": { + "application/vnd.ibexa.api.ContentObjectStates+json": { "schema": { - "$ref": "#/components/schemas/ObjectStateGroupWrapper" + "$ref": "#/components/schemas/ContentObjectStatesWrapper" }, "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" - } - ] - } + "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.ObjectStateGroup+xml": { + "application/vnd.ibexa.api.ContentObjectStates+xml": { "schema": { - "$ref": "#/components/schemas/ObjectStateGroup" + "$ref": "#/components/schemas/ContentObjectStates" }, - "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" + "example": "\n\n \n\n" } } }, @@ -10688,17 +9851,17 @@ "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." + "description": "Error - The user is not authorized to set an Object state." }, "403": { - "description": "Error - An Object state group with the provided identifier already exists." + "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 Object state group", - "description": "Updates an Object state group. PATCH or POST with header X-HTTP-Method-Override PATCH.", + "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", @@ -10706,13 +9869,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 }, { "name": "If-Match", @@ -10720,253 +9881,107 @@ "description": "ETag", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "objectStateGroupId", + "name": "contentId", "in": "path", - "description": "", + "description": "ObjectStatesForContentUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "The Object state group input schema encoded in XML or JSON format.", + "description": "The content item Object states input schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ObjectStateGroupUpdate+json": { + "application/vnd.ibexa.api.ContentObjectStates+json": { "schema": { - "$ref": "#/components/schemas/ObjectStateGroupUpdateWrapper" + "$ref": "#/components/schemas/ContentObjectStatesWrapper" }, "example": { - "ObjectStateGroupUpdate": { - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "New Custom State name" - } - ] - } + "ContentObjectStates": { + "ObjectState": [ + { + "_href": "/api/ibexa/v2/content/objectstategroups/2/objectstates/2" + } + ] } } }, - "application/vnd.ibexa.api.ObjectStateGroupUpdate+xml": { + "application/vnd.ibexa.api.ContentObjectStates+xml": { "schema": { - "$ref": "#/components/schemas/ObjectStateGroupUpdate" + "$ref": "#/components/schemas/ContentObjectStates" }, - "example": "\n\n \n New Custom State name\n \n\n" + "example": "\n\n \n\n" } }, "required": false - }, - "deprecated": false + } } }, - "/content/objectstategroups/{objectStateGroupId}/objectstates": { + "/content/objects/{contentId}/relations": { "get": { - "operationId": "ibexa.rest.load_object_states", + "operationId": "ibexa.rest.redirect_current_version_relations", "tags": [ - "Object State Groups" + "Objects" ], "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" - } - } + "307": { + "description": "Temporary redirect." }, "401": { - "description": "Error - The user has no permission to read Object states." + "description": "Error - the user is not authorized to read this content item." + }, + "404": { + "description": "Error - the content item was not found." } }, - "summary": "List Object states", - "description": "Returns a list of all Object states of the given group.", + "summary": "Load Relations of content item", + "description": "Redirects to the Relations of the current version.", "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": "contentId", "in": "path", - "description": "", + "description": "ContentCurrentVersionRelationsRedirectController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false - }, + ] + } + }, + "/content/objects/{contentId}/reveal": { "post": { - "operationId": "ibexa.rest.create_object_state", + "operationId": "ibexa.rest.reveal_content", "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": "\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." + "204": { + "description": "OK - Object item is revealed." }, "401": { - "description": "Error - The user is not authorized to create an Object state." + "description": "Error - The user has no permission to change Object item visibility." }, - "403": { - "description": "Error - An Object state with the same identifier already exists in the given group." + "404": { + "description": "Error - The content item was not found." } }, - "summary": "Create Object state", - "description": "Creates a new Object state.", + "summary": "Reveal content item", + "description": "Makes or keep the content item visible", "parameters": [ { "name": "X-CSRF-Token", @@ -10974,690 +9989,783 @@ "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", + "name": "contentId", "in": "path", - "description": "", + "description": "ContentRevealController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": 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" - } - }, + "description": "No payload required", + "content": [], "required": false - }, - "deprecated": false + } } }, - "/content/objectstategroups/{objectStateGroupId}/objectstates/{objectStateId}": { - "get": { - "operationId": "ibexa.rest.load_object_state", + "/content/objects/{contentId}/translations/{languageCode}": { + "delete": { + "operationId": "ibexa.rest.delete_content_translation", "tags": [ - "Object State Groups" + "Objects" ], "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" - } - } + "204": { + "description": "No Content" }, "401": { - "description": "Error - The user is not authorized to read this Object state." + "description": "Error - the user is not authorized to delete content item (content/remove policy)." }, "404": { - "description": "Error - The Object state does not exist." + "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": "Get Object state", - "description": "Returns the Object state.", + "summary": "Delete translation (permanently)", + "description": "Permanently deletes a translation from all versions of a content item.", "parameters": [ { - "name": "If-None-Match", + "name": "X-CSRF-Token", "in": "header", - "description": "ETag", - "required": false, + "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", + "name": "contentId", "in": "path", - "description": "", + "description": "ContentTranslationDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "objectStateId", + "name": "languageCode", "in": "path", - "description": "", + "description": "ContentTranslationDeleteController 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_object_state", + ] + } + }, + "/content/objects/{contentId}/versions": { + "get": { + "operationId": "ibexa.rest.load_content_versions", "tags": [ - "Object State Groups" + "Objects" ], "responses": { - "204": { - "description": "No Content - Object state deleted." + "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 is not authorized to delete an Object state." - }, - "404": { - "description": "Error - The Object state does not exist." + "description": "Error - the user has no permission to read the versions." } }, - "summary": "Delete Object state", - "description": "Deletes provided Object state.", + "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": "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": "", + "description": "ContentVersionsListController 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_object_state", + ] + } + }, + "/content/objects/{contentId}/versions/{versionNo}": { + "get": { + "operationId": "ibexa.rest.load_content_in_version", "tags": [ - "Object State Groups" + "Objects" ], "responses": { "200": { - "description": "OK - Object State updated", + "description": "If set, the version list is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ObjectState+json": { + "application/vnd.ibexa.api.Version+json": { "schema": { - "$ref": "#/components/schemas/ObjectStateWrapper" + "$ref": "#/components/schemas/VersionWrapper" }, "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" + "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" + } }, - "defaultLanguageCode": "eng-GB", - "languageCodes": "eng-GB", - "names": { - "value": [ + "Fields": { + "field": [ { - "_languageCode": "eng-GB", - "#text": "New Object State name" - } - ] - }, - "descriptions": { - "value": [ + "id": 477, + "fieldDefinitionIdentifier": "name", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_string", + "fieldValue": "Features" + }, { - "_languageCode": "eng-GB", - "#text": "" + "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.ObjectState+xml": { + "application/vnd.ibexa.api.Version+xml": { "schema": { - "$ref": "#/components/schemas/ObjectState" + "$ref": "#/components/schemas/Version" }, - "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" + "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." + "304": { + "description": "Not Modified - the ETag matches the current one." }, "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." + "description": "Error - the user is not authorized to read this content item." }, - "412": { - "description": "Error - The current ETag does not match the one provided in the If-Match header." + "404": { + "description": "Error - the ID or version is not found." } }, - "summary": "Update Object state", - "description": "Updates an Object state. PATCH or POST with header X-HTTP-Method-Override PATCH.", + "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": "The CSRF Token needed on all unsafe HTTP methods with session.", + "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": "If-Match", + "name": "versionNo", + "in": "path", + "description": "ContentInVersionLoadController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": 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": "ETag", + "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", + "name": "contentId", "in": "path", - "description": "", + "description": "ContentDraftCreateFromVersionController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "objectStateId", + "name": "versionNo", "in": "path", - "description": "", + "description": "ContentDraftCreateFromVersionController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": 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" - } - }, + "description": "No payload required", + "content": [], "required": false - }, - "deprecated": false - } - }, - "/content/objects": { - "get": { - "operationId": "ibexa.rest.redirect_content", + } + }, + "delete": { + "operationId": "ibexa.rest.delete_content_version", "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." + "204": { + "description": "No Content - the version is deleted." }, "404": { - "description": "Error - the content with the given remote ID 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": "Load content by remote ID", - "description": "Loads content item for a given remote ID.", + "summary": "Delete content version", + "description": "Deletes the content version.", "parameters": [ { - "name": "remoteId", - "in": "query", - "description": "Remote ID of the content item.", + "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": "form", - "explode": false, - "allowReserved": false + "style": "simple", + "explode": false + }, + { + "name": "contentId", + "in": "path", + "description": "ContentVersionDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "versionNo", + "in": "path", + "description": "ContentVersionDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } - ], - "deprecated": false + ] }, - "post": { - "operationId": "ibexa.rest.create_content", + "patch": { + "operationId": "ibexa.rest.update_version", "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.", + "200": { + "description": "If set, the updated version is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Content+json": { + "application/vnd.ibexa.api.Version+json": { "schema": { - "$ref": "#/components/schemas/ContentWrapper" + "$ref": "#/components/schemas/VersionWrapper" }, "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" + "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" + } }, - "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": 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" } }, - "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" + { + "id": 480, + "fieldDefinitionIdentifier": "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/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" + "Relations": { + "_media-type": "application/vnd.ibexa.api.RelationList+json", + "_href": "/api/ibexa/v2/content/objects/107/versions/5/relations", + "Relation": [] }, - "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" + "Thumbnail": { + "_media-type": "application/vnd.ibexa.api.Thumbnail+json", + "resource": "/placeholder", + "width": null, + "height": null, + "mimeType": "image/svg+xml" } } } }, - "application/vnd.ibexa.api.ContentInfo+xml": { + "application/vnd.ibexa.api.Version+xml": { "schema": { - "$ref": "#/components/schemas/ContentInfo" + "$ref": "#/components/schemas/Version" }, - "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" + "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 or the validation on a field fails." + "description": "Error - the input does not match the input schema definition." }, "401": { - "description": "Error - the user is not authorized to create this Object in this Location." + "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 parent Location specified in the request body does not exist." + "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": "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.", + "summary": "Update version", + "description": "A specific draft is updated. PATCH or POST with header X-HTTP-Method-Override PATCH.", "parameters": [ { "name": "X-CSRF-Token", @@ -11665,311 +10773,188 @@ "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": "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 ContentCreate schema encoded in XML or JSON format.", + "description": "The VersionUpdate schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ContentCreate+json": { + "application/vnd.ibexa.api.VersionUpdate+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

" - } - } - ] - } - } + "$ref": "#/components/schemas/VersionUpdateWrapper" } }, - "application/vnd.ibexa.api.ContentCreate+xml": { + "application/vnd.ibexa.api.VersionUpdate+xml": { "schema": { - "$ref": "#/components/schemas/ContentCreate" + "$ref": "#/components/schemas/VersionUpdate" }, - "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" + "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}": { + "/content/objects/{contentId}/versions/{versionNo}/relations": { "get": { - "operationId": "ibexa.rest.load_content", + "operationId": "ibexa.rest.load_version_relations", "tags": [ "Objects" ], "responses": { "200": { - "description": "OK - returns the Content or ContentInfo in XML or JSON format.", + "description": "If set, the Relation is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Content+json": { + "application/vnd.ibexa.api.RelationList+json": { "schema": { - "$ref": "#/components/schemas/ContentWrapper" + "$ref": "#/components/schemas/RelationListWrapper" }, "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/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" }, - "Relations": { - "_media-type": "application/vnd.ibexa.api.RelationList+json", - "_href": "/api/ibexa/v2/content/objects/54/versions/1/relations", - "Relation": [] + "DestinationContent": { + "_media-type": "application/vnd.ibexa.api.ContentInfo+json", + "_href": "/api/ibexa/v2/content/objects/52" }, - "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" - } + "RelationType": "LINK" } - }, - "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": { + "application/vnd.ibexa.api.RelationList+xml": { "schema": { - "$ref": "#/components/schemas/Content" + "$ref": "#/components/schemas/RelationList" }, - "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" - } + "example": "\n\n \n \n \n LINK\n \n\n" } } }, "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." + "description": "Error - the user is not authorized to read this content item." }, "404": { - "description": "Error - the ID is not found." + "description": "Error - the content item was 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.", + "summary": "Load Relations of content item version", + "description": "Loads the Relations of the given version.", "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, + "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": "contentId", + "name": "versionNo", "in": "path", - "description": "", + "description": "ContentVersionsRelationsListController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { - "type": "integer" + "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] }, - "delete": { - "operationId": "ibexa.rest.delete_content", + "post": { + "operationId": "ibexa.rest.create_relation", "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." + "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 Content", - "description": "Deletes content item. If content item has multiple Locations, all of them will be deleted via delete a subtree.", + "summary": "Create new Relation", + "description": "Creates a new Relation of type COMMON for the given draft.", "parameters": [ { "name": "X-CSRF-Token", @@ -11977,397 +10962,170 @@ "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": "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_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 + "explode": false }, { - "name": "contentId", + "name": "versionNo", "in": "path", - "description": "", + "description": "ContentRelationCreateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "The ContentUpdate schema encoded in XML or JSON format.", + "description": "The RelationCreate schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ContentUpdate+json": { + "application/vnd.ibexa.api.RelationCreate+json": { "schema": { - "$ref": "#/components/schemas/ContentInfoWrapper" + "$ref": "#/components/schemas/RelationCreateWrapper" + }, + "example": { + "RelationCreate": { + "Destination": { + "_href": "/api/ibexa/v2/content/objects/59" + } + } } }, - "application/vnd.ibexa.api.ContentUpdate+xml": { + "application/vnd.ibexa.api.RelationCreate+xml": { "schema": { - "$ref": "#/components/schemas/ContentInfo" + "$ref": "#/components/schemas/RelationCreate" }, - "example": "\n\n eng-GB\n
\n \n \n false\n 69848aeb86164c35e5c98202eebe9e05\n\n" + "example": "\n\n \n\n" } }, "required": false - }, - "deprecated": false + } } }, - "/content/objects/{contentId}/currentversion": { + "/content/objects/{contentId}/versions/{versionNo}/relations/{relationId}": { "get": { - "operationId": "ibexa.rest.redirect_current_version", + "operationId": "ibexa.rest.load_version_relation", "tags": [ "Objects" ], "responses": { "200": { - "description": "OK - returns the Version in XML or JSON format.", + "description": "OK - loads a Relation for the given content item.", "content": { - "application/vnd.ibexa.api.Version+json": { + "application/vnd.ibexa.api.Relation+json": { "schema": { - "$ref": "#/components/schemas/VersionWrapper" + "$ref": "#/components/schemas/RelationWrapper" }, "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" - } - } - ] + "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" }, - "Relations": { - "_media-type": "application/vnd.ibexa.api.RelationList+json", - "_href": "/api/ibexa/v2/content/objects/107/versions/2/relations", - "Relation": [] + "DestinationContent": { + "_media-type": "application/vnd.ibexa.api.ContentInfo+json", + "_href": "/api/ibexa/v2/content/objects/59" }, - "Thumbnail": { - "_media-type": "application/vnd.ibexa.api.Thumbnail+json", - "resource": "/placeholder", - "width": null, - "height": null, - "mimeType": "image/svg+xml" - } + "RelationType": "COMMON" } } }, - "application/vnd.ibexa.api.Version+xml": { + "application/vnd.ibexa.api.Relation+xml": { "schema": { - "$ref": "#/components/schemas/Version" + "$ref": "#/components/schemas/Relation" }, - "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" + "example": "\n\n \n \n COMMON\n\n" } } }, - "307": { - "description": "Temporary redirect." + "401": { + "description": "Error - the user is not authorized to read this content item." }, "404": { - "description": "Error - the resource does not exist." + "description": "Error - the content item with the given ID or the Relation does not exist." } }, - "summary": "Get current version", - "description": "Redirects to the current version of the content item.", + "summary": "Load Relation", + "description": "Loads a Relation for the given content item.", "parameters": [ { "name": "contentId", "in": "path", - "description": "", + "description": "ContentVersionRelationLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false + }, + { + "name": "versionNo", + "in": "path", + "description": "ContentVersionRelationLoadByIdController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "relationId", + "in": "path", + "description": "ContentVersionRelationLoadByIdController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } - ], - "deprecated": false + ] }, - "post": { - "operationId": "ibexa.rest.content.create_draft_from_current_version", + "delete": { + "operationId": "ibexa.rest.remove_relation", "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" - } - } + "204": { + "description": "No Content - deleted a Relation of the given draft." }, "401": { - "description": "Error - the user is not authorized to update this content item." + "description": "Error - the user is not authorized to delete this Relation." }, "403": { - "description": "Error - the current version is already a draft." + "description": "Error - the Relation is not of type COMMON or the given version is not a draft." }, "404": { - "description": "Error - the content item was not found." + "description": "Error - content item or the Relation were not found in the given version." } }, - "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.", + "summary": "Delete Relation", + "description": "Deletes a Relation of the given draft.", "parameters": [ { "name": "X-CSRF-Token", @@ -12375,56 +11133,79 @@ "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": "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 } - ], - "requestBody": { - "description": "No payload required", - "content": [], - "required": false - }, - "deprecated": false + ] } }, - "/content/objects/{contentId}/hide": { - "post": { - "operationId": "ibexa.rest.hide_content", + "/content/objects/{contentId}/versions/{versionNo}/translations/{languageCode}": { + "delete": { + "operationId": "ibexa.rest.delete_translation_from_draft", "tags": [ "Objects" ], "responses": { "204": { - "description": "OK - Object item is hidden." + "description": "No Content - removes a translation from a version draft." }, "401": { - "description": "Error - The user has no permission to change Object item visibility." + "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 was not found." + "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": "Hide content item", - "description": "Makes or keep the content item invisible", + "summary": "Delete translation from version draft", + "description": "Removes a translation from a version draft.", "parameters": [ { "name": "X-CSRF-Token", @@ -12432,7695 +11213,1619 @@ "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": "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 } - ], - "requestBody": { - "description": "No payload required", - "content": [], - "required": false - }, - "deprecated": false + ] } }, - "/content/objects/{contentId}/locations": { + "/page/structure": { "get": { - "operationId": "ibexa.rest.load_locations_for_content", + "operationId": "ibexa.page_builder.rest.page_structure", "tags": [ - "Objects" + "Page" ], "responses": { "200": { - "description": "If set, the Location list is returned in XML or JSON format.", + "description": "The Page structure is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.LocationList+json": { + "application/vnd.ibexa.api.PageStructure+json": { "schema": { - "$ref": "#/components/schemas/LocationListWrapper" + "$ref": "#/components/schemas/PageStructureWrapper" }, "example": { - "LocationList": { - "_media-type": "application/vnd.ibexa.api.LocationList+json", - "_href": "/api/ibexa/v2/content/objects/63/locations", - "Location": [ + "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.Location+json", - "_href": "/api/ibexa/v2/content/locations/1/2/57/65" + "_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.LocationList+xml": { + "application/vnd.ibexa.api.PageStructure+xml": { "schema": { - "$ref": "#/components/schemas/LocationList" - }, - "example": "\n\n \n\n" + "$ref": "#/components/schemas/PageStructure" + } } } }, - "401": { - "description": "Error - the user is not authorized to read this content item." + "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 content item with the given ID does not exist." + "description": "Error - the identifier given in `contentTypeIdentifier` names no existing content type." } }, - "summary": "Get Locations for content item", - "description": "Loads all Locations for the given content item.", + "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", - "explode": false, - "allowReserved": false - }, - { - "name": "contentId", - "in": "path", - "description": "", - "required": true, - "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_location", - "tags": [ - "Objects" + ] + } + }, + "/product/catalog/products": { + "get": { + "operationId": "ibexa.product_catalog.rest.products", + "tags": [ + "Product" ], "responses": { - "201": { - "description": "If set, the new Location 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.Location+json": { + "application/vnd.ibexa.api.ProductList+json": { "schema": { - "$ref": "#/components/schemas/LocationWrapper" + "$ref": "#/components/schemas/ProductListWrapper" }, "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" + "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": [] }, - "CurrentVersion": { - "_media-type": "application/vnd.ibexa.api.Version+json", - "_href": "/api/ibexa/v2/content/objects/59/currentversion" + "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": 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": [] }, - "Locations": { - "_media-type": "application/vnd.ibexa.api.LocationList+json", - "_href": "/api/ibexa/v2/content/objects/59/locations" + "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" + } }, - "Owner": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" + "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" }, - "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" - } + "created_at": 1645787893, + "updated_at": 1645787893, + "AttributesList": [] } - } + ] } } - }, - "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." + "description": "Error - the user has no permission to read product." } }, - "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 - } - ], + "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 LocationCreate schema encoded in XML or JSON format.", + "description": "The product list schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.LocationCreate+json": { + "application/vnd.ibexa.api.ProductListGet+json": { "schema": { - "$ref": "#/components/schemas/LocationCreateWrapper" + "$ref": "#/components/schemas/ProductListGetWrapper" }, "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" + "ProductListGet": { + "offset": 0, + "limit": 10, + "languages": [ + "eng-GB" + ] } } - }, - "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", + "/product/catalog/products/view": { + "post": { + "operationId": "ibexa.product_catalog.rest.products.view", "tags": [ - "Objects" + "Product" ], "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.", + "description": "The view in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ContentObjectStates+json": { + "application/vnd.ibexa.api.ProductView+json": { "schema": { - "$ref": "#/components/schemas/ContentObjectStatesWrapper" + "$ref": "#/components/schemas/ProductViewWrapper" }, "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" + "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" } - ] - }, - "names": { - "value": [ + }, + "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": [ { - "_languageCode": "eng-GB", - "#text": "Art1" + "_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 } - ] - }, - "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" - } - ] + ], + "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" + } }, - "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.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" + } + } + ] }, - { - "_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": ">=" + "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 + } + ] } - } - ] - } - } - } - } - }, - "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": { + }, + "application/vnd.ibexa.api.ProductView+xml": { "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": ">=" - } - } - ] - } + "$ref": "#/components/schemas/ProductView" } } } }, "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.", + "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": "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 + "explode": false } ], "requestBody": { - "description": "If set, the copied catalog is returned in XML or JSON format.", + "description": "The view input in XML or JSON format.", "content": { - "application/vnd.ibexa.api.CatalogCopy+json": { + "application/vnd.ibexa.api.ProductViewInput+json": { "schema": { - "$ref": "#/components/schemas/CatalogCopyWrapper" + "$ref": "#/components/schemas/ProductViewInputWrapper" }, "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" - }, + "ViewInput": { + "identifier": "TitleView", + "ProductQuery": { + "limit": "10", + "offset": "0", + "Filter": { + "ProductTypeCriterion": "desk", + "ProductAvailabilityCriterion": false + }, + "SortClauses": { + "ProductName": "descending" + }, + "Aggregations": [ { - "_media-type": "application/vnd.ibexa.api.ProductSortClause+json", - "name": "CreatedAt" + "ProductPriceRange": { + "name": "price", + "currencyCode": "EUR", + "ranges": [ + { + "from": 0, + "to": 10000 + }, + { + "from": 10000, + "to": null + } + ] + } } ] } } - }, - "application/vnd.ibexa.api.ProductSortClauseList+xml": { - "schema": { - "$ref": "#/components/schemas/ProductSortClauseList" - } + } + }, + "application/vnd.ibexa.api.ProductViewInput+xml": { + "schema": { + "$ref": "#/components/schemas/ProductViewInput" } } - } - }, - "summary": "Load catalog sort clauses", - "description": "Loads product sort clauses available for catalogs.", - "parameters": [], - "deprecated": false + }, + "required": false + } } }, - "/product/catalog/catalogs/view": { - "post": { - "operationId": "ibexa.product_catalog.rest.catalogs.view", + "/product/catalog/products/{code}": { + "get": { + "operationId": "ibexa.product_catalog.rest.product", "tags": [ - "Product Catalog" + "Product" ], "responses": { "200": { - "description": "The view in XML or JSON format.", + "description": "If set, the products are returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.CatalogView+json": { + "application/vnd.ibexa.api.Product+json": { "schema": { - "$ref": "#/components/schemas/CatalogViewWrapper" + "$ref": "#/components/schemas/ProductWrapper" }, "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", + "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": "", - "User": { + "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" }, - "created": 1665479475, - "modified": 1665479475, - "status": "draft", - "Criteria": [ + "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": [ { - "_media-type": "application/vnd.ibexa.api.ProductCode+json", - "ProductCodeCriterion": { - "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json", - "codes": [ - "test" + "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": [] + } + ] } } - }, - "application/vnd.ibexa.api.CatalogView+xml": { - "schema": { - "$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 view this product." + }, + "404": { + "description": "Error - no product with the given code exists." } }, - "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.", + "summary": "Load the given product", + "description": "Loads the given product.", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token is required when passing user session.", + "name": "code", + "in": "path", + "description": "ProductLoadByCodeController identifier", "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": "An optional product schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.CatalogViewInput+json": { + "application/vnd.ibexa.api.ProductGet+json": { "schema": { - "$ref": "#/components/schemas/CatalogViewInputWrapper" + "$ref": "#/components/schemas/ProductGetWrapper" }, "example": { - "ViewInput": { - "identifier": "TitleView", - "CatalogQuery": { - "Query": { - "CatalogIdentifierCriterion": "test", - "CatalogNameCriterion": "test" - } - } + "ProductGet": { + "languages": [ + "eng-GB" + ] } } - }, - "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", + } + }, + "patch": { + "operationId": "ibexa.product_catalog.rest.products.update", "tags": [ - "Product Catalog" + "Product" ], "responses": { - "200": { - "description": "If set, the catalog is returned in XML or JSON format.", + "201": { + "description": "If set, the updated product is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Catalog+json": { + "application/vnd.ibexa.api.Product+json": { "schema": { - "$ref": "#/components/schemas/CatalogWrapper" + "$ref": "#/components/schemas/ProductWrapper" }, "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 + "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" }, - { - "_media-type": "application/vnd.ibexa.api.ColorAttribute+json", - "ColorAttributeCriterion": { - "_media-type": "application/vnd.ibexa.api.ColorAttributeCriterion+json", - "identifier": "color", - "value": [ - "#000000", - "#FFFFFF" - ] - } + "Name": "fgh", + "TranslatedName": "fgh", + "Versions": { + "_media-type": "application/vnd.ibexa.api.VersionList+json", + "_href": "/api/ibexa/v2/content/objects/141/versions" }, - { - "_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" + "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" + } }, - "operator": ">=" + "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.FloatAttribute+json", - "FloatAttributeCriterion": { - "_media-type": "application/vnd.ibexa.api.FloatAttributeCriterion+json", - "identifier": "width", - "value": 16.6 - } + "_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.IntegerAttributeRange+json", - "IntegerAttributeRangeCriterion": { - "_media-type": "application/vnd.ibexa.api.IntegerAttributeRangeCriterion+json", - "identifier": "length", - "min": 180, - "max": 230 - } + "_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": [] } ] } } - }, - "application/vnd.ibexa.api.Catalog+xml": { - "schema": { - "$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 view this catalog." + "description": "Error - the user is not authorized to update this product." }, - "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." + "403": { + "description": "Error - a product with the same code already exists." }, - "401": { - "description": "Error - the user is not authorized to delete this catalog." + "404": { + "description": "Error - no product with the given code exists." } }, - "summary": "Delete catalog", - "description": "Deletes the given catalog.", + "summary": "Update product", + "description": "Updates product.", "parameters": [ { - "name": "identifier", + "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", @@ -20128,385 +12833,198 @@ "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.product_catalog.rest.catalogs.update", + "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 + } + } + }, + "/product/catalog/products/{code}/prices": { + "get": { + "operationId": "ibexa.product_catalog.rest.prices.list", "tags": [ - "Product Catalog" + "Product" ], "responses": { - "201": { - "description": "If set, the updated catalog is returned in XML or JSON format.", + "200": { + "description": "OK - loads the list of product prices.", "content": { - "application/vnd.ibexa.api.Catalog+json": { + "application/vnd.ibexa.api.PriceList+json": { "schema": { - "$ref": "#/components/schemas/CatalogWrapper" + "$ref": "#/components/schemas/PriceListWrapper" }, "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" - ] - } - }, + "PriceList": { + "_media-type": "application/vnd.ibexa.api.PriceList+json", + "prices": [ { - "_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.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.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": ">=" - } + "_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 } } } } }, - "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." + "description": "Error - the user has no permission to read prices." } }, - "summary": "Update catalog", - "description": "Updates a catalog.", + "summary": "Load the list of product prices", + "description": "Loads the list of product prices.", "parameters": [ { - "name": "identifier", + "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": "PriceLoadAllController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "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 - }, - "deprecated": false - } - }, - "/product/catalog/catalogs/{identifier}/products/view": { + ] + }, "post": { - "operationId": "ibexa.product_catalog.rest.catalogs.products.view", + "operationId": "ibexa.product_catalog.rest.prices.create", "tags": [ - "Product Catalog" + "Product" ], "responses": { "200": { - "description": "The view in XML or JSON format.", + "description": "OK - creates product price.", "content": { - "application/vnd.ibexa.api.ProductView+json": { + "application/vnd.ibexa.api.CustomPrice+json": { "schema": { - "$ref": "#/components/schemas/ProductViewWrapper" + "$ref": "#/components/schemas/CustomPriceWrapper" }, "example": { - "ProductView": { - "_media-type": "application/vnd.ibexa.api.ProductView+json", - "identifier": "TitleView", - "ProductQuery": { - "_media-type": "application/vnd.ibexa.api.ProductQuery+json" + "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 }, - "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": [] - } - ] - } - } + "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" } } - }, - "application/vnd.ibexa.api.ProductView+xml": { - "schema": { - "$ref": "#/components/schemas/ProductView" - } } } }, "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": "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.", + "summary": "Create product price or custom price", + "description": "Create product price or custom price.", "parameters": [ { - "name": "identifier", + "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": "X-CSRF-Token", @@ -20514,436 +13032,421 @@ "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.", + "description": "The product price schema encoded in JSON format.", "content": { - "application/vnd.ibexa.api.ProductViewInput+json": { + "application/vnd.ibexa.api.CustomPriceCreateStruct+json": { "schema": { - "$ref": "#/components/schemas/ProductViewInputWrapper" + "$ref": "#/components/schemas/CustomPriceCreateStructWrapper" }, "example": { - "ViewInput": { - "identifier": "TitleView", - "ProductQuery": { - "Query": { - "ProductCodeCriterion": "test", - "ProductAvailabilityCriterion": true - } - } + "CustomPriceCreateStruct": { + "customerGroup": "test", + "amount": 2500, + "customAmount": 1500, + "currency": "EUR" } } }, - "application/vnd.ibexa.api.ProductViewInput+xml": { + "application/vnd.ibexa.api.PriceCreateStruct+json": { "schema": { - "$ref": "#/components/schemas/ProductViewInput" + "$ref": "#/components/schemas/PriceCreateStructWrapper" + }, + "example": { + "PriceCreateStruct": { + "amount": 9, + "currency": "CHF" + } } } }, "required": false - }, - "deprecated": false + } } }, - "/product/catalog/currencies": { + "/product/catalog/products/{code}/prices/{currencyCode}": { "get": { - "operationId": "ibexa.product_catalog.rest.currencies", + "operationId": "ibexa.product_catalog.rest.prices.get.base_price", "tags": [ - "Product Currency" + "Product" ], "responses": { "200": { - "description": "OK - loads currencies.", + "description": "OK - gets price in given currency.", "content": { - "application/vnd.ibexa.api.CurrencyList+json": { + "application/vnd.ibexa.api.Price+json": { "schema": { - "$ref": "#/components/schemas/CurrencyListWrapper" + "$ref": "#/components/schemas/PriceWrapper" }, "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 - } - ] + "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 currencies." + "description": "Error - the user has no permission to read prices." + }, + "404": { + "description": "Error - the price does not exist." } }, - "summary": "Load currencies", - "description": "Loads the list of currencies.", - "parameters": [], - "deprecated": false - }, - "post": { - "operationId": "ibexa.product_catalog.rest.currencies.create", + "summary": "Get price in given currency", + "description": "Get price in given currency.", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "PriceLoadByProductCodeController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "currencyCode", + "in": "path", + "description": "PriceLoadByProductCodeController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] + } + }, + "/product/catalog/products/{code}/prices/{currencyCode}/customer-group/{customerGroupIdentifier}": { + "get": { + "operationId": "ibexa.product_catalog.rest.prices.get.custom_price", "tags": [ - "Product Currency" + "Product" ], "responses": { "200": { - "description": "If set, the new currency is returned in JSON format.", + "description": "OK - gets price in given currency and customer group.", "content": { - "application/vnd.ibexa.api.Currency+json": { + "application/vnd.ibexa.api.CustomPrice+json": { "schema": { - "$ref": "#/components/schemas/CurrencyWrapper" + "$ref": "#/components/schemas/CustomPriceWrapper" }, "example": { - "Currency": { - "_media-type": "application/vnd.ibexa.api.Currency+json", - "id": 181, - "code": "cur", - "subunits": 1, - "enabled": true + "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" } } } } }, - "400": { - "description": "Error - the input does not match the input schema definition." - }, "401": { - "description": "Error - the user is not authorized to create this currency." + "description": "Error - the user has no permission to read prices." }, - "406": { - "description": "Error - a currency with this code already exists." + "404": { + "description": "Error - the price does not exist." } }, - "summary": "Create currency", - "description": "Creates a new currency.", + "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 is required when passing user 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 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 - } - } - } + "explode": false }, - "required": false - }, - "deprecated": false + { + "name": "currencyCode", + "in": "path", + "description": "PriceLoadByProductCodeController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "customerGroupIdentifier", + "in": "path", + "description": "PriceLoadByProductCodeController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + } + ] } }, - "/product/catalog/currencies/view": { - "post": { - "operationId": "ibexa.product_catalog.rest.currencies.view", + "/product/catalog/products/{code}/prices/{id}": { + "delete": { + "operationId": "ibexa.product_catalog.rest.prices.delete", "tags": [ - "Product Currency" + "Product" ], "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" - } - } - } + "description": "No content - the given price is deleted." }, - "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": "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.", + "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, - "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.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", + ] + }, + "patch": { + "operationId": "ibexa.product_catalog.rest.prices.update", "tags": [ - "Product Currency" + "Product" ], "responses": { "200": { - "description": "OK - loads the currency.", + "description": "OK - updates product price.", "content": { - "application/vnd.ibexa.api.Currency+json": { + "application/vnd.ibexa.api.CustomPrice+json": { "schema": { - "$ref": "#/components/schemas/CurrencyWrapper" + "$ref": "#/components/schemas/CustomPriceWrapper" }, "example": { - "Currency": { - "_media-type": "application/vnd.ibexa.api.Currency+json", + "CustomPrice": { + "_media-type": "application/vnd.ibexa.api.CustomPrice+json", "id": 3, - "code": "ALL", - "subunits": 2, - "enabled": false + "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" } } } } }, - "401": { - "description": "Error - the user has no permission to read currencies." + "400": { + "description": "Error - the input does not match the input schema definition." }, - "404": { - "description": "Error - the currency does not exist." + "401": { + "description": "Error - the user is not authorized to update this price." } }, - "summary": "Load currency", - "description": "Loads a currency.", + "summary": "Update product price", + "description": "Updates product price.", "parameters": [ + { + "name": "code", + "in": "path", + "description": "PriceUpdateController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, { "name": "id", "in": "path", - "description": "", + "description": "PriceUpdateController 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 + "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.product_catalog.rest.currencies.delete", + "operationId": "ibexa.product_catalog.rest.products.delete", "tags": [ - "Product Currency" + "Product" ], "responses": { - "200": { - "description": "No content - the given currency is deleted." + "204": { + "description": "No content - the given product is deleted." }, "401": { - "description": "Error - the user is not authorized to delete this currency." + "description": "Error - the user is not authorized to delete this product." } }, - "summary": "Delete currency", - "description": "Deletes the given currency.", + "summary": "Delete product", + "description": "Deletes the given product.", "parameters": [ { - "name": "id", + "name": "identifier", "in": "path", - "description": "", + "description": "ProductDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "X-CSRF-Token", @@ -20951,37 +13454,187 @@ "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.product_catalog.rest.currencies.update", + ] + } + }, + "/product/catalog/products/{productTypeIdentifier}": { + "post": { + "operationId": "ibexa.product_catalog.rest.products.create", "tags": [ - "Product Currency" + "Product" ], "responses": { - "200": { - "description": "If set, the updated currency 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.Currency+json": { + "application/vnd.ibexa.api.ProductCreate+json": { "schema": { - "$ref": "#/components/schemas/CurrencyWrapper" + "$ref": "#/components/schemas/ProductWrapper" }, "example": { - "Currency": { - "_media-type": "application/vnd.ibexa.api.Currency+json", - "id": 1, - "code": "AFN", - "subunits": 1, - "enabled": false + "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": [] } } } @@ -20991,31 +13644,29 @@ "description": "Error - the input does not match the input schema definition." }, "401": { - "description": "Error - the user is not authorized to create this User." + "description": "Error - the user is not authorized to update this product." }, "403": { - "description": "Error - a currency with the same ID already exists." + "description": "Error - a product with the same name already exists." }, "404": { - "description": "Error - the currency with the given ID does not exist." + "description": "Error - no product with the given code exists." } }, - "summary": "Update currency", - "description": "Updates a currency.", + "summary": "Create product", + "description": "Creates a new product.", "parameters": [ { - "name": "id", + "name": "productTypeIdentifier", "in": "path", - "description": "", + "description": "ProductCreateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "X-CSRF-Token", @@ -21023,108 +13674,188 @@ "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 CurrencyUpdate schema encoded in XML or JSON format.", + "description": "The product schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.CurrencyUpdate+json": { + "application/vnd.ibexa.api.ProductCreate+json": { "schema": { - "$ref": "#/components/schemas/CurrencyUpdateWrapper" + "$ref": "#/components/schemas/ProductCreateWrapper" }, "example": { - "CurrencyUpdate": { - "subunits": 1, - "enabled": false + "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/customer_groups": { + "/product/catalog/attributes": { "get": { - "operationId": "ibexa.product_catalog.rest.customer_groups.list", + "operationId": "ibexa.product_catalog.rest.attributes", "tags": [ - "Product Customer Group" + "Product Attribute" ], "responses": { "200": { - "description": "If set, the customer groups list 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.CustomerGroupList+json": { + "application/vnd.ibexa.api.AttributeList+json": { "schema": { - "$ref": "#/components/schemas/CustomerGroupListWrapper" + "$ref": "#/components/schemas/AttributeListWrapper" }, "example": { - "CustomerGroupList": { - "_media-type": "application/vnd.ibexa.api.CustomerGroupList+json", - "CustomerGroup": [ + "AttributeList": { + "_media-type": "application/vnd.ibexa.api.AttributeList+json", + "Attribute": [ { - "_media-type": "application/vnd.ibexa.api.CustomerGroup+json", - "id": 1, - "name": "Resellers", - "identifier": "resellers", + "_media-type": "application/vnd.ibexa.api.Attribute+json", + "identifier": "attrib1", + "name": "Attrib1", "description": "", - "users": [], - "global_price_rate": "0.00" + "type": "Checkbox", + "type_identifier": "checkbox", + "value": true, + "group": "Attribute Group Test", + "position": 0, + "options": [] }, { - "_media-type": "application/vnd.ibexa.api.CustomerGroup+json", - "id": 2, - "name": "Contractors", - "identifier": "contractors", + "_media-type": "application/vnd.ibexa.api.Attribute+json", + "identifier": "attrib2", + "name": "Attrib2", "description": "", - "users": [], - "global_price_rate": "-20.00" + "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 customer groups." + "description": "Error - the user has no permission to read user groups." } }, - "summary": "Load customer groups", - "description": "Returns a list of customer 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": [], - "deprecated": false + "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.customer_group.create", + "operationId": "ibexa.product_catalog.rest.attributes.create", "tags": [ - "Product Customer Group" + "Product Attribute" ], "responses": { "201": { - "description": "If set, the new customer group is returned in XML or JSON format.", + "description": "If set, the new attribute is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.CustomerGroup+json": { + "application/vnd.ibexa.api.Attribute+json": { "schema": { - "$ref": "#/components/schemas/CustomerGroupWrapper" + "$ref": "#/components/schemas/AttributeWrapper" }, "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" + "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": [] } } } @@ -21134,91 +13865,162 @@ "description": "Error - the input does not match the input schema definition." }, "401": { - "description": "Error - the user is not authorized to create this Customer Group." + "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, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": 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 + } + } + }, + "/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": "AttributeTranslationDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false + }, + { + "name": "languageCode", + "in": "path", + "description": "AttributeTranslationDeleteController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false }, - "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 + "explode": 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": { + "/product/catalog/attributes/view": { "post": { - "operationId": "ibexa.product_catalog.rest.customer_groups.view", + "operationId": "ibexa.product_catalog.rest.attributes.view", "tags": [ - "Product Customer Group" + "Product Attribute" ], "responses": { "200": { "description": "The view in XML or JSON format.", "content": { - "application/vnd.ibexa.api.CustomerGroupView+json": { + "application/vnd.ibexa.api.AttributeView+json": { "schema": { - "$ref": "#/components/schemas/CustomerGroupViewWrapper" + "$ref": "#/components/schemas/AttributeViewWrapper" }, "example": { - "CustomerGroupView": { - "_media-type": "application/vnd.ibexa.api.CustomerGroupView+json", + "AttributeView": { + "_media-type": "application/vnd.ibexa.api.AttributeView+json", "identifier": "TitleView", - "CustomerGroupQuery": { - "_media-type": "application/vnd.ibexa.api.CustomerGroupQuery+json" + "AttributeQuery": { + "_media-type": "application/vnd.ibexa.api.AttributeQuery+json" }, "Result": { "_media-type": "application/vnd.ibexa.api.ViewResult+json", "count": 1, - "CustomerGroupList": { - "_media-type": "application/vnd.ibexa.api.CustomerGroupList+json", - "CustomerGroup": [ + "AttributeList": { + "_media-type": "application/vnd.ibexa.api.AttributeList+json", + "Attribute": [ { - "_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" + "_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 + } + } } ] } @@ -21226,9 +14028,9 @@ } } }, - "application/vnd.ibexa.api.CustomerGroupView+xml": { + "application/vnd.ibexa.api.AttributeView+xml": { "schema": { - "$ref": "#/components/schemas/CustomerGroupView" + "$ref": "#/components/schemas/AttributeView" } } } @@ -21237,7 +14039,7 @@ "description": "Error - the input does not match the input schema definition." } }, - "summary": "Filter customer groups", + "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": [ { @@ -21246,124 +14048,128 @@ "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.CustomerGroupViewInput+json": { + "application/vnd.ibexa.api.AttributeViewInput+json": { "schema": { - "$ref": "#/components/schemas/CustomerGroupViewInputWrapper" + "$ref": "#/components/schemas/AttributeViewInputWrapper" }, "example": { "ViewInput": { "identifier": "TitleView", - "CustomerGroupQuery": { + "AttributeQuery": { "limit": "10", - "offset": "0" + "offset": "0", + "Query": { + "AttributeNameCriterion": "measure", + "AttributeGroupIdentifierCriterion": "test_attribute_group" + } } } } }, - "application/vnd.ibexa.api.CustomerGroupViewInput+xml": { + "application/vnd.ibexa.api.AttributeViewInput+xml": { "schema": { - "$ref": "#/components/schemas/CustomerGroupViewInput" + "$ref": "#/components/schemas/AttributeViewInput" } } }, "required": false - }, - "deprecated": false + } } }, - "/product/catalog/customer_groups/{identifier}": { + "/product/catalog/attributes/{id}": { "get": { - "operationId": "ibexa.product_catalog.rest.customer_groups.identifier", + "operationId": "ibexa.product_catalog.rest.attributes.get", "tags": [ - "Product Customer Group" + "Product Attribute" ], "responses": { "200": { - "description": "If set, the customer group is returned in XML or JSON format.", + "description": "Attribute - If set, the given attribute is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.CustomerGroup+json": { + "application/vnd.ibexa.api.Attribute+json": { "schema": { - "$ref": "#/components/schemas/CustomerGroupWrapper" + "$ref": "#/components/schemas/AttributeWrapper" }, "example": { - "CustomerGroup": { - "_media-type": "application/vnd.ibexa.api.CustomerGroup+json", - "id": 1, - "name": "Resellers", - "identifier": "resellers", + "Attribute": { + "_media-type": "application/vnd.ibexa.api.Attribute+json", + "identifier": "attrib2", + "name": "Attrib2", "description": "", - "users": [], - "global_price_rate": "0.00" + "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 customer groups." + "description": "Error - the user has no permission to read the attribute." } }, - "summary": "Load customer group", - "description": "Returns a customer group", + "summary": "Load attribute", + "description": "Loads given attribute.", "parameters": [ { - "name": "identifier", + "name": "id", "in": "path", - "description": "", + "description": "AttributeLoadByIdentifierController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] }, "delete": { - "operationId": "ibexa.product_catalog.rest.customer_groups.delete", + "operationId": "ibexa.product_catalog.rest.attributes.delete", "tags": [ - "Product Customer Group" + "Product Attribute" ], "responses": { - "204": { - "description": "No content - the given customer group is deleted." + "200": { + "description": "No Content." }, "401": { - "description": "Error - the user is not authorized to delete this customer group." + "description": "Error - the user is not authorized to delete this attribute." } }, - "summary": "Delete customer group", - "description": "Deletes the given customer group.", + "summary": "Delete attribute", + "description": "The given attribute is removed from the attribute group.", "parameters": [ { - "name": "identifier", + "name": "id", "in": "path", - "description": "", + "description": "AttributeDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "X-CSRF-Token", @@ -21371,39 +14177,41 @@ "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 - }, + ] + } + }, + "/product/catalog/attributes/{id}/{group_id}": { "patch": { - "operationId": "ibexa.product_catalog.rest.customer_group.update", + "operationId": "ibexa.product_catalog.rest.attributes.update", "tags": [ - "Product Customer Group" + "Product Attribute" ], "responses": { "201": { - "description": "If set, the updated customer group is returned in XML or JSON format.", + "description": "If set, the updated attribute is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.CustomerGroup+json": { + "application/vnd.ibexa.api.Attribute+json": { "schema": { - "$ref": "#/components/schemas/CustomerGroupWrapper" + "$ref": "#/components/schemas/AttributeWrapper" }, "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" + "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": [] } } } @@ -21413,425 +14221,169 @@ "description": "Error - the input does not match the input schema definition." }, "401": { - "description": "Error - the user is not authorized to update a customer group." + "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 customer group", - "description": "Updates the given customer group.", + "summary": "Update attribute", + "description": "Updates an attribute.", "parameters": [ { - "name": "identifier", + "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.", + "description": "AttributeUpdateController 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}": { - "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" - } - } - } - } + "explode": false }, - "401": { - "description": "Error - the user has no permission to read customer groups." - } - }, - "summary": "Load customer group", - "description": "Returns a customer group", - "parameters": [ { - "name": "id", + "name": "group_id", "in": "path", - "description": "", + "description": "AttributeUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { - "type": "integer" + "type": "string" }, "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" - } - } - } + "explode": false }, - "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 + "explode": false } ], "requestBody": { - "description": "The view input in XML or JSON format.", + "description": "If set, the updated attribute group is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.RegionViewInput+json": { + "application/vnd.ibexa.api.AttributeUpdate+json": { "schema": { - "$ref": "#/components/schemas/RegionViewInputWrapper" + "$ref": "#/components/schemas/AttributeUpdateWrapper" }, "example": { - "ViewInput": { - "identifier": "TitleView", - "RegionQuery": { - "limit": "10", - "offset": "0" + "AttributeUpdate": { + "identifier": "attr_group", + "names": { + "eng-GB": "Attribute Group" + }, + "descriptions": { + "eng-GB": "description" + }, + "position": 0, + "options": { + "foo": "bar" } } } - }, - "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": { + "/product/catalog/attribute_groups": { "get": { - "operationId": "ibexa.product_catalog.rest.product_types", + "operationId": "ibexa.product_catalog.rest.attribute_groups", "tags": [ - "Product Type" + "Product Attribute Group" ], "responses": { "200": { - "description": "ProductTypeList - If set, the product type list is returned in XML or JSON format.", + "description": "AttributeGroupList - If set, the attribute group list is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ProductTypeList+json": { + "application/vnd.ibexa.api.AttributeGroupList+json": { "schema": { - "$ref": "#/components/schemas/ProductTypeListWrapper" + "$ref": "#/components/schemas/AttributeGroupListWrapper" }, "example": { - "ProductTypeList": { - "_media-type": "application/vnd.ibexa.api.ProductTypeList+json", - "ProductType": [ + "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.ProductType+json", - "identifier": "s_rope", - "name": "Static ropes", - "AttributeAssignmentList": [] + "_media-type": "application/vnd.ibexa.api.AttributeGroup+json", + "name": "Dimensions", + "identifier": "ag_dimensions", + "position": 0 } ] } } }, - "application/vnd.ibexa.api.ProductTypeList+xml": { + "application/vnd.ibexa.api.AttributeGroupList+xml": { "schema": { - "$ref": "#/components/schemas/ProductTypeList" + "$ref": "#/components/schemas/AttributeGroupList" } } } }, "401": { - "description": "Error - the user has no permission to read product type." + "description": "Error - the user has no permission to read attribute groups." } }, - "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.", + "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 ProductTypeList schema encoded in XML or JSON format.", + "description": "The AttributeGroupListGet schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ProductTypeListGet+json": { + "application/vnd.ibexa.api.AttributeGroupListGet+json": { "schema": { - "$ref": "#/components/schemas/ProductTypeListGetWrapper" + "$ref": "#/components/schemas/AttributeGroupListGetWrapper" }, "example": { - "ProductTypeListGet": { - "name_prefix": "s", + "AttributeGroupListGet": { + "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", + "operationId": "ibexa.product_catalog.rest.attribute_groups.create", "tags": [ - "Product Type" + "Product Attribute Group" ], "responses": { "201": { - "description": "If set, the new product type is returned in XML or JSON format.", + "description": "If set, the new attribute group is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ProductType+json": { + "application/vnd.ibexa.api.AttributeGroup+json": { "schema": { - "$ref": "#/components/schemas/ProductTypeWrapper" + "$ref": "#/components/schemas/AttributeGroupWrapper" }, "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": [] - } - } - ] + "AttributeGroup": { + "_media-type": "application/vnd.ibexa.api.AttributeGroup+json", + "name": "Attribute Group Test", + "identifier": "attr_group_test", + "position": 0 } } } @@ -21841,17 +14393,14 @@ "description": "Error - the input does not match the input schema definition." }, "401": { - "description": "Error - the user is not authorized to create this product type." + "description": "Error - the user is not authorized to create this attribute group." }, "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." + "description": "Error - an attribute group with the same identifier already exists." } }, - "summary": "Create product type", - "description": "Creates a new product type.", + "summary": "Create attribute group", + "description": "Creates a new attribute group.", "parameters": [ { "name": "X-CSRF-Token", @@ -21859,242 +14408,123 @@ "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 ProductType schema encoded in XML or JSON format.", + "description": "The AttributeGroup schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ProductTypeCreate+json": { + "application/vnd.ibexa.api.AttributeGroupCreate+json": { "schema": { - "$ref": "#/components/schemas/ProductTypeCreateWrapper" + "$ref": "#/components/schemas/AttributeGroupCreateWrapper" }, "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 - } - } - } - ] - } + "AttributeGroupCreate": { + "identifier": "attr_group_test", + "names": { + "eng-GB": "Attribute Group Test" }, - "main_language_code": "eng-GB", - "assigned_attributes": [ - { - "identifier": "testAttr", - "is_required": false, - "is_discriminator": true - } - ] + "position": 0 } } } }, "required": false - }, - "deprecated": false + } } }, - "/product/catalog/product_types/is_used/{identifier}": { - "get": { - "operationId": "ibexa.product_catalog.rest.product_types.is_used", + "/product/catalog/attribute_groups/translation/{id}/{languageCode}": { + "delete": { + "operationId": "ibexa.product_catalog.rest.attribute_groups.translation.delete", "tags": [ - "Product Type" + "Product Attribute Group" ], "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" - } - } + "description": "No content - the given attribute group translation is deleted." }, - "404": { - "description": "Error - product type not found." + "401": { + "description": "Error - the user is not authorized to delete this attribute group translation assignment." } }, - "summary": "Check product type usage", - "description": "Checks whether the product type is in use.", + "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 + "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 is required when passing user session.", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } - ], - "deprecated": false + ] } }, - "/product/catalog/product_types/view": { + "/product/catalog/attribute_groups/view": { "post": { - "operationId": "ibexa.product_catalog.rest.product_types.view", + "operationId": "ibexa.product_catalog.rest.attribute_groups.view", "tags": [ - "Product Type" + "Product Attribute Group" ], "responses": { "200": { "description": "The view in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ProductTypeView+json": { + "application/vnd.ibexa.api.AttributeGroupView+json": { "schema": { - "$ref": "#/components/schemas/ProductTypeViewWrapper" + "$ref": "#/components/schemas/AttributeGroupViewWrapper" }, "example": { - "ProductTypeView": { - "_media-type": "application/vnd.ibexa.api.ProductTypeView+json", + "AttributeGroupView": { + "_media-type": "application/vnd.ibexa.api.AttributeGroupView+json", "identifier": "TitleView", - "ProductTypeQuery": { - "_media-type": "application/vnd.ibexa.api.ProductTypeQuery+json" + "AttributeGroupQuery": { + "_media-type": "application/vnd.ibexa.api.AttributeGroupQuery+json" }, "Result": { "_media-type": "application/vnd.ibexa.api.ViewResult+json", "count": 1, - "ProductTypeList": { - "_media-type": "application/vnd.ibexa.api.ProductTypeList+json", - "ProductType": [ + "AttributeGroupList": { + "_media-type": "application/vnd.ibexa.api.AttributeGroupList+json", + "AttributeGroup": [ { - "_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": [] - } - } - ] + "_media-type": "application/vnd.ibexa.api.AttributeGroup+json", + "name": "Test Attribute group", + "identifier": "test_attribute_group", + "position": 0 } ] } @@ -22102,9 +14532,9 @@ } } }, - "application/vnd.ibexa.api.ProductTypeView+xml": { + "application/vnd.ibexa.api.AttributeGroupView+xml": { "schema": { - "$ref": "#/components/schemas/ProductTypeView" + "$ref": "#/components/schemas/AttributeGroupView" } } } @@ -22113,7 +14543,7 @@ "description": "Error - the input does not match the input schema definition." } }, - "summary": "Filter product types", + "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": [ { @@ -22122,132 +14552,142 @@ "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.ProductTypeViewInput+json": { + "application/vnd.ibexa.api.AttributeGroupViewInput+json": { "schema": { - "$ref": "#/components/schemas/ProductTypeViewInputWrapper" + "$ref": "#/components/schemas/AttributeGroupViewInputWrapper" }, "example": { "ViewInput": { "identifier": "TitleView", - "ProductTypeQuery": { + "AttributeGroupQuery": { "limit": "10", "offset": "0", - "name_prefix": "new" + "name_prefix": "test" } } } }, - "application/vnd.ibexa.api.ProductTypeViewInput+xml": { + "application/vnd.ibexa.api.AttributeGroupViewInput+xml": { "schema": { - "$ref": "#/components/schemas/ProductTypeViewInput" + "$ref": "#/components/schemas/AttributeGroupViewInput" } } }, "required": false - }, - "deprecated": false + } } }, - "/product/catalog/product_types/{identifier}": { + "/product/catalog/attribute_groups/{id}": { "get": { - "operationId": "ibexa.product_catalog.rest.product_type", + "operationId": "ibexa.product_catalog.rest.attribute_groups.get", "tags": [ - "Product Type" + "Product Attribute Group" ], "responses": { "200": { - "description": "OK - load the product type", + "description": "AttributeGroupGet - If set, the attribute group List is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ProductType+json": { + "application/vnd.ibexa.api.AttributeGroup+json": { "schema": { - "$ref": "#/components/schemas/ProductTypeWrapper" + "$ref": "#/components/schemas/AttributeGroupWrapper" }, "example": { - "ProductType": { - "_media-type": "application/vnd.ibexa.api.ProductType+json", - "identifier": "d_rope", - "name": "Dynamic ropes", - "AttributeAssignmentList": [] + "AttributeGroup": { + "_media-type": "application/vnd.ibexa.api.AttributeGroup+json", + "name": "Attribute Group Test", + "identifier": "attr_group_test", + "position": 0 } } }, - "application/vnd.ibexa.api.ProductType+xml": { + "application/vnd.ibexa.api.AttributeGroup+xml": { "schema": { - "$ref": "#/components/schemas/ProductType" + "$ref": "#/components/schemas/AttributeGroup" } } } }, "401": { - "description": "Error - the user has no permission to read product type." - }, - "404": { - "description": "Error - product type not found." + "description": "Error - the user has no permission to read attribute groups." } }, - "summary": "Load product type", - "description": "Returns the given product type.", + "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 + "explode": false } ], - "deprecated": false - } - }, - "/product/catalog/product_types/{id}": { + "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.product_catalog.rest.product_types.delete", + "operationId": "ibexa.product_catalog.rest.attribute_groups.delete", "tags": [ - "Product Type" + "Product Attribute Group" ], "responses": { "204": { - "description": "No content - the given product type is deleted." + "description": "No content - the given attribute group is deleted." }, "401": { - "description": "Error - the user is not authorized to delete this product type." + "description": "Error - the user is not authorized to delete this attribute group." } }, - "summary": "Delete product type", - "description": "Deletes the given product type.", + "summary": "Delete attribute group", + "description": "Deletes an attribute group.", "parameters": [ { "name": "id", "in": "path", - "description": "", + "description": "AttributeGroupDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "X-CSRF-Token", @@ -22255,56 +14695,40 @@ "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.product_catalog.rest.product_types.update", + "operationId": "ibexa.product_catalog.rest.attribute_groups.update", "tags": [ - "Product Type" + "Product Attribute Group" ], "responses": { "201": { - "description": "If set, the updated product type is returned in XML or JSON format.", + "description": "If set, the updated attribute group is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ProductType+json": { + "application/vnd.ibexa.api.AttributeGroup+json": { "schema": { - "$ref": "#/components/schemas/ProductTypeWrapper" + "$ref": "#/components/schemas/AttributeGroupWrapper" }, "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": [] - } - } - ] + "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" + } } } }, @@ -22312,28 +14736,29 @@ "description": "Error - the input does not match the input schema definition." }, "401": { - "description": "Error - the user is not authorized to create this product type." + "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 product type with the given ID does not exist." + "description": "Error - the group with the given ID does not exist." } }, - "summary": "Update product type", - "description": "Updates product type.", + "summary": "Update attribute group", + "description": "Updates an attribute group.", "parameters": [ { "name": "id", "in": "path", - "description": "", + "description": "AttributeGroupUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "X-CSRF-Token", @@ -22341,944 +14766,555 @@ "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" - } - ] - } + }, + "style": "simple", + "explode": 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" }, - "assigned_attributes": [ - { - "identifier": "size", - "is_required": false, - "is_discriminator": true - } - ] + "position": 0 } } + }, + "application/vnd.ibexa.api.AttributeGroupUpdate+xml": { + "schema": { + "$ref": "#/components/schemas/AttributeGroupUpdate" + } } }, "required": 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" + } + } + } + } }, - "deprecated": false + "summary": "List Attribute Types", + "description": "Lists all Attribute Types.", + "parameters": [] } }, - "/product/catalog/product_variant/{code}": { + "/product/catalog/attribute_types/{identifier}": { "get": { - "operationId": "ibexa.product_catalog.rest.product_variant", + "operationId": "ibexa.product_catalog.rest.attribute_type", "tags": [ - "Product Variant" + "Product Attribute Type" ], "responses": { "200": { - "description": "OK - loads the product variant.", + "description": "OK - returns the Attribute Type", "content": { - "application/vnd.ibexa.api.ProductVariant+json": { + "application/vnd.ibexa.api.AttributeType+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" - } - }, - { - "id": 719, - "fieldDefinitionIdentifier": "image", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_image_asset", - "fieldValue": { - "destinationContentId": null, - "alternativeText": null, - "source": null - } - }, - { - "id": 720, - "fieldDefinitionIdentifier": "category", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", - "fieldValue": { - "taxonomy_entries": [], - "taxonomy": null - } - } - ] - }, - "Relations": { - "_media-type": "application/vnd.ibexa.api.RelationList+json", - "_href": "/api/ibexa/v2/content/objects/152/versions/1/relations", - "Relation": [] - }, - "Thumbnail": { - "_media-type": "application/vnd.ibexa.api.Thumbnail+json", - "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", - "width": null, - "height": null, - "mimeType": "image/svg+xml" - } - } - }, - "Section": { - "_media-type": "application/vnd.ibexa.api.Section+json", - "_href": "/api/ibexa/v2/content/sections/1" - }, - "Locations": { - "_media-type": "application/vnd.ibexa.api.LocationList+json", - "_href": "/api/ibexa/v2/content/objects/152/locations" - }, - "Owner": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "lastModificationDate": "2022-07-21T15:17:18+02:00", - "publishedDate": "2022-07-21T15:17:18+02:00", - "mainLanguageCode": "eng-GB", - "currentVersionNo": 1, - "alwaysAvailable": true, - "isHidden": false, - "status": "PUBLISHED", - "ObjectStates": { - "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", - "_href": "/api/ibexa/v2/content/objects/152/objectstates" - } - }, - "Thumbnail": { - "_media-type": "application/vnd.ibexa.api.Thumbnail+json", - "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", - "width": null, - "height": null, - "mimeType": "image/svg+xml" - }, - "created_at": 1658409438, - "updated_at": 1658409438, - "AttributesList": [] - }, - "DiscriminatorAttributesList": [ - { - "_media-type": "application/vnd.ibexa.api.Attribute+json", - "identifier": "number", - "name": "number", - "description": "", - "type": "Float", - "type_identifier": "float", - "value": 1.5, - "group": "test", - "position": 0, - "options": { - "min": 4, - "max": 5 - } - }, - { - "_media-type": "application/vnd.ibexa.api.Attribute+json", - "identifier": "testattr", - "name": "testAttr", - "description": "", - "type": "Integer", - "type_identifier": "integer", - "value": 5, - "group": "test", - "position": 0, - "options": { - "min": 4, - "max": 5 - } - } - ] - } + "$ref": "#/components/schemas/AttributeTypeWrapper" + } + }, + "application/vnd.ibexa.api.AttributeType+xml": { + "schema": { + "$ref": "#/components/schemas/AttributeType" } } } }, - "401": { - "description": "Error - the user is not authorized to view this product variant." - }, "404": { - "description": "Error - no product variant with the given code exists." + "description": "Error - The Attribute Type does not exist." } }, - "summary": "Load product variant", - "description": "Loads the given product variant.", + "summary": "Get Attribute Type", + "description": "Gets an Attribute Type by its identifier.", "parameters": [ { - "name": "code", + "name": "identifier", "in": "path", - "description": "", + "description": "AttributeTypeLoadByIdentifierController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] } }, - "/product/catalog/product_variants/generate/{baseProductCode}": { + "/product/catalog/catalogs": { "post": { - "operationId": "ibexa.product_catalog.rest.product_variants.generate", + "operationId": "ibexa.product_catalog.rest.catalogs.create", "tags": [ - "Product Variant" + "Product Catalog" ], "responses": { "201": { - "description": "No content - product variants are generated." + "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 create this product variant." + "description": "Error - the user is not authorized to update this catalog." }, "403": { - "description": "Error - a product variant with the same name already exists." + "description": "Error - a catalog with the same name already exists." }, "404": { - "description": "Error - no base product with the given code exists." + "description": "Error - no catalog with the given code exists." } }, - "summary": "Generate product variants", - "description": "Generates new product variants based on selected (discriminator) attributes.", + "summary": "Create catalog", + "description": "Creates a new catalog.", "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 product variant schema encoded in XML or JSON format.", + "description": "The catalog schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ProductVariantGenerate+json": { + "application/vnd.ibexa.api.CatalogCreate+json": { "schema": { - "$ref": "#/components/schemas/ProductVariantGenerateWrapper" + "$ref": "#/components/schemas/CatalogCreateWrapper" }, "example": { - "ProductVariantGenerate": { - "attributes": { - "width": [ - 123 + "CatalogCreate": { + "identifier": "test_catalog", + "criteria": { + "ProductCodeCriterion": [ + "ski", + "snowboard" ], - "colors": [ - "#000000", - "#ffffff", - "#d4d400", - "#ff0000" + "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 + } + } + }, + "/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": ">=" + } + } ] } } } } }, - "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": "\n
test
\n", - "xhtml5edit": "\n

test

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

test

\n" - } - }, - { - "id": 719, - "fieldDefinitionIdentifier": "image", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_image_asset", - "fieldValue": { - "destinationContentId": null, - "alternativeText": null, - "source": null - } - }, - { - "id": 720, - "fieldDefinitionIdentifier": "category", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", - "fieldValue": { - "taxonomy_entries": [], - "taxonomy": null - } - } - ] - }, - "Relations": { - "_media-type": "application/vnd.ibexa.api.RelationList+json", - "_href": "/api/ibexa/v2/content/objects/152/versions/1/relations", - "Relation": [] - }, - "Thumbnail": { - "_media-type": "application/vnd.ibexa.api.Thumbnail+json", - "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", - "width": null, - "height": null, - "mimeType": "image/svg+xml" - } - } - }, - "Section": { - "_media-type": "application/vnd.ibexa.api.Section+json", - "_href": "/api/ibexa/v2/content/sections/1" - }, - "Locations": { - "_media-type": "application/vnd.ibexa.api.LocationList+json", - "_href": "/api/ibexa/v2/content/objects/152/locations" - }, - "Owner": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "lastModificationDate": "2022-07-21T15:17:18+02:00", - "publishedDate": "2022-07-21T15:17:18+02:00", - "mainLanguageCode": "eng-GB", - "currentVersionNo": 1, - "alwaysAvailable": true, - "isHidden": false, - "status": "PUBLISHED", - "ObjectStates": { - "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", - "_href": "/api/ibexa/v2/content/objects/152/objectstates" - } - }, - "Thumbnail": { - "_media-type": "application/vnd.ibexa.api.Thumbnail+json", - "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", - "width": null, - "height": null, - "mimeType": "image/svg+xml" - }, - "created_at": 1658409438, - "updated_at": 1658409438, - "AttributesList": [] + "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.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" }, - "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 - } - }, + "created": 1665479475, + "modified": 1665479475, + "status": "draft", + "Criteria": [ { - "_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.ProductCode+json", + "ProductCodeCriterion": { + "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json", + "codes": [ + "test" + ] } } ] @@ -23289,119 +15325,312 @@ } } }, - "application/vnd.ibexa.api.ProductVariantView+xml": { + "application/vnd.ibexa.api.CatalogView+xml": { "schema": { - "$ref": "#/components/schemas/ProductVariantView" + "$ref": "#/components/schemas/CatalogView" } } } }, "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 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": "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.CatalogViewInput+json": { "schema": { - "$ref": "#/components/schemas/ProductVariantViewInputWrapper" + "$ref": "#/components/schemas/CatalogViewInputWrapper" }, "example": { "ViewInput": { "identifier": "TitleView", - "ProductVariantQuery": { - "offset": "0", - "limit": "10" + "CatalogQuery": { + "Query": { + "CatalogIdentifierCriterion": "test", + "CatalogNameCriterion": "test" + } } } } }, - "application/vnd.ibexa.api.ProductVariantViewInput+xml": { + "application/vnd.ibexa.api.CatalogViewInput+xml": { "schema": { - "$ref": "#/components/schemas/ProductVariantViewInput" + "$ref": "#/components/schemas/CatalogViewInput" } } }, "required": false - }, - "deprecated": false + } } }, - "/product/catalog/product_variants/{baseProductCode}": { - "post": { - "operationId": "ibexa.product_catalog.rest.product_variants.create", + "/product/catalog/catalogs/{identifier}": { + "get": { + "operationId": "ibexa.product_catalog.rest.catalogs.get", "tags": [ - "Product Variant" + "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": "No content - product variant is created." + "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 create this product variant." + "description": "Error - the user is not authorized to update this catalog." }, "403": { - "description": "Error - a product variant with the same name already exists." + "description": "Error - a catalog with the same identifier already exists." }, "404": { - "description": "Error - no base product with the given code exists." + "description": "Error - no catalog with the given identifier exists." } }, - "summary": "Create product variant", - "description": "Creates a new product variant.", + "summary": "Update catalog", + "description": "Updates a catalog.", "parameters": [ { - "name": "baseProductCode", + "name": "identifier", "in": "path", - "description": "", + "description": "CatalogUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "X-CSRF-Token", @@ -23409,69 +15638,272 @@ "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 schema encoded in XML or JSON format.", + "description": "If set, the updated catalog is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ProductVariantCreate+json": { + "application/vnd.ibexa.api.CatalogUpdate+json": { "schema": { - "$ref": "#/components/schemas/ProductVariantCreateWrapper" + "$ref": "#/components/schemas/CatalogUpdateWrapper" }, "example": { - "ProductVariantCreate": { - "attributes": { - "width": 100, - "height": 50, - "color": "#000000" + "CatalogUpdate": { + "identifier": "test_catalog_updated", + "criteria": { + "ProductCodeCriterion": [ + "ski" + ], + "ProductAvailabilityCriterion": false, + "CreatedAtCriterion": { + "operator": ">=", + "created_at": "12-12-2022" + } }, - "code": "macbook_pro" + "names": { + "eng-GB": "Snow Equipment updated" + }, + "descriptions": { + "eng-GB": "Snow Equipment catalog for 2022" + }, + "transition": "publish" } } } }, "required": false - }, - "deprecated": false + } } }, - "/product/catalog/product_variants/{code}": { - "delete": { - "operationId": "ibexa.product_catalog.rest.product_variants.delete", + "/product/catalog/catalogs/{identifier}/products/view": { + "post": { + "operationId": "ibexa.product_catalog.rest.catalogs.products.view", "tags": [ - "Product Variant" + "Product Catalog" ], "responses": { - "204": { - "description": "No content - product variant is deleted." + "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" + } + } + } }, - "401": { - "description": "Error - the user is not authorized to delete this product variant." + "400": { + "description": "Error - the input does not match the input schema definition." } }, - "summary": "Delete product variant", - "description": "Deletes the given product variant.", + "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": "code", + "name": "identifier", "in": "path", - "description": "", + "description": "CatalogProductsViewController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "X-CSRF-Token", @@ -23479,243 +15911,136 @@ "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.product_catalog.rest.product_variants.update", + "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 + } + } + }, + "/product/catalog/currencies": { + "get": { + "operationId": "ibexa.product_catalog.rest.currencies", "tags": [ - "Product Variant" + "Product Currency" ], "responses": { - "201": { - "description": "If set, the updated product variant is returned in XML or JSON format.", + "200": { + "description": "OK - loads currencies.", "content": { - "application/vnd.ibexa.api.ProductVariant+json": { + "application/vnd.ibexa.api.CurrencyList+json": { "schema": { - "$ref": "#/components/schemas/ProductVariantWrapper" + "$ref": "#/components/schemas/CurrencyListWrapper" }, "example": { - "ProductVariant": { - "_media-type": "application/vnd.ibexa.api.ProductVariant+json", - "code": "test", - "name": "Macbook Air ", - "Product": { - "_media-type": "application/vnd.ibexa.api.Product+json", - "code": "mac_air", - "name": "Macbook Air", - "ProductType": { - "_media-type": "application/vnd.ibexa.api.ProductType+json", - "identifier": "laptop", - "name": "Laptop", - "AttributeAssignmentList": [ - { - "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", - "is_required": false, - "is_discriminator": true, - "Attribute": { - "_media-type": "application/vnd.ibexa.api.Attribute+json", - "identifier": "number", - "name": "number", - "description": "", - "type": "Float", - "type_identifier": "float", - "value": 1.5, - "group": "test", - "position": 0, - "options": { - "min": 4, - "max": 5 - } - } - }, - { - "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", - "is_required": false, - "is_discriminator": true, - "Attribute": { - "_media-type": "application/vnd.ibexa.api.Attribute+json", - "identifier": "testattr", - "name": "testAttr", - "description": "", - "type": "Integer", - "type_identifier": "integer", - "value": 5, - "group": "test", - "position": 0, - "options": { - "min": 4, - "max": 5 - } - } - } - ] - }, - "Content": { - "_media-type": "application/vnd.ibexa.api.Content+json", - "_href": "/api/ibexa/v2/content/objects/152", - "_remoteId": "2d61ff8d0043eb299ca8c29c74f25441", - "_id": 152, - "ContentType": { - "_media-type": "application/vnd.ibexa.api.ContentType+json", - "_href": "/api/ibexa/v2/content/types/56" - }, - "Name": "Macbook Air", - "TranslatedName": "Macbook Air", - "Versions": { - "_media-type": "application/vnd.ibexa.api.VersionList+json", - "_href": "/api/ibexa/v2/content/objects/152/versions" - }, - "CurrentVersion": { - "_media-type": "application/vnd.ibexa.api.Version+json", - "_href": "/api/ibexa/v2/content/objects/152/currentversion", - "Version": { - "_media-type": "application/vnd.ibexa.api.Version+json", - "_href": "/api/ibexa/v2/content/objects/152/versions/1", - "VersionInfo": { - "id": 635, - "versionNo": 1, - "status": "PUBLISHED", - "modificationDate": "2022-07-21T15:17:18+02:00", - "Creator": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "creationDate": "2022-07-21T15:17:18+02:00", - "initialLanguageCode": "eng-GB", - "languageCodes": "eng-GB", - "VersionTranslationInfo": { - "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", - "Language": [ - { - "languageCode": "eng-GB" - } - ] - }, - "names": { - "value": [ - { - "_languageCode": "eng-GB", - "#text": "Macbook Air" - } - ] - }, - "Content": { - "_media-type": "application/vnd.ibexa.api.ContentInfo+json", - "_href": "/api/ibexa/v2/content/objects/152" - } - }, - "Fields": { - "field": [ - { - "id": 716, - "fieldDefinitionIdentifier": "name", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_string", - "fieldValue": "Macbook Air" - }, - { - "id": 717, - "fieldDefinitionIdentifier": "product_specification", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_product_specification", - "fieldValue": { - "id": 89, - "code": "mac_air", - "attributes": [] - } - }, - { - "id": 718, - "fieldDefinitionIdentifier": "description", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_richtext", - "fieldValue": { - "xml": "\n
test
\n", - "xhtml5edit": "\n

test

\n" - } - }, - { - "id": 719, - "fieldDefinitionIdentifier": "image", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_image_asset", - "fieldValue": { - "destinationContentId": null, - "alternativeText": null, - "source": null - } - }, - { - "id": 720, - "fieldDefinitionIdentifier": "category", - "languageCode": "eng-GB", - "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", - "fieldValue": { - "taxonomy_entries": [], - "taxonomy": null - } - } - ] - }, - "Relations": { - "_media-type": "application/vnd.ibexa.api.RelationList+json", - "_href": "/api/ibexa/v2/content/objects/152/versions/1/relations", - "Relation": [] - }, - "Thumbnail": { - "_media-type": "application/vnd.ibexa.api.Thumbnail+json", - "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", - "width": null, - "height": null, - "mimeType": "image/svg+xml" - } - } - }, - "Section": { - "_media-type": "application/vnd.ibexa.api.Section+json", - "_href": "/api/ibexa/v2/content/sections/1" - }, - "Locations": { - "_media-type": "application/vnd.ibexa.api.LocationList+json", - "_href": "/api/ibexa/v2/content/objects/152/locations" - }, - "Owner": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" - }, - "lastModificationDate": "2022-07-21T15:17:18+02:00", - "publishedDate": "2022-07-21T15:17:18+02:00", - "mainLanguageCode": "eng-GB", - "currentVersionNo": 1, - "alwaysAvailable": true, - "isHidden": false, - "status": "PUBLISHED", - "ObjectStates": { - "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", - "_href": "/api/ibexa/v2/content/objects/152/objectstates" - } + "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 }, - "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" + { + "_media-type": "application/vnd.ibexa.api.Currency+json", + "id": 2, + "code": "EUR", + "subunits": 2, + "enabled": false }, - "created_at": 1658409438, - "updated_at": 1658409438, - "AttributesList": [] - }, - "DiscriminatorAttributesList": [] + { + "_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": [] + }, + "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 } } } @@ -23725,531 +16050,721 @@ "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." + "description": "Error - the user is not authorized to create this currency." }, - "404": { - "description": "Error - no product variant with the given code exists." + "406": { + "description": "Error - a currency with this code already exists." } }, - "summary": "Update product variant", - "description": "Updates product variant.", + "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 + "explode": 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 + } + } + }, + "/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 + "explode": false } ], "requestBody": { - "description": "The product variant update schema encoded in XML or JSON format.", + "description": "The view input in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ProductVariantUpdate+json": { + "application/vnd.ibexa.api.CurrencyViewInput+json": { "schema": { - "$ref": "#/components/schemas/ProductVariantUpdateWrapper" + "$ref": "#/components/schemas/CurrencyViewInputWrapper" }, "example": { - "ProductVariantUpdate": { - "code": "test", - "attributes": { - "number": 2, - "testattr": 10 + "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/vat/{region}": { + "/product/catalog/currencies/{id}": { "get": { - "operationId": "ibexa.product_catalog.rest.vat.list", + "operationId": "ibexa.product_catalog.rest.currencies.get", "tags": [ - "Product Vat" + "Product Currency" ], "responses": { "200": { - "description": "OK - loads the VAT category list.", + "description": "OK - loads the currency.", "content": { - "application/vnd.ibexa.api.VatCategoryList+json": { + "application/vnd.ibexa.api.Currency+json": { "schema": { - "$ref": "#/components/schemas/VatCategoryListWrapper" + "$ref": "#/components/schemas/CurrencyWrapper" }, "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 - } - ] + "Currency": { + "_media-type": "application/vnd.ibexa.api.Currency+json", + "id": 3, + "code": "ALL", + "subunits": 2, + "enabled": false } } } } }, "401": { - "description": "Error - the user is not authorized to read this object." + "description": "Error - the user has no permission to read currencies." }, "404": { - "description": "Error - the VAT category region does not exist." + "description": "Error - the currency does not exist." } }, - "summary": "Load VAT region", - "description": "Loads a VAT category for the given region.", + "summary": "Load currency", + "description": "Loads a currency.", "parameters": [ { - "name": "region", + "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 } + ] + }, + "delete": { + "operationId": "ibexa.product_catalog.rest.currencies.delete", + "tags": [ + "Product Currency" ], - "deprecated": false - } - }, - "/product/catalog/vat/{region}/{identifier}": { - "get": { - "operationId": "ibexa.product_catalog.rest.vat", + "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": "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 Vat" + "Product Currency" ], "responses": { "200": { - "description": "OK - loads the VAT category.", + "description": "If set, the updated currency is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.VatCategory+json": { + "application/vnd.ibexa.api.Currency+json": { "schema": { - "$ref": "#/components/schemas/VatCategoryWrapper" + "$ref": "#/components/schemas/CurrencyWrapper" }, "example": { - "VatCategory": { - "_media-type": "application/vnd.ibexa.api.VatCategory+json", - "identifier": "standard", - "region": "region_1", - "vatValue": 18 + "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 read this object." + "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 VAT category for the given identifier not exists." + "description": "Error - the currency with the given ID does not exist." } }, - "summary": "Load VAT specific region", - "description": "Loads a VAT category for the given identifier.", + "summary": "Update currency", + "description": "Updates a currency.", "parameters": [ { - "name": "region", + "name": "id", "in": "path", - "description": "", + "description": "CurrencyUpdateController 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 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 + } } }, - "/content/sections": { + "/product/catalog/customer_groups": { "get": { - "operationId": "ibexa.rest.list_sections", + "operationId": "ibexa.product_catalog.rest.customer_groups.list", "tags": [ - "Section" + "Product Customer Group" ], "responses": { "200": { - "description": "If set, the Section list is returned in XML or JSON format.", + "description": "If set, the customer groups list is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.SectionList+json": { + "application/vnd.ibexa.api.CustomerGroupList+json": { "schema": { - "$ref": "#/components/schemas/SectionListWrapper" + "$ref": "#/components/schemas/CustomerGroupListWrapper" }, "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" - }, + "CustomerGroupList": { + "_media-type": "application/vnd.ibexa.api.CustomerGroupList+json", + "CustomerGroup": [ { - "_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.CustomerGroup+json", + "id": 1, + "name": "Resellers", + "identifier": "resellers", + "description": "", + "users": [], + "global_price_rate": "0.00" }, { - "_media-type": "application/vnd.ibexa.api.Section+json", - "_href": "/api/ibexa/v2/content/sections/8", - "sectionId": 8, - "identifier": "restricted", - "name": "Restricted" + "_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.SectionList+xml": { + } + } + }, + "401": { + "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/SectionList" + "$ref": "#/components/schemas/CustomerGroupWrapper" }, - "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" + "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 has no permission to read the Section." + "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": "Get Sections", - "description": "Returns a list of all Sections.", + "summary": "Create customer group", + "description": "Creates a new customer group.", "parameters": [ { - "name": "If-None-Match", + "name": "X-CSRF-Token", "in": "header", - "description": "ETag", - "required": false, + "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 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.rest.create_section", + "operationId": "ibexa.product_catalog.rest.customer_groups.view", "tags": [ - "Section" + "Product Customer Group" ], "responses": { - "201": { - "description": "If set, the new Section is returned in XML or JSON format.", + "200": { + "description": "The view in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Section+json": { + "application/vnd.ibexa.api.CustomerGroupView+json": { "schema": { - "$ref": "#/components/schemas/SectionWrapper" + "$ref": "#/components/schemas/CustomerGroupViewWrapper" }, "example": { - "Section": { - "_media-type": "application/vnd.ibexa.api.Section+json", - "_href": "/api/ibexa/v2/content/sections/13", - "sectionId": 13, - "identifier": "restricted", - "name": "Restricted" + "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.Section+xml": { + "application/vnd.ibexa.api.CustomerGroupView+xml": { "schema": { - "$ref": "#/components/schemas/Section" - }, - "example": "\n
\n 7\n restricted\n Restricted\n
\n" + "$ref": "#/components/schemas/CustomerGroupView" + } } } + }, + "400": { + "description": "Error - the input does not match the input schema definition." } }, - "summary": "Create new Section", - "description": "Creates a new Section.", + "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 needed on all unsafe HTTP methods with session.", + "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 format.", + "description": "The view input in XML or JSON format.", "content": { - "application/vnd.ibexa.api.SectionInput+json": { + "application/vnd.ibexa.api.CustomerGroupViewInput+json": { "schema": { - "$ref": "#/components/schemas/SectionInputWrapper" + "$ref": "#/components/schemas/CustomerGroupViewInputWrapper" }, "example": { - "SectionInput": { - "identifier": "restricted", - "name": "Restricted" + "ViewInput": { + "identifier": "TitleView", + "CustomerGroupQuery": { + "limit": "10", + "offset": "0" + } } } }, - "application/vnd.ibexa.api.SectionInput+xml": { + "application/vnd.ibexa.api.CustomerGroupViewInput+xml": { "schema": { - "$ref": "#/components/schemas/SectionInput" - }, - "example": "\n\n restricted\n Restricted\n" + "$ref": "#/components/schemas/CustomerGroupViewInput" + } } }, "required": false - }, - "deprecated": false + } } }, - "/content/sections/{sectionId}": { + "/product/catalog/customer_groups/{identifier}": { "get": { - "operationId": "ibexa.rest.load_section", + "operationId": "ibexa.product_catalog.rest.customer_groups.identifier", "tags": [ - "Section" + "Product Customer Group" ], "responses": { "200": { - "description": "If set, the Section is returned in XML or JSON format.", + "description": "If set, the customer group is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Section+json": { + "application/vnd.ibexa.api.CustomerGroup+json": { "schema": { - "$ref": "#/components/schemas/SectionWrapper" + "$ref": "#/components/schemas/CustomerGroupWrapper" }, "example": { - "Section": { - "_media-type": "application/vnd.ibexa.api.Section+json", - "_href": "/api/ibexa/v2/content/sections/10", - "sectionId": 10, - "identifier": "design", - "name": "Design" + "CustomerGroup": { + "_media-type": "application/vnd.ibexa.api.CustomerGroup+json", + "id": 1, + "name": "Resellers", + "identifier": "resellers", + "description": "", + "users": [], + "global_price_rate": "0.00" } } - }, - "application/vnd.ibexa.api.Section+xml": { - "schema": { - "$ref": "#/components/schemas/Section" - }, - "example": "\n
\n 10\n design\n Design\n
\n" } } }, "401": { - "description": "Error - The user is not authorized to read this Section." - }, - "404": { - "description": "Error - The Section does not exist." + "description": "Error - the user has no permission to read customer groups." } }, - "summary": "Get Section", - "description": "Returns the Section by given Section ID.", + "summary": "Load customer group", + "description": "Returns a customer 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": "sectionId", + "name": "identifier", "in": "path", - "description": "", + "description": "CustomerGroupLoadByIdentifierController 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_section", + "operationId": "ibexa.product_catalog.rest.customer_groups.delete", "tags": [ - "Section" + "Product Customer Group" ], "responses": { "204": { - "description": "No Content - given Section is deleted." + "description": "No content - the given customer group 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 customer group." } }, - "summary": "Delete Section", - "description": "The given Section is deleted.", + "summary": "Delete customer group", + "description": "Deletes the given customer 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": "CustomerGroupDeleteController 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", + "operationId": "ibexa.product_catalog.rest.customer_group.update", "tags": [ - "Section" + "Product Customer Group" ], "responses": { - "200": { - "description": "OK - Section updated.", + "201": { + "description": "If set, the updated customer group is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Section+json": { + "application/vnd.ibexa.api.CustomerGroup+json": { "schema": { - "$ref": "#/components/schemas/SectionWrapper" + "$ref": "#/components/schemas/CustomerGroupWrapper" }, "example": { - "Section": { - "_media-type": "application/vnd.ibexa.api.Section+json", - "_href": "/api/ibexa/v2/content/sections/7", - "sectionId": 7, - "identifier": "template", - "name": "Template" + "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.Section+xml": { - "schema": { - "$ref": "#/components/schemas/Section" - }, - "example": "\n
\n 7\n template\n Template\n
\n" } } }, @@ -24257,794 +16772,865 @@ "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." + "description": "Error - the user is not authorized to update a customer group." } }, - "summary": "Update a Section", - "description": "Updates a Section. PATCH or POST with header X-HTTP-Method-Override PATCH.", + "summary": "Update customer group", + "description": "Updates the given customer 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": "CustomerGroupUpdateController 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 CustomerGroupUpdate schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.SectionInput+json": { + "application/vnd.ibexa.api.CustomerGroupUpdate+json": { "schema": { - "$ref": "#/components/schemas/SectionInputWrapper" + "$ref": "#/components/schemas/CustomerGroupUpdateWrapper" }, "example": { - "SectionInput": { - "identifier": "template", - "name": "Template" + "CustomerGroupUpdate": { + "identifier": "customer_group", + "names": { + "eng-GB": "Customer Group" + }, + "global_price_rate": "1" } } - }, - "application/vnd.ibexa.api.SectionInput+xml": { - "schema": { - "$ref": "#/components/schemas/SectionInput" - }, - "example": "\n\n template\n Template\n\n" } }, "required": 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." + } }, - "deprecated": false + "summary": "Load customer group", + "description": "Returns a customer group", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "CustomerGroupLoadByIdController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "integer" + }, + "style": "simple", + "explode": false + } + ] } }, - "/segment_groups": { + "/product/catalog/regions": { "get": { - "operationId": "ibexa.segmentation.rest.segment_groups.list", + "operationId": "ibexa.product_catalog.rest.regions", "tags": [ - "Segmentation" + "Product Region" ], "responses": { "200": { - "description": "OK - list the segment groups.", + "description": "OK - loads regions.", "content": { - "application/vnd.ibexa.api.SegmentGroupList+json": { + "application/vnd.ibexa.api.RegionList+json": { "schema": { - "$ref": "#/components/schemas/SegmentGroupListWrapper" + "$ref": "#/components/schemas/RegionListWrapper" }, "example": { - "SegmentGroupList": { - "_media-type": "application/vnd.ibexa.api.SegmentGroupList+json", - "_href": "/api/ibexa/v2/segment_groups", - "SegmentGroup": [ + "RegionList": { + "_media-type": "application/vnd.ibexa.api.RegionList+json", + "Region": [ { - "_media-type": "application/vnd.ibexa.api.SegmentGroup+json", - "_href": "/api/ibexa/v2/segment_groups/corporate_accounts", - "id": 1, - "identifier": "corporate_accounts", - "name": "Corporate Accounts" + "_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.SegmentGroupList+xml": { - "schema": { - "$ref": "#/components/schemas/SegmentGroupList" - }, - "example": "\n\n \n 1\n corporate_accounts\n Corporate Accounts\n \n\n" + }, + "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, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": 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" + } + } } - } - }, - "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" - } + }, + "application/vnd.ibexa.api.RegionViewInput+xml": { + "schema": { + "$ref": "#/components/schemas/RegionViewInput" } } - } - }, - "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/regions/{identifier}": { "get": { - "operationId": "ibexa.segmentation.rest.segment_groups.view", + "operationId": "ibexa.product_catalog.rest.region", "tags": [ - "Segmentation" + "Product Region" ], "responses": { "200": { - "description": "OK - return the segment group.", + "description": "OK - loads region.", "content": { - "application/vnd.ibexa.api.SegmentGroup+json": { + "application/vnd.ibexa.api.Region+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" - } + "$ref": "#/components/schemas/RegionWrapper" } }, - "application/vnd.ibexa.api.SegmentGroup+xml": { + "application/vnd.ibexa.api.Region+xml": { "schema": { - "$ref": "#/components/schemas/SegmentGroup" - }, - "example": "\n\n 1\n corporate_accounts\n Corporate Accounts\n\n" + "$ref": "#/components/schemas/Region" + } } } }, - "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 region does not exist." } }, - "summary": "Load segment group", - "description": "Loads segment group.", + "summary": "Load region", + "description": "Loads a region by its identifier", "parameters": [ { "name": "identifier", "in": "path", - "description": "", + "description": "RegionLoadByIdentifierController 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 } ] } }, - "/segment_groups/{identifier}/segments": { + "/product/catalog/product_types": { "get": { - "operationId": "ibexa.segmentation.rest.segment_groups.list.segments", + "operationId": "ibexa.product_catalog.rest.product_types", "tags": [ - "Segmentation" + "Product Type" ], "responses": { "200": { - "description": "OK - list the group's segments.", + "description": "ProductTypeList - If set, the product type list is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.SegmentList+json": { + "application/vnd.ibexa.api.ProductTypeList+json": { "schema": { - "$ref": "#/components/schemas/SegmentListWrapper" + "$ref": "#/components/schemas/ProductTypeListWrapper" }, "example": { - "SegmentList": { - "_media-type": "application/vnd.ibexa.api.SegmentList+json", - "_href": "/api/ibexa/v2/segment_groups/corporate_accounts/segments", - "Segment": [] + "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.SegmentList+xml": { + "application/vnd.ibexa.api.ProductTypeList+xml": { "schema": { - "$ref": "#/components/schemas/SegmentList" + "$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": "\n\n" + "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 load this group's segments." + "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 identifier doesn't match any segment group." + "description": "Error - the product type with the given ID does not exist." } }, - "summary": "List segment group's segments", - "description": "Lists segment group's segments.", + "summary": "Create product type", + "description": "Creates a new product type.", "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 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 + } + ] + } + } + } }, - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - } - ] + "required": false + } } }, - "/segments/{identifier}": { + "/product/catalog/product_types/is_used/{identifier}": { "get": { - "operationId": "ibexa.segmentation.rest.segments.view", + "operationId": "ibexa.product_catalog.rest.product_types.is_used", "tags": [ - "Segmentation" + "Product Type" ], "responses": { "200": { - "description": "OK - Return the segment.", + "description": "OK - product type usage is returned.", "content": { - "application/vnd.ibexa.api.Segment+json": { + "application/vnd.ibexa.api.ProductTypeUsage+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" - } - } + "$ref": "#/components/schemas/ProductTypeUsageWrapper" } }, - "application/vnd.ibexa.api.Segment+xml": { + "application/vnd.ibexa.api.ProductTypeUsage+xml": { "schema": { - "$ref": "#/components/schemas/Segment" + "$ref": "#/components/schemas/ProductTypeUsage" }, - "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" + "example": "\n\n 1\n\n" } } }, - "401": { - "description": "Error - the user is not authorized to load this group's segments." - }, "404": { - "description": "Error - the identifier doesn't match any segment group." + "description": "Error - product type not found." } }, - "summary": "Load segment", - "description": "Loads the identified segment.", + "summary": "Check product type usage", + "description": "Checks whether the product type is in use.", "parameters": [ { "name": "identifier", "in": "path", - "description": "", + "description": "ProductTypeIsUsedController 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 } ] } }, - "/orders/order/{orderIdentifier}/shipments": { + "/product/catalog/product_types/view": { "post": { - "operationId": "ibexa.shipping.rest.shipment.create", + "operationId": "ibexa.product_catalog.rest.product_types.view", "tags": [ - "Shipping" + "Product Type" ], "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.ProductTypeView+json": { "schema": { - "$ref": "#/components/schemas/ShipmentWrapper" + "$ref": "#/components/schemas/ProductTypeViewWrapper" }, "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" + "ProductTypeView": { + "_media-type": "application/vnd.ibexa.api.ProductTypeView+json", + "identifier": "TitleView", + "ProductTypeQuery": { + "_media-type": "application/vnd.ibexa.api.ProductTypeQuery+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, + "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.Shipment+xml": { + "application/vnd.ibexa.api.ProductTypeView+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/ProductTypeView" + } } } }, "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 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.", - "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.ProductTypeViewInput+json": { "schema": { - "$ref": "#/components/schemas/ShipmentCreateWrapper" + "$ref": "#/components/schemas/ProductTypeViewInputWrapper" }, "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": "\n\n abc\n \n \n 1922\n EUR\n \n \n \n value1\n value2\n \n\n" - } - }, - "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" - } - ] + "ViewInput": { + "identifier": "TitleView", + "ProductTypeQuery": { + "limit": "10", + "offset": "0", + "name_prefix": "new" } } - }, - "application/vnd.ibexa.api.ShipmentRefList+xml": { - "schema": { - "$ref": "#/components/schemas/ShipmentRefList" - }, - "example": "\n\n \n \n \n \n\n" + } + }, + "application/vnd.ibexa.api.ProductTypeViewInput+xml": { + "schema": { + "$ref": "#/components/schemas/ProductTypeViewInput" } } }, - "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" - } - ] + "required": false + } } }, - "/shipments/{identifier}": { + "/product/catalog/product_types/{identifier}": { "get": { - "operationId": "ibexa.shipping.rest.shipment.get", + "operationId": "ibexa.product_catalog.rest.product_type", "tags": [ - "Shipping" + "Product Type" ], "responses": { "200": { - "description": "OK - loads the shipment.", + "description": "OK - load the product type", "content": { - "application/vnd.ibexa.api.Shipment+json": { + "application/vnd.ibexa.api.ProductType+json": { "schema": { - "$ref": "#/components/schemas/ShipmentWrapper" + "$ref": "#/components/schemas/ProductTypeWrapper" }, "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" - } + "ProductType": { + "_media-type": "application/vnd.ibexa.api.ProductType+json", + "identifier": "d_rope", + "name": "Dynamic ropes", + "AttributeAssignmentList": [] } } }, - "application/vnd.ibexa.api.Shipment+xml": { + "application/vnd.ibexa.api.ProductType+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" + "$ref": "#/components/schemas/ProductType" + } } } }, "401": { - "description": "Error - the user has no permission to read shipments." + "description": "Error - the user has no permission to read product type." }, "404": { - "description": "Error - the shipment does not exist." + "description": "Error - product type not found." } }, - "summary": "Load a single shipment based on its identifier", - "description": "Loads a single shipment based on its identifier.", + "summary": "Load product type", + "description": "Returns the given product type.", "parameters": [ { "name": "identifier", "in": "path", - "description": "The shipment identifier.", + "description": "ProductTypeLoadByIdentifierController 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 } ] - }, + } + }, + "/product/catalog/product_types/{id}": { "delete": { - "operationId": "ibexa.shipping.rest.shipment.delete", + "operationId": "ibexa.product_catalog.rest.product_types.delete", "tags": [ - "Shipping" + "Product Type" ], "responses": { "204": { - "description": "No content - shipment is deleted." + "description": "No content - the given product type 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." + "description": "Error - the user is not authorized to delete this product type." } }, - "summary": "Delete shipment", - "description": "Deletes a shipment.", + "summary": "Delete product type", + "description": "Deletes the given product type.", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", + "name": "id", + "in": "path", + "description": "ProductTypeDeleteController 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 } ] }, "patch": { - "operationId": "ibexa.shipping.rest.shipment.update", + "operationId": "ibexa.product_catalog.rest.product_types.update", "tags": [ - "Shipping" + "Product Type" ], "responses": { - "200": { - "description": "If set, the updated shipment is returned in XML or JSON format.", + "201": { + "description": "If set, the updated product type is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Shipment+json": { + "application/vnd.ibexa.api.ProductType+json": { "schema": { - "$ref": "#/components/schemas/ShipmentWrapper" + "$ref": "#/components/schemas/ProductTypeWrapper" }, "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" - } + "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": [] + } + } + ] } } - }, - "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,1958 +17638,2199 @@ "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 product type." }, "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" + "description": "Error - the product type with the given ID does not exist." } }, - "summary": "Update shipment", - "description": "Updates a shipment.", + "summary": "Update product type", + "description": "Updates product type.", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "The CSRF token.", + "name": "id", + "in": "path", + "description": "ProductTypeUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { - "name": "identifier", - "in": "path", - "description": "The shipment identifier.", + "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 ShipmentUpdate schema encoded in XML or JSON format.", + "description": "If set, the updated product type is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShipmentUpdate+json": { + "application/vnd.ibexa.api.ProductTypeUpdate+json": { "schema": { - "$ref": "#/components/schemas/ShipmentUpdateWrapper" + "$ref": "#/components/schemas/ProductTypeUpdateWrapper" }, "example": { - "ShipmentUpdate": { - "identifier": "new_identifier", - "transition": "prepare", - "Owner": { - "_media-type": "application/vnd.ibexa.api.User+json", - "_href": "/api/ibexa/v2/user/users/14" + "ProductTypeUpdate": { + "ContentTypeUpdateStruct": { + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "pt_1_updated" + } + ] + }, + "descriptions": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "updated" + } + ] + } }, - "Context": { - "item1": "value1", - "item2": "value2" - } + "assigned_attributes": [ + { + "identifier": "size", + "is_required": false, + "is_discriminator": true + } + ] } } - }, - "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/product_variant/{code}": { "get": { - "operationId": "ibexa.shipping.rest.shipping_method.type.list", + "operationId": "ibexa.product_catalog.rest.product_variant", "tags": [ - "Shipping" + "Product Variant" ], "responses": { "200": { - "description": "OK - loads the shipping method.", + "description": "OK - loads the product variant.", "content": { - "application/vnd.ibexa.api.ShippingMethodTypesList+json": { + "application/vnd.ibexa.api.ProductVariant+json": { "schema": { - "$ref": "#/components/schemas/ShippingMethodTypesListWrapper" + "$ref": "#/components/schemas/ProductVariantWrapper" }, "example": { - "ShippingMethodTypesList": { - "_media-type": "application/vnd.ibexa.api.ShippingMethodTypesList+json", - "_href": "/api/ibexa/v2/shipping/method-types", - "ShippingMethodTypes": [ + "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" + } + }, + { + "id": 719, + "fieldDefinitionIdentifier": "image", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_image_asset", + "fieldValue": { + "destinationContentId": null, + "alternativeText": null, + "source": null + } + }, + { + "id": 720, + "fieldDefinitionIdentifier": "category", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", + "fieldValue": { + "taxonomy_entries": [], + "taxonomy": null + } + } + ] + }, + "Relations": { + "_media-type": "application/vnd.ibexa.api.RelationList+json", + "_href": "/api/ibexa/v2/content/objects/152/versions/1/relations", + "Relation": [] + }, + "Thumbnail": { + "_media-type": "application/vnd.ibexa.api.Thumbnail+json", + "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", + "width": null, + "height": null, + "mimeType": "image/svg+xml" + } + } + }, + "Section": { + "_media-type": "application/vnd.ibexa.api.Section+json", + "_href": "/api/ibexa/v2/content/sections/1" + }, + "Locations": { + "_media-type": "application/vnd.ibexa.api.LocationList+json", + "_href": "/api/ibexa/v2/content/objects/152/locations" + }, + "Owner": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "lastModificationDate": "2022-07-21T15:17:18+02:00", + "publishedDate": "2022-07-21T15:17:18+02:00", + "mainLanguageCode": "eng-GB", + "currentVersionNo": 1, + "alwaysAvailable": true, + "isHidden": false, + "status": "PUBLISHED", + "ObjectStates": { + "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", + "_href": "/api/ibexa/v2/content/objects/152/objectstates" + } + }, + "Thumbnail": { + "_media-type": "application/vnd.ibexa.api.Thumbnail+json", + "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", + "width": null, + "height": null, + "mimeType": "image/svg+xml" + }, + "created_at": 1658409438, + "updated_at": 1658409438, + "AttributesList": [] + }, + "DiscriminatorAttributesList": [ { - "_media-type": "application/vnd.ibexa.api.ShippingMethodType+json", - "_href": "/api/ibexa/v2/shipping/method-types/flat_rate", - "identifier": "flat_rate", - "name": "Flat rate" + "_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.ShippingMethodType+json", - "_href": "/api/ibexa/v2/shipping/method-types/free", - "identifier": "free", - "name": "Free shipping" + "_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.ShippingMethodTypesList+xml": { - "schema": { - "$ref": "#/components/schemas/ShippingMethodTypesList" - }, - "example": "\n\n \n flat_rate\n Flat rate\n \n \n free\n Free shipping\n \n\n" } } }, "401": { - "description": "Error - the user has no permission to read shipping methods types." + "description": "Error - the user is not authorized to view this product variant." }, "404": { - "description": "Error - the shipping method type does not exist." + "description": "Error - no product variant with the given code exists." } }, - "summary": "Load shipping methods types", - "description": "Loads shipping methods types.", - "parameters": [], - "deprecated": false, - "x-badges": [ + "summary": "Load product variant", + "description": "Loads the given product variant.", + "parameters": [ { - "name": "Commerce", - "color": "#A32768", - "position": "after" + "name": "code", + "in": "path", + "description": "ProductVariantLoadByCodeController identifier", + "required": true, + "deprecated": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false } ] } }, - "/shipping/method-types/{identifier}": { - "get": { - "operationId": "ibexa.shipping.rest.shipping_method.type.get", + "/product/catalog/product_variants/generate/{baseProductCode}": { + "post": { + "operationId": "ibexa.product_catalog.rest.product_variants.generate", "tags": [ - "Shipping" + "Product Variant" ], "responses": { - "200": { - "description": "OK - loads the shipping method.", - "content": { - "application/vnd.ibexa.api.ShippingMethodType+json": { - "schema": { - "$ref": "#/components/schemas/ShippingMethodTypeWrapper" - }, - "example": { - "ShippingMethodType": { - "_media-type": "application/vnd.ibexa.api.ShippingMethodType+json", - "_href": "/api/ibexa/v2/shipping/method-types/flat_rate", - "identifier": "flat_rate", - "name": "Flat rate" - } - } - }, - "application/vnd.ibexa.api.ShippingMethodType+xml": { - "schema": { - "$ref": "#/components/schemas/ShippingMethodType" - }, - "example": "\n\n flat_rate\n Flat rate\n\n" - } - } + "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 has no permission to read shipping methods." + "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 - the shipping method type does not exist." + "description": "Error - no base product with the given code exists." } }, - "summary": "Load shipping method type based on its identifier", - "description": "Loads shipping methods type based on their identifiers.", + "summary": "Generate product variants", + "description": "Generates new product variants based on selected (discriminator) attributes.", "parameters": [ { - "name": "identifier", + "name": "baseProductCode", "in": "path", - "description": "", + "description": "ProductVariantGenereateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false, - "x-badges": [ + "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 } - ] - } - }, - "/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 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" ] } } - }, - "application/vnd.ibexa.api.ShippingMethodRefList+xml": { - "schema": { - "$ref": "#/components/schemas/ShippingMethodRefList" - }, - "example": "\n\n \n \n\n" } } }, - "401": { - "description": "Error - the user has no permission to read shipping methods." - } - }, - "summary": "Load shipping methods", - "description": "Loads shipping methods.", - "parameters": [], - "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/product_variants/view/{baseProductCode}": { + "post": { + "operationId": "ibexa.product_catalog.rest.product_variants.view", "tags": [ - "Shipping" + "Product Variant" ], "responses": { "200": { - "description": "OK - loads the shipping method.", + "description": "The view in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShippingMethod+json": { + "application/vnd.ibexa.api.ProductVariantView+json": { "schema": { - "$ref": "#/components/schemas/ShippingMethodWrapper" + "$ref": "#/components/schemas/ProductVariantViewWrapper" }, "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" - } - ] + "ProductVariantView": { + "_media-type": "application/vnd.ibexa.api.ProductVariantView+json", + "identifier": "TitleView", + "ProductVariantQuery": { + "_media-type": "application/vnd.ibexa.api.ProductVariantQuery+json" }, - "type": { - "_media-type": "application/vnd.ibexa.api.ShippingMethodType+json", - "_href": "/api/ibexa/v2/shipping/method-types/flat_rate" + "Result": { + "_media-type": "application/vnd.ibexa.api.ViewResult+json", + "count": 2, + "ProductVariantList": { + "_media-type": "application/vnd.ibexa.api.ProductVariantList+json", + "ProductVariant": [ + { + "_media-type": "application/vnd.ibexa.api.ProductVariant+json", + "code": "test", + "name": "Macbook Air 2/10", + "Product": { + "_media-type": "application/vnd.ibexa.api.Product+json", + "code": "mac_air", + "name": "Macbook Air", + "ProductType": { + "_media-type": "application/vnd.ibexa.api.ProductType+json", + "identifier": "laptop", + "name": "Laptop", + "AttributeAssignmentList": [ + { + "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", + "is_required": false, + "is_discriminator": true, + "Attribute": { + "_media-type": "application/vnd.ibexa.api.Attribute+json", + "identifier": "number", + "name": "number", + "description": "", + "type": "Float", + "type_identifier": "float", + "value": 1.5, + "group": "test", + "position": 0, + "options": { + "min": 4, + "max": 5 + } + } + }, + { + "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", + "is_required": false, + "is_discriminator": true, + "Attribute": { + "_media-type": "application/vnd.ibexa.api.Attribute+json", + "identifier": "testattr", + "name": "testAttr", + "description": "", + "type": "Integer", + "type_identifier": "integer", + "value": 5, + "group": "test", + "position": 0, + "options": { + "min": 4, + "max": 5 + } + } + } + ] + }, + "Content": { + "_media-type": "application/vnd.ibexa.api.Content+json", + "_href": "/api/ibexa/v2/content/objects/152", + "_remoteId": "2d61ff8d0043eb299ca8c29c74f25441", + "_id": 152, + "ContentType": { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/56" + }, + "Name": "Macbook Air", + "TranslatedName": "Macbook Air", + "Versions": { + "_media-type": "application/vnd.ibexa.api.VersionList+json", + "_href": "/api/ibexa/v2/content/objects/152/versions" + }, + "CurrentVersion": { + "_media-type": "application/vnd.ibexa.api.Version+json", + "_href": "/api/ibexa/v2/content/objects/152/currentversion", + "Version": { + "_media-type": "application/vnd.ibexa.api.Version+json", + "_href": "/api/ibexa/v2/content/objects/152/versions/1", + "VersionInfo": { + "id": 635, + "versionNo": 1, + "status": "PUBLISHED", + "modificationDate": "2022-07-21T15:17:18+02:00", + "Creator": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "creationDate": "2022-07-21T15:17:18+02:00", + "initialLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "VersionTranslationInfo": { + "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", + "Language": [ + { + "languageCode": "eng-GB" + } + ] + }, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Macbook Air" + } + ] + }, + "Content": { + "_media-type": "application/vnd.ibexa.api.ContentInfo+json", + "_href": "/api/ibexa/v2/content/objects/152" + } + }, + "Fields": { + "field": [ + { + "id": 716, + "fieldDefinitionIdentifier": "name", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_string", + "fieldValue": "Macbook Air" + }, + { + "id": 717, + "fieldDefinitionIdentifier": "product_specification", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_product_specification", + "fieldValue": { + "id": 89, + "code": "mac_air", + "attributes": [] + } + }, + { + "id": 718, + "fieldDefinitionIdentifier": "description", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_richtext", + "fieldValue": { + "xml": "\n
test
\n", + "xhtml5edit": "\n

test

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

test

\n" + } + }, + { + "id": 719, + "fieldDefinitionIdentifier": "image", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_image_asset", + "fieldValue": { + "destinationContentId": null, + "alternativeText": null, + "source": null + } + }, + { + "id": 720, + "fieldDefinitionIdentifier": "category", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", + "fieldValue": { + "taxonomy_entries": [], + "taxonomy": null + } + } + ] + }, + "Relations": { + "_media-type": "application/vnd.ibexa.api.RelationList+json", + "_href": "/api/ibexa/v2/content/objects/152/versions/1/relations", + "Relation": [] + }, + "Thumbnail": { + "_media-type": "application/vnd.ibexa.api.Thumbnail+json", + "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", + "width": null, + "height": null, + "mimeType": "image/svg+xml" + } + } + }, + "Section": { + "_media-type": "application/vnd.ibexa.api.Section+json", + "_href": "/api/ibexa/v2/content/sections/1" + }, + "Locations": { + "_media-type": "application/vnd.ibexa.api.LocationList+json", + "_href": "/api/ibexa/v2/content/objects/152/locations" + }, + "Owner": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "lastModificationDate": "2022-07-21T15:17:18+02:00", + "publishedDate": "2022-07-21T15:17:18+02:00", + "mainLanguageCode": "eng-GB", + "currentVersionNo": 1, + "alwaysAvailable": true, + "isHidden": false, + "status": "PUBLISHED", + "ObjectStates": { + "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", + "_href": "/api/ibexa/v2/content/objects/152/objectstates" + } + }, + "Thumbnail": { + "_media-type": "application/vnd.ibexa.api.Thumbnail+json", + "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", + "width": null, + "height": null, + "mimeType": "image/svg+xml" + }, + "created_at": 1658409438, + "updated_at": 1658409438, + "AttributesList": [] + }, + "DiscriminatorAttributesList": [ + { + "_media-type": "application/vnd.ibexa.api.Attribute+json", + "identifier": "number", + "name": "number", + "description": "", + "type": "Float", + "type_identifier": "float", + "value": 1.5, + "group": "test", + "position": 0, + "options": { + "min": 4, + "max": 5 + } + }, + { + "_media-type": "application/vnd.ibexa.api.Attribute+json", + "identifier": "testattr", + "name": "testAttr", + "description": "", + "type": "Integer", + "type_identifier": "integer", + "value": 5, + "group": "test", + "position": 0, + "options": { + "min": 4, + "max": 5 + } + } + ] + } + ] + } } } } }, - "application/vnd.ibexa.api.ShippingMethod+xml": { + "application/vnd.ibexa.api.ProductVariantView+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" + "$ref": "#/components/schemas/ProductVariantView" + } } } }, - "401": { - "description": "Error - the user has no permission to read shipping methods." + "400": { + "description": "Error - the input does not match the input schema definition." }, "404": { - "description": "Error - the shipping method does not exist." + "description": "Error - the base product does not exist." } }, - "summary": "Load shipping method based on its identifier", - "description": "Loads shipping method based on its identifier.", + "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, - "x-badges": [ + "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", - "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" - } - ] + "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.ShoppingListCollection+xml": { - "schema": { - "$ref": "#/components/schemas/ShoppingListCollection" - }, - "example": "\n\n 2\n 2\n \n 550e8400-e29b-41d4-a716-446655440000\n My Shopping List\n 1\n \n \n 650e8400-e29b-41d4-a716-446655440001\n \n PRODUCT-001\n Sample Product\n \n 2024-10-29T12:15:00+00:00\n \n 2024-10-29T12:00:00+00:00\n 2024-10-29T12:00:00+00:00\n \n \n 660e8400-e29b-41d4-a716-446655440001\n Weekend Shopping\n 0\n \n \n 2024-10-30T08:30:00+00:00\n 2024-10-30T08:30:00+00:00\n \n\n" + } + }, + "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 list shopping lists." + "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": "List shopping lists", - "description": "Returns a list of shopping lists owned by the current user.", + "summary": "Create product variant", + "description": "Creates a new product variant.", "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": "baseProductCode", + "in": "path", + "description": "ProductVariantCreateController identifier", + "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 + "style": "simple", + "explode": 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, + "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", - "enum": [ - "true", - "false" - ] + "type": "string" }, - "style": "form", - "explode": false, - "allowReserved": false + "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" + } + } + } }, - { - "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 + "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": "sort", - "in": "query", - "description": "Sort shopping lists by field. Available fields: name, is_default, created_at, updated_at.", - "required": false, + "name": "code", + "in": "path", + "description": "ProductVariantDeleteController identifier", + "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { - "type": "string", - "enum": [ - "name", - "is_default", - "created_at", - "updated_at" - ] + "type": "string" }, - "style": "form", - "explode": false, - "allowReserved": false + "style": "simple", + "explode": false }, { - "name": "order", - "in": "query", - "description": "Sort direction. Default is \"asc\".", - "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", - "enum": [ - "asc", - "desc" - ], - "default": "asc" + "type": "string" }, - "style": "form", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - }, - { - "name": "LTS Update", - "color": "#5DA7C0", - "position": "after" + "style": "simple", + "explode": false } ] }, - "post": { - "operationId": "ibexa.rest.shopping_list.create", + "patch": { + "operationId": "ibexa.product_catalog.rest.product_variants.update", "tags": [ - "Shopping List" + "Product Variant" ], "responses": { "201": { - "description": "Shopping list created.", + "description": "If set, the updated product variant is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShoppingList+json": { + "application/vnd.ibexa.api.ProductVariant+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListWrapper" + "$ref": "#/components/schemas/ProductVariantWrapper" }, "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" + "ProductVariant": { + "_media-type": "application/vnd.ibexa.api.ProductVariant+json", + "code": "test", + "name": "Macbook Air ", + "Product": { + "_media-type": "application/vnd.ibexa.api.Product+json", + "code": "mac_air", + "name": "Macbook Air", + "ProductType": { + "_media-type": "application/vnd.ibexa.api.ProductType+json", + "identifier": "laptop", + "name": "Laptop", + "AttributeAssignmentList": [ + { + "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", + "is_required": false, + "is_discriminator": true, + "Attribute": { + "_media-type": "application/vnd.ibexa.api.Attribute+json", + "identifier": "number", + "name": "number", + "description": "", + "type": "Float", + "type_identifier": "float", + "value": 1.5, + "group": "test", + "position": 0, + "options": { + "min": 4, + "max": 5 + } + } + }, + { + "_media-type": "application/vnd.ibexa.api.AttributeAssignment+json", + "is_required": false, + "is_discriminator": true, + "Attribute": { + "_media-type": "application/vnd.ibexa.api.Attribute+json", + "identifier": "testattr", + "name": "testAttr", + "description": "", + "type": "Integer", + "type_identifier": "integer", + "value": 5, + "group": "test", + "position": 0, + "options": { + "min": 4, + "max": 5 + } + } + } + ] + }, + "Content": { + "_media-type": "application/vnd.ibexa.api.Content+json", + "_href": "/api/ibexa/v2/content/objects/152", + "_remoteId": "2d61ff8d0043eb299ca8c29c74f25441", + "_id": 152, + "ContentType": { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/56" + }, + "Name": "Macbook Air", + "TranslatedName": "Macbook Air", + "Versions": { + "_media-type": "application/vnd.ibexa.api.VersionList+json", + "_href": "/api/ibexa/v2/content/objects/152/versions" + }, + "CurrentVersion": { + "_media-type": "application/vnd.ibexa.api.Version+json", + "_href": "/api/ibexa/v2/content/objects/152/currentversion", + "Version": { + "_media-type": "application/vnd.ibexa.api.Version+json", + "_href": "/api/ibexa/v2/content/objects/152/versions/1", + "VersionInfo": { + "id": 635, + "versionNo": 1, + "status": "PUBLISHED", + "modificationDate": "2022-07-21T15:17:18+02:00", + "Creator": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "creationDate": "2022-07-21T15:17:18+02:00", + "initialLanguageCode": "eng-GB", + "languageCodes": "eng-GB", + "VersionTranslationInfo": { + "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json", + "Language": [ + { + "languageCode": "eng-GB" + } + ] + }, + "names": { + "value": [ + { + "_languageCode": "eng-GB", + "#text": "Macbook Air" + } + ] + }, + "Content": { + "_media-type": "application/vnd.ibexa.api.ContentInfo+json", + "_href": "/api/ibexa/v2/content/objects/152" + } + }, + "Fields": { + "field": [ + { + "id": 716, + "fieldDefinitionIdentifier": "name", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_string", + "fieldValue": "Macbook Air" + }, + { + "id": 717, + "fieldDefinitionIdentifier": "product_specification", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_product_specification", + "fieldValue": { + "id": 89, + "code": "mac_air", + "attributes": [] + } + }, + { + "id": 718, + "fieldDefinitionIdentifier": "description", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_richtext", + "fieldValue": { + "xml": "\n
test
\n", + "xhtml5edit": "\n

test

\n" + } + }, + { + "id": 719, + "fieldDefinitionIdentifier": "image", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_image_asset", + "fieldValue": { + "destinationContentId": null, + "alternativeText": null, + "source": null + } + }, + { + "id": 720, + "fieldDefinitionIdentifier": "category", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", + "fieldValue": { + "taxonomy_entries": [], + "taxonomy": null + } + } + ] + }, + "Relations": { + "_media-type": "application/vnd.ibexa.api.RelationList+json", + "_href": "/api/ibexa/v2/content/objects/152/versions/1/relations", + "Relation": [] + }, + "Thumbnail": { + "_media-type": "application/vnd.ibexa.api.Thumbnail+json", + "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", + "width": null, + "height": null, + "mimeType": "image/svg+xml" + } + } + }, + "Section": { + "_media-type": "application/vnd.ibexa.api.Section+json", + "_href": "/api/ibexa/v2/content/sections/1" + }, + "Locations": { + "_media-type": "application/vnd.ibexa.api.LocationList+json", + "_href": "/api/ibexa/v2/content/objects/152/locations" + }, + "Owner": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "lastModificationDate": "2022-07-21T15:17:18+02:00", + "publishedDate": "2022-07-21T15:17:18+02:00", + "mainLanguageCode": "eng-GB", + "currentVersionNo": 1, + "alwaysAvailable": true, + "isHidden": false, + "status": "PUBLISHED", + "ObjectStates": { + "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", + "_href": "/api/ibexa/v2/content/objects/152/objectstates" + } + }, + "Thumbnail": { + "_media-type": "application/vnd.ibexa.api.Thumbnail+json", + "resource": "/bundles/ibexaadminui/img/ibexa-icons.svg#file", + "width": null, + "height": null, + "mimeType": "image/svg+xml" + }, + "created_at": 1658409438, + "updated_at": 1658409438, + "AttributesList": [] }, - "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" + "DiscriminatorAttributesList": [] } } - }, - "application/vnd.ibexa.api.ShoppingList+xml": { - "schema": { - "$ref": "#/components/schemas/ShoppingList" - }, - "example": "\n\n 550e8400-e29b-41d4-a716-446655440000\n My Shopping List\n 0\n \n \n 650e8400-e29b-41d4-a716-446655440001\n \n PRODUCT-001\n Sample Product\n \n 2024-10-29T12:15:00+00:00\n \n 2024-10-29T12:00:00+00:00\n 2024-10-29T12:00:00+00:00\n\n" } } }, "400": { - "description": "Error - The input does not match the input schema definition." + "description": "Error - the input does not match the input schema definition." }, "401": { - "description": "Error - The user is not authorized to create a shopping list." + "description": "Error - the user is not authorized to update this product variant." }, "403": { - "description": "Error - Invalid request (e.g., missing required name)." + "description": "Error - a product variant with the same code already exists." }, - "406": { - "description": "Error - Shopping list limit exceeded for the current user." + "404": { + "description": "Error - no product variant with the given code exists." } }, - "summary": "Create shopping list", - "description": "Creates a new shopping list for the current user. The list will be owned by the authenticated user.", + "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": "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 to create", + "description": "The product variant update schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShoppingListCreate+json": { + "application/vnd.ibexa.api.ProductVariantUpdate+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListCreateWrapper" + "$ref": "#/components/schemas/ProductVariantUpdateWrapper" }, "example": { - "ShoppingListCreate": { - "name": "My Shopping List" + "ProductVariantUpdate": { + "code": "test", + "attributes": { + "number": 2, + "testattr": 10 + } } } - }, - "application/vnd.ibexa.api.ShoppingListCreate+xml": { - "schema": { - "$ref": "#/components/schemas/ShoppingListCreate" - }, - "example": "\n\n My Shopping List\n\n" } }, "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - }, - { - "name": "LTS Update", - "color": "#5DA7C0", - "position": "after" - } - ] + } } }, - "/shopping-list/default/entries": { - "post": { - "operationId": "ibexa.rest.shopping_list.add_to_default_entries", + "/product/catalog/vat/{region}": { + "get": { + "operationId": "ibexa.product_catalog.rest.vat.list", "tags": [ - "Shopping List" + "Product Vat" ], "responses": { "200": { - "description": "Entries added successfully. Returns the default shopping list.", + "description": "OK - loads the VAT category list.", "content": { - "application/vnd.ibexa.api.ShoppingList+json": { + "application/vnd.ibexa.api.VatCategoryList+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListWrapper" + "$ref": "#/components/schemas/VatCategoryListWrapper" }, "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": [ + "VatCategoryList": { + "_media-type": "application/vnd.ibexa.api.VatCategoryList+json", + "VatCategory": [ { - "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.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 } - ], - "createdAt": "2024-10-29T12:00:00+00:00", - "updatedAt": "2024-10-29T12:00:00+00:00" + ] } } - }, - "application/vnd.ibexa.api.ShoppingList+xml": { - "schema": { - "$ref": "#/components/schemas/ShoppingList" - }, - "example": "\n\n 550e8400-e29b-41d4-a716-446655440000\n My Shopping List\n 0\n \n \n 650e8400-e29b-41d4-a716-446655440001\n \n PRODUCT-001\n Sample Product\n \n 2024-10-29T12:15:00+00:00\n \n 2024-10-29T12:00:00+00:00\n 2024-10-29T12:00:00+00:00\n\n" } } }, - "400": { - "description": "Error - The input does not match the input schema definition." - }, "401": { - "description": "Error - The user is not authorized to add entries to the default shopping list." - }, - "403": { - "description": "Error - Invalid request (e.g., invalid product code, duplicate entry)." + "description": "Error - the user is not authorized to read this object." }, - "406": { - "description": "Error - Shopping list entry limit exceeded." + "404": { + "description": "Error - the VAT category region 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": "Load VAT region", + "description": "Loads a VAT category for the given region.", "parameters": [ { - "name": "X-CSRF-Token", - "in": "header", - "description": "CSRF Token is needed to execute this unsafe request.", + "name": "region", + "in": "path", + "description": "VatCategoriesListController identifier", "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": "\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" + "explode": false } ] } }, - "/shopping-list/{identifier}": { + "/product/catalog/vat/{region}/{identifier}": { "get": { - "operationId": "ibexa.rest.shopping_list.get", + "operationId": "ibexa.product_catalog.rest.vat", "tags": [ - "Shopping List" + "Product Vat" ], "responses": { "200": { - "description": "OK - returns the shopping list", + "description": "OK - loads the VAT category.", "content": { - "application/vnd.ibexa.api.ShoppingList+json": { + "application/vnd.ibexa.api.VatCategory+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListWrapper" + "$ref": "#/components/schemas/VatCategoryWrapper" }, "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" + "VatCategory": { + "_media-type": "application/vnd.ibexa.api.VatCategory+json", + "identifier": "standard", + "region": "region_1", + "vatValue": 18 } } - }, - "application/vnd.ibexa.api.ShoppingList+xml": { - "schema": { - "$ref": "#/components/schemas/ShoppingList" - }, - "example": "\n\n 550e8400-e29b-41d4-a716-446655440000\n My Shopping List\n 0\n \n \n 650e8400-e29b-41d4-a716-446655440001\n \n PRODUCT-001\n Sample Product\n \n 2024-10-29T12:15:00+00:00\n \n \n 650e8400-e29b-41d4-a716-446655440002\n \n PRODUCT-002\n Another Product\n \n 2024-10-29T12:30:00+00:00\n \n 2024-10-29T12:00:00+00:00\n 2024-10-29T12:00:00+00:00\n\n" } } }, "401": { - "description": "Error - the user is not authorized to access this shopping list." + "description": "Error - the user is not authorized to read this object." }, "404": { - "description": "Error - the identifier does not match any shopping list." + "description": "Error - the VAT category for the given identifier not exists." } }, - "summary": "Get shopping list", - "description": "Gets a shopping list by its identifier.", + "summary": "Load VAT specific region", + "description": "Loads a VAT category for the given identifier.", "parameters": [ { - "name": "identifier", + "name": "region", "in": "path", - "description": "The shopping list identifier (UUID)", + "description": "VatCategoryLoadByIdentifierController 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" - } - ] - }, - "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." + "explode": false }, - "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.", + "description": "VatCategoryLoadByIdentifierController 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 } ] - }, - "patch": { - "operationId": "ibexa.rest.shopping_list.update", + } + }, + "/content/sections": { + "get": { + "operationId": "ibexa.rest.list_sections", "tags": [ - "Shopping List" + "Section" ], "responses": { "200": { - "description": "Shopping list updated.", + "description": "If set, the Section list is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShoppingList+json": { + "application/vnd.ibexa.api.SectionList+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListWrapper" + "$ref": "#/components/schemas/SectionListWrapper" }, "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": [ + "SectionList": { + "_media-type": "application/vnd.ibexa.api.SectionList+json", + "_href": "/api/ibexa/v2/content/sections", + "Section": [ { - "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.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" } - ], - "createdAt": "2024-10-29T12:00:00+00:00", - "updatedAt": "2024-10-29T12:30:00+00:00" + ] } } }, - "application/vnd.ibexa.api.ShoppingList+xml": { + "application/vnd.ibexa.api.SectionList+xml": { "schema": { - "$ref": "#/components/schemas/ShoppingList" + "$ref": "#/components/schemas/SectionList" }, - "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" + "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" } } }, - "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." + "description": "Error - The user has no permission to read the Section." } }, - "summary": "Update shopping list", - "description": "Updates an existing shopping list. Only the name can be updated.", + "summary": "Get Sections", + "description": "Returns a list of all Sections.", "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", + "name": "If-None-Match", "in": "header", - "description": "CSRF Token is needed to execute this unsafe request.", - "required": true, + "description": "ETag", + "required": false, "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": "\n\n Updated Shopping List Name\n\n" - } - }, - "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - }, - { - "name": "LTS Update", - "color": "#5DA7C0", - "position": "after" + "explode": false } ] - } - }, - "/shopping-list/{identifier}/add-entries-to-cart": { + }, "post": { - "operationId": "ibexa.rest.cart.shopping_list.add_entries_to_cart", + "operationId": "ibexa.rest.create_section", "tags": [ - "Shopping List" + "Section" ], "responses": { - "200": { - "description": "OK - returns the cart with added shopping list entries", + "201": { + "description": "If set, the new Section is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Cart+json": { + "application/vnd.ibexa.api.Section+json": { "schema": { - "$ref": "#/components/schemas/CartWrapper" + "$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.Cart+xml": { + "application/vnd.ibexa.api.Section+xml": { "schema": { - "$ref": "#/components/schemas/Cart" - } + "$ref": "#/components/schemas/Section" + }, + "example": "\n
\n 7\n restricted\n Restricted\n
\n" } } - }, - "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).", + "summary": "Create new Section", + "description": "Creates a new Section.", "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 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 ShoppingListEntryIdentifiers schema encoded in XML or JSON format.", + "description": "The Section input schema encoded in XML or JSON format.", "content": { - "application/vnd.ibexa.api.ShoppingListEntryIdentifiers+json": { + "application/vnd.ibexa.api.SectionInput+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListEntryIdentifiersWrapper" + "$ref": "#/components/schemas/SectionInputWrapper" }, "example": { - "ShoppingListEntryIdentifiers": { - "entries": [ - { - "identifier": "entry-001" - }, - { - "identifier": "entry-003" - } - ] + "SectionInput": { + "identifier": "restricted", + "name": "Restricted" } } }, - "application/vnd.ibexa.api.ShoppingListEntryIdentifiers+xml": { + "application/vnd.ibexa.api.SectionInput+xml": { "schema": { - "$ref": "#/components/schemas/ShoppingListEntryIdentifiers" + "$ref": "#/components/schemas/SectionInput" }, - "example": "\n\n \n entry-001\n \n \n entry-003\n \n\n" + "example": "\n\n restricted\n Restricted\n" } }, "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - }, - { - "name": "LTS Update", - "color": "#5DA7C0", - "position": "after" - } - ] + } } }, - "/shopping-list/{identifier}/add-entries-to-cart/{cartIdentifier}": { - "post": { - "operationId": "ibexa.rest.cart.shopping_list.add_entries_to_cart.cart_identifier", + "/content/sections/{sectionId}": { + "get": { + "operationId": "ibexa.rest.load_section", "tags": [ - "Shopping List" + "Section" ], "responses": { "200": { - "description": "OK - returns the cart with added shopping list entries", + "description": "If set, the Section is returned in XML or JSON format.", "content": { - "application/vnd.ibexa.api.Cart+json": { + "application/vnd.ibexa.api.Section+json": { "schema": { - "$ref": "#/components/schemas/CartWrapper" + "$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.Cart+xml": { + "application/vnd.ibexa.api.Section+xml": { "schema": { - "$ref": "#/components/schemas/Cart" - } + "$ref": "#/components/schemas/Section" + }, + "example": "\n
\n 10\n design\n Design\n
\n" } } }, - "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 read this Section." }, "404": { - "description": "Error - the shopping list, cart, or entry identifiers don't match any existing resource." + "description": "Error - The Section does not exist." } }, - "summary": "Add Selected Entries from Shopping List to Specific Cart", - "description": "Adds selected entries from the given Shopping List to the specified Cart.", + "summary": "Get Section", + "description": "Returns the Section by given Section ID.", "parameters": [ { - "name": "identifier", - "in": "path", - "description": "The Shopping List identifier", - "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": "cartIdentifier", + "name": "sectionId", "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": "SectionLoadByIdController 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.rest.delete_section", "tags": [ - "Shopping List" + "Section" ], "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 - given Section is deleted." }, "401": { - "description": "Error - the user is not authorized to add shopping list to cart." + "description": "Error - the user is not authorized to delete this Section." }, "404": { - "description": "Error - the shopping list identifier doesn't match any existing resource." + "description": "Error - the Section does not exist." } }, - "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 Section", + "description": "The given Section is deleted.", "parameters": [ { - "name": "identifier", - "in": "path", - "description": "The Shopping List identifier", + "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": "X-CSRF-Token", - "in": "header", - "description": "CSRF Token is needed to execute this unsafe request.", + "name": "sectionId", + "in": "path", + "description": "SectionDeleteController 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" - }, - { - "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.rest.update_section", "tags": [ - "Shopping List" + "Section" ], "responses": { "200": { - "description": "OK - returns the cart with added shopping list entries", + "description": "OK - Section updated.", "content": { - "application/vnd.ibexa.api.Cart+json": { + "application/vnd.ibexa.api.Section+json": { "schema": { - "$ref": "#/components/schemas/CartWrapper" + "$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.Cart+xml": { + "application/vnd.ibexa.api.Section+xml": { "schema": { - "$ref": "#/components/schemas/Cart" - } + "$ref": "#/components/schemas/Section" + }, + "example": "\n
\n 7\n template\n Template\n
\n" } } }, + "400": { + "description": "Error - the input does not match the input schema definition." + }, "401": { - "description": "Error - the user is not authorized to add shopping list to cart." + "description": "Error - the user is not authorized to create this Section." }, - "404": { - "description": "Error - the shopping list or cart identifier doesn't match any existing resource." + "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": "Add Shopping List to Specific Cart", - "description": "Adds all entries from the given Shopping List to the specified Cart.", + "summary": "Update a Section", + "description": "Updates a Section. PATCH or POST with header X-HTTP-Method-Override PATCH.", "parameters": [ { - "name": "identifier", - "in": "path", - "description": "The Shopping List identifier", + "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": "cartIdentifier", - "in": "path", - "description": "The Cart identifier", + "name": "If-Match", + "in": "header", + "description": "ETag", "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": "sectionId", + "in": "path", + "description": "SectionUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { - "description": "No payload required", - "content": [], + "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": "\n\n template\n Template\n\n" + } + }, "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" + } + } + }, + "/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": "\n\n \n 1\n corporate_accounts\n Corporate Accounts\n \n\n" + } + } }, - { - "name": "LTS Update", - "color": "#5DA7C0", - "position": "after" + "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": [] } }, - "/shopping-list/{identifier}/clear": { - "post": { - "operationId": "ibexa.rest.shopping_list.clear", + "/segment_groups/{identifier}": { + "get": { + "operationId": "ibexa.segmentation.rest.segment_groups.view", "tags": [ - "Shopping List" + "Segmentation" ], "responses": { "200": { - "description": "Shopping list cleared successfully. Returns the updated shopping list with no entries.", + "description": "OK - return the segment group.", "content": { - "application/vnd.ibexa.api.ShoppingList+json": { + "application/vnd.ibexa.api.SegmentGroup+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListWrapper" + "$ref": "#/components/schemas/SegmentGroupWrapper" }, "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" + "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.ShoppingList+xml": { + "application/vnd.ibexa.api.SegmentGroup+xml": { "schema": { - "$ref": "#/components/schemas/ShoppingList" + "$ref": "#/components/schemas/SegmentGroup" }, - "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" + "example": "\n\n 1\n corporate_accounts\n Corporate Accounts\n\n" } } }, "401": { - "description": "Error - The user is not authorized to clear this shopping list." - }, - "403": { - "description": "Error - Invalid request." + "description": "Error - the user is not authorized to load this segment group." }, "404": { - "description": "Error - Shopping list not found." + "description": "Error - the identifier doesn't match any segment group." } }, - "summary": "Clear shopping list", - "description": "Removes all entries from a shopping list while keeping the list itself.", + "summary": "Load segment group", + "description": "Loads segment group.", "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": "SegmentGroupViewController 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" - }, - { - "name": "LTS Update", - "color": "#5DA7C0", - "position": "after" + "explode": false } ] } }, - "/shopping-list/{identifier}/entries": { - "post": { - "operationId": "ibexa.rest.shopping_list.add_entries", + "/segment_groups/{identifier}/segments": { + "get": { + "operationId": "ibexa.segmentation.rest.segment_groups.list.segments", "tags": [ - "Shopping List" + "Segmentation" ], "responses": { "200": { - "description": "Entries added successfully. Returns the updated shopping list.", + "description": "OK - list the group's segments.", "content": { - "application/vnd.ibexa.api.ShoppingList+json": { + "application/vnd.ibexa.api.SegmentList+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListWrapper" + "$ref": "#/components/schemas/SegmentListWrapper" }, "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" + "SegmentList": { + "_media-type": "application/vnd.ibexa.api.SegmentList+json", + "_href": "/api/ibexa/v2/segment_groups/corporate_accounts/segments", + "Segment": [] } } }, - "application/vnd.ibexa.api.ShoppingList+xml": { + "application/vnd.ibexa.api.SegmentList+xml": { "schema": { - "$ref": "#/components/schemas/ShoppingList" + "$ref": "#/components/schemas/SegmentList" }, - "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": "\n\n" } } }, - "400": { - "description": "Error - The input does not match the input schema definition." - }, "401": { - "description": "Error - The user is not authorized to add entries to this shopping list." - }, - "403": { - "description": "Error - Invalid request (e.g., invalid product code, duplicate entry)." - }, - "406": { - "description": "Error - Shopping list entry limit exceeded." + "description": "Error - the user is not authorized to load this group's segments." }, "404": { - "description": "Error - Shopping list not found." + "description": "Error - the identifier doesn't match any segment group." } }, - "summary": "Add entries to shopping list", - "description": "Adds one or more product entries to an existing shopping list.", + "summary": "List segment group's segments", + "description": "Lists segment group's segments.", "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": "SegmentListController identifier", "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": "\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" + "explode": false } ] } }, - "/shopping-list/{identifier}/entries/remove": { - "post": { - "operationId": "ibexa.rest.shopping_list.remove_entries", + "/segments/{identifier}": { + "get": { + "operationId": "ibexa.segmentation.rest.segments.view", "tags": [ - "Shopping List" + "Segmentation" ], "responses": { "200": { - "description": "Entries removed successfully. Returns the updated shopping list.", + "description": "OK - Return the segment.", "content": { - "application/vnd.ibexa.api.ShoppingList+json": { + "application/vnd.ibexa.api.Segment+json": { "schema": { - "$ref": "#/components/schemas/ShoppingListWrapper" + "$ref": "#/components/schemas/SegmentWrapper" }, "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" + "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.ShoppingList+xml": { + "application/vnd.ibexa.api.Segment+xml": { "schema": { - "$ref": "#/components/schemas/ShoppingList" + "$ref": "#/components/schemas/Segment" }, - "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": "\n\n 1\n corporate_account\n Corporate Account\n cohesivo\n 14\n 2026-06-30T12:00:00+00: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 remove entries from this shopping list." - }, - "403": { - "description": "Error - Invalid request (e.g., invalid entry identifier, entry does not exist)." + "description": "Error - the user is not authorized to load this group's segments." }, "404": { - "description": "Error - Shopping list not found." + "description": "Error - the identifier doesn't match any segment group." } }, - "summary": "Remove entries from shopping list", - "description": "Removes one or more product entries from an existing shopping list by their identifiers.", + "summary": "Load segment", + "description": "Loads the identified segment.", "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": "SegmentViewController identifier", "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": "\n\n \n 650e8400-e29b-41d4-a716-446655440001\n 650e8400-e29b-41d4-a716-446655440002\n \n\n" - } - }, - "required": false - }, - "deprecated": false, - "x-badges": [ - { - "name": "Commerce", - "color": "#A32768", - "position": "after" - }, - { - "name": "LTS Update", - "color": "#5DA7C0", - "position": "after" + "explode": false } ] } @@ -27034,27 +19861,23 @@ "description": "The CSRF token.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "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 } ], "requestBody": { @@ -27080,8 +19903,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/taxonomy/{taxonomyName}/entries/move": { @@ -27113,27 +19935,23 @@ "description": "The CSRF token.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "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": { @@ -27167,8 +19985,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/taxonomy/{taxonomyName}/entry-assignment/{id}": { @@ -27203,33 +20020,28 @@ { "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": "", + "description": "TaxonomyEntryAssignmentLoadByIdController identifier", "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": { @@ -27258,27 +20070,23 @@ "description": "The CSRF token.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "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": { @@ -27300,8 +20108,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/taxonomy/{taxonomyName}/entry-assignments/content-id/{contentId}": { @@ -27455,33 +20262,28 @@ { "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": "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 + ] } }, "/taxonomy/{taxonomyName}/entry-assignments/unassign-from-content": { @@ -27510,27 +20312,23 @@ "description": "The CSRF token.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "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": { @@ -27552,8 +20350,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/taxonomy/{taxonomyName}/entry/content-id/{contentId}": { @@ -27591,33 +20388,28 @@ { "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": "", + "description": "TaxonomyEntryLoadByContentIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] } }, "/taxonomy/{taxonomyName}/entry/identifier/{identifier}": { @@ -27655,33 +20447,28 @@ { "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": "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 + ] } }, "/taxonomy/{taxonomyName}/entry/{id}": { @@ -27719,33 +20506,28 @@ { "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": "", + "description": "TaxonomyEntryLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] } }, "/content/trash": { @@ -27923,8 +20705,7 @@ }, "summary": "List Trash items", "description": "Returns a list of all items in the Trash.", - "parameters": [], - "deprecated": false + "parameters": [] }, "delete": { "operationId": "ibexa.rest.empty_trash", @@ -27948,16 +20729,13 @@ "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 + ] } }, "/content/trash/{trashItemid}": { @@ -28067,19 +20845,16 @@ { "name": "trashItemid", "in": "path", - "description": "", + "description": "TrashItemLoadByIdController 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_trash_item", @@ -28106,30 +20881,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": "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/types": { @@ -28904,8 +21674,7 @@ }, "summary": "List content types", "description": "Returns a list of content types.", - "parameters": [], - "deprecated": false + "parameters": [] } }, "/content/types/view": { @@ -29677,13 +22446,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": { @@ -29725,8 +22492,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/content/types/{contentTypeId}": { @@ -30071,30 +22837,25 @@ "description": "ETag", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "contentTypeId", "in": "path", - "description": "", + "description": "ContentTypeLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] }, "post": { "operationId": "ibexa.rest.create_content_type_draft", @@ -30183,27 +22944,23 @@ "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", "in": "path", - "description": "", + "description": "ContentTypeDraftCreateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { @@ -30228,8 +22985,7 @@ } }, "required": false - }, - "deprecated": false + } }, "delete": { "operationId": "ibexa.rest.delete_content_type", @@ -30259,30 +23015,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": "contentTypeId", "in": "path", - "description": "", + "description": "ContentTypeDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] } }, "/content/types/{contentTypeId}/draft": { @@ -30624,19 +23375,16 @@ { "name": "contentTypeId", "in": "path", - "description": "", + "description": "ContentTypeDraftLoadController 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_content_type_draft", @@ -30663,30 +23411,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": "contentTypeId", "in": "path", - "description": "", + "description": "ContentTypeDraftDeleteController 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", @@ -30783,27 +23526,23 @@ "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", "in": "path", - "description": "", + "description": "ContentTypeDraftUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { @@ -30843,8 +23582,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/content/types/{contentTypeId}/draft/fieldDefinitions": { @@ -30879,19 +23617,16 @@ { "name": "contentTypeId", "in": "path", - "description": "", + "description": "ContentTypeDraftFieldDefinitionListController 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_content_type_draft_field_definition", @@ -30972,27 +23707,23 @@ "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", "in": "path", - "description": "", + "description": "ContentTypeDraftFieldDefinitionAddController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { @@ -31011,8 +23742,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/content/types/{contentTypeId}/draft/fieldDefinitions/{fieldDefinitionId}": { @@ -31089,33 +23819,28 @@ { "name": "contentTypeId", "in": "path", - "description": "", + "description": "ContentTypeDraftFieldDefinitionLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "fieldDefinitionId", "in": "path", - "description": "", + "description": "ContentTypeDraftFieldDefinitionLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] }, "delete": { "operationId": "ibexa.rest.remove_content_type_draft_field_definition", @@ -31142,44 +23867,37 @@ "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", "in": "path", - "description": "", + "description": "ContentTypeDraftFieldDefinitionDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "fieldDefinitionId", "in": "path", - "description": "", + "description": "ContentTypeDraftFieldDefinitionDeleteController 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", @@ -31260,41 +23978,35 @@ "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", "in": "path", - "description": "", + "description": "ContentTypeDraftFieldDefinitionUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "fieldDefinitionId", "in": "path", - "description": "", + "description": "ContentTypeDraftFieldDefinitionUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { @@ -31313,8 +24025,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/content/types/{contentTypeId}/fieldDefinitions": { @@ -31349,19 +24060,16 @@ { "name": "contentTypeId", "in": "path", - "description": "", + "description": "ContentTypeFieldDefinitionListController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] } }, "/content/types/{contentTypeId}/fieldDefinitions/{fieldDefinitionId}": { @@ -31438,33 +24146,28 @@ { "name": "contentTypeId", "in": "path", - "description": "", + "description": "ContentTypeFieldDefinitionLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "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 + ] } }, "/content/types/{contentTypeId}/groups": { @@ -31515,19 +24218,16 @@ { "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 } - ], - "deprecated": false + ] }, "post": { "operationId": "ibexa.rest.link_content_type_to_group", @@ -31594,27 +24294,23 @@ "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", "in": "path", - "description": "", + "description": "ContentTypeLinkToGroupController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "group", @@ -31622,21 +24318,18 @@ "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}": { @@ -31708,44 +24401,37 @@ "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", "in": "path", - "description": "", + "description": "ContentTypeUnlinkFromGroupController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "id", "in": "path", - "description": "", + "description": "ContentTypeUnlinkFromGroupController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] } }, "/content/typegroups": { @@ -31851,8 +24537,7 @@ }, "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 + "parameters": [] }, "post": { "operationId": "ibexa.rest.create_content_type_group", @@ -31917,13 +24602,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": { @@ -31947,8 +24630,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/content/typegroups/{contentTypeGroupId}": { @@ -33585,30 +26267,25 @@ "description": "ETag", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "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_content_type_group", @@ -33638,30 +26315,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": "contentTypeGroupId", "in": "path", - "description": "", + "description": "ContentTypeGroupDeleteController 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", @@ -33729,13 +26401,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 }, { "name": "If-Match", @@ -33743,27 +26413,23 @@ "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": "contentTypeGroupId", "in": "path", - "description": "", + "description": "ContentTypeGroupUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { @@ -33787,8 +26453,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/content/typegroups/{contentTypeGroupId}/types": { @@ -36579,19 +29244,16 @@ { "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.create_content_type", @@ -36634,27 +29296,23 @@ "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": "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": { @@ -36759,8 +29417,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/content/urlaliases": { @@ -36804,8 +29461,7 @@ }, "summary": "List global URL aliases", "description": "Returns the list of global URL aliases.", - "parameters": [], - "deprecated": false + "parameters": [] }, "post": { "operationId": "ibexa.rest.create_url_alias", @@ -36863,13 +29519,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": { @@ -36898,8 +29552,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/content/urlaliases/{urlAliasId}": { @@ -36953,19 +29606,16 @@ { "name": "urlAliasId", "in": "path", - "description": "", + "description": "URLAliasLoadByIdController 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", @@ -36992,30 +29642,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": "urlAliasId", "in": "path", - "description": "", + "description": "URLAliasDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] } }, "/content/urlwildcards": { @@ -37063,8 +29708,7 @@ }, "summary": "List URL wildcards", "description": "Returns a list of URL wildcards.", - "parameters": [], - "deprecated": false + "parameters": [] }, "post": { "operationId": "ibexa.rest.create_url_wildcard", @@ -37117,13 +29761,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": { @@ -37149,8 +29791,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/content/urlwildcards/{wildcardId}": { @@ -37199,19 +29840,16 @@ { "name": "wildcardId", "in": "path", - "description": "", + "description": "URLWildcardLoadByIdController 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_wildcard", @@ -37238,30 +29876,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": "wildcardId", "in": "path", - "description": "", + "description": "URLWildcardDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] } }, "/user/current": { @@ -37455,16 +30088,13 @@ "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 + "explode": false } - ], - "deprecated": false + ] } }, "/user/users": { @@ -37669,16 +30299,13 @@ "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 } - ], - "deprecated": false + ] }, "head": { "operationId": "api_userusers_head", @@ -37695,8 +30322,7 @@ }, "summary": "Verify Users", "description": "Verifies if there are Users matching given filter.", - "parameters": [], - "deprecated": false + "parameters": [] } }, "/user/users/{userId}": { @@ -37893,13 +30519,11 @@ "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 + "explode": false }, { "name": "If-None-Match", @@ -37907,30 +30531,25 @@ "description": "ETag", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "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 } - ], - "deprecated": false + ] }, "delete": { "operationId": "api_userusers_userId_delete", @@ -37957,19 +30576,16 @@ { "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": "api_userusers_userId_patch", @@ -38164,13 +30780,11 @@ "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", @@ -38178,13 +30792,11 @@ "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 + "explode": false }, { "name": "If-Match", @@ -38192,27 +30804,23 @@ "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": "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": { @@ -38237,8 +30845,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/user/users/{userId}/drafts": { @@ -38276,30 +30883,25 @@ "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 + "explode": false }, { "name": "userId", "in": "path", - "description": "", + "description": "UserDraftListController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] } }, "/user/users/{userId}/groups": { @@ -38310,7 +30912,7 @@ ], "responses": { "200": { - "description": "200", + "description": "OK - list of the User Groups the User belongs to.", "content": { "application/vnd.ibexa.api.UserGroupRefList+json": { "schema": { @@ -38353,30 +30955,25 @@ "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": "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 + ] }, "post": { "operationId": "api_userusers_userIdgroups_post", @@ -38385,7 +30982,7 @@ ], "responses": { "200": { - "description": "200", + "description": "OK - the User has been assigned to the User Group.", "content": { "application/vnd.ibexa.api.UserGroupRefList+json": { "schema": { @@ -38431,35 +31028,30 @@ "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": "userId", "in": "path", - "description": "", + "description": "UserAssignToUserGroupController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { "description": "The new UserAssignToUserGroupController resource", "content": [], "required": false - }, - "deprecated": false + } } }, "/user/users/{userId}/groups/{groupId}": { @@ -38470,7 +31062,7 @@ ], "responses": { "200": { - "description": "200", + "description": "OK - the User has been unassigned from the User Group.", "content": { "application/vnd.ibexa.api.UserGroupRefList+json": { "schema": { @@ -38519,44 +31111,37 @@ "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": "userId", "in": "path", - "description": "", + "description": "UserUnassignFromUserGroupController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "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 } - ], - "deprecated": false + ] } }, "/user/users/{userId}/roles": { @@ -38619,19 +31204,16 @@ { "name": "userId", "in": "path", - "description": "", + "description": "RoleAssignmentForUserListController 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", @@ -38717,27 +31299,23 @@ "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": "userId", "in": "path", - "description": "", + "description": "RoleAssignToUserController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { @@ -38779,8 +31357,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/user/users/{userId}/roles/{roleId}": { @@ -38837,33 +31414,28 @@ { "name": "userId", "in": "path", - "description": "", + "description": "RoleAssignmentForUserLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "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 } - ], - "deprecated": false + ] }, "delete": { "operationId": "ibexa.rest.unassign_role_from_user", @@ -38924,44 +31496,37 @@ "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": "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": "", + "description": "RoleUnassignFromUserController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] } }, "/user/users/{userId}/segments": { @@ -38988,7 +31553,7 @@ "id": 1, "identifier": "corporate_account", "name": "Corporate Account", - "source": "ibexa", + "source": "cohesivo", "lastUpdatedBy": "14", "updatedAt": "2026-06-30T12:00:00+00:00", "SegmentGroup": { @@ -39008,7 +31573,7 @@ "schema": { "$ref": "#/components/schemas/UserSegmentList" }, - "example": "\n\n \n 1\n corporate_account\n Corporate Account\n ibexa\n 14\n 2026-06-30T12:00:00+00:00\n \n \n \n\n" + "example": "\n\n \n 1\n corporate_account\n Corporate Account\n cohesivo\n 14\n 2026-06-30T12:00:00+00:00\n \n \n \n\n" } } }, @@ -39022,19 +31587,16 @@ { "name": "userId", "in": "path", - "description": "", + "description": "UserSegmentListController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] }, "post": { "operationId": "ibexa.segmentation.rest.user.segments.assign", @@ -39061,27 +31623,23 @@ "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": "userId", "in": "path", - "description": "", + "description": "UserSegmentAssignController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { @@ -39107,8 +31665,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/user/users/{userId}/segments/{segmentIdentifier}": { @@ -39137,44 +31694,37 @@ "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": "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": "segmentIdentifier", "in": "path", - "description": "", + "description": "UserSegmentUnassignController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] } }, "/user/groups": { @@ -39185,7 +31735,7 @@ ], "responses": { "200": { - "description": "200", + "description": "OK - list of User Groups.", "content": { "application/vnd.ibexa.api.UserGroupList+json": { "schema": { @@ -39392,16 +31942,13 @@ "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 } - ], - "deprecated": false + ] } }, "/user/groups/root": { @@ -39417,8 +31964,7 @@ }, "summary": "Get root User Group", "description": "Redirects to the root User Group.", - "parameters": [], - "deprecated": false + "parameters": [] } }, "/user/groups/subgroups": { @@ -39580,13 +32126,11 @@ "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": "Content-Type", @@ -39594,13 +32138,11 @@ "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 } ], "requestBody": { @@ -39639,8 +32181,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/user/groups/{path}": { @@ -39802,13 +32343,11 @@ "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": "If-None-Match", @@ -39816,30 +32355,25 @@ "description": "ETag", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "path", "in": "path", - "description": "", + "description": "UserGroupLoadByPathController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] }, "delete": { "operationId": "api_usergroups_path_delete", @@ -39863,19 +32397,16 @@ { "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 } - ], - "deprecated": false + ] }, "patch": { "operationId": "api_usergroups_path_patch", @@ -40038,13 +32569,11 @@ "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": "Content-Type", @@ -40052,13 +32581,11 @@ "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 + "explode": false }, { "name": "If-Match", @@ -40066,27 +32593,23 @@ "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 + "explode": false }, { "name": "path", "in": "path", - "description": "", + "description": "UserGroupUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { @@ -40112,8 +32635,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/user/groups/{path}/roles": { @@ -40159,19 +32681,16 @@ { "name": "path", "in": "path", - "description": "", + "description": "RoleAssignmentForUserGroupListController 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", @@ -40227,27 +32746,23 @@ "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", "in": "path", - "description": "", + "description": "RoleAssignToUserGroupController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { @@ -40289,8 +32804,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/user/groups/{path}/roles/{roleId}": { @@ -40336,33 +32850,28 @@ { "name": "path", "in": "path", - "description": "", + "description": "RoleAssignmentForUserGroupLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "roleId", "in": "path", - "description": "", + "description": "RoleAssignmentForUserGroupLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] }, "delete": { "operationId": "ibexa.rest.unassign_role_from_user_group", @@ -40426,44 +32935,37 @@ "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", "in": "path", - "description": "", + "description": "RoleUnassignFromUserGroupController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "roleId", "in": "path", - "description": "", + "description": "RoleUnassignFromUserGroupController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] } }, "/user/groups/{path}/subgroups": { @@ -40684,30 +33186,25 @@ "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 + "explode": false }, { "name": "path", "in": "path", - "description": "", + "description": "UserSubGroupListController identifier", "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", @@ -40716,7 +33213,7 @@ ], "responses": { "201": { - "description": "201", + "description": "Created - the User Group has been created.", "content": { "application/vnd.ibexa.api.UserGroup+json": { "schema": { @@ -40867,13 +33364,11 @@ "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": "Content-Type", @@ -40881,27 +33376,23 @@ "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 }, { "name": "path", "in": "path", - "description": "", + "description": "UserGroupCreateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { @@ -40940,8 +33431,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/user/groups/{path}/users": { @@ -41009,30 +33499,25 @@ "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 + "explode": false }, { "name": "path", "in": "path", - "description": "", + "description": "UserGroupUsersListController identifier", "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", @@ -41041,7 +33526,7 @@ ], "responses": { "201": { - "description": "201", + "description": "Created - the User has been created.", "content": { "application/vnd.ibexa.api.User+json": { "schema": { @@ -41227,13 +33712,11 @@ "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 + "explode": false }, { "name": "Content-Type", @@ -41241,27 +33724,23 @@ "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 + "explode": false }, { "name": "path", "in": "path", - "description": "", + "description": "UserCreateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { @@ -41315,8 +33794,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/user/policies": { @@ -41452,8 +33930,7 @@ }, "summary": "List Policies for User", "description": "Search all Policies which are applied to a given User.", - "parameters": [], - "deprecated": false + "parameters": [] } }, "/user/roles": { @@ -41556,8 +34033,7 @@ }, "summary": "Load Roles", "description": "Returns a list of all Roles.", - "parameters": [], - "deprecated": false + "parameters": [] }, "post": { "operationId": "ibexa.rest.create_role", @@ -41608,13 +34084,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": { @@ -41638,8 +34112,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/user/roles/{id}": { @@ -41692,30 +34165,25 @@ "description": "ETag", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "id", "in": "path", - "description": "", + "description": "RoleLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] }, "post": { "operationId": "ibexa.rest.create_role_draft", @@ -41763,35 +34231,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": "id", "in": "path", - "description": "", + "description": "RoleDraftCreateController 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", @@ -41815,30 +34278,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": "id", "in": "path", - "description": "", + "description": "RoleDeleteController 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", @@ -41892,13 +34350,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 }, { "name": "If-Match", @@ -41906,27 +34362,23 @@ "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 + "explode": false }, { "name": "id", "in": "path", - "description": "", + "description": "RoleUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { @@ -41950,8 +34402,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/user/roles/{id}/draft": { @@ -42004,30 +34455,25 @@ "description": "ETag", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "id", "in": "path", - "description": "", + "description": "RoleDraftLoadByRoleIdController 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", @@ -42051,30 +34497,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": "id", "in": "path", - "description": "", + "description": "RoleDraftDeleteController 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", @@ -42131,13 +34572,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 }, { "name": "If-Match", @@ -42145,27 +34584,23 @@ "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 + "explode": false }, { "name": "id", "in": "path", - "description": "", + "description": "RoleDraftUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { @@ -42189,8 +34624,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/user/roles/{id}/policies": { @@ -42333,19 +34767,16 @@ { "name": "id", "in": "path", - "description": "", + "description": "RolePolicyListController 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", @@ -42397,27 +34828,23 @@ "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", "in": "path", - "description": "", + "description": "RolePolicyCreateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { @@ -42436,8 +34863,7 @@ } }, "required": false - }, - "deprecated": false + } }, "delete": { "operationId": "ibexa.rest.delete_policies", @@ -42461,30 +34887,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": "id", "in": "path", - "description": "", + "description": "RolePolicyDeleteAllFromRoleController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] } }, "/user/roles/{roleId}/policies/{policyId}": { @@ -42535,27 +34956,23 @@ "description": "ETag", "required": false, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "policyId", "in": "path", - "description": "", + "description": "RolePolicyLoadByIdController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "roleId", @@ -42563,16 +34980,13 @@ "description": "RolePolicyLoadByIdController 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", @@ -42599,27 +35013,23 @@ "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": "policyId", "in": "path", - "description": "", + "description": "RolePolicyDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "roleId", @@ -42627,16 +35037,13 @@ "description": "RolePolicyDeleteController 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", @@ -42691,13 +35098,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 }, { "name": "If-Match", @@ -42705,27 +35110,23 @@ "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": "policyId", "in": "path", - "description": "", + "description": "RolePolicyUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "roleId", @@ -42733,13 +35134,11 @@ "description": "RolePolicyUpdateController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } ], "requestBody": { @@ -42758,8 +35157,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/user/sessions": { @@ -42844,13 +35242,11 @@ "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 + "explode": false }, { "name": "Content-Type", @@ -42858,13 +35254,11 @@ "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 + "explode": false }, { "name": "Cookie", @@ -42872,13 +35266,11 @@ "description": "Only needed for session's checking {sessionName}={sessionID}.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "X-CSRF-Token", @@ -42886,13 +35278,11 @@ "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 + "explode": false } ], "requestBody": { @@ -42917,8 +35307,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/user/sessions/current": { @@ -42969,13 +35358,11 @@ "description": "Only needed for session's checking {sessionName}={sessionID}.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "Accept", @@ -42983,16 +35370,13 @@ "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 + "explode": false } - ], - "deprecated": false + ] } }, "/user/sessions/{sessionId}": { @@ -43018,13 +35402,11 @@ "description": "{sessionName}={sessionID}", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "X-CSRF-Token", @@ -43032,30 +35414,25 @@ "description": "The {csrfToken} needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "sessionId", "in": "path", - "description": "", + "description": "SessionDeleteController identifier", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false } - ], - "deprecated": false + ] } }, "/user/sessions/{sessionId}/refresh": { @@ -43066,7 +35443,7 @@ ], "responses": { "200": { - "description": "200", + "description": "OK - session refreshed.", "content": { "application/vnd.ibexa.api.Session+json": { "schema": { @@ -43106,13 +35483,11 @@ "description": "{sessionName}={sessionID}", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "X-CSRF-Token", @@ -43120,13 +35495,11 @@ "description": "The {csrfToken} needed on all unsafe HTTP methods with session.", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "Accept", @@ -43134,35 +35507,30 @@ "description": "", "required": true, "deprecated": false, - "allowEmptyValue": false, "schema": { "type": "string" }, "style": "simple", - "explode": false, - "allowReserved": false + "explode": false }, { "name": "sessionId", "in": "path", - "description": "", + "description": "SessionRefreshController 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": { @@ -43213,8 +35581,7 @@ } }, "required": false - }, - "deprecated": false + } } }, "/views": { @@ -43248,13 +35615,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": { @@ -43301,8 +35666,7 @@ } }, "required": false - }, - "deprecated": false + } } } }, @@ -46754,764 +39118,269 @@ "description": "This class is the base class for facet builders.", "type": "object", "required": [ - "name", - "global", - "filter", - "limit", - "minCount" - ], - "properties": { - "name": { - "description": "The name of the facet.", - "type": "string" - }, - "global": { - "description": "If true the facet runs in a global mode not restricted by the query.", - "type": "boolean" - }, - "filter": { - "description": "An additional facet filter that will further filter the documents the facet will be executed on.", - "$ref": "#/components/schemas/Criterion" - }, - "limit": { - "description": "Number of facets (terms) returned.", - "type": "integer" - }, - "minCount": { - "description": "Specifies the minimum count. Only facet groups with more or equal results are returned.", - "type": "integer" - } - } - }, - "Specifications": { - "description": "This class is used by Criteria to describe which operators they support. Instances of this class are returned in an array by the {@see Criterion::getSpecifications()} method.", - "type": "object", - "required": [ - "operator", - "valueFormat", - "valueTypes", - "valueCount" - ], - "properties": { - "operator": { - "description": "Specified operator, as one of the Operator::* constants.", - "type": "string" - }, - "valueFormat": { - "description": "Format supported for the Criterion value, either {@see self::FORMAT_SINGLE} for single or {@see self::FORMAT_ARRAY} for multiple.", - "type": "string" - }, - "valueTypes": { - "description": "Accepted values types, specifying what type of variables are accepted as a value. Criterion input value type description constants: const TYPE_INTEGER = 1; const TYPE_STRING = 2; const TYPE_BOOLEAN = 4.", - "type": "integer" - }, - "valueCount": { - "description": "Limitation on the number of items as the value. Only usable if {@see $valueFormat} is {@see self::FORMAT_ARRAY}.", - "type": "integer" - } - } - }, - "Role": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - }, - { - "description": "This class represents a role.", - "type": "object", - "required": [ - "identifier", - "Policies" - ], - "properties": { - "identifier": { - "description": "Readable string identifier of a role.", - "type": "string" - }, - "Policies": { - "description": "Returns the list of policies of this role.", - "$ref": "#/components/schemas/BaseObject" - } - } - } - ] - }, - "RoleWrapper": { - "type": "object", - "required": [ - "Role" - ], - "properties": { - "Role": { - "$ref": "#/components/schemas/Role" - } - } - }, - "RoleDraft": { - "description": "This class represents a draft of a role, extends Role.", - "$ref": "#/components/schemas/Role" - }, - "RoleDraftWrapper": { - "type": "object", - "required": [ - "Role" - ], - "properties": { - "Role": { - "$ref": "#/components/schemas/RoleDraft" - } - } - }, - "RoleInput": { - "description": "This class represents a Role input.", - "type": "object", - "required": [ - "identifier" - ], - "properties": { - "identifier": { - "type": "string" - } - } - }, - "RoleInputWrapper": { - "type": "object", - "required": [ - "RoleInput" - ], - "properties": { - "RoleInput": { - "$ref": "#/components/schemas/RoleInput" - } - } - }, - "RoleList": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - }, - { - "description": "This class represents a list roles.", - "type": "object", - "required": [ - "Role" - ], - "properties": { - "Role": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Role" - } - } - } - } - ] - }, - "RoleListWrapper": { - "type": "object", - "required": [ - "RoleList" - ], - "properties": { - "RoleList": { - "$ref": "#/components/schemas/RoleList" - } - } - }, - "Policy": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - }, - { - "description": "This class represents a policy value.", - "type": "object", - "required": [ - "id", - "module", - "function" - ], - "properties": { - "id": { - "description": "ID of the policy.", - "type": "integer" - }, - "module": { - "description": "Name of module, associated with the Policy e.g. content.", - "type": "string" - }, - "function": { - "description": "Name of the module function Or all functions with '*' e.g. read.", - "type": "string" - }, - "limitations": { - "description": "Limitations.", - "type": "object", - "required": [ - "limitation" - ], - "properties": { - "limitation": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Limitation" - } - } - } - } - } - } - ] - }, - "PolicyWrapper": { - "type": "object", - "required": [ - "Policy" - ], - "properties": { - "Policy": { - "$ref": "#/components/schemas/Policy" - } - } - }, - "Limitation": { - "description": "This class represents a Limitation applied to a policy.", - "type": "object", - "required": [ - "_identifier", - "values" - ], - "properties": { - "_identifier": { - "description": "Returns the limitation identifier (one of the defined constants) or a custom limitation. Constants: CONTENTTYPE = Class; LANGUAGE = Language; LOCATION = Node; OWNER = Owner; PARENTOWNER = ParentOwner; PARENTCONTENTTYPE = ParentClass; PARENTDEPTH = ParentDepth; SECTION = Section; NEWSECTION = NewSection; SITEACCESS = SiteAccess; STATE = State; NEWSTATE = NewState; SUBTREE = Subtree; USERGROUP = Group; PARENTUSERGROUP = ParentGroup; STATUS = Status.", - "enum": [ - "ContentType", - "Language", - "Location", - "Owner", - "Parentowner", - "ParentContentType", - "ParentDepth", - "Section", - "NewSection", - "SiteAccess", - "State", - "NewState", - "Subtree", - "UserGroup", - "ParentUserGroup", - "Status", - "Class" - ], - "xml": { - "attribute": true, - "name": "identifier" - }, - "type": "string" - }, - "values": { - "description": "A read-only list of IDs or identifiers for which the limitation should be applied. The value of this property must conform to a hash, which means that it may only consist of array and scalar values, but must not contain objects or resources.", - "type": "object", - "required": [ - "$ref" - ], - "properties": { - "ref": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Ref" - } - } - } - } - } - }, - "PolicyList": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - }, - { - "description": "List of policies.", - "type": "object", - "required": [ - "Policy" - ], - "properties": { - "Policy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Policy" - } - } - } - } - ] - }, - "PolicyListWrapper": { - "type": "object", - "required": [ - "PolicyList" - ], - "properties": { - "PolicyList": { - "$ref": "#/components/schemas/PolicyList" - } - } - }, - "PolicyCreate": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - }, - { - "description": "This class is used to create a Policy.", - "type": "object", - "required": [ - "module", - "function", - "Limitations" - ], - "properties": { - "module": { - "description": "Name of module associated with the Policy. For example, content.", - "type": "string" - }, - "function": { - "description": "Name of the module function, or all functions with ''*''. For example, read.", - "type": "string" - }, - "Limitations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Limitation" - } - } - } - } - ] - }, - "PolicyCreateWrapper": { - "type": "object", - "required": [ - "PolicyCreate" - ], - "properties": { - "PolicyCreate": { - "$ref": "#/components/schemas/PolicyCreate" - } - } - }, - "PolicyUpdate": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - }, - { - "description": "This class is used to update a Policy.", - "type": "object", - "required": [ - "Limitations" - ], - "properties": { - "Limitations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Limitation" - } - } - } - } - ] - }, - "PolicyUpdateWrapper": { - "type": "object", - "required": [ - "PolicyUpdate" - ], - "properties": { - "PolicyUpdate": { - "$ref": "#/components/schemas/PolicyUpdate" - } - } - }, - "RoleAssignment": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - }, - { - "description": "This value object represents an assignment of a User or User group to a role including a limitation.", - "type": "object", - "required": [ - "Role" - ], - "properties": { - "limitation": { - "description": "Returns the limitation of the role assignment." - }, - "Role": { - "description": "Returns the role to which the User or User group is assigned to.", - "$ref": "#/components/schemas/Ref" - } - } - } - ] - }, - "RoleAssignmentWrapper": { - "type": "object", - "required": [ - "RoleAssignment" - ], - "properties": { - "RoleAssignment": { - "$ref": "#/components/schemas/RoleAssignment" - } - } - }, - "RoleAssignInput": { - "description": "This class represents a Role assign input.", - "type": "object", - "required": [ - "Role", - "limitation" - ], - "properties": { - "Role": { - "description": "Returns the Role to which the user or user group is assigned to.", - "$ref": "#/components/schemas/Ref" - }, - "limitation": { - "description": "Returns the Limitation of the Role assignment.", - "$ref": "#/components/schemas/Limitation" - } - } - }, - "RoleAssignInputWrapper": { - "type": "object", - "required": [ - "RoleAssignInput" + "name", + "global", + "filter", + "limit", + "minCount" ], "properties": { - "RoleAssignInput": { - "$ref": "#/components/schemas/RoleAssignInput" - } - } - }, - "RoleAssignmentList": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "name": { + "description": "The name of the facet.", + "type": "string" }, - { - "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" - } - } - } + "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" } - ] + } }, - "RoleAssignmentListWrapper": { + "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": [ - "RoleAssignmentList" + "operator", + "valueFormat", + "valueTypes", + "valueCount" ], "properties": { - "RoleAssignmentList": { - "$ref": "#/components/schemas/RoleAssignmentList" + "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" } } }, - "Session": { + "Role": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "Value for session.", + "description": "This class represents a role.", "type": "object", "required": [ - "name", "identifier", - "csrfToken", - "User" + "Policies" ], "properties": { - "name": { - "description": "Name.", - "type": "string" - }, "identifier": { - "description": "Identifier.", - "type": "string" - }, - "csrfToken": { - "description": "csrfToken.", + "description": "Readable string identifier of a role.", "type": "string" }, - "User": { - "description": "User.", + "Policies": { + "description": "Returns the list of policies of this role.", "$ref": "#/components/schemas/BaseObject" } } } ] }, - "SessionWrapper": { + "RoleWrapper": { "type": "object", "required": [ - "Session" + "Role" ], "properties": { - "Session": { - "$ref": "#/components/schemas/Session" + "Role": { + "$ref": "#/components/schemas/Role" } } }, - "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" - } - } - } - ] + "RoleDraft": { + "description": "This class represents a draft of a role, extends Role.", + "$ref": "#/components/schemas/Role" }, - "SessionInputWrapper": { + "RoleDraftWrapper": { "type": "object", "required": [ - "SessionInput" + "Role" ], "properties": { - "SessionInput": { - "$ref": "#/components/schemas/SessionInput" + "Role": { + "$ref": "#/components/schemas/RoleDraft" } } }, - "JWT": { - "description": "This class represents the JWT authentication token", + "RoleInput": { + "description": "This class represents a Role input.", "type": "object", "required": [ - "token" + "identifier" ], "properties": { - "token": { - "description": "JWT authentication token", + "identifier": { "type": "string" } } }, - "JWTWrapper": { + "RoleInputWrapper": { "type": "object", "required": [ - "JWT" + "RoleInput" ], "properties": { - "JWT": { - "$ref": "#/components/schemas/JWT" + "RoleInput": { + "$ref": "#/components/schemas/RoleInput" } } }, - "JWTInput": { + "RoleList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class represents the input for a JWT authentication token", + "description": "This class represents a list roles.", "type": "object", "required": [ - "username", - "password" + "Role" ], "properties": { - "username": { - "description": "User name", - "type": "string" - }, - "password": { - "description": "User password", - "type": "string" + "Role": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Role" + } } } } ] }, - "JWTInputWrapper": { + "RoleListWrapper": { "type": "object", "required": [ - "JWTInput" + "RoleList" ], "properties": { - "JWTInput": { - "$ref": "#/components/schemas/JWTInput" + "RoleList": { + "$ref": "#/components/schemas/RoleList" } } }, - "UserGroup": { + "Policy": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "Content ID matcher class.", + "description": "This class represents a policy value.", "type": "object", "required": [ - "_remoteId", - "_id", - "ContentType", - "name", - "Versions", - "Section", - "MainLocation", - "Locations", - "Owner", - "lastModificationDate", - "mainLanguageCode", - "alwaysAvailable", - "Version", - "ParentUserGroup", - "Subgroups", - "Users", - "Roles" + "id", + "module", + "function" ], "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": "ID of the policy.", "type": "integer" }, - "ContentType": { - "description": "Content type.", - "$ref": "#/components/schemas/Ref" - }, - "name": { + "module": { + "description": "Name of module, associated with the Policy e.g. content.", "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.", + "function": { + "description": "Name of the module function Or all functions with '*' e.g. read.", "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" + "limitations": { + "description": "Limitations.", + "type": "object", + "required": [ + "limitation" + ], + "properties": { + "limitation": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Limitation" + } + } + } } } } ] }, - "UserGroupWrapper": { + "PolicyWrapper": { "type": "object", "required": [ - "UserGroup" + "Policy" ], "properties": { - "UserGroup": { - "$ref": "#/components/schemas/UserGroup" + "Policy": { + "$ref": "#/components/schemas/Policy" } } }, - "UserGroupList": { - "description": "This class represents a User Group list.", - "$ref": "#/components/schemas/BaseObject" - }, - "UserGroupListWrapper": { + "Limitation": { + "description": "This class represents a Limitation applied to a policy.", "type": "object", "required": [ - "UserGroupList" + "_identifier", + "values" ], "properties": { - "UserGroupList": { - "$ref": "#/components/schemas/UserGroupList" - } - } - }, - "UserGroupRefList": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "_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" }, - { - "description": "Returns a list of the sub groups.", + "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": [ - "UserGroup" + "$ref" ], "properties": { - "UserGroup": { - "description": "This class represents a User group.", + "ref": { "type": "array", "items": { "$ref": "#/components/schemas/Ref" @@ -47519,1351 +39388,1229 @@ } } } - ] - }, - "UserGroupRefListWrapper": { - "type": "object", - "required": [ - "UserGroupRefList" - ], - "properties": { - "UserGroupRefList": { - "$ref": "#/components/schemas/UserGroupRefList" - } - } - }, - "UserGroupCreate": { - "description": "This class is used to create a User Group.", - "type": "object", - "required": [ - "mainLanguageCode", - "remoteId", - "fields" - ], - "properties": { - "mainLanguageCode": { - "type": "string" - }, - "remoteId": { - "type": "string" - }, - "fields": { - "$ref": "#/components/schemas/Fields" - } - } - }, - "UserGroupCreateWrapper": { - "type": "object", - "required": [ - "UserGroupCreate" - ], - "properties": { - "UserGroupCreate": { - "$ref": "#/components/schemas/UserGroupCreate" - } - } - }, - "UserGroupUpdate": { - "description": "This class is used to update a User group in the Repository.", - "type": "object", - "required": [ - "Section" - ], - "properties": { - "Section": { - "type": "object", - "required": [ - "_href" - ], - "properties": { - "_href": { - "xml": { - "attribute": true, - "name": "href" - }, - "type": "string" - } - } - } - } - }, - "UserGroupUpdateWrapper": { - "type": "object", - "required": [ - "UserGroupUpdate" - ], - "properties": { - "UserGroupUpdate": { - "$ref": "#/components/schemas/UserGroupUpdate" - } } }, - "UserGroupUnassign": { + "PolicyList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class represents a User group.", + "description": "List of policies.", "type": "object", "required": [ - "Unassign" + "Policy" ], "properties": { - "Unassign": { - "$ref": "#/components/schemas/Unlink" + "Policy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Policy" + } } } } ] }, - "Unlink": { - "description": "Unlink a content type group from a content type.", - "type": "object", - "required": [ - "_href", - "_method" - ], - "properties": { - "_href": { - "type": "string" - }, - "_method": { - "enum": [ - "DELETE" - ], - "type": "string" - } - } - }, - "User": { - "type": "object", - "description": "Reference to a registered user account", - "properties": { - "_media-type": { - "type": "string", - "description": "Media type identifier for the user reference" - }, - "_href": { - "type": "string", - "description": "REST API URL reference to the user resource", - "format": "uri" - } - }, - "required": [ - "_media-type", - "_href" - ], - "additionalProperties": false - }, - "UserWrapper": { + "PolicyListWrapper": { "type": "object", "required": [ - "User" + "PolicyList" ], "properties": { - "User": { - "$ref": "#/components/schemas/User" + "PolicyList": { + "$ref": "#/components/schemas/PolicyList" } } }, - "UserList": { + "PolicyCreate": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class represents a list of users.", + "description": "This class is used to create a Policy.", "type": "object", "required": [ - "User" + "module", + "function", + "Limitations" ], "properties": { - "User": { + "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/User" + "$ref": "#/components/schemas/Limitation" } } } } ] }, - "UserListWrapper": { + "PolicyCreateWrapper": { "type": "object", "required": [ - "UserList" + "PolicyCreate" ], "properties": { - "UserList": { - "$ref": "#/components/schemas/UserList" + "PolicyCreate": { + "$ref": "#/components/schemas/PolicyCreate" } } }, - "UserRefList": { + "PolicyUpdate": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "Returns a list of the users.", + "description": "This class is used to update a Policy.", "type": "object", "required": [ - "User" + "Limitations" ], "properties": { - "User": { - "description": "This class represents a User.", + "Limitations": { "type": "array", "items": { - "$ref": "#/components/schemas/BaseObject" + "$ref": "#/components/schemas/Limitation" } } } } ] }, - "UserRefListWrapper": { + "PolicyUpdateWrapper": { "type": "object", "required": [ - "UserRefList" + "PolicyUpdate" ], "properties": { - "UserRefList": { - "$ref": "#/components/schemas/UserRefList" + "PolicyUpdate": { + "$ref": "#/components/schemas/PolicyUpdate" } } }, - "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." + "RoleAssignment": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "ContentMetadataUpdate": { - "description": "The update structure for the profile metadata." + { + "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" + } + } } - } + ] }, - "UserUpdateWrapper": { + "RoleAssignmentWrapper": { "type": "object", "required": [ - "UserUpdate" + "RoleAssignment" ], "properties": { - "UserUpdate": { - "$ref": "#/components/schemas/UserUpdate" + "RoleAssignment": { + "$ref": "#/components/schemas/RoleAssignment" } } }, - "UserCreate": { - "description": "This class is used to create a User.", + "RoleAssignInput": { + "description": "This class represents a Role assign input.", "type": "object", "required": [ - "mainLanguageCode", - "remoteId", - "login", - "email", - "password" + "Role", + "limitation" ], "properties": { - "mainLanguageCode": { - "type": "string" - }, - "remoteId": { - "type": "string" - }, - "login": { - "type": "string" - }, - "email": { - "type": "string" - }, - "password": { - "type": "string" + "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" } } }, - "UserCreateWrapper": { + "RoleAssignInputWrapper": { "type": "object", "required": [ - "UserCreate" + "RoleAssignInput" ], "properties": { - "UserCreate": { - "$ref": "#/components/schemas/UserCreate" + "RoleAssignInput": { + "$ref": "#/components/schemas/RoleAssignInput" } } }, - "Event": { + "RoleAssignmentList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "Calendar event.", + "description": "This value object represents a list of assignments of a User or User group to a role including a limitation.", "type": "object", "required": [ - "id", - "datetime", - "type", - "name", - "attributes" + "RoleAssignment" ], "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.", + "RoleAssignment": { "type": "array", "items": { - "$ref": "#/components/schemas/EventAttribute" + "$ref": "#/components/schemas/RoleAssignment" } } } } ] }, - "EventAttribute": { + "RoleAssignmentListWrapper": { "type": "object", "required": [ - "label", - "value" + "RoleAssignmentList" ], "properties": { - "label": { - "description": "Label of the attribute.", - "type": "string" - }, - "value": { - "description": "Value of the attribute.", - "type": "string" + "RoleAssignmentList": { + "$ref": "#/components/schemas/RoleAssignmentList" } } }, - "EventList": { + "Session": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "List of calendar events.", + "description": "Value for session.", "type": "object", "required": [ - "_currentPage", - "totalCount", - "events" + "name", + "identifier", + "csrfToken", + "User" ], "properties": { - "_currentPage": { - "description": "Current page representation.", - "xml": { - "attribute": true, - "name": "currentPage" - }, + "name": { + "description": "Name.", "type": "string" }, - "nextPage": { - "description": "Next page representation.", + "identifier": { + "description": "Identifier.", "type": "string" }, - "totalCount": { - "description": "Total count of events.", - "type": "integer" + "csrfToken": { + "description": "csrfToken.", + "type": "string" }, - "events": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Event" - } + "User": { + "description": "User.", + "$ref": "#/components/schemas/BaseObject" } } } ] }, - "EventListWrapper": { + "SessionWrapper": { "type": "object", "required": [ - "EventList" + "Session" ], "properties": { - "EventList": { - "$ref": "#/components/schemas/EventList" + "Session": { + "$ref": "#/components/schemas/Session" } } }, - "EventGroup": { + "SessionInput": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "Event group.", + "description": "This class represents a session input.", "type": "object", "required": [ - "_currentPage", - "totalCount", - "events" + "login", + "password" ], "properties": { - "_currentPage": { - "description": "Current page representation.", - "xml": { - "attribute": true, - "name": "currentPage" - }, + "login": { "type": "string" }, - "nextPage": { - "description": "Next page representation.", + "password": { "type": "string" - }, - "groupKey": { - "$ref": "#/components/schemas/DateRange" - }, - "totalCount": { - "description": "Total count of events.", - "type": "integer" - }, - "events": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Event" - } - } - } - } - ] - }, - "EventGroupList": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - }, - { - "description": "Grouped calendar event list.", - "type": "object", - "required": [ - "groups" - ], - "properties": { - "groups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EventGroup" - } } } } ] }, - "EventGroupListWrapper": { - "type": "object", - "required": [ - "EventGroupList" - ], - "properties": { - "EventGroupList": { - "$ref": "#/components/schemas/EventGroupList" - } - } - }, - "RescheduleAction": { - "description": "This class represents events to reschedule", - "type": "object", - "required": [ - "events", - "dateTime" - ], - "properties": { - "events": { - "description": "list of events", - "type": "array", - "items": { - "type": "string" - } - }, - "dateTime": { - "description": "timestamp to reschedule events to", - "type": "integer" - } - } - }, - "RescheduleActionWrapper": { + "SessionInputWrapper": { "type": "object", "required": [ - "RescheduleAction" + "SessionInput" ], "properties": { - "RescheduleAction": { - "$ref": "#/components/schemas/RescheduleAction" + "SessionInput": { + "$ref": "#/components/schemas/SessionInput" } } }, - "UnscheduleAction": { - "description": "This class represents events to unschedule", + "JWT": { + "description": "This class represents the JWT authentication token", "type": "object", "required": [ - "events" + "token" ], "properties": { - "events": { - "description": "list of events", - "type": "array", - "items": { - "type": "string" - } + "token": { + "description": "JWT authentication token", + "type": "string" } } }, - "UnscheduleActionWrapper": { + "JWTWrapper": { "type": "object", "required": [ - "UnscheduleAction" + "JWT" ], "properties": { - "UnscheduleAction": { - "$ref": "#/components/schemas/UnscheduleAction" + "JWT": { + "$ref": "#/components/schemas/JWT" } } }, - "AttributeGroup": { - "description": "This class represents an attribute group.", - "type": "object", - "required": [ - "name", - "identifier", - "position" - ], - "properties": { - "name": { - "type": "string" - }, - "identifier": { - "type": "string" + "JWTInput": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "position": { - "type": "integer" + { + "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" + } + } } - } + ] }, - "AttributeGroupWrapper": { + "JWTInputWrapper": { "type": "object", "required": [ - "AttributeGroup" + "JWTInput" ], "properties": { - "AttributeGroup": { - "$ref": "#/components/schemas/AttributeGroup" + "JWTInput": { + "$ref": "#/components/schemas/JWTInput" } } }, - "AttributeGroupCreate": { - "description": "This class is used to create an attribute group.", - "type": "object", - "required": [ - "identifier", - "names", - "position" - ], - "properties": { - "identifier": { - "type": "string" - }, - "names": { - "type": "object" + "UserGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "position": { - "type": "integer" - } - } - }, - "AttributeGroupCreateWrapper": { - "type": "object", - "required": [ - "AttributeGroupCreate" - ], - "properties": { - "AttributeGroupCreate": { - "$ref": "#/components/schemas/AttributeGroupCreate" + { + "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" + } + } } - } + ] }, - "AttributeGroupUpdate": { - "description": "This class is used to update an attribute group.", + "UserGroupWrapper": { "type": "object", "required": [ - "identifier", - "names", - "position" + "UserGroup" ], "properties": { - "identifier": { - "type": "string" - }, - "names": { - "type": "object" - }, - "position": { - "type": "integer" + "UserGroup": { + "$ref": "#/components/schemas/UserGroup" } } }, - "AttributeGroupUpdateWrapper": { + "UserGroupList": { + "description": "This class represents a User Group list.", + "$ref": "#/components/schemas/BaseObject" + }, + "UserGroupListWrapper": { "type": "object", "required": [ - "AttributeGroupUpdate" + "UserGroupList" ], "properties": { - "AttributeGroupUpdate": { - "$ref": "#/components/schemas/AttributeGroupUpdate" + "UserGroupList": { + "$ref": "#/components/schemas/UserGroupList" } } }, - "AttributeGroupList": { + "UserGroupRefList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class represents an attribute group list.", + "description": "Returns a list of the sub groups.", "type": "object", "required": [ - "AttributeGroup" + "UserGroup" ], "properties": { - "AttributeGroup": { + "UserGroup": { + "description": "This class represents a User group.", "type": "array", "items": { - "$ref": "#/components/schemas/AttributeGroup" + "$ref": "#/components/schemas/Ref" } } } } ] }, - "AttributeGroupListWrapper": { + "UserGroupRefListWrapper": { "type": "object", "required": [ - "AttributeGroupList" + "UserGroupRefList" ], "properties": { - "AttributeGroupList": { - "$ref": "#/components/schemas/AttributeGroupList" + "UserGroupRefList": { + "$ref": "#/components/schemas/UserGroupRefList" } } }, - "AttributeGroupListGet": { - "description": "This class represents an attribute group list request.", + "UserGroupCreate": { + "description": "This class is used to create a User Group.", "type": "object", "required": [ - "prefix", - "offset", - "limit" + "mainLanguageCode", + "remoteId", + "fields" ], "properties": { - "prefix": { + "mainLanguageCode": { "type": "string" }, - "offset": { - "type": "integer" + "remoteId": { + "type": "string" }, - "limit": { - "type": "integer" + "fields": { + "$ref": "#/components/schemas/Fields" } } }, - "AttributeGroupListGetWrapper": { + "UserGroupCreateWrapper": { "type": "object", "required": [ - "AttributeGroupListGet" + "UserGroupCreate" ], "properties": { - "AttributeGroupListGet": { - "$ref": "#/components/schemas/AttributeGroupListGet" + "UserGroupCreate": { + "$ref": "#/components/schemas/UserGroupCreate" } } }, - "AttributeGroupGet": { - "description": "This class represents an attribute group query.", + "UserGroupUpdate": { + "description": "This class is used to update a User group in the Repository.", "type": "object", "required": [ - "languages" + "Section" ], "properties": { - "languages": { - "type": "array", - "items": { - "type": "string" + "Section": { + "type": "object", + "required": [ + "_href" + ], + "properties": { + "_href": { + "xml": { + "attribute": true, + "name": "href" + }, + "type": "string" + } } } } }, - "AttributeGroupGetWrapper": { + "UserGroupUpdateWrapper": { "type": "object", "required": [ - "AttributeGroupGet" + "UserGroupUpdate" ], "properties": { - "AttributeGroupGet": { - "$ref": "#/components/schemas/AttributeGroupGet" + "UserGroupUpdate": { + "$ref": "#/components/schemas/UserGroupUpdate" } } }, - "AttributeGroupListResult": { + "UserGroupUnassign": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { + "description": "This class represents a User group.", "type": "object", "required": [ - "count", - "AttributeGroupList" + "Unassign" ], "properties": { - "count": { - "type": "integer" - }, - "AttributeGroupList": { - "$ref": "#/components/schemas/AttributeGroupList" + "Unassign": { + "$ref": "#/components/schemas/Unlink" } } } ] }, - "AttributeGroupView": { + "Unlink": { + "description": "Unlink a content type group from a content type.", + "type": "object", + "required": [ + "_href", + "_method" + ], + "properties": { + "_href": { + "type": "string" + }, + "_method": { + "enum": [ + "DELETE" + ], + "type": "string" + } + } + }, + "User": { + "type": "object", + "description": "Reference to a registered user account", + "properties": { + "_media-type": { + "type": "string", + "description": "Media type identifier for the user reference" + }, + "_href": { + "type": "string", + "description": "REST API URL reference to the user resource", + "format": "uri" + } + }, + "required": [ + "_media-type", + "_href" + ], + "additionalProperties": false + }, + "UserWrapper": { + "type": "object", + "required": [ + "User" + ], + "properties": { + "User": { + "$ref": "#/components/schemas/User" + } + } + }, + "UserList": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class represents an attribute group view.", + "description": "This class represents a list of users.", "type": "object", "required": [ - "identifier", - "Result" + "User" ], "properties": { - "identifier": { - "type": "string" - }, - "Result": { - "$ref": "#/components/schemas/AttributeGroupListResult" + "User": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } } } } ] }, - "AttributeGroupViewWrapper": { + "UserListWrapper": { "type": "object", "required": [ - "AttributeGroupView" + "UserList" ], "properties": { - "AttributeGroupView": { - "$ref": "#/components/schemas/AttributeGroupView" + "UserList": { + "$ref": "#/components/schemas/UserList" } } }, - "AttributeGroupViewInput": { - "description": "This class represents an attribute group view input.", - "xml": { - "name": "ViewInput" - }, - "type": "object", - "required": [ - "identifier", - "AttributeGroupQuery" - ], - "properties": { - "identifier": { - "type": "string" + "UserRefList": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "AttributeGroupQuery": { + { + "description": "Returns a list of the users.", "type": "object", "required": [ - "limit", - "offset", - "name_prefix" + "User" ], "properties": { - "limit": { - "type": "string" - }, - "offset": { - "type": "string" - }, - "name_prefix": { - "type": "string" + "User": { + "description": "This class represents a User.", + "type": "array", + "items": { + "$ref": "#/components/schemas/BaseObject" + } } } } - } + ] }, - "AttributeGroupViewInputWrapper": { + "UserRefListWrapper": { "type": "object", "required": [ - "ViewInput" + "UserRefList" ], "properties": { - "ViewInput": { - "$ref": "#/components/schemas/AttributeGroupViewInput" + "UserRefList": { + "$ref": "#/components/schemas/UserRefList" } } }, - "AttributeType": { - "description": "This class represents an attribute type.", + "UserUpdate": { + "description": "This class is used to update a User.", "type": "object", "required": [ - "identifier", - "name" + "login" ], "properties": { - "identifier": { + "login": { "type": "string" }, - "name": { + "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." } } }, - "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": { + "UserUpdateWrapper": { "type": "object", "required": [ - "AttributeTypeList" + "UserUpdate" ], "properties": { - "AttributeTypeList": { - "$ref": "#/components/schemas/AttributeTypeList" + "UserUpdate": { + "$ref": "#/components/schemas/UserUpdate" } } }, - "CartList": { - "type": "object" - }, - "Attribute": { - "description": "This class represents an attribute.", + "UserCreate": { + "description": "This class is used to create a User.", "type": "object", "required": [ - "name", - "identifier", - "description", - "type", - "type_identifier", - "value", - "group", - "position", - "options" + "mainLanguageCode", + "remoteId", + "login", + "email", + "password" ], "properties": { - "name": { - "type": "string" - }, - "identifier": { + "mainLanguageCode": { "type": "string" }, - "description": { + "remoteId": { "type": "string" }, - "type": { + "login": { "type": "string" }, - "type_identifier": { + "email": { "type": "string" }, - "value": { - "type": [] - }, - "group": { + "password": { "type": "string" }, - "position": { - "type": "integer" - }, - "options": { - "type": [ - "object", - "array" - ] + "enabled": { + "type": "boolean" } } }, - "AttributeWrapper": { + "UserCreateWrapper": { "type": "object", "required": [ - "Attribute" + "UserCreate" ], "properties": { - "Attribute": { - "$ref": "#/components/schemas/Attribute" + "UserCreate": { + "$ref": "#/components/schemas/UserCreate" } } }, - "AttributeCreate": { - "description": "This class is used to create an attribute.", + "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": [ - "identifier", - "type", - "group", - "names", - "descriptions", - "position", - "options" + "label", + "value" ], "properties": { - "identifier": { - "type": "string" - }, - "type": { + "label": { + "description": "Label of the attribute.", "type": "string" }, - "group": { + "value": { + "description": "Value of the attribute.", "type": "string" - }, - "names": { - "type": "object" - }, - "descriptions": { - "type": "object" - }, - "position": { - "type": "integer" - }, - "options": { - "type": [ - "object", - "array" - ] } } }, - "AttributeCreateWrapper": { + "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": [ - "AttributeCreate" + "EventList" ], "properties": { - "AttributeCreate": { - "$ref": "#/components/schemas/AttributeCreate" + "EventList": { + "$ref": "#/components/schemas/EventList" } } }, - "AttributeUpdate": { - "description": "This class is used to update an attribute.", - "type": "object", - "required": [ - "identifier", - "names", - "descriptions", - "position", - "options" - ], - "properties": { - "identifier": { - "type": "string" - }, - "names": { - "type": "object" - }, - "descriptions": { - "type": "object" - }, - "position": { - "type": "integer" + "EventGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + }, + { + "description": "Event group.", + "type": "object", + "required": [ + "_currentPage", + "totalCount", + "events" + ], + "properties": { + "_currentPage": { + "description": "Current page representation.", + "xml": { + "attribute": true, + "name": "currentPage" + }, + "type": "string" + }, + "nextPage": { + "description": "Next page representation.", + "type": "string" + }, + "groupKey": { + "$ref": "#/components/schemas/DateRange" + }, + "totalCount": { + "description": "Total count of events.", + "type": "integer" + }, + "events": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Event" + } + } + } + } + ] + }, + "EventGroupList": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "options": { - "type": "object" + { + "description": "Grouped calendar event list.", + "type": "object", + "required": [ + "groups" + ], + "properties": { + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EventGroup" + } + } + } } - } + ] }, - "AttributeUpdateWrapper": { + "EventGroupListWrapper": { "type": "object", "required": [ - "AttributeUpdate" + "EventGroupList" ], "properties": { - "AttributeUpdate": { - "$ref": "#/components/schemas/AttributeUpdate" + "EventGroupList": { + "$ref": "#/components/schemas/EventGroupList" } } }, - "AttributeListGet": { - "description": "This class represents an attribute list query", + "RescheduleAction": { + "description": "This class represents events to reschedule", "type": "object", + "required": [ + "events", + "dateTime" + ], "properties": { - "group_name_prefix": { - "type": "string" - }, - "name_prefix": { - "type": "string" - }, - "offset": { - "type": "integer" + "events": { + "description": "list of events", + "type": "array", + "items": { + "type": "string" + } }, - "limit": { + "dateTime": { + "description": "timestamp to reschedule events to", "type": "integer" } } }, - "AttributeListGetWrapper": { + "RescheduleActionWrapper": { "type": "object", "required": [ - "AttributeListGet" + "RescheduleAction" ], "properties": { - "AttributeListGet": { - "$ref": "#/components/schemas/AttributeListGet" + "RescheduleAction": { + "$ref": "#/components/schemas/RescheduleAction" } } }, - "AttributeList": { - "description": "This class represents an attribute list.", + "UnscheduleAction": { + "description": "This class represents events to unschedule", "type": "object", "required": [ - "Attribute" + "events" ], "properties": { - "Attribute": { + "events": { + "description": "list of events", "type": "array", "items": { - "$ref": "#/components/schemas/Attribute" + "type": "string" } } } }, - "AttributeListWrapper": { + "UnscheduleActionWrapper": { "type": "object", "required": [ - "AttributeList" + "UnscheduleAction" ], "properties": { - "AttributeList": { - "$ref": "#/components/schemas/AttributeList" + "UnscheduleAction": { + "$ref": "#/components/schemas/UnscheduleAction" } } }, - "AttributeView": { - "description": "This class represents an attribute view.", + "AttributeGroup": { + "description": "This class represents an attribute group.", "type": "object", "required": [ + "name", "identifier", - "AttributeQuery", - "Result" + "position" ], "properties": { - "identifier": { + "name": { "type": "string" }, - "AttributeQuery": { - "type": "object" - }, - "Result": { - "type": "object" - } - } - }, - "AttributeViewWrapper": { - "type": "object", - "required": [ - "AttributeView" - ], - "properties": { - "AttributeView": { - "$ref": "#/components/schemas/AttributeView" - } - } - }, - "AttributeViewInput": { - "description": "This class represents an attribute view input.", - "xml": { - "name": "ViewInput" - }, - "type": "object", - "required": [ - "identifier", - "AttributeQuery" - ], - "properties": { "identifier": { "type": "string" }, - "AttributeQuery": { - "type": "object" - } - } - }, - "AttributeViewInputWrapper": { - "type": "object", - "required": [ - "ViewInput" - ], - "properties": { - "ViewInput": { - "$ref": "#/components/schemas/AttributeViewInput" + "position": { + "type": "integer" } } }, - "AttributeAssignment": { + "AttributeGroupWrapper": { "type": "object", "required": [ - "is_required", - "is_discriminator", - "Attribute" + "AttributeGroup" ], "properties": { - "is_required": { - "type": "boolean" - }, - "is_discriminator": { - "type": "boolean" - }, - "Attribute": { - "$ref": "#/components/schemas/Attribute" + "AttributeGroup": { + "$ref": "#/components/schemas/AttributeGroup" } } }, - "Catalog": { - "description": "This class represents a catalog.", + "AttributeGroupCreate": { + "description": "This class is used to create an attribute group.", "type": "object", "required": [ "identifier", - "name", - "description", - "created", - "modified", - "status", - "User", - "Criteria" + "names", + "position" ], "properties": { "identifier": { "type": "string" }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "created": { - "type": "integer" + "names": { + "type": "object" }, - "modified": { + "position": { "type": "integer" - }, - "status": { - "type": "string" - }, - "User": { - "$ref": "#/components/schemas/Ref" - }, - "Criteria": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Criterion" - } } } }, - "CatalogWrapper": { + "AttributeGroupCreateWrapper": { "type": "object", "required": [ - "Catalog" + "AttributeGroupCreate" ], "properties": { - "Catalog": { - "$ref": "#/components/schemas/Catalog" + "AttributeGroupCreate": { + "$ref": "#/components/schemas/AttributeGroupCreate" } } }, - "CatalogCreate": { - "description": "This class is used to create a catalog.", + "AttributeGroupUpdate": { + "description": "This class is used to update an attribute group.", "type": "object", "required": [ "identifier", - "criteria", "names", - "status" + "position" ], "properties": { "identifier": { "type": "string" }, - "criteria": { - "$ref": "#/components/schemas/Criterion" - }, "names": { "type": "object" }, - "descriptions": { - "type": "object" - }, - "status": { - "type": "string" - }, - "creator_id": { + "position": { "type": "integer" } } }, - "CatalogCreateWrapper": { + "AttributeGroupUpdateWrapper": { "type": "object", "required": [ - "CatalogCreate" + "AttributeGroupUpdate" ], "properties": { - "CatalogCreate": { - "$ref": "#/components/schemas/CatalogCreate" + "AttributeGroupUpdate": { + "$ref": "#/components/schemas/AttributeGroupUpdate" } } }, - "CatalogUpdate": { - "description": "This class is used to update a catalog.", - "type": "object", - "required": [ - "identifier", - "transition", - "criteria", - "names", - "descriptions" - ], - "properties": { - "identifier": { - "type": "string" - }, - "transition": { - "type": "string" - }, - "criteria": { - "$ref": "#/components/schemas/Criterion" - }, - "names": { - "type": "object" + "AttributeGroupList": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "descriptions": { - "type": "object" + { + "description": "This class represents an attribute group list.", + "type": "object", + "required": [ + "AttributeGroup" + ], + "properties": { + "AttributeGroup": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttributeGroup" + } + } + } } - } + ] }, - "CatalogUpdateWrapper": { + "AttributeGroupListWrapper": { "type": "object", "required": [ - "CatalogUpdate" + "AttributeGroupList" ], "properties": { - "CatalogUpdate": { - "$ref": "#/components/schemas/CatalogUpdate" + "AttributeGroupList": { + "$ref": "#/components/schemas/AttributeGroupList" } } }, - "CatalogCopy": { - "description": "This class is used to copy a catalog.", + "AttributeGroupListGet": { + "description": "This class represents an attribute group list request.", "type": "object", "required": [ - "identifier", - "creator_id" + "prefix", + "offset", + "limit" ], "properties": { - "identifier": { + "prefix": { "type": "string" }, - "creator_id": { - "description": "Optional", + "offset": { + "type": "integer" + }, + "limit": { "type": "integer" } } }, - "CatalogCopyWrapper": { + "AttributeGroupListGetWrapper": { "type": "object", "required": [ - "CatalogCopy" + "AttributeGroupListGet" ], "properties": { - "CatalogCopy": { - "$ref": "#/components/schemas/CatalogCopy" + "AttributeGroupListGet": { + "$ref": "#/components/schemas/AttributeGroupListGet" } } }, - "CatalogList": { - "description": "This class represents a catalog list.", + "AttributeGroupGet": { + "description": "This class represents an attribute group query.", "type": "object", "required": [ - "Catalog" + "languages" ], "properties": { - "Catalog": { + "languages": { "type": "array", "items": { - "$ref": "#/components/schemas/Catalog" + "type": "string" } } } }, - "CatalogListViewResult": { + "AttributeGroupGetWrapper": { + "type": "object", + "required": [ + "AttributeGroupGet" + ], + "properties": { + "AttributeGroupGet": { + "$ref": "#/components/schemas/AttributeGroupGet" + } + } + }, + "AttributeGroupListResult": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" @@ -48871,277 +40618,171 @@ { "type": "object", "required": [ - "CatalogList" + "count", + "AttributeGroupList" ], "properties": { - "CatalogList": { - "$ref": "#/components/schemas/CatalogList" + "count": { + "type": "integer" + }, + "AttributeGroupList": { + "$ref": "#/components/schemas/AttributeGroupList" } } } ] }, - "CatalogView": { + "AttributeGroupView": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { + "description": "This class represents an attribute group view.", "type": "object", "required": [ "identifier", - "CatalogQuery", "Result" ], "properties": { "identifier": { "type": "string" }, - "CatalogQuery": { - "$ref": "#/components/schemas/Ref" - }, "Result": { - "$ref": "#/components/schemas/CatalogListViewResult" + "$ref": "#/components/schemas/AttributeGroupListResult" } } } ] }, - "CatalogViewWrapper": { + "AttributeGroupViewWrapper": { "type": "object", "required": [ - "CatalogView" + "AttributeGroupView" ], "properties": { - "CatalogView": { - "$ref": "#/components/schemas/CatalogView" + "AttributeGroupView": { + "$ref": "#/components/schemas/AttributeGroupView" } } }, - "CatalogViewInput": { - "description": "This class represents a catalog view input.", + "AttributeGroupViewInput": { + "description": "This class represents an attribute group view input.", "xml": { "name": "ViewInput" }, "type": "object", - "required": [ - "CatalogQuery" - ], - "properties": { - "CatalogQuery": { - "type": "object" - } - } - }, - "CatalogViewInputWrapper": { - "type": "object", - "required": [ - "ViewInput" - ], - "properties": { - "ViewInput": { - "$ref": "#/components/schemas/CatalogViewInput" - } - } - }, - "Currency": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - }, - { - "description": "This class represents currency.", - "type": "object", - "required": [ - "id", - "code", - "subunits", - "enabled" - ], - "properties": { - "id": { - "type": "integer" - }, - "code": { - "type": "string" - }, - "subunits": { - "type": "integer" - }, - "enabled": { - "type": "boolean" - } - } - } - ] - }, - "CurrencyWrapper": { - "type": "object", - "required": [ - "Currency" - ], - "properties": { - "Currency": { - "$ref": "#/components/schemas/Currency" - } - } - }, - "CurrencyCreate": { - "description": "This class is used to create currency.", - "type": "object", - "required": [ - "code", - "subunits", - "enabled" - ], - "properties": { - "code": { - "type": "string" - }, - "subunits": { - "type": "integer" - }, - "enabled": { - "type": "boolean" - } - } - }, - "CurrencyCreateWrapper": { - "type": "object", - "required": [ - "CurrencyCreate" - ], - "properties": { - "CurrencyCreate": { - "$ref": "#/components/schemas/CurrencyCreate" - } - } - }, - "CurrencyUpdate": { - "description": "This class is used to update currency.", - "type": "object", - "required": [ - "subunits", - "enabled" - ], - "properties": { - "subunits": { - "type": "integer" - }, - "enabled": { - "type": "boolean" - } - } - }, - "CurrencyUpdateWrapper": { - "type": "object", - "required": [ - "CurrencyUpdate" - ], - "properties": { - "CurrencyUpdate": { - "$ref": "#/components/schemas/CurrencyUpdate" - } - } - }, - "CurrencyView": { - "description": "This class represents a currency view.", - "type": "object", "required": [ "identifier", - "CurrencyQuery", - "Result" + "AttributeGroupQuery" ], "properties": { "identifier": { "type": "string" }, - "CurrencyQuery": { - "type": "object" - }, - "Result": { - "type": "object" + "AttributeGroupQuery": { + "type": "object", + "required": [ + "limit", + "offset", + "name_prefix" + ], + "properties": { + "limit": { + "type": "string" + }, + "offset": { + "type": "string" + }, + "name_prefix": { + "type": "string" + } + } } } }, - "CurrencyViewWrapper": { + "AttributeGroupViewInputWrapper": { "type": "object", "required": [ - "CurrencyView" + "ViewInput" ], "properties": { - "CurrencyView": { - "$ref": "#/components/schemas/CurrencyView" + "ViewInput": { + "$ref": "#/components/schemas/AttributeGroupViewInput" } } }, - "CurrencyViewInput": { - "description": "This class represents a currency view input.", - "xml": { - "name": "ViewInput" - }, + "AttributeType": { + "description": "This class represents an attribute type.", "type": "object", "required": [ - "CurrencyQuery" + "identifier", + "name" ], "properties": { - "CurrencyQuery": { - "type": "object" + "identifier": { + "type": "string" + }, + "name": { + "type": "string" } } }, - "CurrencyViewInputWrapper": { + "AttributeTypeWrapper": { "type": "object", "required": [ - "ViewInput" + "AttributeType" ], "properties": { - "ViewInput": { - "$ref": "#/components/schemas/CurrencyViewInput" + "AttributeType": { + "$ref": "#/components/schemas/AttributeType" } } }, - "CurrencyList": { - "description": "This class represents a currency list.", + "AttributeTypeList": { + "description": "This class represents an attribute type list.", "type": "object", "required": [ - "Currency" + "attributeTypes" ], "properties": { - "Currency": { + "attributeTypes": { "type": "array", "items": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/AttributeType" } } } }, - "CurrencyListWrapper": { + "AttributeTypeListWrapper": { "type": "object", "required": [ - "CurrencyList" + "AttributeTypeList" ], "properties": { - "CurrencyList": { - "$ref": "#/components/schemas/CurrencyList" + "AttributeTypeList": { + "$ref": "#/components/schemas/AttributeTypeList" } } }, - "CustomerGroup": { - "description": "This class represents a customer group.", + "CartList": { + "type": "object" + }, + "Attribute": { + "description": "This class represents an attribute.", "type": "object", "required": [ - "id", "name", "identifier", "description", - "users", - "global_price_rate" + "type", + "type_identifier", + "value", + "group", + "position", + "options" ], "properties": { - "id": { - "type": "integer" - }, "name": { "type": "string" }, @@ -49151,284 +40792,197 @@ "description": { "type": "string" }, - "users": { - "description": "A list of users attached to the customer group.", - "type": "array", - "items": { - "$ref": "#/components/schemas/User" - } + "type": { + "type": "string" }, - "global_price_rate": { - "description": "A numeric string", + "type_identifier": { + "type": "string" + }, + "value": { + "type": [] + }, + "group": { "type": "string" + }, + "position": { + "type": "integer" + }, + "options": { + "type": [ + "object", + "array" + ] } } }, - "CustomerGroupWrapper": { + "AttributeWrapper": { "type": "object", "required": [ - "CustomerGroup" + "Attribute" ], "properties": { - "CustomerGroup": { - "$ref": "#/components/schemas/CustomerGroup" + "Attribute": { + "$ref": "#/components/schemas/Attribute" } } }, - "CustomerGroupCreate": { - "description": "This class is used to create a customer group.", + "AttributeCreate": { + "description": "This class is used to create an attribute.", "type": "object", "required": [ "identifier", + "type", + "group", "names", "descriptions", - "global_price_rate" + "position", + "options" ], "properties": { "identifier": { "type": "string" }, + "type": { + "type": "string" + }, + "group": { + "type": "string" + }, "names": { "type": "object" }, "descriptions": { "type": "object" }, - "global_price_rate": { - "description": "numeric-string", - "type": "string" + "position": { + "type": "integer" + }, + "options": { + "type": [ + "object", + "array" + ] } } }, - "CustomerGroupCreateWrapper": { + "AttributeCreateWrapper": { "type": "object", "required": [ - "CustomerGroupCreate" + "AttributeCreate" ], "properties": { - "CustomerGroupCreate": { - "$ref": "#/components/schemas/CustomerGroupCreate" + "AttributeCreate": { + "$ref": "#/components/schemas/AttributeCreate" } } }, - "CustomerGroupUpdate": { - "description": "This class is used to update a customer group.", + "AttributeUpdate": { + "description": "This class is used to update an attribute.", "type": "object", "required": [ - "names", "identifier", - "global_price_rate" + "names", + "descriptions", + "position", + "options" ], "properties": { - "names": { - "type": "object" - }, "identifier": { "type": "string" }, - "global_price_rate": { - "type": "string" + "names": { + "type": "object" }, "descriptions": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "CustomerGroupUpdateWrapper": { - "type": "object", - "required": [ - "CustomerGroupUpdate" - ], - "properties": { - "CustomerGroupUpdate": { - "$ref": "#/components/schemas/CustomerGroupUpdate" - } - } - }, - "CustomerGroupList": { - "description": "This class represents a customer group list.", - "type": "object", - "required": [ - "CustomerGroup" - ], - "properties": { - "CustomerGroup": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerGroup" - } - } - } - }, - "CustomerGroupListWrapper": { - "type": "object", - "required": [ - "CustomerGroupList" - ], - "properties": { - "CustomerGroupList": { - "$ref": "#/components/schemas/CustomerGroupList" - } - } - }, - "CustomerGroupListResult": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "type": "object" }, - { - "type": "object", - "required": [ - "CustomerGroupList" - ], - "properties": { - "CustomerGroupList": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - }, - { - "type": "object", - "required": [ - "CustomerGroup" - ], - "properties": { - "CustomerGroup": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerGroup" - } - } - } - } - ] - } - } - } - ] - }, - "CustomerGroupViewInput": { - "description": "This class represents a customer group view input.", - "xml": { - "name": "ViewInput" - }, - "type": "object", - "required": [ - "CustomerGroupQuery" - ], - "properties": { - "CustomerGroupQuery": { + "position": { + "type": "integer" + }, + "options": { "type": "object" } } }, - "CustomerGroupViewInputWrapper": { + "AttributeUpdateWrapper": { "type": "object", "required": [ - "ViewInput" + "AttributeUpdate" ], "properties": { - "ViewInput": { - "$ref": "#/components/schemas/CustomerGroupViewInput" + "AttributeUpdate": { + "$ref": "#/components/schemas/AttributeUpdate" } } }, - "CustomerGroupView": { - "description": "This class represents a customer group view.", + "AttributeListGet": { + "description": "This class represents an attribute list query", "type": "object", - "required": [ - "identifier", - "CustomerGroupQuery", - "Result" - ], "properties": { - "identifier": { + "group_name_prefix": { "type": "string" }, - "CustomerGroupQuery": { - "type": "object" - }, - "Result": { - "$ref": "#/components/schemas/CustomerGroupListResult" - } - } - }, - "CustomerGroupViewWrapper": { - "type": "object", - "required": [ - "CustomerGroupView" - ], - "properties": { - "CustomerGroupView": { - "$ref": "#/components/schemas/CustomerGroupView" - } - } - }, - "Region": { - "description": "This class represents a region.", - "type": "object", - "required": [ - "identifier" - ], - "properties": { - "identifier": { + "name_prefix": { "type": "string" + }, + "offset": { + "type": "integer" + }, + "limit": { + "type": "integer" } } }, - "RegionWrapper": { + "AttributeListGetWrapper": { "type": "object", "required": [ - "Region" + "AttributeListGet" ], "properties": { - "Region": { - "$ref": "#/components/schemas/Region" + "AttributeListGet": { + "$ref": "#/components/schemas/AttributeListGet" } } }, - "RegionList": { - "description": "This class represents a region list.", + "AttributeList": { + "description": "This class represents an attribute list.", "type": "object", "required": [ - "Region" + "Attribute" ], "properties": { - "Region": { + "Attribute": { "type": "array", "items": { - "$ref": "#/components/schemas/Ref" + "$ref": "#/components/schemas/Attribute" } } } }, - "RegionListWrapper": { + "AttributeListWrapper": { "type": "object", "required": [ - "RegionList" + "AttributeList" ], "properties": { - "RegionList": { - "$ref": "#/components/schemas/RegionList" + "AttributeList": { + "$ref": "#/components/schemas/AttributeList" } } }, - "RegionView": { - "description": "This class represents a region view.", + "AttributeView": { + "description": "This class represents an attribute view.", "type": "object", "required": [ "identifier", - "RegionQuery", + "AttributeQuery", "Result" ], "properties": { "identifier": { "type": "string" }, - "RegionQuery": { + "AttributeQuery": { "type": "object" }, "Result": { @@ -49436,3474 +40990,3414 @@ } } }, - "RegionViewWrapper": { + "AttributeViewWrapper": { "type": "object", "required": [ - "RegionView" + "AttributeView" ], "properties": { - "RegionView": { - "$ref": "#/components/schemas/RegionView" + "AttributeView": { + "$ref": "#/components/schemas/AttributeView" } } }, - "RegionViewInput": { - "description": "This class represents a region view input.", + "AttributeViewInput": { + "description": "This class represents an attribute view input.", "xml": { "name": "ViewInput" }, "type": "object", "required": [ - "RegionQuery" + "identifier", + "AttributeQuery" ], "properties": { - "RegionQuery": { + "identifier": { + "type": "string" + }, + "AttributeQuery": { "type": "object" } } }, - "RegionViewInputWrapper": { + "AttributeViewInputWrapper": { "type": "object", "required": [ "ViewInput" ], "properties": { "ViewInput": { - "$ref": "#/components/schemas/RegionViewInput" + "$ref": "#/components/schemas/AttributeViewInput" } } }, - "ProductType": { - "description": "This class represents a product type.", + "AttributeAssignment": { "type": "object", "required": [ - "identifier", - "name", - "AttributeAssignmentList" + "is_required", + "is_discriminator", + "Attribute" ], "properties": { - "identifier": { - "type": "string" + "is_required": { + "type": "boolean" }, - "name": { - "type": "string" + "is_discriminator": { + "type": "boolean" }, - "AttributeAssignmentList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttributeAssignment" - } - } - } - }, - "ProductTypeWrapper": { - "type": "object", - "required": [ - "ProductType" - ], - "properties": { - "ProductType": { - "$ref": "#/components/schemas/ProductType" + "Attribute": { + "$ref": "#/components/schemas/Attribute" } } }, - "ProductTypeCreate": { - "description": "This class is used to create a product type.", + "Catalog": { + "description": "This class represents a catalog.", "type": "object", "required": [ - "ContentTypeCreateStruct", - "main_language_code", - "assigned_attributes" + "identifier", + "name", + "description", + "created", + "modified", + "status", + "User", + "Criteria" ], "properties": { - "ContentTypeCreateStruct": { - "type": "object" + "identifier": { + "type": "string" }, - "main_language_code": { + "name": { "type": "string" }, - "assigned_attributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductTypeAssignedAttribute" - } - } - } - }, - "ProductTypeCreateWrapper": { - "type": "object", - "required": [ - "ProductTypeCreate" - ], - "properties": { - "ProductTypeCreate": { - "$ref": "#/components/schemas/ProductTypeCreate" - } - } - }, - "ProductTypeUpdate": { - "description": "This class is used to update a product type.", - "type": "object", - "required": [ - "ContentTypeUpdateStruct", - "assigned_attributes" - ], - "properties": { - "ContentTypeUpdateStruct": { - "$ref": "#/components/schemas/ContentTypeUpdateStruct" + "description": { + "type": "string" }, - "assigned_attributes": { + "created": { + "type": "integer" + }, + "modified": { + "type": "integer" + }, + "status": { + "type": "string" + }, + "User": { + "$ref": "#/components/schemas/Ref" + }, + "Criteria": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductTypeAssignedAttribute" + "$ref": "#/components/schemas/Criterion" } } } }, - "ProductTypeUpdateWrapper": { - "type": "object", - "required": [ - "ProductTypeUpdate" - ], - "properties": { - "ProductTypeUpdate": { - "$ref": "#/components/schemas/ProductTypeUpdate" - } - } - }, - "ProductTypeUsage": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - }, - { - "description": "This class represents a product type usage.", - "type": "object", - "required": [ - "is_used" - ], - "properties": { - "is_used": { - "type": "boolean" - } - } - } - ] - }, - "ProductTypeUsageWrapper": { + "CatalogWrapper": { "type": "object", "required": [ - "ProductTypeUsage" + "Catalog" ], "properties": { - "ProductTypeUsage": { - "$ref": "#/components/schemas/ProductTypeUsage" + "Catalog": { + "$ref": "#/components/schemas/Catalog" } } }, - "ProductTypeView": { - "description": "This class represents a product type view.", + "CatalogCreate": { + "description": "This class is used to create a catalog.", "type": "object", "required": [ "identifier", - "ProductTypeQuery", - "Result" + "criteria", + "names", + "status" ], "properties": { "identifier": { "type": "string" }, - "ProductTypeQuery": { + "criteria": { + "$ref": "#/components/schemas/Criterion" + }, + "names": { "type": "object" }, - "Result": { + "descriptions": { "type": "object" + }, + "status": { + "type": "string" + }, + "creator_id": { + "type": "integer" } } }, - "ProductTypeViewWrapper": { + "CatalogCreateWrapper": { "type": "object", "required": [ - "ProductTypeView" + "CatalogCreate" ], "properties": { - "ProductTypeView": { - "$ref": "#/components/schemas/ProductTypeView" + "CatalogCreate": { + "$ref": "#/components/schemas/CatalogCreate" } } }, - "ProductTypeList": { - "description": "This class represents a product type list.", + "CatalogUpdate": { + "description": "This class is used to update a catalog.", "type": "object", "required": [ - "ProductType" + "identifier", + "transition", + "criteria", + "names", + "descriptions" ], "properties": { - "ProductType": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductType" - } + "identifier": { + "type": "string" + }, + "transition": { + "type": "string" + }, + "criteria": { + "$ref": "#/components/schemas/Criterion" + }, + "names": { + "type": "object" + }, + "descriptions": { + "type": "object" } } }, - "ProductTypeListWrapper": { + "CatalogUpdateWrapper": { "type": "object", "required": [ - "ProductTypeList" + "CatalogUpdate" ], "properties": { - "ProductTypeList": { - "$ref": "#/components/schemas/ProductTypeList" + "CatalogUpdate": { + "$ref": "#/components/schemas/CatalogUpdate" } } }, - "ProductTypeListGet": { - "description": "This class represents a product type list query.", + "CatalogCopy": { + "description": "This class is used to copy a catalog.", "type": "object", "required": [ - "name_prefix", - "offset", - "limit" + "identifier", + "creator_id" ], "properties": { - "name_prefix": { + "identifier": { "type": "string" }, - "offset": { - "type": "integer" - }, - "limit": { + "creator_id": { + "description": "Optional", "type": "integer" - }, - "languages": { - "type": "array", - "items": { - "type": "string" - } } } }, - "ProductTypeListGetWrapper": { + "CatalogCopyWrapper": { "type": "object", "required": [ - "ProductTypeListGet" + "CatalogCopy" ], "properties": { - "ProductTypeListGet": { - "$ref": "#/components/schemas/ProductTypeListGet" + "CatalogCopy": { + "$ref": "#/components/schemas/CatalogCopy" } } }, - "ProductTypeViewInput": { - "description": "This class represents a product type view input.", - "xml": { - "name": "ViewInput" - }, + "CatalogList": { + "description": "This class represents a catalog list.", "type": "object", "required": [ - "ProductTypeQuery" + "Catalog" ], "properties": { - "ProductTypeQuery": { - "type": "object" + "Catalog": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Catalog" + } } } }, - "ProductTypeViewInputWrapper": { + "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": [ - "ViewInput" + "CatalogView" ], "properties": { - "ViewInput": { - "$ref": "#/components/schemas/ProductTypeViewInput" + "CatalogView": { + "$ref": "#/components/schemas/CatalogView" } } }, - "ProductTypeAssignedAttribute": { + "CatalogViewInput": { + "description": "This class represents a catalog view input.", + "xml": { + "name": "ViewInput" + }, "type": "object", "required": [ - "identifier", - "is_required", - "is_discriminator" + "CatalogQuery" ], "properties": { - "identifier": { - "type": "string" - }, - "is_required": { - "type": "boolean" - }, - "is_discriminator": { - "type": "boolean" + "CatalogQuery": { + "type": "object" } } }, - "ProductVariant": { - "description": "This class represents a product variant.", + "CatalogViewInputWrapper": { "type": "object", "required": [ - "code", - "name", - "Product", - "DiscriminatorAttributesList" + "ViewInput" ], "properties": { - "code": { - "type": "string" - }, - "name": { - "type": "string" - }, - "Product": { - "$ref": "#/components/schemas/Product" + "ViewInput": { + "$ref": "#/components/schemas/CatalogViewInput" + } + } + }, + "Currency": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "DiscriminatorAttributesList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Attribute" + { + "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" + } } } - } + ] }, - "ProductVariantWrapper": { + "CurrencyWrapper": { "type": "object", "required": [ - "ProductVariant" + "Currency" ], "properties": { - "ProductVariant": { - "$ref": "#/components/schemas/ProductVariant" + "Currency": { + "$ref": "#/components/schemas/Currency" } } }, - "ProductVariantView": { - "description": "This class represents a product variant view.", + "CurrencyCreate": { + "description": "This class is used to create currency.", "type": "object", "required": [ - "identifier", - "ProductVariantQuery", - "Result" + "code", + "subunits", + "enabled" ], "properties": { - "identifier": { + "code": { "type": "string" }, - "ProductVariantQuery": { - "type": "object" + "subunits": { + "type": "integer" }, - "Result": { - "type": "object" + "enabled": { + "type": "boolean" } } }, - "ProductVariantViewWrapper": { + "CurrencyCreateWrapper": { "type": "object", "required": [ - "ProductVariantView" + "CurrencyCreate" ], "properties": { - "ProductVariantView": { - "$ref": "#/components/schemas/ProductVariantView" + "CurrencyCreate": { + "$ref": "#/components/schemas/CurrencyCreate" } } }, - "ProductVariantViewInput": { - "description": "This class represents a product variant view input.", + "CurrencyUpdate": { + "description": "This class is used to update currency.", "type": "object", "required": [ - "ProductVariantQuery" + "subunits", + "enabled" ], "properties": { - "ProductVariantQuery": { - "type": "object" + "subunits": { + "type": "integer" + }, + "enabled": { + "type": "boolean" } } }, - "ProductVariantViewInputWrapper": { + "CurrencyUpdateWrapper": { "type": "object", "required": [ - "ViewInput" + "CurrencyUpdate" ], "properties": { - "ViewInput": { - "$ref": "#/components/schemas/ProductVariantViewInput" + "CurrencyUpdate": { + "$ref": "#/components/schemas/CurrencyUpdate" } } }, - "ProductVariantCreate": { - "description": "This class is used to create a product variant.", + "CurrencyView": { + "description": "This class represents a currency view.", "type": "object", "required": [ - "code", - "attributes" + "identifier", + "CurrencyQuery", + "Result" ], "properties": { - "code": { + "identifier": { "type": "string" }, - "attributes": { - "description": "array", + "CurrencyQuery": { + "type": "object" + }, + "Result": { "type": "object" } } }, - "ProductVariantCreateWrapper": { + "CurrencyViewWrapper": { "type": "object", "required": [ - "ProductVariantCreate" + "CurrencyView" ], "properties": { - "ProductVariantCreate": { - "$ref": "#/components/schemas/ProductVariantCreate" + "CurrencyView": { + "$ref": "#/components/schemas/CurrencyView" } } }, - "ProductVariantUpdate": { - "description": "This class is used to update a product variant.", + "CurrencyViewInput": { + "description": "This class represents a currency view input.", + "xml": { + "name": "ViewInput" + }, "type": "object", "required": [ - "code", - "attributes" + "CurrencyQuery" ], "properties": { - "code": { - "type": "string" - }, - "attributes": { - "description": "array", + "CurrencyQuery": { "type": "object" } } }, - "ProductVariantUpdateWrapper": { + "CurrencyViewInputWrapper": { "type": "object", "required": [ - "ProductVariantUpdate" + "ViewInput" ], "properties": { - "ProductVariantUpdate": { - "$ref": "#/components/schemas/ProductVariantUpdate" + "ViewInput": { + "$ref": "#/components/schemas/CurrencyViewInput" } } }, - "ProductVariantGenerate": { - "description": "This class is used to generate a product variant.", + "CurrencyList": { + "description": "This class represents a currency list.", "type": "object", "required": [ - "attributes" + "Currency" ], "properties": { - "attributes": { - "description": "array", - "type": "object" + "Currency": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Currency" + } } } }, - "ProductVariantGenerateWrapper": { + "CurrencyListWrapper": { "type": "object", "required": [ - "ProductVariantGenerate" + "CurrencyList" ], "properties": { - "ProductVariantGenerate": { - "$ref": "#/components/schemas/ProductVariantGenerate" + "CurrencyList": { + "$ref": "#/components/schemas/CurrencyList" } } }, - "ProductSortClause": { + "CustomerGroup": { + "description": "This class represents a customer group.", "type": "object", "required": [ - "name" + "id", + "name", + "identifier", + "description", + "users", + "global_price_rate" ], "properties": { + "id": { + "type": "integer" + }, "name": { "type": "string" - } - } - }, - "ProductSortClauseList": { - "description": "This class represents a product sort clause list.", - "type": "object", - "required": [ - "ProductSortClause" - ], - "properties": { - "ProductSortClause": { + }, + "identifier": { + "type": "string" + }, + "description": { + "type": "string" + }, + "users": { + "description": "A list of users attached to the customer group.", "type": "array", "items": { - "$ref": "#/components/schemas/ProductSortClause" + "$ref": "#/components/schemas/User" } + }, + "global_price_rate": { + "description": "A numeric string", + "type": "string" } } }, - "ProductSortClauseListWrapper": { + "CustomerGroupWrapper": { "type": "object", "required": [ - "ProductSortClauseList" + "CustomerGroup" ], "properties": { - "ProductSortClauseList": { - "$ref": "#/components/schemas/ProductSortClauseList" + "CustomerGroup": { + "$ref": "#/components/schemas/CustomerGroup" } } }, - "Product": { - "description": "This class represents a product.", + "CustomerGroupCreate": { + "description": "This class is used to create a customer group.", "type": "object", "required": [ - "code", - "name", - "ProductType", - "AttributesList" + "identifier", + "names", + "descriptions", + "global_price_rate" ], "properties": { - "isVariant": { - "type": "boolean" - }, - "isBaseProduct": { - "type": "boolean" - }, - "code": { - "type": "string" - }, - "name": { + "identifier": { "type": "string" }, - "ProductType": { - "$ref": "#/components/schemas/ProductType" - }, - "Content": { - "$ref": "#/components/schemas/Content" - }, - "Thumbnail": { - "$ref": "#/components/schemas/Thumbnail" - }, - "created_at": { - "type": "integer" + "names": { + "type": "object" }, - "updated_at": { - "type": "integer" + "descriptions": { + "type": "object" }, - "AttributesList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Attribute" - } + "global_price_rate": { + "description": "numeric-string", + "type": "string" } } }, - "ProductWrapper": { + "CustomerGroupCreateWrapper": { "type": "object", "required": [ - "Product" + "CustomerGroupCreate" ], "properties": { - "Product": { - "$ref": "#/components/schemas/Product" + "CustomerGroupCreate": { + "$ref": "#/components/schemas/CustomerGroupCreate" } } }, - "ProductCreate": { - "description": "This class is used to create a product.", + "CustomerGroupUpdate": { + "description": "This class is used to update a customer group.", "type": "object", "required": [ - "ContentCreate", - "code", - "attributes" + "names", + "identifier", + "global_price_rate" ], "properties": { - "ContentCreate": { - "$ref": "#/components/schemas/ContentCreate" + "names": { + "type": "object" }, - "code": { + "identifier": { "type": "string" }, - "attributes": { - "type": "object" + "global_price_rate": { + "type": "string" + }, + "descriptions": { + "type": "array", + "items": { + "type": "string" + } } } }, - "ProductCreateWrapper": { + "CustomerGroupUpdateWrapper": { "type": "object", "required": [ - "ProductCreate" + "CustomerGroupUpdate" ], "properties": { - "ProductCreate": { - "$ref": "#/components/schemas/ProductCreate" + "CustomerGroupUpdate": { + "$ref": "#/components/schemas/CustomerGroupUpdate" } } - }, - "ProductUpdate": { - "description": "This class is used to update a product.", + }, + "CustomerGroupList": { + "description": "This class represents a customer group list.", "type": "object", "required": [ - "ContentUpdate", - "code" + "CustomerGroup" ], "properties": { - "ContentUpdate": { - "$ref": "#/components/schemas/ContentUpdate" - }, - "code": { - "type": "string" - }, - "attributes": { + "CustomerGroup": { "type": "array", "items": { - "type": "object" + "$ref": "#/components/schemas/CustomerGroup" } } } }, - "ProductUpdateWrapper": { + "CustomerGroupListWrapper": { "type": "object", "required": [ - "ProductUpdate" + "CustomerGroupList" ], "properties": { - "ProductUpdate": { - "$ref": "#/components/schemas/ProductUpdate" + "CustomerGroupList": { + "$ref": "#/components/schemas/CustomerGroupList" } } }, - "ProductContentUpdate": { - "type": "object", - "required": [ - "__url", - "fields" - ], - "properties": { - "__url": { - "xml": { - "attribute": true, - "name": "url" - }, - "type": "string" + "CustomerGroupListResult": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "fields": { + { "type": "object", "required": [ - "field" + "CustomerGroupList" ], "properties": { - "field": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Field" - } + "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" + } } }, - "ProductView": { - "description": "This class represents a product view.", + "CustomerGroupViewInputWrapper": { + "type": "object", + "required": [ + "ViewInput" + ], + "properties": { + "ViewInput": { + "$ref": "#/components/schemas/CustomerGroupViewInput" + } + } + }, + "CustomerGroupView": { + "description": "This class represents a customer group view.", "type": "object", "required": [ "identifier", - "ProductQuery", + "CustomerGroupQuery", "Result" ], "properties": { "identifier": { "type": "string" }, - "ProductQuery": { + "CustomerGroupQuery": { "type": "object" }, "Result": { - "type": "object" + "$ref": "#/components/schemas/CustomerGroupListResult" } } }, - "ProductViewWrapper": { + "CustomerGroupViewWrapper": { "type": "object", "required": [ - "ProductView" + "CustomerGroupView" ], "properties": { - "ProductView": { - "$ref": "#/components/schemas/ProductView" + "CustomerGroupView": { + "$ref": "#/components/schemas/CustomerGroupView" } } }, - "ProductViewInput": { - "description": "This class represents a product view input.", - "xml": { - "name": "ViewInput" - }, + "Region": { + "description": "This class represents a region.", "type": "object", "required": [ - "ProductQuery" + "identifier" ], "properties": { - "ProductQuery": { - "type": "object" + "identifier": { + "type": "string" } } }, - "ProductViewInputWrapper": { + "RegionWrapper": { "type": "object", "required": [ - "ViewInput" + "Region" ], "properties": { - "ViewInput": { - "$ref": "#/components/schemas/ProductViewInput" + "Region": { + "$ref": "#/components/schemas/Region" } } }, - "ProductList": { - "description": "This class represents a product list.", + "RegionList": { + "description": "This class represents a region list.", "type": "object", "required": [ - "Product" + "Region" ], "properties": { - "Product": { + "Region": { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Ref" } } } }, - "ProductListWrapper": { + "RegionListWrapper": { "type": "object", "required": [ - "ProductList" + "RegionList" ], "properties": { - "ProductList": { - "$ref": "#/components/schemas/ProductList" + "RegionList": { + "$ref": "#/components/schemas/RegionList" } } }, - "ProductListGet": { - "description": "This class represents a product list GET.", + "RegionView": { + "description": "This class represents a region view.", "type": "object", "required": [ - "offset", - "limit", - "languages" + "identifier", + "RegionQuery", + "Result" ], "properties": { - "offset": { - "type": "integer" + "identifier": { + "type": "string" }, - "limit": { - "type": "integer" + "RegionQuery": { + "type": "object" }, - "languages": { - "type": "array", - "items": { - "type": "string" - } + "Result": { + "type": "object" } } }, - "ProductListGetWrapper": { + "RegionViewWrapper": { "type": "object", "required": [ - "ProductListGet" + "RegionView" ], "properties": { - "ProductListGet": { - "$ref": "#/components/schemas/ProductListGet" + "RegionView": { + "$ref": "#/components/schemas/RegionView" } } }, - "ProductGet": { - "description": "This class represents a product GET.", + "RegionViewInput": { + "description": "This class represents a region view input.", + "xml": { + "name": "ViewInput" + }, "type": "object", "required": [ - "languages" + "RegionQuery" ], "properties": { - "languages": { - "type": "array", - "items": { - "type": "string" - } + "RegionQuery": { + "type": "object" } } }, - "ProductGetWrapper": { + "RegionViewInputWrapper": { "type": "object", "required": [ - "ProductGet" + "ViewInput" ], "properties": { - "ProductGet": { - "$ref": "#/components/schemas/ProductGet" + "ViewInput": { + "$ref": "#/components/schemas/RegionViewInput" } } }, - "ProductFilter": { + "ProductType": { + "description": "This class represents a product type.", "type": "object", "required": [ - "name" + "identifier", + "name", + "AttributeAssignmentList" ], "properties": { + "identifier": { + "type": "string" + }, "name": { "type": "string" - } - } - }, - "ProductFilterList": { - "description": "This class represents a product filter list.", - "type": "object", - "required": [ - "ProductFilter" - ], - "properties": { - "ProductFilter": { + }, + "AttributeAssignmentList": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductFilter" + "$ref": "#/components/schemas/AttributeAssignment" } } } }, - "ProductFilterListWrapper": { + "ProductTypeWrapper": { "type": "object", "required": [ - "ProductFilterList" + "ProductType" ], "properties": { - "ProductFilterList": { - "$ref": "#/components/schemas/ProductFilterList" + "ProductType": { + "$ref": "#/components/schemas/ProductType" } } }, - "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": { + "ProductTypeCreate": { + "description": "This class is used to create a product type.", "type": "object", "required": [ - "Price" + "ContentTypeCreateStruct", + "main_language_code", + "assigned_attributes" ], "properties": { - "Price": { - "$ref": "#/components/schemas/Price" + "ContentTypeCreateStruct": { + "type": "object" + }, + "main_language_code": { + "type": "string" + }, + "assigned_attributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductTypeAssignedAttribute" + } } } }, - "PriceCreateStruct": { - "description": "This class represents a price creation structure.", + "ProductTypeCreateWrapper": { "type": "object", "required": [ - "amount", - "currency" + "ProductTypeCreate" ], "properties": { - "amount": { - "type": "integer" - }, - "currency": { - "type": "string" + "ProductTypeCreate": { + "$ref": "#/components/schemas/ProductTypeCreate" } } }, - "PriceCreateStructWrapper": { + "ProductTypeUpdate": { + "description": "This class is used to update a product type.", "type": "object", "required": [ - "PriceCreateStruct" + "ContentTypeUpdateStruct", + "assigned_attributes" ], "properties": { - "PriceCreateStruct": { - "$ref": "#/components/schemas/PriceCreateStruct" + "ContentTypeUpdateStruct": { + "$ref": "#/components/schemas/ContentTypeUpdateStruct" + }, + "assigned_attributes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductTypeAssignedAttribute" + } } } }, - "RestPrice": { + "ProductTypeUpdateWrapper": { "type": "object", "required": [ - "Price", - "formatted" + "ProductTypeUpdate" ], "properties": { - "Price": { - "$ref": "#/components/schemas/Price" - }, - "formatted": { - "type": "string" + "ProductTypeUpdate": { + "$ref": "#/components/schemas/ProductTypeUpdate" } } }, - "RestPriceWrapper": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - }, - { - "type": "object", - "required": [ - "RestPrice" - ], - "properties": { - "RestPrice": { - "$ref": "#/components/schemas/RestPrice" - } - } - } - ] - }, - "CustomPrice": { + "ProductTypeUsage": { "allOf": [ { "$ref": "#/components/schemas/BaseObject" }, { - "description": "This class represents a custom price.", + "description": "This class represents a product type usage.", "type": "object", "required": [ - "amount", - "base_amount", - "Currency", - "money", - "base_money", - "custom_money", - "custom_amount" + "is_used" ], "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" - ] + "is_used": { + "type": "boolean" } } } ] }, - "CustomPriceWrapper": { + "ProductTypeUsageWrapper": { "type": "object", "required": [ - "CustomPrice" + "ProductTypeUsage" ], "properties": { - "CustomPrice": { - "$ref": "#/components/schemas/CustomPrice" + "ProductTypeUsage": { + "$ref": "#/components/schemas/ProductTypeUsage" } } }, - "CustomPriceCreateStruct": { - "description": "This class represents a custom price creation structure.", + "ProductTypeView": { + "description": "This class represents a product type view.", "type": "object", "required": [ - "amount", - "currency", - "customAmount", - "customerGroup" + "identifier", + "ProductTypeQuery", + "Result" ], "properties": { - "amount": { - "type": "integer" - }, - "currency": { + "identifier": { "type": "string" }, - "customAmount": { - "type": "integer" + "ProductTypeQuery": { + "type": "object" }, - "customerGroup": { - "type": "string" + "Result": { + "type": "object" } } }, - "CustomPriceCreateStructWrapper": { + "ProductTypeViewWrapper": { "type": "object", "required": [ - "CustomPriceCreateStruct" + "ProductTypeView" ], "properties": { - "CustomPriceCreateStruct": { - "$ref": "#/components/schemas/CustomPriceCreateStruct" + "ProductTypeView": { + "$ref": "#/components/schemas/ProductTypeView" } } }, - "CustomPriceUpdateStruct": { - "description": "This class represents a custom price updating structure.", + "ProductTypeList": { + "description": "This class represents a product type list.", "type": "object", "required": [ - "amount", - "currency", - "customAmount" + "ProductType" ], "properties": { - "amount": { - "type": "integer" - }, - "currency": { - "type": "string" - }, - "customAmount": { - "type": "integer" + "ProductType": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductType" + } } } }, - "CustomPriceUpdateStructWrapper": { + "ProductTypeListWrapper": { "type": "object", "required": [ - "CustomPriceUpdateStruct" + "ProductTypeList" ], "properties": { - "CustomPriceUpdateStruct": { - "$ref": "#/components/schemas/CustomPriceUpdateStruct" + "ProductTypeList": { + "$ref": "#/components/schemas/ProductTypeList" } } }, - "PriceUpdateStruct": { - "description": "This class represents a price updating structure.", + "ProductTypeListGet": { + "description": "This class represents a product type list query.", "type": "object", "required": [ - "amount", - "currency" + "name_prefix", + "offset", + "limit" ], "properties": { - "amount": { + "name_prefix": { + "type": "string" + }, + "offset": { "type": "integer" }, - "currency": { - "type": "string" + "limit": { + "type": "integer" + }, + "languages": { + "type": "array", + "items": { + "type": "string" + } } } }, - "PriceUpdateStructWrapper": { + "ProductTypeListGetWrapper": { "type": "object", "required": [ - "PriceUpdateStruct" + "ProductTypeListGet" ], "properties": { - "PriceUpdateStruct": { - "$ref": "#/components/schemas/PriceUpdateStruct" + "ProductTypeListGet": { + "$ref": "#/components/schemas/ProductTypeListGet" } } }, - "PriceList": { - "description": "This class represents a price list.", + "ProductTypeViewInput": { + "description": "This class represents a product type view input.", + "xml": { + "name": "ViewInput" + }, "type": "object", "required": [ - "prices" + "ProductTypeQuery" ], "properties": { - "prices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } + "ProductTypeQuery": { + "type": "object" } } }, - "PriceListWrapper": { + "ProductTypeViewInputWrapper": { "type": "object", "required": [ - "PriceList" + "ViewInput" ], "properties": { - "PriceList": { - "$ref": "#/components/schemas/PriceList" + "ViewInput": { + "$ref": "#/components/schemas/ProductTypeViewInput" } } }, - "Thumbnail": { - "description": "This class represents a thumbnail that can be a target URL or a Base64 data.", + "ProductTypeAssignedAttribute": { "type": "object", "required": [ - "resource", - "width", - "height", - "mimeType" + "identifier", + "is_required", + "is_discriminator" ], "properties": { - "resource": { + "identifier": { "type": "string" }, - "width": { - "type": [ - "integer", - "null" - ] - }, - "height": { - "type": [ - "integer", - "null" - ] + "is_required": { + "type": "boolean" }, - "mimeType": { - "type": "string" + "is_discriminator": { + "type": "boolean" } } }, - "VatCategory": { - "description": "This class represents a VAT category.", + "ProductVariant": { + "description": "This class represents a product variant.", "type": "object", "required": [ - "identifier", - "region", - "vatValue" + "code", + "name", + "Product", + "DiscriminatorAttributesList" ], "properties": { - "identifier": { + "code": { "type": "string" }, - "region": { + "name": { "type": "string" }, - "vatValue": { - "type": [ - "number", - "null" - ] + "Product": { + "$ref": "#/components/schemas/Product" + }, + "DiscriminatorAttributesList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Attribute" + } } } }, - "VatCategoryWrapper": { + "ProductVariantWrapper": { "type": "object", "required": [ - "VatCategory" + "ProductVariant" ], "properties": { - "VatCategory": { - "$ref": "#/components/schemas/VatCategory" + "ProductVariant": { + "$ref": "#/components/schemas/ProductVariant" } } }, - "VatCategoryList": { - "description": "This class represents a VAT category list.", + "ProductVariantView": { + "description": "This class represents a product variant view.", "type": "object", "required": [ - "VatCategory" + "identifier", + "ProductVariantQuery", + "Result" ], "properties": { - "VatCategory": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VatCategory" - } + "identifier": { + "type": "string" + }, + "ProductVariantQuery": { + "type": "object" + }, + "Result": { + "type": "object" } } }, - "VatCategoryListWrapper": { + "ProductVariantViewWrapper": { "type": "object", "required": [ - "VatCategoryList" + "ProductVariantView" ], "properties": { - "VatCategoryList": { - "$ref": "#/components/schemas/VatCategoryList" + "ProductVariantView": { + "$ref": "#/components/schemas/ProductVariantView" } } }, - "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" - } - } + "ProductVariantViewInput": { + "description": "This class represents a product variant view input.", + "type": "object", + "required": [ + "ProductVariantQuery" + ], + "properties": { + "ProductVariantQuery": { + "type": "object" } - ] + } }, - "TaxonomyEntryWrapper": { + "ProductVariantViewInputWrapper": { "type": "object", "required": [ - "TaxonomyEntry" + "ViewInput" ], "properties": { - "TaxonomyEntry": { - "$ref": "#/components/schemas/TaxonomyEntry" + "ViewInput": { + "$ref": "#/components/schemas/ProductVariantViewInput" } } }, - "TaxonomyEntryBulkRemove": { - "description": "This class is used to bulk remove taxonomy entries.", + "ProductVariantCreate": { + "description": "This class is used to create a product variant.", "type": "object", "required": [ - "entries" + "code", + "attributes" ], "properties": { - "entries": { - "type": "array", - "items": { - "type": "integer" - } + "code": { + "type": "string" + }, + "attributes": { + "description": "array", + "type": "object" } } }, - "TaxonomyEntryBulkRemoveWrapper": { + "ProductVariantCreateWrapper": { "type": "object", "required": [ - "TaxonomyEntryBulkRemove" + "ProductVariantCreate" ], "properties": { - "TaxonomyEntryBulkRemove": { - "$ref": "#/components/schemas/TaxonomyEntryBulkRemove" + "ProductVariantCreate": { + "$ref": "#/components/schemas/ProductVariantCreate" } } }, - "TaxonomyEntryMove": { + "ProductVariantUpdate": { + "description": "This class is used to update a product variant.", "type": "object", "required": [ - "entry", - "sibling", - "position" + "code", + "attributes" ], "properties": { - "entry": { - "type": "integer" - }, - "sibling": { - "type": "integer" - }, - "position": { + "code": { "type": "string" + }, + "attributes": { + "description": "array", + "type": "object" } } }, - "TaxonomyEntryBulkMove": { - "description": "This class is used to bulk move taxonomy entries.", + "ProductVariantUpdateWrapper": { "type": "object", "required": [ - "entries" + "ProductVariantUpdate" ], "properties": { - "entries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxonomyEntryMove" - } + "ProductVariantUpdate": { + "$ref": "#/components/schemas/ProductVariantUpdate" } } }, - "TaxonomyEntryBulkMoveWrapper": { + "ProductVariantGenerate": { + "description": "This class is used to generate a product variant.", "type": "object", "required": [ - "TaxonomyEntryBulkMove" + "attributes" ], "properties": { - "TaxonomyEntryBulkMove": { - "$ref": "#/components/schemas/TaxonomyEntryBulkMove" + "attributes": { + "description": "array", + "type": "object" } } }, - "TaxonomyEntryAssignment": { - "description": "This class represents a taxonomy entry assignment.", + "ProductVariantGenerateWrapper": { "type": "object", "required": [ - "id", - "content", - "entry" + "ProductVariantGenerate" ], "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" - } - } - } - ] + "ProductVariantGenerate": { + "$ref": "#/components/schemas/ProductVariantGenerate" } } }, - "TaxonomyEntryAssignmentWrapper": { + "ProductSortClause": { "type": "object", "required": [ - "TaxonomyEntryAssignment" + "name" ], "properties": { - "TaxonomyEntryAssignment": { - "$ref": "#/components/schemas/TaxonomyEntryAssignment" + "name": { + "type": "string" } } }, - "TaxonomyEntryAssignToContent": { - "description": "This class is used to assign taxonomy entry to content.", + "ProductSortClauseList": { + "description": "This class represents a product sort clause list.", "type": "object", "required": [ - "content", - "entries" + "ProductSortClause" ], "properties": { - "content": { - "type": "integer" - }, - "entries": { + "ProductSortClause": { "type": "array", "items": { - "type": "integer" + "$ref": "#/components/schemas/ProductSortClause" } } } }, - "TaxonomyEntryAssignToContentWrapper": { + "ProductSortClauseListWrapper": { "type": "object", "required": [ - "TaxonomyEntryAssignToContent" + "ProductSortClauseList" ], "properties": { - "TaxonomyEntryAssignToContent": { - "$ref": "#/components/schemas/TaxonomyEntryAssignToContent" + "ProductSortClauseList": { + "$ref": "#/components/schemas/ProductSortClauseList" } } }, - "TaxonomyEntryUnassignFromContent": { - "description": "This class is used to unassign taxonomy entry from content.", + "Product": { + "description": "This class represents a product.", "type": "object", "required": [ - "content", - "entries" + "code", + "name", + "ProductType", + "AttributesList" ], "properties": { - "content": { + "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" }, - "entries": { + "updated_at": { + "type": "integer" + }, + "AttributesList": { "type": "array", "items": { - "type": "integer" + "$ref": "#/components/schemas/Attribute" } } } }, - "TaxonomyEntryUnassignFromContentWrapper": { + "ProductWrapper": { "type": "object", "required": [ - "TaxonomyEntryUnassignFromContent" + "Product" ], "properties": { - "TaxonomyEntryUnassignFromContent": { - "$ref": "#/components/schemas/TaxonomyEntryUnassignFromContent" + "Product": { + "$ref": "#/components/schemas/Product" } } }, - "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": { + "ProductCreate": { + "description": "This class is used to create a product.", "type": "object", "required": [ - "EntryAssignmentCollection" + "ContentCreate", + "code", + "attributes" ], "properties": { - "EntryAssignmentCollection": { - "$ref": "#/components/schemas/EntryAssignmentCollection" - } - } - }, - "Segment": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "ContentCreate": { + "$ref": "#/components/schemas/ContentCreate" }, - { - "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" - } - } + "code": { + "type": "string" + }, + "attributes": { + "type": "object" } - ] + } }, - "SegmentWrapper": { + "ProductCreateWrapper": { "type": "object", "required": [ - "Segment" + "ProductCreate" ], "properties": { - "Segment": { - "$ref": "#/components/schemas/Segment" + "ProductCreate": { + "$ref": "#/components/schemas/ProductCreate" } } }, - "SegmentList": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "ProductUpdate": { + "description": "This class is used to update a product.", + "type": "object", + "required": [ + "ContentUpdate", + "code" + ], + "properties": { + "ContentUpdate": { + "$ref": "#/components/schemas/ContentUpdate" }, - { - "description": "This class lists segments.", - "type": "object", - "required": [ - "Segment" - ], - "properties": { - "Segment": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Segment" - } - } + "code": { + "type": "string" + }, + "attributes": { + "type": "array", + "items": { + "type": "object" } } - ] + } }, - "SegmentListWrapper": { + "ProductUpdateWrapper": { "type": "object", "required": [ - "SegmentList" + "ProductUpdate" ], "properties": { - "SegmentList": { - "$ref": "#/components/schemas/SegmentList" + "ProductUpdate": { + "$ref": "#/components/schemas/ProductUpdate" } } }, - "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": { + "ProductContentUpdate": { "type": "object", "required": [ - "SegmentGroup" + "__url", + "fields" ], "properties": { - "SegmentGroup": { - "$ref": "#/components/schemas/SegmentGroup" - } - } - }, - "SegmentGroupList": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "__url": { + "xml": { + "attribute": true, + "name": "url" + }, + "type": "string" }, - { - "description": "This class lists segment groups.", + "fields": { "type": "object", "required": [ - "SegmentGroup" + "field" ], "properties": { - "SegmentGroup": { + "field": { "type": "array", "items": { - "$ref": "#/components/schemas/SegmentGroup" + "$ref": "#/components/schemas/Field" } } } } - ] + } }, - "SegmentGroupListWrapper": { + "ProductView": { + "description": "This class represents a product view.", "type": "object", "required": [ - "SegmentGroupList" + "identifier", + "ProductQuery", + "Result" ], "properties": { - "SegmentGroupList": { - "$ref": "#/components/schemas/SegmentGroupList" + "identifier": { + "type": "string" + }, + "ProductQuery": { + "type": "object" + }, + "Result": { + "type": "object" } } }, - "UserSegment": { - "description": "This class represents a segment and a user it's associate to.", + "ProductViewWrapper": { "type": "object", + "required": [ + "ProductView" + ], "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" + "ProductView": { + "$ref": "#/components/schemas/ProductView" } } }, - "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" - } - } - } + "ProductViewInput": { + "description": "This class represents a product view input.", + "xml": { + "name": "ViewInput" + }, + "type": "object", + "required": [ + "ProductQuery" + ], + "properties": { + "ProductQuery": { + "type": "object" } - ] + } }, - "UserSegmentListWrapper": { + "ProductViewInputWrapper": { "type": "object", "required": [ - "UserSegmentList" + "ViewInput" ], "properties": { - "UserSegmentList": { - "$ref": "#/components/schemas/SegmentList" + "ViewInput": { + "$ref": "#/components/schemas/ProductViewInput" } } }, - "UserSegmentAssignInput": { + "ProductList": { + "description": "This class represents a product list.", "type": "object", + "required": [ + "Product" + ], "properties": { - "segments": { + "Product": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/Product" } } } }, - "UserSegmentAssignInputWrapper": { + "ProductListWrapper": { "type": "object", "required": [ - "UserSegmentAssignInput" + "ProductList" ], "properties": { - "UserSegmentAssignInput": { - "$ref": "#/components/schemas/UserSegmentAssignInput" + "ProductList": { + "$ref": "#/components/schemas/ProductList" } } }, - "CorporateAccountRoot": { - "description": "This class represents Corporate Account Root resource information.", + "ProductListGet": { + "description": "This class represents a product list GET.", "type": "object", "required": [ - "links" + "offset", + "limit", + "languages" ], "properties": { - "links": { - "xml": { - "wrapped": false - }, + "offset": { + "type": "integer" + }, + "limit": { + "type": "integer" + }, + "languages": { "type": "array", "items": { - "$ref": "#/components/schemas/Link" + "type": "string" } } } }, - "CorporateAccountRootWrapper": { + "ProductListGetWrapper": { "type": "object", "required": [ - "CorporateAccountRoot" + "ProductListGet" ], "properties": { - "CorporateAccountRoot": { - "$ref": "#/components/schemas/CorporateAccountRoot" + "ProductListGet": { + "$ref": "#/components/schemas/ProductListGet" } } }, - "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.", + "ProductGet": { + "description": "This class represents a product GET.", "type": "object", "required": [ - "id", - "name", - "Content", - "billingAddress", - "contactId", - "salesRepresentativeId", - "defaultAddressId", - "addressBookId", - "membersId", - "MemberList", - "Location", - "locationPath", - "isActive" + "languages" ], "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" + "languages": { + "type": "array", + "items": { + "type": "string" + } } } }, - "CompanyWrapper": { + "ProductGetWrapper": { "type": "object", "required": [ - "Company" + "ProductGet" ], "properties": { - "Company": { - "$ref": "#/components/schemas/Company" + "ProductGet": { + "$ref": "#/components/schemas/ProductGet" } } }, - "CompanyCreate": { - "description": "This class is used to create a company.", + "ProductFilter": { "type": "object", "required": [ - "fields" + "name" ], "properties": { - "fields": { - "type": "object", - "required": [ - "field" - ], - "properties": { - "field": { - "description": "Fields of a Company content item.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Field" - } - } - } + "name": { + "type": "string" } } }, - "CompanyCreateWrapper": { + "ProductFilterList": { + "description": "This class represents a product filter list.", "type": "object", "required": [ - "CompanyCreate" + "ProductFilter" ], "properties": { - "CompanyCreate": { - "$ref": "#/components/schemas/CompanyCreate" + "ProductFilter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFilter" + } } } }, - "CompanyUpdate": { - "description": "This class is used to update a Company.", + "ProductFilterListWrapper": { "type": "object", "required": [ - "fields" + "ProductFilterList" ], "properties": { - "fields": { + "ProductFilterList": { + "$ref": "#/components/schemas/ProductFilterList" + } + } + }, + "Price": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + }, + { + "description": "This class represents a price.", "type": "object", "required": [ - "field" + "amount", + "Currency" ], "properties": { - "field": { - "description": "Fields of a Company content item.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Field" - } + "amount": { + "type": "string" + }, + "base_amount": { + "type": "string" + }, + "Currency": { + "$ref": "#/components/schemas/Currency" + }, + "money": { + "type": "string" + }, + "base_money": { + "type": "string" } } } - } + ] }, - "CompanyUpdateWrapper": { + "PriceWrapper": { "type": "object", "required": [ - "CompanyUpdate" + "Price" ], "properties": { - "CompanyUpdate": { - "$ref": "#/components/schemas/CompanyUpdate" + "Price": { + "$ref": "#/components/schemas/Price" } } }, - "CompanyList": { - "description": "This class represents a list of companies.", + "PriceCreateStruct": { + "description": "This class represents a price creation structure.", "type": "object", "required": [ - "companies" + "amount", + "currency" ], "properties": { - "companies": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Company" - } + "amount": { + "type": "integer" + }, + "currency": { + "type": "string" } } }, - "CompanyListWrapper": { + "PriceCreateStructWrapper": { "type": "object", "required": [ - "CompanyList" + "PriceCreateStruct" ], "properties": { - "CompanyList": { - "$ref": "#/components/schemas/CompanyList" + "PriceCreateStruct": { + "$ref": "#/components/schemas/PriceCreateStruct" } } }, - "Member": { - "description": "This class represents a company member.", + "RestPrice": { "type": "object", "required": [ - "id", - "name", - "Company", - "User", - "Role" + "Price", + "formatted" ], "properties": { - "id": { - "type": "integer" + "Price": { + "$ref": "#/components/schemas/Price" }, - "name": { + "formatted": { "type": "string" + } + } + }, + "RestPriceWrapper": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "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.", + { + "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" + ] + } + } } - } + ] }, - "MemberWrapper": { + "CustomPriceWrapper": { "type": "object", "required": [ - "Member" + "CustomPrice" ], "properties": { - "Member": { - "$ref": "#/components/schemas/Member" + "CustomPrice": { + "$ref": "#/components/schemas/CustomPrice" } } }, - "MemberCreate": { - "description": "This class is used to create a member.", + "CustomPriceCreateStruct": { + "description": "This class represents a custom price creation structure.", "type": "object", "required": [ - "login", - "email", - "password", - "Role", - "fields" + "amount", + "currency", + "customAmount", + "customerGroup" ], "properties": { - "login": { - "type": "string" - }, - "email": { - "type": "string" + "amount": { + "type": "integer" }, - "password": { + "currency": { "type": "string" }, - "Role": { - "description": "Reference to a Role resource company member should be given.", - "$ref": "#/components/schemas/BaseObject" + "customAmount": { + "type": "integer" }, - "fields": { - "type": "object", - "required": [ - "field" - ], - "properties": { - "field": { - "description": "Fields of a Member content item.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Field" - } - } - } + "customerGroup": { + "type": "string" } } }, - "MemberCreateWrapper": { + "CustomPriceCreateStructWrapper": { "type": "object", "required": [ - "MemberCreate" + "CustomPriceCreateStruct" ], "properties": { - "MemberCreate": { - "$ref": "#/components/schemas/MemberCreate" + "CustomPriceCreateStruct": { + "$ref": "#/components/schemas/CustomPriceCreateStruct" } } }, - "MemberUpdate": { - "description": "This class is used to update a member.", + "CustomPriceUpdateStruct": { + "description": "This class represents a custom price updating structure.", "type": "object", "required": [ - "email", - "password", - "enabled", - "maxLogin", - "Role", - "fields" + "amount", + "currency", + "customAmount" ], "properties": { - "email": { - "type": "string" + "amount": { + "type": "integer" }, - "password": { + "currency": { "type": "string" }, - "enabled": { - "type": "boolean" - }, - "maxLogin": { - "description": "Max number of failed login attempts.", + "customAmount": { "type": "integer" - }, - "Role": { - "description": "Reference to a Role resource company member should be given.", - "$ref": "#/components/schemas/BaseObject" - }, - "fields": { - "type": "object", - "required": [ - "field" - ], - "properties": { - "field": { - "description": "Fields of a Member content item.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Field" - } - } - } } } }, - "MemberUpdateWrapper": { + "CustomPriceUpdateStructWrapper": { "type": "object", "required": [ - "MemberUpdate" + "CustomPriceUpdateStruct" ], "properties": { - "MemberUpdate": { - "$ref": "#/components/schemas/MemberUpdate" + "CustomPriceUpdateStruct": { + "$ref": "#/components/schemas/CustomPriceUpdateStruct" } } }, - "MemberList": { - "description": "This class represents a list of company members.", + "PriceUpdateStruct": { + "description": "This class represents a price updating structure.", "type": "object", "required": [ - "members" + "amount", + "currency" ], "properties": { - "members": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Member" - } + "amount": { + "type": "integer" + }, + "currency": { + "type": "string" } } }, - "MemberListWrapper": { + "PriceUpdateStructWrapper": { "type": "object", "required": [ - "MemberList" + "PriceUpdateStruct" ], "properties": { - "MemberList": { - "$ref": "#/components/schemas/MemberList" + "PriceUpdateStruct": { + "$ref": "#/components/schemas/PriceUpdateStruct" } } }, - "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" - } - } + "PriceList": { + "description": "This class represents a price list.", + "type": "object", + "required": [ + "prices" + ], + "properties": { + "prices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" } } - ] + } }, - "SalesRepresentativesListWrapper": { + "PriceListWrapper": { "type": "object", "required": [ - "SalesRepresentativesList" + "PriceList" ], "properties": { - "SalesRepresentativesList": { - "$ref": "#/components/schemas/SalesRepresentativesList" + "PriceList": { + "$ref": "#/components/schemas/PriceList" } } }, - "BillingAddress": { + "Thumbnail": { + "description": "This class represents a thumbnail that can be a target URL or a Base64 data.", "type": "object", "required": [ - "name", - "country", - "fields" + "resource", + "width", + "height", + "mimeType" ], "properties": { - "name": { + "resource": { + "type": "string" + }, + "width": { "type": [ - "string", + "integer", "null" ] }, - "country": { + "height": { "type": [ - "string", + "integer", "null" ] }, - "fields": { - "type": [ - "object", - "array" - ] + "mimeType": { + "type": "string" } } }, - "ActivityLog": { - "description": "This class represents an activity log entry.", - "type": "object" - }, - "ActivityLogGroup": { + "VatCategory": { + "description": "This class represents a VAT category.", "type": "object", "required": [ - "user_id", - "logged_at", - "ActivityLogEntries" + "identifier", + "region", + "vatValue" ], "properties": { - "user_id": { - "description": "The ID of the user performing the logged actions", - "type": "integer" + "identifier": { + "type": "string" }, - "logged_at": { - "description": "Timestamp representing when the group has been logged", - "type": "integer" + "region": { + "type": "string" }, - "ActivityLogEntries": { - "description": "Log entries from the group", - "type": "array", - "items": { - "$ref": "#/components/schemas/ActivityLog" - } + "vatValue": { + "type": [ + "number", + "null" + ] } } }, - "ActivityLogGroupListInput": { - "description": "This class represents the activity log group search query's criteria and sort clauses.", + "VatCategoryWrapper": { "type": "object", + "required": [ + "VatCategory" + ], "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" - ] - } - } - } + "VatCategory": { + "$ref": "#/components/schemas/VatCategory" } } }, - "ActivityLogGroupListInputWrapper": { + "VatCategoryList": { + "description": "This class represents a VAT category list.", "type": "object", "required": [ - "ActivityLogGroupListInput" + "VatCategory" ], "properties": { - "ActivityLogGroupListInput": { - "$ref": "#/components/schemas/ActivityLogGroupListInput" + "VatCategory": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VatCategory" + } } } }, - "ActivityLogGroupList": { - "description": "This class represents activity log context groups", + "VatCategoryListWrapper": { "type": "object", "required": [ - "ActivityLogGroups" + "VatCategoryList" ], "properties": { - "ActivityLogGroups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ActivityLogGroup" - } + "VatCategoryList": { + "$ref": "#/components/schemas/VatCategoryList" } } }, - "ActivityLogGroupListWrapper": { + "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": [ - "ActivityLogGroupList" + "TaxonomyEntry" ], "properties": { - "ActivityLogGroupList": { - "$ref": "#/components/schemas/ActivityLogGroupList" + "TaxonomyEntry": { + "$ref": "#/components/schemas/TaxonomyEntry" } } }, - "Cart": { - "description": "This class represents a Cart", + "TaxonomyEntryBulkRemove": { + "description": "This class is used to bulk remove taxonomy entries.", "type": "object", "required": [ - "id", - "identifier", - "owner", - "Currency", "entries" ], "properties": { - "id": { - "description": "Cart ID", - "type": "integer" - }, - "identifier": { - "description": "Cart unique identifier", - "type": "string" - }, - "owner": { - "description": "User reference", - "$ref": "#/components/schemas/Ref" - }, - "Currency": { - "$ref": "#/components/schemas/Currency" - }, "entries": { "type": "array", "items": { - "$ref": "#/components/schemas/CartEntry" + "type": "integer" } } } }, - "CartWrapper": { + "TaxonomyEntryBulkRemoveWrapper": { "type": "object", "required": [ - "Cart" + "TaxonomyEntryBulkRemove" ], "properties": { - "Cart": { - "$ref": "#/components/schemas/Cart" + "TaxonomyEntryBulkRemove": { + "$ref": "#/components/schemas/TaxonomyEntryBulkRemove" } } }, - "CartCreate": { - "description": "This class represents a new Cart to create", + "TaxonomyEntryMove": { "type": "object", "required": [ - "name", - "currencyCode" + "entry", + "sibling", + "position" ], "properties": { - "name": { - "description": "the name of the new Cart", - "type": "string" + "entry": { + "type": "integer" }, - "currencyCode": { - "description": "the currency code such as `EUR`", - "type": "string" + "sibling": { + "type": "integer" }, - "context": { - "description": "associative array of scalars describing additional, contextual data attached to the cart", - "type": "object" + "position": { + "type": "string" } } }, - "CartCreateWrapper": { + "TaxonomyEntryBulkMove": { + "description": "This class is used to bulk move taxonomy entries.", "type": "object", "required": [ - "CartCreate" + "entries" ], "properties": { - "CartCreate": { - "$ref": "#/components/schemas/CartCreate" + "entries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxonomyEntryMove" + } } } }, - "CartProduct": { - "description": "This class represents a cart entry product", + "TaxonomyEntryBulkMoveWrapper": { "type": "object", "required": [ - "code" + "TaxonomyEntryBulkMove" ], "properties": { - "code": { - "description": "product's code", - "type": "string" + "TaxonomyEntryBulkMove": { + "$ref": "#/components/schemas/TaxonomyEntryBulkMove" } } }, - "CartView": { - "description": "This class represents a cart view.", + "TaxonomyEntryAssignment": { + "description": "This class represents a taxonomy entry assignment.", "type": "object", "required": [ - "identifier", - "Result" + "id", + "content", + "entry" ], "properties": { - "identifier": { - "type": "string" + "id": { + "type": "integer" }, - "Result": { - "$ref": "#/components/schemas/CartListViewResult" + "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" + } + } + } + ] } } }, - "CartViewWrapper": { + "TaxonomyEntryAssignmentWrapper": { "type": "object", "required": [ - "CartView" + "TaxonomyEntryAssignment" ], "properties": { - "CartView": { - "$ref": "#/components/schemas/CartView" + "TaxonomyEntryAssignment": { + "$ref": "#/components/schemas/TaxonomyEntryAssignment" } } }, - "CartViewInput": { - "description": "This class represents a cart view input.", + "TaxonomyEntryAssignToContent": { + "description": "This class is used to assign taxonomy entry to content.", "type": "object", "required": [ - "identifier", - "CartQuery" + "content", + "entries" ], "properties": { - "identifier": { - "type": "string" + "content": { + "type": "integer" }, - "CartQuery": { - "$ref": "#/components/schemas/CartViewInput" + "entries": { + "type": "array", + "items": { + "type": "integer" + } } } }, - "CartViewInputWrapper": { + "TaxonomyEntryAssignToContentWrapper": { "type": "object", "required": [ - "CartViewInput" + "TaxonomyEntryAssignToContent" ], "properties": { - "CartViewInput": { - "$ref": "#/components/schemas/CartViewInput" + "TaxonomyEntryAssignToContent": { + "$ref": "#/components/schemas/TaxonomyEntryAssignToContent" } } }, - "CartQuery": { + "TaxonomyEntryUnassignFromContent": { + "description": "This class is used to unassign taxonomy entry from content.", "type": "object", "required": [ - "offset", - "limit", - "ownerId" + "content", + "entries" ], "properties": { - "offset": { - "type": "integer" - }, - "limit": { + "content": { "type": "integer" }, - "ownerId": { - "type": "integer" + "entries": { + "type": "array", + "items": { + "type": "integer" + } } } }, - "CartEntry": { + "TaxonomyEntryUnassignFromContentWrapper": { "type": "object", "required": [ - "identifier", - "id", - "names", - "quantity", - "Price" + "TaxonomyEntryUnassignFromContent" ], "properties": { - "identifier": { - "type": "string" - }, - "id": { - "type": "integer" + "TaxonomyEntryUnassignFromContent": { + "$ref": "#/components/schemas/TaxonomyEntryUnassignFromContent" + } + } + }, + "EntryAssignmentCollection": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "names": { - "type": "array", - "items": { - "type": "object" + { + "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" + } + } } - }, - "quantity": { - "type": "integer" - }, - "Price": { - "$ref": "#/components/schemas/Price" } - } + ] }, - "CartEntryAdd": { - "description": "This class represents a cart entry", + "EntryAssignmentCollectionWrapper": { "type": "object", "required": [ - "quantity", - "Product" + "EntryAssignmentCollection" ], "properties": { - "quantity": { - "description": "the quantity of entry items", - "type": "integer" - }, - "Product": { - "description": "product data" - }, - "context": { - "description": "associative array of scalars describing additional, contextual data attached to the cart entry", - "type": "object" + "EntryAssignmentCollection": { + "$ref": "#/components/schemas/EntryAssignmentCollection" } } }, - "CartEntryAddWrapper": { + "BulkTranslationSetupSectionInput": { "type": "object", - "required": [ - "CartEntryAdd" - ], "properties": { - "CartEntryAdd": { - "$ref": "#/components/schemas/CartEntryAdd" + "search": { + "type": "string", + "default": "" + }, + "contentType": { + "type": "string", + "default": "" + }, + "page": { + "type": "integer", + "minimum": 1, + "default": 1 } } }, - "CartEntryUpdate": { + "BulkTranslationSetupActionResource": { "type": "object", "required": [ - "quantity" + "href", + "method", + "enabled" ], "properties": { - "quantity": { - "type": "integer" + "href": { + "type": "string" }, - "context": { - "description": "associative array of scalars describing additional, contextual data attached to the cart entry", - "type": "object" + "method": { + "type": "string" + }, + "enabled": { + "type": "boolean" } } }, - "CartEntryUpdateWrapper": { + "BulkTranslationSetupLanguageChoiceResource": { "type": "object", "required": [ - "CartEntryUpdate" + "code", + "name" ], "properties": { - "CartEntryUpdate": { - "$ref": "#/components/schemas/CartEntryUpdate" + "code": { + "type": "string" + }, + "name": { + "type": "string" } } }, - "CartMetadataUpdate": { - "description": "This class represents the update of cart metadata.", + "BulkTranslationSetupProviderChoiceResource": { "type": "object", "required": [ "identifier", - "defaultLanguageCode", - "names", - "descriptions" + "name" ], "properties": { "identifier": { "type": "string" }, - "defaultLanguageCode": { + "name": { "type": "string" - }, - "names": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Value" - } - }, - "descriptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Value" - } } } }, - "CartMetadataUpdateWrapper": { + "BulkTranslationSetupContentTypeChoiceResource": { "type": "object", "required": [ - "CartMetadataUpdate" + "identifier", + "name" ], "properties": { - "CartMetadataUpdate": { - "$ref": "#/components/schemas/CartMetadataUpdate" + "identifier": { + "type": "string" + }, + "name": { + "type": "string" } } }, - "CartSummary": { - "description": "This class represents a cart summary.", + "BulkTranslationSetupRowResource": { "type": "object", "required": [ "id", - "identifier", "name", - "createdAt", - "updatedAt", - "Owner", - "SummaryEntryCollection", - "TotalPrice", - "TotalPriceInclVat", - "vatCategorySummary", - "Currency" + "contentTypeIdentifier", + "contentTypeName", + "duplicated" ], "properties": { "id": { "type": "integer" }, - "identifier": { - "type": "string" - }, "name": { "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time" - }, - "updatedAt": { - "type": "string", - "format": "date-time" - }, - "Owner": { - "$ref": "#/components/schemas/Ref" + "contentTypeIdentifier": { + "type": "string" }, - "SummaryEntryCollection": { - "$ref": "#/components/schemas/SummaryEntryCollection" + "contentTypeName": { + "type": "string" }, - "TotalPrice": { - "$ref": "#/components/schemas/RestPriceWrapper" + "duplicated": { + "type": "boolean" + } + } + }, + "BulkTranslationSetupFiltersResource": { + "type": "object", + "required": [ + "search", + "contentType", + "contentTypeChoices" + ], + "properties": { + "search": { + "type": "string" }, - "TotalPriceInclVat": { - "$ref": "#/components/schemas/RestPriceWrapper" + "contentType": { + "type": "string" }, - "vatCategorySummary": { + "contentTypeChoices": { "type": "array", "items": { - "$ref": "#/components/schemas/VatCategorySummary" + "$ref": "#/components/schemas/BulkTranslationSetupContentTypeChoiceResource" } - }, - "Currency": { - "$ref": "#/components/schemas/Currency" } } }, - "CartSummaryWrapper": { + "BulkTranslationSetupPaginationResource": { "type": "object", "required": [ - "CartSummary" + "page", + "pageSize", + "totalPages" ], "properties": { - "CartSummary": { - "$ref": "#/components/schemas/CartSummary" + "page": { + "type": "integer" + }, + "pageSize": { + "type": "integer" + }, + "totalPages": { + "type": "integer" } } }, - "CartListViewResult": { + "BulkTranslationSetupSectionResource": { "type": "object", "required": [ "count", - "Result" + "rows", + "filters", + "pagination" ], "properties": { "count": { "type": "integer" }, - "Result": { - "$ref": "#/components/schemas/CartList" + "rows": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BulkTranslationSetupRowResource" + } + }, + "filters": { + "$ref": "#/components/schemas/BulkTranslationSetupFiltersResource" + }, + "pagination": { + "$ref": "#/components/schemas/BulkTranslationSetupPaginationResource" } } }, - "SummaryEntryCollection": { - "description": "This class represents a summary entry collection.", + "BulkTranslationSetupSectionsResource": { "type": "object", "required": [ - "count", - "SummaryEntry" + "duplicates", + "items" ], "properties": { - "count": { - "type": "string" + "duplicates": { + "$ref": "#/components/schemas/BulkTranslationSetupSectionResource" }, - "SummaryEntry": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SummaryEntry" - } + "items": { + "$ref": "#/components/schemas/BulkTranslationSetupSectionResource" } } }, - "ShoppingListEntryIdentifiers": { - "description": "This class represents a list of shopping list entry identifiers to add to cart", + "BulkTranslationSetupConfigurationResource": { "type": "object", "required": [ - "entries" + "sourceLanguage", + "sourceLanguageChoices", + "targetLanguage", + "targetLanguageChoices", + "provider", + "providerChoices" ], "properties": { - "entries": { - "description": "Array of entry identifiers", + "sourceLanguage": { + "type": "string" + }, + "sourceLanguageChoices": { "type": "array", "items": { - "type": "object", - "required": [ - "identifier" - ], - "properties": { - "identifier": { - "description": "Entry identifier", - "type": "string" - } - } + "$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" } } } }, - "ShoppingListEntryIdentifiersWrapper": { + "BulkTranslationSetupSummaryResource": { "type": "object", "required": [ - "ShoppingListEntryIdentifiers" + "totalItems", + "duplicates", + "itemsToTranslate" ], "properties": { - "ShoppingListEntryIdentifiers": { - "$ref": "#/components/schemas/ShoppingListEntryIdentifiers" + "totalItems": { + "type": "integer" + }, + "duplicates": { + "type": "integer" + }, + "itemsToTranslate": { + "type": "integer" } } }, - "CartEntryIdentifiers": { - "description": "This class represents a list of cart entry identifiers", + "BulkTranslationSetupSelectionResource": { "type": "object", "required": [ - "entries" + "selectedContentIds" ], "properties": { - "entries": { - "description": "Array of entry identifiers", + "selectedContentIds": { "type": "array", "items": { - "type": "object", - "required": [ - "identifier" - ], - "properties": { - "identifier": { - "description": "Entry identifier", - "type": "string" - } - } + "type": "integer" } } } }, - "CartEntryIdentifiersWrapper": { + "BulkTranslationSetupActionsResource": { "type": "object", "required": [ - "CartEntryIdentifiers" + "start" ], "properties": { - "CartEntryIdentifiers": { - "$ref": "#/components/schemas/CartEntryIdentifiers" + "start": { + "$ref": "#/components/schemas/BulkTranslationSetupActionResource" } } }, - "TimezoneDate": { + "BulkTranslationSetupResource": { "type": "object", "required": [ - "date", - "timezone_type", - "timezone" + "configuration", + "summary", + "sections", + "selection", + "actions" ], "properties": { - "date": { - "type": "string" + "configuration": { + "$ref": "#/components/schemas/BulkTranslationSetupConfigurationResource" }, - "timezone_type": { - "type": "integer" + "summary": { + "$ref": "#/components/schemas/BulkTranslationSetupSummaryResource" }, - "timezone": { - "type": "string" + "sections": { + "$ref": "#/components/schemas/BulkTranslationSetupSectionsResource" + }, + "selection": { + "$ref": "#/components/schemas/BulkTranslationSetupSelectionResource" + }, + "actions": { + "$ref": "#/components/schemas/BulkTranslationSetupActionsResource" } } }, - "Order": { - "description": "This class represents order.", + "MissingTranslationsRowResource": { "type": "object", "required": [ - "id", - "identifier", - "created", - "modified", - "status", - "OrderUser", - "OrderCurrency", - "OrderValue", - "OrderItemsList", - "context" + "contentId", + "name", + "contentTypeIdentifier", + "contentTypeName", + "missingLanguages" ], "properties": { - "id": { + "contentId": { "type": "integer" }, - "identifier": { + "name": { "type": "string" }, - "created": { - "$ref": "#/components/schemas/TimezoneDate" - }, - "modified": { - "$ref": "#/components/schemas/TimezoneDate" - }, - "status": { + "contentTypeIdentifier": { "type": "string" }, - "source": { + "contentTypeName": { "type": "string" }, - "OrderUser": { - "$ref": "#/components/schemas/OrderUser" - }, - "OrderCurrency": { - "$ref": "#/components/schemas/OrderCurrency" - }, - "OrderValue": { - "$ref": "#/components/schemas/OrderValue" - }, - "OrderCompany": { - "$ref": "#/components/schemas/OrderCompany" - }, - "OrderItemsList": { + "missingLanguages": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderItem" + "type": "string" } }, - "context": { - "type": "object" - } - } - }, - "OrderWrapper": { - "type": "object", - "required": [ - "Order" - ], - "properties": { - "Order": { - "$ref": "#/components/schemas/Order" + "mainLocationId": { + "type": "integer", + "nullable": true } } }, - "OrderList": { - "description": "This class represents an orders list.", + "MissingTranslationsResource": { "type": "object", "required": [ - "Order" + "totalCount", + "page", + "limit", + "rows" ], "properties": { - "Order": { + "totalCount": { + "type": "integer" + }, + "page": { + "type": "integer" + }, + "limit": { + "type": "integer" + }, + "rows": { "type": "array", "items": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/MissingTranslationsRowResource" } } } }, - "OrderListWrapper": { + "MissingTranslationIdsResource": { "type": "object", "required": [ - "OrderList" + "ids", + "returnedCount", + "totalCount", + "limited" ], "properties": { - "OrderList": { - "$ref": "#/components/schemas/OrderList" + "ids": { + "type": "array", + "items": { + "type": "integer" + } + }, + "returnedCount": { + "type": "integer" + }, + "totalCount": { + "type": "integer" + }, + "limited": { + "type": "boolean" } } }, - "OrderUser": { - "description": "This class represents order user.", + "BulkTranslationContextResource": { "type": "object", "required": [ - "id", - "name", - "email" + "jobItemId", + "jobId", + "jobItemStatus", + "jobCreatorId" ], "properties": { - "id": { - "type": [ - "null", - "integer" - ] + "jobItemId": { + "type": "integer" }, - "name": { - "type": "string" + "jobId": { + "type": "integer" }, - "email": { + "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." } } }, - "OrderCurrency": { - "description": "This class represents order currency.", + "ReviewItemRowResource": { "type": "object", "required": [ - "id", - "code" + "autoTranslationId", + "contentId", + "versionNo", + "sourceLanguageCode", + "targetLanguageCode", + "providerIdentifier", + "reviewStatus", + "origin" ], "properties": { - "id": { + "autoTranslationId": { "type": "integer" }, - "code": { + "contentId": { + "type": "integer" + }, + "contentName": { + "type": "string", + "nullable": true + }, + "contentTypeIdentifier": { + "type": "string", + "nullable": true + }, + "versionNo": { + "type": "integer" + }, + "sourceLanguageCode": { "type": "string" - } - } - }, - "OrderValue": { - "description": "This class represents order value.", - "type": "object", - "required": [ - "vat", - "total_gross", - "total_net" - ], - "properties": { - "vat": { - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/OrderPrice" - } - ] }, - "total_gross": { - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/OrderPrice" - } + "targetLanguageCode": { + "type": "string" + }, + "providerIdentifier": { + "type": "string" + }, + "reviewStatus": { + "type": "string" + }, + "origin": { + "type": "string", + "enum": [ + "bulk", + "individual" ] }, - "total_net": { - "oneOf": [ - { - "type": "string" - }, + "bulkContext": { + "nullable": true, + "allOf": [ { - "$ref": "#/components/schemas/OrderPrice" + "$ref": "#/components/schemas/BulkTranslationContextResource" } ] } } }, - "OrderCompany": { - "description": "This class represents order company.", + "ForReviewResource": { "type": "object", "required": [ - "id", - "name" + "totalCount", + "page", + "limit", + "rows" ], "properties": { - "id": { + "totalCount": { "type": "integer" }, - "name": { - "type": "string" - } - } - }, - "OrderPrice": { - "type": "object", - "required": [ - "amount", - "currency" - ], - "properties": { - "amount": { - "type": "string" + "page": { + "type": "integer" }, - "currency": { - "type": "string" + "limit": { + "type": "integer" + }, + "rows": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReviewItemRowResource" + } } } }, - "OrderCreate": { - "description": "This class is used to create order.", + "TranslatedResource": { "type": "object", "required": [ - "source", - "OrderUser", - "OrderCurrency", - "OrderValue", - "OrderCompany", - "items" + "totalCount", + "page", + "limit", + "rows" ], "properties": { - "source": { - "type": "string" - }, - "OrderUser": { - "$ref": "#/components/schemas/OrderUser" - }, - "OrderCurrency": { - "$ref": "#/components/schemas/OrderCurrency" + "totalCount": { + "type": "integer" }, - "OrderValue": { - "$ref": "#/components/schemas/OrderValue" + "page": { + "type": "integer" }, - "OrderCompany": { - "$ref": "#/components/schemas/OrderCompany" + "limit": { + "type": "integer" }, - "items": { + "rows": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderItemWrapper" + "$ref": "#/components/schemas/ReviewItemRowResource" } } } }, - "OrderCreateWrapper": { - "type": "object", - "required": [ - "OrderCreate" - ], - "properties": { - "OrderCreate": { - "$ref": "#/components/schemas/OrderCreate" - } - } - }, - "OrderItem": { - "description": "This class represents order item.", + "BulkTranslationStartResource": { "type": "object", "required": [ - "OrderItemValue", - "OrderItemProduct" + "started", + "totalItems", + "requestedCount", + "acceptedCount", + "skippedCount" ], "properties": { - "OrderItemValue": { - "$ref": "#/components/schemas/OrderItemValue" + "started": { + "type": "boolean" }, - "OrderItemProduct": { - "$ref": "#/components/schemas/OrderItemProduct" + "jobId": { + "type": "integer", + "nullable": true }, - "quantity": { + "totalItems": { "type": "integer" }, - "context": { - "type": "object" - } - } - }, - "OrderItemWrapper": { - "type": "object", - "required": [ - "OrderItem" - ], - "properties": { - "OrderItem": { - "$ref": "#/components/schemas/OrderItem" + "requestedCount": { + "type": "integer" + }, + "acceptedCount": { + "type": "integer" + }, + "skippedCount": { + "type": "integer" } } }, - "OrderItemValue": { - "description": "This class represents order item value.", + "HistoryRowResource": { "type": "object", "required": [ - "unit_price_gross", - "unit_price_net", - "vat_rate", - "subtotal_price_gross", - "subtotal_price_net" + "id", + "title", + "createdAt", + "targetLanguageCodes", + "creatorId", + "status", + "totalItems", + "successfulItems", + "reviewItems", + "failedItems" ], "properties": { - "unit_price_gross": { - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/OrderPrice" - } - ] + "id": { + "type": "integer" }, - "unit_price_net": { - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/OrderPrice" - } - ] + "title": { + "type": "string", + "description": "The job title, or a \"#\" label when the job was created without one." }, - "vat_rate": { - "type": "string" + "createdAt": { + "type": "string", + "format": "date-time" }, - "subtotal_price_gross": { - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/OrderPrice" - } - ] + "targetLanguageCodes": { + "type": "array", + "items": { + "type": "string" + } }, - "subtotal_price_net": { - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/OrderPrice" - } + "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" } } }, - "OrderItemProduct": { - "description": "This class represents order item product.", + "HistoryCreatorChoiceResource": { "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.", + "HistoryResource": { "type": "object", "required": [ - "status", - "transition" + "totalCount", + "page", + "limit", + "rows", + "creatorChoices" ], "properties": { - "status": { - "type": "string" + "totalCount": { + "type": "integer" }, - "transition": { + "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" + } } } }, - "OrderUpdateWrapper": { + "PageStructureWrapper": { "type": "object", "required": [ - "OrderUpdate" + "PageStructure" ], "properties": { - "OrderUpdate": { - "$ref": "#/components/schemas/OrderUpdate" + "PageStructure": { + "$ref": "#/components/schemas/PageStructure" } } }, - "PaymentMethod": { + "PageStructureLayout": { + "description": "Page layout, together with the zones it is divided into.", "type": "object", "required": [ - "id", + "_media-type", "identifier", - "enabled", "name", - "description" + "description", + "zones" ], "properties": { - "id": { - "type": "integer" + "_media-type": { + "type": "string" }, "identifier": { + "description": "Unique layout identifier, as used in configuration.", "type": "string" }, - "enabled": { - "type": "boolean" - }, "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" + } } } }, - "PaymentMethodWrapper": { + "PageStructureZone": { + "description": "Zone of a Page layout.", "type": "object", "required": [ - "PaymentMethod" + "_media-type", + "identifier", + "name", + "description" ], "properties": { - "PaymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "_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" } } }, - "PaymentMethodCreateStruct": { + "PageStructureBlock": { + "description": "Page block, together with its views and attributes.", "type": "object", "required": [ + "_media-type", "identifier", - "type", - "names" + "name", + "description", + "category", + "views", + "attributes" ], "properties": { + "_media-type": { + "type": "string" + }, "identifier": { + "description": "Unique block identifier, as used in configuration.", "type": "string" }, - "type": { + "name": { + "description": "Human-readable block name.", "type": "string" }, - "names": { - "description": "If set this array of names with languageCode keys replace the complete name collection.", - "type": "object" + "description": { + "description": "Human-readable block description. Empty string when the block declares no description.", + "type": "string" }, - "descriptions": { - "description": "An array of descriptions with languageCode keys.", + "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": { - "type": "string" + "$ref": "#/components/schemas/PageStructureView" } }, - "enabled": { - "type": "boolean" - }, - "options": { - "type": "object" + "attributes": { + "description": "Attributes the block accepts.", + "type": "array", + "items": { + "$ref": "#/components/schemas/PageStructureAttribute" + } } } }, - "PaymentMethodCreateStructWrapper": { + "PageStructureView": { + "description": "View a Page block can be rendered with.", "type": "object", "required": [ - "PaymentMethodCreateStruct" + "_media-type", + "identifier", + "name", + "description" ], "properties": { - "PaymentMethodCreateStruct": { - "$ref": "#/components/schemas/PaymentMethodCreateStruct" + "_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" } } }, - "PaymentMethodUpdateStruct": { + "PageStructureAttribute": { + "description": "Attribute of a Page block.", "type": "object", + "required": [ + "_media-type", + "identifier", + "name", + "type", + "category", + "options" + ], "properties": { + "_media-type": { + "type": "string" + }, "identifier": { + "description": "Unique attribute identifier within its block.", "type": "string" }, - "names": { - "description": "If set this array of names with languageCode keys replace the complete name collection.", - "type": "object" + "name": { + "description": "Human-readable attribute name.", + "type": "string" }, - "descriptions": { - "description": "An array of descriptions with languageCode keys.", - "type": "array", - "items": { - "type": "string" - } + "type": { + "description": "Identifier of the attribute type, which determines how the value is edited and stored.", + "type": "string" }, - "enabled": { - "type": "boolean" + "category": { + "description": "Identifier of the category the attribute is grouped under in the block edit form.", + "type": "string" }, "options": { - "type": "array", - "items": { - "type": [] - } + "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", + "additionalProperties": true } } }, - "PaymentMethodUpdateStructWrapper": { + "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": [ - "PaymentMethodUpdateStructParser" + "Segment" ], "properties": { - "PaymentMethodUpdateStructParser": { - "$ref": "#/components/schemas/PaymentMethodUpdateStruct" + "Segment": { + "$ref": "#/components/schemas/Segment" } } }, - "PaymentMethodView": { + "SegmentList": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + }, + { + "description": "This class lists segments.", + "type": "object", + "required": [ + "Segment" + ], + "properties": { + "Segment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Segment" + } + } + } + } + ] + }, + "SegmentListWrapper": { "type": "object", "required": [ - "identifier", - "Result" + "SegmentList" ], "properties": { - "identifier": { - "type": "string" - }, - "Result": { - "$ref": "#/components/schemas/PaymentMethodList" + "SegmentList": { + "$ref": "#/components/schemas/SegmentList" } } }, - "PaymentMethodViewWrapper": { + "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", "required": [ - "PaymentMethodView" + "createGroup" ], "properties": { - "PaymentMethodView": { - "$ref": "#/components/schemas/PaymentMethodView" + "createGroup": { + "description": "Whether the current user is allowed to create segment groups.", + "type": "boolean" } } }, - "PaymentMethodViewInput": { + "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", "required": [ - "identifier", - "PaymentMethodQuery" + "update", + "delete", + "createSegment" ], "properties": { - "identifier": { - "type": "string" + "update": { + "description": "Whether the current user is allowed to update the segment group.", + "type": "boolean" }, - "PaymentMethodQuery": { - "type": "object" + "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" } } }, - "PaymentMethodViewInputWrapper": { + "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", "required": [ - "PaymentMethodViewInput" + "update", + "delete" ], "properties": { - "PaymentMethodViewInput": { - "$ref": "#/components/schemas/PaymentMethodViewInput" + "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" } } }, - "PaymentMethodList": { + "SegmentViewGroupInfo": { + "description": "This class represents a segment group within the segment view.", "type": "object", "required": [ - "count", - "PaymentMethodList" + "id", + "identifier", + "name", + "permissions" ], "properties": { - "count": { + "id": { "type": "integer" }, - "PaymentMethodList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentMethod" - } + "identifier": { + "type": "string" + }, + "name": { + "type": "string" + }, + "permissions": { + "$ref": "#/components/schemas/SegmentViewGroupPermissions" } } }, - "Shipment": { - "description": "This class represents a single shipment.", + "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", - "status", - "transitions", - "Order", - "Amount", - "createdAt", - "updatedAt", - "Owner", - "Method" + "name", + "source", + "blocksCount", + "permissions" ], "properties": { "id": { @@ -52912,1021 +44406,957 @@ "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" + "source": { + "type": "string" }, - "Amount": { - "type": "object", - "required": [ - "value", - "currency" - ], - "properties": { - "value": { - "type": "string" - }, - "currency": { - "type": "string" - } - } + "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", + "nullable": true }, - "createdAt": { + "lastUpdatedBy": { "type": "string", - "format": "date-time" + "nullable": true }, "updatedAt": { "type": "string", - "format": "date-time" + "format": "date-time", + "nullable": true }, - "Owner": { - "$ref": "#/components/schemas/Ref" + "lastUpdatedByLabel": { + "type": "string", + "nullable": true }, - "Method": { - "$ref": "#/components/schemas/Ref" - } - } - }, - "ShipmentWrapper": { - "type": "object", - "required": [ - "Shipment" - ], - "properties": { - "Shipment": { - "$ref": "#/components/schemas/Shipment" + "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" } } }, - "ShipmentRefList": { - "description": "This class represents a list of Shipments", + "SegmentViewGroupSegments": { + "description": "This class represents a segment group together with its segments.", "type": "object", "required": [ - "shipmentRefList" + "group", + "segments" ], "properties": { - "shipmentRefList": { + "group": { + "$ref": "#/components/schemas/SegmentViewGroupInfo" + }, + "segments": { "type": "array", "items": { - "$ref": "#/components/schemas/Ref" + "$ref": "#/components/schemas/SegmentViewSegment" } } } }, - "ShipmentRefListWrapper": { - "type": "object", - "required": [ - "ShipmentRefList" - ], - "properties": { - "ShipmentRefList": { - "$ref": "#/components/schemas/ShipmentRefList" - } - } - }, - "ShipmentUpdate": { - "description": "This class represents the update of a shipment.", + "SegmentViewGroupFilterOption": { + "description": "This class represents a segment group filter value with its segment count.", "type": "object", "required": [ + "id", "identifier", - "transition", - "Owner", - "Context" + "name", + "count" ], "properties": { + "id": { + "type": "integer" + }, "identifier": { "type": "string" }, - "transition": { + "name": { "type": "string" }, - "Owner": { - "$ref": "#/components/schemas/Ref" - }, - "Context": { - "type": "object" + "count": { + "type": "integer" } } }, - "ShipmentUpdateWrapper": { + "SegmentViewSourceFilterOption": { + "description": "This class represents a segment source filter value with its segment count.", "type": "object", "required": [ - "ShipmentUpdate" + "value", + "count" ], "properties": { - "ShipmentUpdate": { - "$ref": "#/components/schemas/ShipmentUpdate" + "value": { + "type": "string" + }, + "count": { + "type": "integer" } } }, - "ShipmentCreate": { - "description": "This class represents the creation of a shipment.", + "SegmentViewMetadataFilterOption": { + "description": "This class represents a segment metadata value with its segment count.", "type": "object", "required": [ - "identifier", - "ShippingMethod", - "Owner", - "Context" + "value", + "count" ], "properties": { - "identifier": { + "value": { "type": "string" }, - "ShippingMethod": { - "$ref": "#/components/schemas/Ref" - }, - "Owner": { - "$ref": "#/components/schemas/Ref" - }, - "Context": { - "type": "object" + "count": { + "type": "integer" } } }, - "ShipmentCreateWrapper": { + "SegmentViewFilters": { + "description": "This class represents the available filter options of the segment view.", "type": "object", "required": [ - "ShipmentCreate" + "groups", + "source", + "metadata" ], "properties": { - "ShipmentCreate": { - "$ref": "#/components/schemas/ShipmentCreate" + "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" + } + } } } }, - "ShippingMethod": { - "description": "This class represents a shipping method.", + "SegmentView": { + "description": "This class lists segments grouped by their segment groups, with available filter values.", "type": "object", "required": [ - "identifier", - "name", - "names", - "description", - "descriptions", - "enabled", - "options", - "regions", - "type" + "totalCount", + "permissions", + "filters", + "groups" ], "properties": { - "identifier": { - "type": "string" - }, - "name": { - "type": "string" + "totalCount": { + "type": "integer" }, - "names": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MultilingualValue" - } - } - } + "permissions": { + "$ref": "#/components/schemas/SegmentViewPermissions" }, - "description": { - "type": "string" + "filters": { + "$ref": "#/components/schemas/SegmentViewFilters" }, - "descriptions": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MultilingualValue" - } - } + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SegmentViewGroupSegments" } + } + } + }, + "SegmentGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "enabled": { - "type": "boolean" - }, - "options": { + { + "description": "This class represents a segment group.", "type": "object", "required": [ - "option" + "id", + "identifier", + "name" ], "properties": { - "option": { - "type": "array", - "items": { - "$ref": "#/components/schemas/KeyValue" - } + "id": { + "type": "integer" + }, + "identifier": { + "type": "string" + }, + "name": { + "type": "string" } } + } + ] + }, + "SegmentGroupWrapper": { + "type": "object", + "required": [ + "SegmentGroup" + ], + "properties": { + "SegmentGroup": { + "$ref": "#/components/schemas/SegmentGroup" + } + } + }, + "SegmentGroupList": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "regions": { + { + "description": "This class lists segment groups.", "type": "object", "required": [ - "RegionRefList" + "SegmentGroup" ], "properties": { - "RegionRefList": { + "SegmentGroup": { "type": "array", "items": { - "$ref": "#/components/schemas/Ref" + "$ref": "#/components/schemas/SegmentGroup" } } } - }, - "type": { - "$ref": "#/components/schemas/Ref" } - } + ] }, - "ShippingMethodWrapper": { + "SegmentGroupListWrapper": { "type": "object", "required": [ - "ShippingMethod" + "SegmentGroupList" ], "properties": { - "ShippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "SegmentGroupList": { + "$ref": "#/components/schemas/SegmentGroupList" + } + } + }, + "UserSegment": { + "description": "This class represents a segment and a user it's associate to.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "identifier": { + "type": "string" + }, + "name": { + "type": "string" + }, + "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" } } }, - "ShippingMethodType": { - "description": "This class represents a shipping method type.", - "type": "object", - "required": [ - "identifier", - "name" - ], - "properties": { - "identifier": { - "type": "string" + "UserSegmentList": { + "description": "this class lists segments associated to users.", + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "name": { - "type": "string" + { + "type": "object", + "properties": { + "UserSegment": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserSegment" + } + } + } } - } + ] }, - "ShippingMethodTypeWrapper": { + "UserSegmentListWrapper": { "type": "object", "required": [ - "ShippingMethodType" + "UserSegmentList" ], "properties": { - "ShippingMethodType": { - "$ref": "#/components/schemas/ShippingMethodType" + "UserSegmentList": { + "$ref": "#/components/schemas/SegmentList" } } }, - "ShippingMethodTypesList": { - "description": "This class represents a list of shipping method types.", + "UserSegmentAssignInput": { "type": "object", - "required": [ - "ShippingMethodTypes" - ], "properties": { - "ShippingMethodTypes": { + "segments": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodType" + "type": "string" } } } }, - "ShippingMethodTypesListWrapper": { + "UserSegmentAssignInputWrapper": { "type": "object", "required": [ - "ShippingMethodTypesList" + "UserSegmentAssignInput" ], "properties": { - "ShippingMethodTypesList": { - "$ref": "#/components/schemas/ShippingMethodTypesList" + "UserSegmentAssignInput": { + "$ref": "#/components/schemas/UserSegmentAssignInput" } } }, - "ShippingMethodRefList": { - "description": "This class represents a list of shipping methods", + "CorporateAccountRoot": { + "description": "This class represents Corporate Account Root resource information.", "type": "object", "required": [ - "ShippingMethodRefs" + "links" ], "properties": { - "ShippingMethodRefs": { + "links": { + "xml": { + "wrapped": false + }, "type": "array", "items": { - "$ref": "#/components/schemas/Ref" + "$ref": "#/components/schemas/Link" } } } }, - "ShippingMethodRefListWrapper": { + "CorporateAccountRootWrapper": { "type": "object", "required": [ - "ShippingMethodRefList" + "CorporateAccountRoot" ], "properties": { - "ShippingMethodRefList": { - "$ref": "#/components/schemas/ShippingMethodRefList" + "CorporateAccountRoot": { + "$ref": "#/components/schemas/CorporateAccountRoot" } } }, - "ExampleSessionCreate": { - "type": "object", - "description": "Schema for creating a new collaboration session", - "properties": { - "ExampleSessionCreate": { + "Link": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + }, + { + "description": "This class represents REST resource information.", "type": "object", + "required": [ + "_rel" + ], "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" + "_rel": { + "description": "Unique identifier of a resource.", + "xml": { + "attribute": true, + "name": "rel" + }, + "type": "string" } - }, - "required": [ - "Owner", - "ParticipantListCreate", - "subject" - ] + } } - }, - "required": [ - "ExampleSessionCreate" - ], - "additionalProperties": false + ] }, - "ExampleSessionUpdate": { + "Company": { + "description": "This class represents a company.", "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" + "id", + "name", + "Content", + "billingAddress", + "contactId", + "salesRepresentativeId", + "defaultAddressId", + "addressBookId", + "membersId", + "MemberList", + "Location", + "locationPath", + "isActive" ], - "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" + "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" } - }, - "required": [ - "InternalParticipantUpdate" - ], - "additionalProperties": false + } }, - "ExternalParticipantUpdate": { + "CompanyWrapper": { "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" + "Company" ], - "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" - ] + "Company": { + "$ref": "#/components/schemas/Company" } - }, - "required": [ - "InvitationCreate" - ], - "additionalProperties": false + } }, - "ParticipantListCreate": { + "CompanyCreate": { + "description": "This class is used to create a company.", "type": "object", - "description": "Schema for creating a list of participants", + "required": [ + "fields" + ], "properties": { - "ParticipantListCreate": { + "fields": { "type": "object", + "required": [ + "field" + ], "properties": { - "ParticipantCreate": { + "field": { + "description": "Fields of a Company content item.", "type": "array", - "description": "Array of participants to create", "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/InternalParticipantCreate" - }, - { - "$ref": "#/components/schemas/ExternalParticipantCreate" - } - ] - }, - "minItems": 1 + "$ref": "#/components/schemas/Field" + } } - }, - "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": { + "CompanyCreateWrapper": { "type": "object", - "description": "Schema for creating an external participant", - "properties": { - "_media-type": { - "type": "string", - "description": "Media type identifier for external participant creation", - "enum": [ - "application/vnd.ibexa.api.ExternalParticipantCreate+json" - ] - }, - "email": { - "type": "string", - "description": "Email address of the external participant", - "format": "email" - }, - "scope": { - "type": "string", - "description": "Permission scope for the participant", - "enum": [ - "view", - "edit", - "admin" - ] - } - }, "required": [ - "_media-type", - "email", - "scope" + "CompanyCreate" ], - "additionalProperties": false - }, - "UserReference": { - "type": "object", - "description": "Reference to a user resource", "properties": { - "_media-type": { - "type": "string", - "description": "Media type identifier for the user reference", - "enum": [ - "application/vnd.ibexa.api.User+json" - ] - }, - "_href": { - "type": "string", - "description": "REST API URL reference to the user resource", - "format": "uri", - "pattern": "^/api/ibexa/v2/user/users/[0-9]+$" + "CompanyCreate": { + "$ref": "#/components/schemas/CompanyCreate" } - }, - "required": [ - "_media-type", - "_href" - ], - "additionalProperties": false + } }, - "ExampleSessionWrapper": { + "CompanyUpdate": { + "description": "This class is used to update a Company.", "type": "object", - "description": "Wrapper object containing a collaboration session", - "properties": { - "CollaborationSession": { - "$ref": "#/components/schemas/CollaborationSession", - "description": "The collaboration session object" - } - }, "required": [ - "CollaborationSession" + "fields" ], - "additionalProperties": false - }, - "CollaborationSession": { - "type": "object", - "description": "A collaboration session representing a shared workspace for participants", "properties": { - "_media-type": { - "type": "string", - "description": "Media type identifier for the collaboration session" - }, - "id": { - "type": "integer", - "description": "Unique identifier of the collaboration session" - }, - "token": { - "type": "string", - "description": "Session access token for authentication and authorization" - }, - "ParticipantList": { - "$ref": "#/components/schemas/ParticipantListObject", - "description": "List of participants in the collaboration session" - }, - "Owner": { - "$ref": "#/components/schemas/Owner", - "description": "Owner of the collaboration session" - }, - "createdAt": { - "type": "string", - "description": "ISO 8601 timestamp when the session was created", - "format": "date-time" - }, - "updatedAt": { - "type": "string", - "description": "ISO 8601 timestamp when the session was last updated", - "format": "date-time" - }, - "subject": { - "type": "string", - "description": "Subject or title of the collaboration session" - }, - "isActive": { - "type": "boolean", - "description": "Whether the collaboration session is currently active" - }, - "hasPublicLink": { - "type": "boolean", - "description": "Whether the session has a public access link enabled" + "fields": { + "type": "object", + "required": [ + "field" + ], + "properties": { + "field": { + "description": "Fields of a Company content item.", + "type": "array", + "items": { + "$ref": "#/components/schemas/Field" + } + } + } } - }, - "required": [ - "_media-type", - "id", - "token", - "ParticipantList", - "Owner", - "createdAt", - "updatedAt", - "subject" - ], - "additionalProperties": false + } }, - "Owner": { - "type": "object", - "description": "Owner of a collaboration session", - "properties": { - "_media-type": { - "type": "string", - "description": "Media type identifier for the owner" - }, - "_href": { - "type": "string", - "description": "REST API URL reference to the owner resource", - "format": "uri" - } - }, + "CompanyUpdateWrapper": { + "type": "object", "required": [ - "_media-type", - "_href" + "CompanyUpdate" ], - "additionalProperties": false + "properties": { + "CompanyUpdate": { + "$ref": "#/components/schemas/CompanyUpdate" + } + } }, - "ExternalParticipantWrapper": { + "CompanyList": { + "description": "This class represents a list of companies.", "type": "object", - "description": "Wrapper object containing an external participant", + "required": [ + "companies" + ], "properties": { - "Participant": { - "$ref": "#/components/schemas/ExternalParticipant", - "description": "The external participant object" + "companies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Company" + } } - }, + } + }, + "CompanyListWrapper": { + "type": "object", "required": [ - "Participant" + "CompanyList" ], - "additionalProperties": false + "properties": { + "CompanyList": { + "$ref": "#/components/schemas/CompanyList" + } + } }, - "ExternalParticipant": { + "Member": { + "description": "This class represents a company member.", "type": "object", - "description": "An external participant in a collaboration session (not a registered user)", + "required": [ + "id", + "name", + "Company", + "User", + "Role" + ], "properties": { - "_media-type": { - "type": "string", - "description": "Media type identifier for the external participant" - }, "id": { - "type": "integer", - "description": "Unique identifier of the participant" + "type": "integer" }, "name": { - "type": "string", - "description": "Display name of the external participant" - }, - "scope": { - "type": "string", - "description": "Permission scope for the participant (e.g., 'read', 'write', 'admin')" + "type": "string" }, - "email": { - "type": "string", - "description": "Email address of the external participant", - "format": "email" + "Company": { + "$ref": "#/components/schemas/Company" }, - "createdAt": { - "type": "string", - "description": "ISO 8601 timestamp when the participant was added", - "format": "date-time" + "User": { + "description": "Underlying User object of a member.", + "$ref": "#/components/schemas/User" }, - "updatedAt": { - "type": "string", - "description": "ISO 8601 timestamp when the participant was last updated", - "format": "date-time" + "Role": { + "description": "Reference to the member role in a Company resource.", + "$ref": "#/components/schemas/BaseObject" } - }, + } + }, + "MemberWrapper": { + "type": "object", "required": [ - "_media-type", - "id", - "name", - "scope", - "email", - "createdAt", - "updatedAt" + "Member" ], - "additionalProperties": false + "properties": { + "Member": { + "$ref": "#/components/schemas/Member" + } + } }, - "InternalParticipantWrapper": { + "MemberCreate": { + "description": "This class is used to create a member.", "type": "object", - "description": "Wrapper object containing an internal participant", + "required": [ + "login", + "email", + "password", + "Role", + "fields" + ], "properties": { - "Participant": { - "$ref": "#/components/schemas/InternalParticipant", - "description": "The internal participant object" + "login": { + "type": "string" + }, + "email": { + "type": "string" + }, + "password": { + "type": "string" + }, + "Role": { + "description": "Reference to a Role resource company member should be given.", + "$ref": "#/components/schemas/BaseObject" + }, + "fields": { + "type": "object", + "required": [ + "field" + ], + "properties": { + "field": { + "description": "Fields of a Member content item.", + "type": "array", + "items": { + "$ref": "#/components/schemas/Field" + } + } + } } - }, + } + }, + "MemberCreateWrapper": { + "type": "object", "required": [ - "Participant" + "MemberCreate" ], - "additionalProperties": false + "properties": { + "MemberCreate": { + "$ref": "#/components/schemas/MemberCreate" + } + } }, - "InternalParticipant": { + "MemberUpdate": { + "description": "This class is used to update a member.", "type": "object", - "description": "An internal participant in a collaboration session (registered user)", + "required": [ + "email", + "password", + "enabled", + "maxLogin", + "Role", + "fields" + ], "properties": { - "_media-type": { - "type": "string", - "description": "Media type identifier for the internal participant" - }, - "id": { - "type": "integer", - "description": "Unique identifier of the participant" + "email": { + "type": "string" }, - "name": { - "type": "string", - "description": "Display name of the internal participant" + "password": { + "type": "string" }, - "scope": { - "type": "string", - "description": "Permission scope for the participant (e.g., 'read', 'write', 'admin')" + "enabled": { + "type": "boolean" }, - "User": { - "$ref": "#/components/schemas/User", - "description": "Reference to the associated user account" + "maxLogin": { + "description": "Max number of failed login attempts.", + "type": "integer" }, - "createdAt": { - "type": "string", - "description": "ISO 8601 timestamp when the participant was added", - "format": "date-time" + "Role": { + "description": "Reference to a Role resource company member should be given.", + "$ref": "#/components/schemas/BaseObject" }, - "updatedAt": { - "type": "string", - "description": "ISO 8601 timestamp when the participant was last updated", - "format": "date-time" + "fields": { + "type": "object", + "required": [ + "field" + ], + "properties": { + "field": { + "description": "Fields of a Member content item.", + "type": "array", + "items": { + "$ref": "#/components/schemas/Field" + } + } + } } - }, - "required": [ - "_media-type", - "id", - "name", - "scope", - "User", - "createdAt", - "updatedAt" - ], - "additionalProperties": false + } }, - "ParticipantListWrapper": { + "MemberUpdateWrapper": { "type": "object", - "description": "Wrapper object containing a list of participants", + "required": [ + "MemberUpdate" + ], "properties": { - "ParticipantList": { - "$ref": "#/components/schemas/ParticipantListObject", - "description": "The participant list object" + "MemberUpdate": { + "$ref": "#/components/schemas/MemberUpdate" } - }, + } + }, + "MemberList": { + "description": "This class represents a list of company members.", + "type": "object", "required": [ - "ParticipantList" + "members" ], - "additionalProperties": false + "properties": { + "members": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Member" + } + } + } }, - "ParticipantListObject": { + "MemberListWrapper": { "type": "object", - "description": "A list of participants in a collaboration session", + "required": [ + "MemberList" + ], "properties": { - "_media-type": { - "type": "string", - "description": "Media type identifier for the participant list" + "MemberList": { + "$ref": "#/components/schemas/MemberList" + } + } + }, + "SalesRepresentativesList": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" }, - "Participants": { - "type": "array", - "description": "Array of participants in the collaboration session", - "items": { - "$ref": "#/components/schemas/ParticipantItem" + { + "description": "This class represents a list of sales representatives.", + "type": "object", + "required": [ + "users" + ], + "properties": { + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } } } - }, + ] + }, + "SalesRepresentativesListWrapper": { + "type": "object", "required": [ - "_media-type", - "Participants" + "SalesRepresentativesList" ], - "additionalProperties": false + "properties": { + "SalesRepresentativesList": { + "$ref": "#/components/schemas/SalesRepresentativesList" + } + } }, - "ParticipantItem": { + "BillingAddress": { "type": "object", - "description": "A participant item that can be either internal or external", + "required": [ + "name", + "country", + "fields" + ], "properties": { - "_media-type": { - "type": "string", - "description": "Media type identifier for the participant" - }, - "id": { - "type": "integer", - "description": "Unique identifier of the participant" - }, "name": { - "type": "string", - "description": "Display name of the participant" - }, - "scope": { - "type": "string", - "description": "Permission scope for the participant (e.g., 'read', 'write', 'admin')" - }, - "User": { - "$ref": "#/components/schemas/User", - "description": "Reference to the associated user account (for internal participants only)" - }, - "email": { - "type": "string", - "description": "Email address of the participant (for external participants only)", - "format": "email" + "type": [ + "string", + "null" + ] }, - "createdAt": { - "type": "string", - "description": "ISO 8601 timestamp when the participant was added", - "format": "date-time" + "country": { + "type": [ + "string", + "null" + ] }, - "updatedAt": { - "type": "string", - "description": "ISO 8601 timestamp when the participant was last updated", - "format": "date-time" + "fields": { + "type": [ + "object", + "array" + ] } - }, - "required": [ - "_media-type", - "id", - "name", - "scope", - "createdAt", - "updatedAt" - ], - "additionalProperties": false + } }, - "InvitationWrapper": { + "ActivityLog": { + "description": "This class represents an activity log entry.", + "type": "object" + }, + "ActivityLogGroup": { "type": "object", - "description": "Wrapper object containing an invitation", - "properties": { - "Invitation": { - "$ref": "#/components/schemas/Invitation", - "description": "The invitation object" - } - }, "required": [ - "Invitation" + "user_id", + "logged_at", + "ActivityLogEntries" ], - "additionalProperties": false - }, - "Invitation": { - "type": "object", - "description": "An invitation to join a collaboration session", "properties": { - "_media-type": { - "type": "string", - "description": "Media type identifier for the invitation" + "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 +45660,684 @@ } } }, - "DiscountList": { + "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": [ - "_media-type", - "Discount" + "ExampleSessionCreate" ], + "additionalProperties": false + }, + "ExampleSessionUpdate": { + "type": "object", + "description": "Schema for updating a collaboration session", "properties": { - "_media-type": { - "type": "string", - "enum": [ - "application/vnd.ibexa.api.DiscountList+json" + "ExampleSessionUpdate": { + "type": "object", + "properties": { + "hasPublicLink": { + "type": "boolean", + "description": "Whether the session should have a public access link enabled" + } + }, + "required": [ + "hasPublicLink" ] - }, - "Discount": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/Discount" - } - ] - } } - } + }, + "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 }, - "Discount": { + "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": [ - "id", - "identifier", - "name", - "type", - "priority", - "isEnabled", - "createdAt", - "updatedAt", - "startDate", - "DiscountRule", - "DiscountExpressionAware", - "DiscountConditions", - "DiscountTranslations" + "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.Discount+json" + "application/vnd.ibexa.api.InternalParticipantCreate+json" ] }, - "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" + "User": { + "$ref": "#/components/schemas/UserReference", + "description": "Reference to the user account" }, - "endDate": { + "scope": { "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" - } + "description": "Permission scope for the participant", + "enum": [ + "view", + "edit", + "admin" + ] } - } - }, - "DiscountRule": { - "type": "object", + }, "required": [ "_media-type", - "type", - "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" + ] }, - "type": { - "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" + ] } - } - }, - "DiscountExpressionAware": { - "type": "object", + }, "required": [ "_media-type", - "expressionValues" + "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.DiscountExpressionAware+json" + "application/vnd.ibexa.api.User+json" ] }, - "expressionValues": { - "type": "object", - "additionalProperties": true + "_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 }, - "DiscountCondition": { + "ExampleSessionWrapper": { "type": "object", + "description": "Wrapper object containing a collaboration session", + "properties": { + "CollaborationSession": { + "$ref": "#/components/schemas/CollaborationSession", + "description": "The collaboration session object" + } + }, "required": [ - "_media-type", - "identifier", - "expressionValues" + "CollaborationSession" ], + "additionalProperties": false + }, + "CollaborationSession": { + "type": "object", + "description": "A collaboration session representing a shared workspace for participants", "properties": { "_media-type": { - "type": "string" + "type": "string", + "description": "Media type identifier for the collaboration session" }, - "identifier": { - "type": "string" + "id": { + "type": "integer", + "description": "Unique identifier of the collaboration session" }, - "expressionValues": { - "type": "object", - "additionalProperties": true + "token": { + "type": "string", + "description": "Session access token for authentication and authorization" + }, + "ParticipantList": { + "$ref": "#/components/schemas/ParticipantListObject", + "description": "List of participants in the collaboration session" + }, + "Owner": { + "$ref": "#/components/schemas/Owner", + "description": "Owner of the collaboration session" + }, + "createdAt": { + "type": "string", + "description": "ISO 8601 timestamp when the session was created", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "description": "ISO 8601 timestamp when the session was last updated", + "format": "date-time" + }, + "subject": { + "type": "string", + "description": "Subject or title of the collaboration session" + }, + "isActive": { + "type": "boolean", + "description": "Whether the collaboration session is currently active" + }, + "hasPublicLink": { + "type": "boolean", + "description": "Whether the session has a public access link enabled" } - } - }, - "DiscountTranslation": { - "type": "object", + }, "required": [ "_media-type", - "languageCode", - "name" + "id", + "token", + "ParticipantList", + "Owner", + "createdAt", + "updatedAt", + "subject" ], + "additionalProperties": false + }, + "Owner": { + "type": "object", + "description": "Owner of a collaboration session", "properties": { "_media-type": { "type": "string", - "enum": [ - "application/vnd.ibexa.api.DiscountTranslation+json" - ] - }, - "languageCode": { - "$ref": "#/components/schemas/Language" - }, - "name": { - "type": "string" - }, - "description": { - "type": "object" - }, - "label": { - "type": "string" + "description": "Media type identifier for the owner" }, - "labelDescription": { - "type": "string" + "_href": { + "type": "string", + "description": "REST API URL reference to the owner resource", + "format": "uri" } - } + }, + "required": [ + "_media-type", + "_href" + ], + "additionalProperties": false }, - "DiscountCreate": { + "ExternalParticipantWrapper": { "type": "object", + "description": "Wrapper object containing an external participant", + "properties": { + "Participant": { + "$ref": "#/components/schemas/ExternalParticipant", + "description": "The external participant object" + } + }, "required": [ - "identifier", - "type", - "priority", - "isEnabled", - "userId", - "rule", - "translations" + "Participant" ], + "additionalProperties": false + }, + "ExternalParticipant": { + "type": "object", + "description": "An external participant in a collaboration session (not a registered user)", "properties": { - "identifier": { - "type": "string", - "minLength": 1 - }, - "type": { + "_media-type": { "type": "string", - "enum": [ - "cart", - "catalog" - ] + "description": "Media type identifier for the external participant" }, - "priority": { + "id": { "type": "integer", - "minimum": 1, - "maximum": 10 - }, - "isEnabled": { - "type": "boolean" - }, - "userId": { - "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 } - } + }, + "required": [ + "_media-type", + "id", + "name", + "scope", + "email", + "createdAt", + "updatedAt" + ], + "additionalProperties": false }, - "DiscountUpdate": { + "InternalParticipantWrapper": { "type": "object", + "description": "Wrapper object containing an internal participant", + "properties": { + "Participant": { + "$ref": "#/components/schemas/InternalParticipant", + "description": "The internal participant object" + } + }, "required": [ - "identifier" + "Participant" ], + "additionalProperties": false + }, + "InternalParticipant": { + "type": "object", + "description": "An internal participant in a collaboration session (registered user)", "properties": { - "identifier": { + "_media-type": { "type": "string", - "minLength": 1 + "description": "Media type identifier for the internal 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" - } - } - }, - "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": [] - } - } - } + "description": "Unique identifier of the participant" }, - "startDate": { + "name": { "type": "string", - "format": "date-time" + "description": "Display name of the internal participant" }, - "endDate": { + "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 } - } - }, - "DiscountCode": { - "type": "object", + }, "required": [ - "code" + "_media-type", + "id", + "name", + "scope", + "User", + "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": { + "ParticipantListWrapper": { "type": "object", - "required": [ - "DiscountCode" - ], + "description": "Wrapper object containing a list of participants", "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" - } - } + "ParticipantList": { + "$ref": "#/components/schemas/ParticipantListObject", + "description": "The participant list object" } - ] - }, - "ShoppingListWrapper": { - "type": "object", + }, "required": [ - "ShoppingList" + "ParticipantList" ], - "properties": { - "ShoppingList": { - "$ref": "#/components/schemas/ShoppingList" - } - } + "additionalProperties": false }, - "ShoppingListEntry": { - "description": "This class represents an entry in a shopping list.", + "ParticipantListObject": { "type": "object", - "required": [ - "identifier", - "product", - "addedAt" - ], + "description": "A list of participants in a collaboration session", "properties": { - "identifier": { - "description": "The unique identifier (UUID) of the entry.", + "_media-type": { "type": "string", - "format": "uuid" + "description": "Media type identifier for the participant list" }, - "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" - } + "Participants": { + "type": "array", + "description": "Array of participants in the collaboration session", + "items": { + "$ref": "#/components/schemas/ParticipantItem" } - }, - "addedAt": { - "description": "The date and time when the entry was added.", - "type": "string", - "format": "date-time" - } - } - }, - "ShoppingListCreate": { - "description": "Creates a new shopping list.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "name": { - "description": "The name of the shopping list (required).", - "type": "string" } - } - }, - "ShoppingListCreateWrapper": { - "type": "object", + }, "required": [ - "ShoppingListCreate" + "_media-type", + "Participants" ], - "properties": { - "ShoppingListCreate": { - "$ref": "#/components/schemas/ShoppingListCreate" - } - } + "additionalProperties": false }, - "ShoppingListUpdate": { - "description": "Updates an existing shopping list.", + "ParticipantItem": { "type": "object", - "required": [ - "name" - ], + "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": { - "description": "The name of the shopping list (required).", - "type": "string" - } - } - }, - "ShoppingListUpdateWrapper": { - "type": "object", - "required": [ - "ShoppingListUpdate" - ], - "properties": { - "ShoppingListUpdate": { - "$ref": "#/components/schemas/ShoppingListUpdate" + "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" } - } - }, - "ShoppingListEntriesAdd": { - "description": "Adds one or more product entries to an existing shopping list.", - "type": "object", + }, "required": [ - "entries" + "_media-type", + "id", + "name", + "scope", + "createdAt", + "updatedAt" ], - "properties": { - "entries": { - "description": "Array of entries to add (required, min 1).", - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/components/schemas/ShoppingListEntryAdd" - } - } - } + "additionalProperties": false }, - "ShoppingListEntriesAddWrapper": { + "InvitationWrapper": { "type": "object", - "required": [ - "ShoppingListEntriesAdd" - ], + "description": "Wrapper object containing an invitation", "properties": { - "ShoppingListEntriesAdd": { - "$ref": "#/components/schemas/ShoppingListEntriesAdd" + "Invitation": { + "$ref": "#/components/schemas/Invitation", + "description": "The invitation object" } - } - }, - "ShoppingListEntriesRemove": { - "description": "Removes one or more entries from a shopping list by their identifiers.", - "type": "object", + }, "required": [ - "identifiers" + "Invitation" ], - "properties": { - "identifiers": { - "description": "Array of entry identifiers (UUIDs) to remove (required, min 1).", - "type": "array", - "minItems": 1, - "items": { - "type": "string", - "format": "uuid" - } - } - } + "additionalProperties": false }, - "ShoppingListEntriesRemoveWrapper": { + "Invitation": { "type": "object", - "required": [ - "ShoppingListEntriesRemove" - ], + "description": "An invitation to join a collaboration session", "properties": { - "ShoppingListEntriesRemove": { - "$ref": "#/components/schemas/ShoppingListEntriesRemove" + "_media-type": { + "type": "string", + "description": "Media type identifier for the invitation" + }, + "id": { + "type": "integer", + "description": "Unique identifier of the invitation" + }, + "status": { + "type": "string", + "description": "Current status of the invitation (e.g., 'pending', 'accepted', 'declined')", + "enum": [ + "pending", + "accepted", + "declined", + "expired" + ] + }, + "createdAt": { + "type": "string", + "description": "ISO 8601 timestamp when the invitation was created", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "description": "ISO 8601 timestamp when the invitation was last updated", + "format": "date-time" + }, + "context": { + "oneOf": [ + { + "type": "array", + "description": "Additional context data as an array" + }, + { + "type": "object", + "description": "Additional context data as an object" + } + ], + "description": "Additional context information for the invitation" + }, + "Sender": { + "$ref": "#/components/schemas/Sender", + "description": "Reference to the user who sent the invitation" } - } - }, - "ShoppingListEntryAdd": { - "description": "Represents a single entry to add to a shopping list.", - "type": "object", + }, "required": [ - "productCode" + "_media-type", + "id", + "status", + "createdAt", + "updatedAt", + "context", + "Sender" ], - "properties": { - "productCode": { - "description": "Product code (required).", - "type": "string" - } - } + "additionalProperties": false }, - "ShoppingListCollection": { - "description": "This class represents a collection of shopping lists.", + "Sender": { "type": "object", - "required": [ - "totalCount", - "count", - "ShoppingList" - ], + "description": "Reference to the sender of an invitation", "properties": { - "totalCount": { - "description": "Total number of shopping lists.", - "type": "integer" - }, - "count": { - "description": "Number of shopping lists in this response.", - "type": "integer" + "_media-type": { + "type": "string", + "description": "Media type identifier for the sender reference" }, - "ShoppingList": { - "description": "Array of shopping lists.", - "type": "array", - "items": { - "$ref": "#/components/schemas/ShoppingList" - } + "_href": { + "type": "string", + "description": "REST API URL reference to the sender resource", + "format": "uri" } - } - }, - "ShoppingListCollectionWrapper": { - "type": "object", + }, "required": [ - "ShoppingListCollection" + "_media-type", + "_href" ], - "properties": { - "ShoppingListCollection": { - "$ref": "#/components/schemas/ShoppingListCollection" - } - } + "additionalProperties": false } }, "responses": [], @@ -54991,132 +46350,153 @@ "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": "User Session", + "description": "Resource 'User Session' operations." }, { - "name": "Product Attribute Group" + "name": "Bookmark", + "description": "Resource 'Bookmark' operations." }, { - "name": "Product Catalog" + "name": "User Token", + "description": "Resource 'User Token' operations." }, { - "name": "Product Currency" + "name": "Calendar", + "description": "Resource 'Calendar' operations." }, { - "name": "Product Customer Group" + "name": "Product Attribute", + "description": "Resource 'Product Attribute' operations." }, { - "name": "Product" + "name": "Product Attribute Type", + "description": "Resource 'Product Attribute Type' operations." }, { - "name": "Product Type" + "name": "Product Attribute Group", + "description": "Resource 'Product Attribute Group' operations." }, { - "name": "Product Variant" + "name": "Product Catalog", + "description": "Resource 'Product Catalog' operations." }, { - "name": "Product Region" + "name": "Product Currency", + "description": "Resource 'Product Currency' operations." }, { - "name": "Product Vat" + "name": "Product Customer Group", + "description": "Resource 'Product Customer Group' operations." }, { - "name": "Taxonomy" + "name": "Product", + "description": "Resource 'Product' operations." }, { - "name": "Segmentation" + "name": "Product Type", + "description": "Resource 'Product Type' operations." }, { - "name": "Corporate Account" + "name": "Product Variant", + "description": "Resource 'Product Variant' operations." }, { - "name": "Activity Log" + "name": "Product Region", + "description": "Resource 'Product Region' operations." }, { - "name": "Cart" + "name": "Product Vat", + "description": "Resource 'Product Vat' operations." }, { - "name": "Shopping List" + "name": "Taxonomy", + "description": "Resource 'Taxonomy' operations." }, { - "name": "Orders" + "name": "Page", + "description": "Resource 'Page' operations." }, { - "name": "Payments" + "name": "Segmentation", + "description": "Resource 'Segmentation' operations." }, { - "name": "Shipping" + "name": "Corporate Account", + "description": "Resource 'Corporate Account' 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..05805cd294 100644 --- a/docs/api/rest_api/rest_api_reference/openapi.yaml +++ b/docs/api/rest_api/rest_api_reference/openapi.yaml @@ -2,7 +2,7 @@ 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 description: "" version: 6.0.0 @@ -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: 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 @@ -613,6 +596,10 @@ paths: responses: 200: description: OK - the given Location is bookmarked. + content: + application/json: + schema: + $ref: '#/components/schemas/BookmarkIsBookmarkedController' 401: description: Error - the user is not authorized for the given Location. 404: @@ -622,16 +609,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 post: operationId: ibexa.rest.create_bookmark tags: @@ -653,28 +637,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 +673,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 +702,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 +747,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 +790,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 +808,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 +1133,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 +1176,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 +1194,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 +1216,6 @@ paths: description: The type of event to execute an action on. required: true deprecated: false - allowEmptyValue: false schema: type: string enum: @@ -1279,7 +1223,6 @@ paths: - future_hide style: simple explode: false - allowReserved: false requestBody: description: Data for the calendar action to execute content: @@ -1305,10521 +1248,6078 @@ 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: |+ + + + 123 + abc123def456ghi789 + 2023-11-15T10:30:00+00:00 + 2023-11-15T14:45:00+00:00 + + + 1 + John Doe + edit + + 2023-11-15T10:30:00+00:00 + 2023-11-15T10:30:00+00:00 + + + 2 + guest@example.com + view + guest@example.com + 2023-11-15T11:00:00+00:00 + 2023-11-15T11:00:00+00:00 + + + + Project Collaboration Session + true + false + + 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: |+ + + + + + + + view + + + + + user@link.invalid + view + + + example + + 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: |+ + + + 123 + abc123def456ghi789 + 2023-11-15T10:30:00+00:00 + 2023-11-15T14:45:00+00:00 + + + 1 + John Doe + edit + + 2023-11-15T10:30:00+00:00 + 2023-11-15T10:30:00+00:00 + + + 2 + guest@example.com + view + guest@example.com + 2023-11-15T11:00:00+00:00 + 2023-11-15T11:00:00+00:00 + + + + Project Collaboration Session + true + false + + 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: |+ + + + 123 + abc123def456ghi789 + 2023-11-15T10:30:00+00:00 + 2023-11-15T14:45:00+00:00 + + + 1 + John Doe + edit + + 2023-11-15T10:30:00+00:00 + 2023-11-15T10:30:00+00:00 + + + 2 + guest@example.com + view + guest@example.com + 2023-11-15T11:00:00+00:00 + 2023-11-15T11:00:00+00:00 + + + + Project Collaboration Session + true + false + + 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: |+ + + + true + + 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: |+ + + + + + anonymous@link.invalid + + + test + value1 + value2 + value3 + value4 + value5 + + value + + bar_value + baz_value + foo_value + + + + 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: |+ + + + + 1 + John Doe + edit + + 2023-11-15T10:30:00+00:00 + 2023-11-15T10:30:00+00:00 + + + 2 + guest@example.com + view + guest@example.com + 2023-11-15T11:00:00+00:00 + 2023-11-15T11:00:00+00:00 + + + + 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: |+ + + + + 1 + John Doe + edit + + 2023-11-15T10:30:00+00:00 + 2023-11-15T10:30:00+00:00 + + + 2 + guest@example.com + view + guest@example.com + 2023-11-15T11:00:00+00:00 + 2023-11-15T11:00:00+00:00 + + + 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: |+ + + + + view + + + + + user@link.invalid + view + + + 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: | - - - - entry-002 - - - entry-004 - - - 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: |+ + + + view + + + 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: |+ + + + view + + 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: | + + + + generate_alt_text + Generate alternative text + image + text + + 512 + 512 + 85 + + + + refine_text + Refine text + text + text + + + + 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: | + + + generate_alt_text + Generate alternative text + image + text + + 512 + 512 + 85 + + + 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 + description: ActionTypeLoadByIdentifierController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: shoppingListIdentifier - in: path - description: The Shopping List identifier - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: X-CSRF-Token - in: header - description: CSRF Token is needed to execute this unsafe request. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: No payload required - content: [] - required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /cart/{identifier}/summary: + 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: | - -
- xhtml5edit: | - -
- - 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: | + + + + rewrite_with_friendly_tone + Rewrite in friendly tone + + 1 + + refine_text + Refine text + text + text + + + + openai-text-to-text + + 4000 + 1 + Rewrite text in friendly tone. Preserve meaning and crucial information. + gpt-4-turbo + + 2025-08-07T13:16:47+02:00 + 2025-08-07T13:16:47+02:00 + + + rewrite_with_professional_tone + Rewrite in professional tone + + 1 + + refine_text + Refine text + text + text + + + + openai-text-to-text + + 4000 + 1 + Rewrite text in professional tone. Preserve meaning and crucial information. + gpt-4-turbo + + 2025-08-07T13:16:47+02:00 + 2025-08-07T13:16:47+02:00 + + + summarize_text + Summarize + + 1 + + refine_text + Refine text + text + text + + + + openai-text-to-text + + 4000 + 1 + Summarize text into one sentence. Preserve meaning and crucial information. + gpt-4-turbo + + 2025-08-07T13:16:47+02:00 + 2025-08-07T13:16:47+02:00 + + + expand_text + Expand text + + 1 + + refine_text + Refine text + text + text + + + + openai-text-to-text + + 4000 + 1 + Expand the given text by 25%. Preserve meaning and crucial information. + gpt-4-turbo + + 2025-08-07T13:16:47+02:00 + 2025-08-07T13:16:47+02:00 + + + shorten_text + Shorten text + + 1 + + refine_text + Refine text + text + text + + + + openai-text-to-text + + 4000 + 1 + Shorten the given text by 25%. Preserve meaning and crucial information. + gpt-4-turbo + + 2025-08-07T13:16:47+02:00 + 2025-08-07T13:16:47+02:00 + + + proofread + Proofread + + 1 + + refine_text + Refine text + text + text + + + + openai-text-to-text + + 4000 + 1 + Rewrite given text to identify and fix grammatical and punctuation errors. Preserve meaning and crucial information. + gpt-4-turbo + + 2025-08-07T13:16:47+02:00 + 2025-08-07T13:16:47+02:00 + + + improve_readability + Improve readability + + 1 + + refine_text + Refine text + text + text + + + + openai-text-to-text + + 4000 + 1 + Rewrite this content to improve readability. Preserve meaning and crucial information. + gpt-4-turbo + + 2025-08-07T13:16:47+02:00 + 2025-08-07T13:16:47+02:00 + + + gen_alt_text + Generate alternative text + + 1 + + generate_alt_text + Generate alternative text + image + text + + 512 + 512 + 85 + + + + 140 + + openai-image-to-text + + 4000 + 1 + + gpt-4-turbo + + 2025-08-07T13:16:47+02:00 + 2025-08-07T13:16:47+02:00 + + + 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: |+ - - - 123 - abc123def456ghi789 - 2023-11-15T10:30:00+00:00 - 2023-11-15T14:45:00+00:00 - - - 1 - John Doe - edit - - 2023-11-15T10:30:00+00:00 - 2023-11-15T10:30:00+00:00 - - - 2 - guest@example.com - view - guest@example.com - 2023-11-15T11:00:00+00:00 - 2023-11-15T11:00:00+00:00 - - - - Project Collaboration Session - true - false - - - 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: | + + + + rewrite_with_professional_tone + Rewrite in professional tone + + 1 + + refine_text + Refine text + text + text + + + + openai-text-to-text + + 4000 + 1 + Rewrite text in professional tone. Preserve meaning and crucial information. + gpt-4-turbo + + 2025-08-07T13:16:47+02:00 + 2025-08-07T13:16:47+02:00 + + + rewrite_with_friendly_tone + Rewrite in friendly tone + + 1 + + refine_text + Refine text + text + text + + + + openai-text-to-text + + 4000 + 1 + Rewrite text in friendly tone. Preserve meaning and crucial information. + gpt-4-turbo + + 2025-08-07T13:16:47+02:00 + 2025-08-07T13:16:47+02:00 + + + 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: | - - - - - - view - - - - - user@link.invalid - view - - - example - - + + Rewrite + refine_text + 1 + 25 + 1 + 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: |+ - - - 123 - abc123def456ghi789 - 2023-11-15T10:30:00+00:00 - 2023-11-15T14:45:00+00:00 - - - 1 - John Doe - edit - - 2023-11-15T10:30:00+00:00 - 2023-11-15T10:30:00+00:00 - - - 2 - guest@example.com - view - guest@example.com - 2023-11-15T11:00:00+00:00 - 2023-11-15T11:00:00+00:00 - - - - Project Collaboration Session - true - false - - - 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: | + + + + Sunlit home office with an open laptop, papers, and a blurred background. + + + 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: | + + + Hello, I hope you are well. How have you been spending your day? + + 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: | + + + + 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 + + + + 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: | + + + + Hey, wassup. What you've been doing the whole day? + + + + 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: | + + + rewrite_with_friendly_tone + Rewrite in friendly tone + + 1 + + refine_text + Refine text + text + text + + + + openai-text-to-text + + 4000 + 1 + Rewrite text in friendly tone. Preserve meaning and crucial information. + gpt-4-turbo + + 2025-08-07T13:16:47+02:00 + 2025-08-07T13:16:47+02:00 + 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 + /corporate: + get: + operationId: ibexa.rest.corporate_account.root tags: - - Collaboration Sessions + - Corporate Account responses: 200: - description: Updated session + description: List of Link objects to specific Corporate Account REST resources content: - application/vnd.ibexa.api.ExampleSession+json: + application/vnd.ibexa.api.CorporateAccountRoot+json: schema: - $ref: '#/components/schemas/ExampleSessionWrapper' + $ref: '#/components/schemas/CorporateAccountRootWrapper' 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: |+ - - - 123 - abc123def456ghi789 - 2023-11-15T10:30:00+00:00 - 2023-11-15T14:45:00+00:00 - - - 1 - John Doe - edit - - 2023-11-15T10:30:00+00:00 - 2023-11-15T10:30:00+00:00 - - - 2 - guest@example.com - view - guest@example.com - 2023-11-15T11:00:00+00:00 - 2023-11-15T11:00:00+00:00 - - - - Project Collaboration Session - true - false - - - 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: |+ - - - true - - - required: false - deprecated: false - /collaboration/sessions/{sessionToken}/invitations: - post: - operationId: api_collaborationsessions_sessionTokeninvitations_post - tags: - - Collaboration Sessions - responses: - 201: - description: Invitation created - content: - application/vnd.ibexa.api.Invitation+json: - schema: - $ref: '#/components/schemas/InvitationWrapper' - application/vnd.ibexa.api.Invitation+xml: + 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/InvitationWrapper' - 400: - description: Error - the input does not match the input schema definition. - 404: - description: Error - the session does not exist. - 401: - description: Error - the user is not authorized to create invitations for - this session. - summary: Create invitation in collaboration session - description: Creates an invitation for a participant to join a collaboration - session. - parameters: - - name: sessionToken - in: path - description: The session token. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: Invitation creation payload - content: - application/vnd.ibexa.api.InvitationCreate+json: - schema: - $ref: '#/components/schemas/InvitationCreate' - example: - InvitationCreate: - email: external.user@example.com - Sender: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - context: - single_value: value - simple_array: - - test - - value1 - - value2 - - value3 - - value4 - - value5 - extended_array: - foo: foo_value - bar: bar_value - baz: baz_value - application/vnd.ibexa.api.InvitationCreate+xml: - schema: - $ref: '#/components/schemas/InvitationCreate' - example: |+ - - - - - anonymous@link.invalid - - - test - value1 - value2 - value3 - value4 - value5 - - value - - bar_value - baz_value - foo_value - - - - - required: false - deprecated: false - /collaboration/sessions/{sessionToken}/participants: + $ref: '#/components/schemas/CorporateAccountRoot' + example: | + + + + + + + + + + + + summary: Root Resource + description: Provides basic information about Corporate Account endpoints and + configuration. + parameters: [] + /corporate/companies: get: - operationId: api_collaborationsessions_sessionTokenparticipants_get - tags: - - Collaboration Sessions - responses: - 200: - description: Participants list - content: - application/vnd.ibexa.api.ParticipantList+json: - schema: - $ref: '#/components/schemas/ParticipantListWrapper' - example: - ParticipantList: - Participants: - - User: - _href: /api/ibexa/v2/user/users/14 - _media-type: application/vnd.ibexa.api.User+json - _media-type: application/vnd.ibexa.api.InternalParticipant+json - createdAt: "2023-11-15T10:30:00+00:00" - id: 1 - name: John Doe - scope: edit - updatedAt: "2023-11-15T10:30:00+00:00" - - _media-type: application/vnd.ibexa.api.ExternalParticipant+json - createdAt: "2023-11-15T11:00:00+00:00" - email: guest@example.com - id: 2 - name: guest@example.com - scope: view - updatedAt: "2023-11-15T11:00:00+00:00" - _media-type: application/vnd.ibexa.api.ParticipantList+json - application/vnd.ibexa.api.ParticipantList+xml: - schema: - $ref: '#/components/schemas/ParticipantListWrapper' - example: |+ - - - - 1 - John Doe - edit - - 2023-11-15T10:30:00+00:00 - 2023-11-15T10:30:00+00:00 - - - 2 - guest@example.com - view - guest@example.com - 2023-11-15T11:00:00+00:00 - 2023-11-15T11:00:00+00:00 - - - - 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 + operationId: ibexa.rest.corporate_account.companies.list tags: - - Collaboration Sessions + - Corporate Account responses: 200: - description: Participants list + description: Company list containing Company objects. content: - application/vnd.ibexa.api.ParticipantList+json: + application/vnd.ibexa.api.CompanyList+json: schema: - $ref: '#/components/schemas/ParticipantListWrapper' + $ref: '#/components/schemas/CompanyListWrapper' 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: |+ - - - - 1 - John Doe - edit - - 2023-11-15T10:30:00+00:00 - 2023-11-15T10:30:00+00:00 - - - 2 - guest@example.com - view - guest@example.com - 2023-11-15T11:00:00+00:00 - 2023-11-15T11:00:00+00:00 - - - - 400: - description: Error - the input does not match the input schema definition. - 404: - description: Error - the session does not exist. - 401: - description: Error - the user is not authorized to modify this session. - summary: Add participants to collaboration session - description: Adds new participants to an existing collaboration session. - parameters: - - name: sessionToken - in: path - description: The session token. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: Participant list creation payload - content: - application/vnd.ibexa.api.ParticipantListCreate+json: - schema: - $ref: '#/components/schemas/ParticipantListCreate' - example: - ParticipantListCreate: - ParticipantCreate: - - _media-type: application/vnd.ibexa.api.InternalParticipantCreate+json - User: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - scope: view - - _media-type: application/vnd.ibexa.api.ExternalParticipantCreate+json - email: user@link.invalid - scope: view - application/vnd.ibexa.api.ParticipantListCreate+xml: - schema: - $ref: '#/components/schemas/ParticipantListCreate' - example: |+ - - - - view - - - - - user@link.invalid - view - - - - required: false - deprecated: false - /collaboration/sessions/{sessionToken}/participants/{participantId}: - delete: - operationId: api_collaborationsessions_sessionTokenparticipants_participantId_delete - tags: - - Collaboration Sessions - responses: - 204: - description: Participant removed - 404: - description: Error - the session or participant does not exist. - 401: - description: Error - the user is not authorized to modify this session. - summary: Remove participant from collaboration session - description: Removes a participant from a collaboration session. - parameters: - - name: sessionToken - in: path - description: The session token. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: participantId - in: path - description: The participant ID to remove. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: integer - style: simple - explode: false - allowReserved: false - deprecated: false - patch: - operationId: api_collaborationsessions_sessionTokenparticipants_participantId_patch - tags: - - Collaboration Sessions - responses: - 200: - description: Updated participant - content: - application/vnd.ibexa.api.ExternalParticipant+json: - schema: - $ref: '#/components/schemas/ExternalParticipantWrapper' - application/vnd.ibexa.api.ExternalParticipant+xml: - schema: - $ref: '#/components/schemas/ExternalParticipantWrapper' - application/vnd.ibexa.api.InternalParticipant+json: - schema: - $ref: '#/components/schemas/InternalParticipantWrapper' - application/vnd.ibexa.api.InternalParticipant+xml: - schema: - $ref: '#/components/schemas/InternalParticipantWrapper' - 400: - description: Error - the input does not match the input schema definition. - 404: - description: Error - the session or participant does not exist. - 401: - description: Error - the user is not authorized to modify this session. - summary: Update participant in collaboration session - description: Updates properties of a participant in a collaboration session. - parameters: - - name: sessionToken - in: path - description: The session token. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: participantId - in: path - description: The participant ID to update. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: integer - style: simple - explode: false - allowReserved: false - requestBody: - description: Participant update payload - content: - application/vnd.ibexa.api.ExternalParticipantUpdate+json: - schema: - $ref: '#/components/schemas/ExternalParticipantUpdate' - example: - ExternalParticipantUpdate: - scope: view - application/vnd.ibexa.api.ExternalParticipantUpdate+xml: - schema: - $ref: '#/components/schemas/ExternalParticipantUpdate' - example: |+ - - - view - - - application/vnd.ibexa.api.InternalParticipantUpdate+json: - schema: - $ref: '#/components/schemas/InternalParticipantUpdate' - example: - InternalParticipantUpdate: - scope: view - application/vnd.ibexa.api.InternalParticipantUpdate+xml: - schema: - $ref: '#/components/schemas/InternalParticipantUpdate' - example: |+ - - - view - - - required: false - deprecated: false - /ai/action-types: - get: - operationId: ibexa.rest.ai.action_type.list - tags: - - Connector AI - responses: - 200: - description: Action type list - content: - application/vnd.ibexa.api.ai.ActionTypeList+json: - schema: - $ref: '#/components/schemas/ActionTypeList' - example: - ActionTypeList: - _media-type: application/vnd.ibexa.api.ai.ActionTypeList+json - _href: /api/ibexa/v2/ai/action-types - ActionType: - - _media-type: application/vnd.ibexa.api.ai.ActionType+json - identifier: generate_alt_text - name: Generate alternative text - inputIdentifier: image - outputIdentifier: text - options: - width: 512 - height: 512 - image_quality: 85 - - _media-type: application/vnd.ibexa.api.ai.ActionType+json - identifier: refine_text - name: Refine text - inputIdentifier: text - outputIdentifier: text - options: [] - application/vnd.ibexa.api.ai.ActionTypeList+xml: - schema: - $ref: '#/components/schemas/ActionTypeList' - example: | - - - - generate_alt_text - Generate alternative text - image - text - - 512 - 512 - 85 - - - - refine_text - Refine text - text - text - - - - summary: Get action types list. - description: Returns action types list. - parameters: [] - deprecated: false - /ai/action-types/{identifier}: - get: - operationId: ibexa.rest.ai.action_type - tags: - - Connector AI - responses: - 200: - description: Action type - content: - application/vnd.ibexa.api.ai.ActionType+json: - schema: - $ref: '#/components/schemas/ActionType' - example: - ActionType: - _media-type: application/vnd.ibexa.api.ai.ActionType+json - identifier: generate_alt_text - name: Generate alternative text - inputIdentifier: image - outputIdentifier: text - options: - width: 512 - height: 512 - image_quality: 85 - application/vnd.ibexa.api.ai.ActionType+xml: - schema: - $ref: '#/components/schemas/ActionType' - example: | - - - generate_alt_text - Generate alternative text - image - text - - 512 - 512 - 85 - - - 406: - description: Error - an action type of the given unique identifier is not - found. - summary: Get an action type by its unique identifier. - description: Returns an action type by its unique string identifier. - parameters: - - name: identifier - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - example: generate_alt_text - deprecated: false - /ai/actions: - get: - operationId: ibexa.rest.ai.action.list.get - tags: - - Connector AI - responses: - 200: - description: Action configuration list is returned in JSON or XML - content: - application/vnd.ibexa.api.ai.ActionConfigurationList+json: - schema: - $ref: '#/components/schemas/ActionConfigurationList' - example: - ActionConfigurationList: - _media-type: application/vnd.ibexa.api.ai.ActionConfigurationList+json - _href: /api/ibexa/v2/ai/actions - ActionConfiguration: - - _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json - identifier: rewrite_with_friendly_tone - name: Rewrite in friendly tone - description: "" - enabled: true - ActionType: - _media-type: application/vnd.ibexa.api.ai.ActionType+json - identifier: refine_text - name: Refine text - inputIdentifier: text - outputIdentifier: text - options: [] - actionTypeOptions: [] - actionHandlerIdentifier: openai-text-to-text - actionHandlerOptions: - max_tokens: 4000 - temperature: 1 - prompt: Rewrite text in friendly tone. Preserve meaning and - crucial information. - model: gpt-4-turbo - createdAt: "2025-08-07T13:16:47+02:00" - updatedAt: "2025-08-07T13:16:47+02:00" - - _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json - identifier: rewrite_with_professional_tone - name: Rewrite in professional tone - description: "" - enabled: true - ActionType: - _media-type: application/vnd.ibexa.api.ai.ActionType+json - identifier: refine_text - name: Refine text - inputIdentifier: text - outputIdentifier: text - options: [] - actionTypeOptions: [] - actionHandlerIdentifier: openai-text-to-text - actionHandlerOptions: - max_tokens: 4000 - temperature: 1 - prompt: Rewrite text in professional tone. Preserve meaning - and crucial information. - model: gpt-4-turbo - createdAt: "2025-08-07T13:16:47+02:00" - updatedAt: "2025-08-07T13:16:47+02:00" - - _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json - identifier: summarize_text - name: Summarize - description: "" - enabled: true - ActionType: - _media-type: application/vnd.ibexa.api.ai.ActionType+json - identifier: refine_text - name: Refine text - inputIdentifier: text - outputIdentifier: text - options: [] - actionTypeOptions: [] - actionHandlerIdentifier: openai-text-to-text - actionHandlerOptions: - max_tokens: 4000 - temperature: 1 - prompt: Summarize text into one sentence. Preserve meaning and - crucial information. - model: gpt-4-turbo - createdAt: "2025-08-07T13:16:47+02:00" - updatedAt: "2025-08-07T13:16:47+02:00" - - _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json - identifier: expand_text - name: Expand text - description: "" - enabled: true - ActionType: - _media-type: application/vnd.ibexa.api.ai.ActionType+json - identifier: refine_text - name: Refine text - inputIdentifier: text - outputIdentifier: text - options: [] - actionTypeOptions: [] - actionHandlerIdentifier: openai-text-to-text - actionHandlerOptions: - max_tokens: 4000 - temperature: 1 - prompt: Expand the given text by 25%. Preserve meaning and crucial - information. - model: gpt-4-turbo - createdAt: "2025-08-07T13:16:47+02:00" - updatedAt: "2025-08-07T13:16:47+02:00" - - _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json - identifier: shorten_text - name: Shorten text - description: "" - enabled: true - ActionType: - _media-type: application/vnd.ibexa.api.ai.ActionType+json - identifier: refine_text - name: Refine text - inputIdentifier: text - outputIdentifier: text - options: [] - actionTypeOptions: [] - actionHandlerIdentifier: openai-text-to-text - actionHandlerOptions: - max_tokens: 4000 - temperature: 1 - prompt: Shorten the given text by 25%. Preserve meaning and - crucial information. - model: gpt-4-turbo - createdAt: "2025-08-07T13:16:47+02:00" - updatedAt: "2025-08-07T13:16:47+02:00" - - _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json - identifier: proofread - name: Proofread - description: "" - enabled: true - ActionType: - _media-type: application/vnd.ibexa.api.ai.ActionType+json - identifier: refine_text - name: Refine text - inputIdentifier: text - outputIdentifier: text - options: [] - actionTypeOptions: [] - actionHandlerIdentifier: openai-text-to-text - actionHandlerOptions: - max_tokens: 4000 - temperature: 1 - prompt: Rewrite given text to identify and fix grammatical and - punctuation errors. Preserve meaning and crucial information. - model: gpt-4-turbo - createdAt: "2025-08-07T13:16:47+02:00" - updatedAt: "2025-08-07T13:16:47+02:00" - - _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json - identifier: improve_readability - name: Improve readability - description: "" - enabled: true - ActionType: - _media-type: application/vnd.ibexa.api.ai.ActionType+json - identifier: refine_text - name: Refine text - inputIdentifier: text - outputIdentifier: text - options: [] - actionTypeOptions: [] - actionHandlerIdentifier: openai-text-to-text - actionHandlerOptions: - max_tokens: 4000 - temperature: 1 - prompt: Rewrite this content to improve readability. Preserve - meaning and crucial information. - model: gpt-4-turbo - createdAt: "2025-08-07T13:16:47+02:00" - updatedAt: "2025-08-07T13:16:47+02:00" - - _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json - identifier: gen_alt_text - name: Generate alternative text - description: "" - enabled: true - ActionType: - _media-type: application/vnd.ibexa.api.ai.ActionType+json - identifier: generate_alt_text - name: Generate alternative text - inputIdentifier: image - outputIdentifier: text - options: - width: 512 - height: 512 - image_quality: 85 - actionTypeOptions: - max_length: 140 - actionHandlerIdentifier: openai-image-to-text - actionHandlerOptions: - max_tokens: 4000 - temperature: 1 - prompt: "" - model: gpt-4-turbo - createdAt: "2025-08-07T13:16:47+02:00" - updatedAt: "2025-08-07T13:16:47+02:00" - application/vnd.ibexa.api.ai.ActionConfigurationList+xml: - schema: - $ref: '#/components/schemas/ActionConfigurationList' - example: | - - - - rewrite_with_friendly_tone - Rewrite in friendly tone - - 1 - - refine_text - Refine text - text - text - - - - openai-text-to-text - - 4000 - 1 - Rewrite text in friendly tone. Preserve meaning and crucial information. - gpt-4-turbo - - 2025-08-07T13:16:47+02:00 - 2025-08-07T13:16:47+02:00 - - - rewrite_with_professional_tone - Rewrite in professional tone - - 1 - - refine_text - Refine text - text - text - - - - openai-text-to-text - - 4000 - 1 - Rewrite text in professional tone. Preserve meaning and crucial information. - gpt-4-turbo - - 2025-08-07T13:16:47+02:00 - 2025-08-07T13:16:47+02:00 - - - summarize_text - Summarize - - 1 - - refine_text - Refine text - text - text - - - - openai-text-to-text - - 4000 - 1 - Summarize text into one sentence. Preserve meaning and crucial information. - gpt-4-turbo - - 2025-08-07T13:16:47+02:00 - 2025-08-07T13:16:47+02:00 - - - expand_text - Expand text - - 1 - - refine_text - Refine text - text - text - - - - openai-text-to-text - - 4000 - 1 - Expand the given text by 25%. Preserve meaning and crucial information. - gpt-4-turbo - - 2025-08-07T13:16:47+02:00 - 2025-08-07T13:16:47+02:00 - - - shorten_text - Shorten text - - 1 - - refine_text - Refine text - text - text - - - - openai-text-to-text - - 4000 - 1 - Shorten the given text by 25%. Preserve meaning and crucial information. - gpt-4-turbo - - 2025-08-07T13:16:47+02:00 - 2025-08-07T13:16:47+02:00 - - - proofread - Proofread - - 1 - - refine_text - Refine text - text - text - - - - openai-text-to-text - - 4000 - 1 - Rewrite given text to identify and fix grammatical and punctuation errors. Preserve meaning and crucial information. - gpt-4-turbo - - 2025-08-07T13:16:47+02:00 - 2025-08-07T13:16:47+02:00 - - - improve_readability - Improve readability - - 1 - - refine_text - Refine text - text - text - - - - openai-text-to-text - - 4000 - 1 - Rewrite this content to improve readability. Preserve meaning and crucial information. - gpt-4-turbo - - 2025-08-07T13:16:47+02:00 - 2025-08-07T13:16:47+02:00 - - - gen_alt_text - Generate alternative text - - 1 - - generate_alt_text - Generate alternative text - image - text - - 512 - 512 - 85 - - - - 140 - - openai-image-to-text - - 4000 - 1 - - gpt-4-turbo - - 2025-08-07T13:16:47+02:00 - 2025-08-07T13:16:47+02:00 - - - summary: Get action configuration list. - description: Returns action configuration list. - parameters: [] - deprecated: false - post: - operationId: ibexa.rest.ai.action.list.post - tags: - - Connector AI - responses: - 200: - description: Action configuration list is returned in JSON or XML - content: - application/vnd.ibexa.api.ai.ActionConfigurationList+json: - schema: - $ref: '#/components/schemas/ActionConfigurationList' - example: - ActionConfigurationList: - _media-type: application/vnd.ibexa.api.ai.ActionConfigurationList+json - _href: /api/ibexa/v2/ai/actions - ActionConfiguration: - - _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json - identifier: rewrite_with_professional_tone - name: Rewrite in professional tone - description: "" - enabled: true - ActionType: - _media-type: application/vnd.ibexa.api.ai.ActionType+json - identifier: refine_text - name: Refine text - inputIdentifier: text - outputIdentifier: text - options: [] - actionTypeOptions: [] - actionHandlerIdentifier: openai-text-to-text - actionHandlerOptions: - max_tokens: 4000 - temperature: 1 - prompt: Rewrite text in professional tone. Preserve meaning - and crucial information. - model: gpt-4-turbo - createdAt: "2025-08-07T13:16:47+02:00" - updatedAt: "2025-08-07T13:16:47+02:00" - - _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json - identifier: rewrite_with_friendly_tone - name: Rewrite in friendly tone - description: "" - enabled: true - ActionType: - _media-type: application/vnd.ibexa.api.ai.ActionType+json - identifier: refine_text - name: Refine text - inputIdentifier: text - outputIdentifier: text - options: [] - actionTypeOptions: [] - actionHandlerIdentifier: openai-text-to-text - actionHandlerOptions: - max_tokens: 4000 - temperature: 1 - prompt: Rewrite text in friendly tone. Preserve meaning and - crucial information. - model: gpt-4-turbo - createdAt: "2025-08-07T13:16:47+02:00" - updatedAt: "2025-08-07T13:16:47+02:00" - application/vnd.ibexa.api.ai.ActionConfigurationList+xml: - schema: - $ref: '#/components/schemas/ActionConfigurationList' - example: | - - - - rewrite_with_professional_tone - Rewrite in professional tone - - 1 - - refine_text - Refine text - text - text - - - - openai-text-to-text - - 4000 - 1 - Rewrite text in professional tone. Preserve meaning and crucial information. - gpt-4-turbo - - 2025-08-07T13:16:47+02:00 - 2025-08-07T13:16:47+02:00 - - - rewrite_with_friendly_tone - Rewrite in friendly tone - - 1 - - refine_text - Refine text - text - text - - - - openai-text-to-text - - 4000 - 1 - Rewrite text in friendly tone. Preserve meaning and crucial information. - gpt-4-turbo - - 2025-08-07T13:16:47+02:00 - 2025-08-07T13:16:47+02:00 - - - summary: Query action configuration list. - description: Returns action configuration list based on the given query. - parameters: - - name: X-CSRF-Token - in: header - description: CSRF token obtained during the authentication. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: Query action configuration search criteria - content: - application/vnd.ibexa.api.ai.ActionConfigurationListInput+json: - schema: - $ref: '#/components/schemas/ActionConfigurationListInput' - example: - ActionConfigurationListInput: - query: Rewrite - action_type_identifier: refine_text - enabled: true - limit: 25 - page: 1 - application/vnd.ibexa.api.ai.ActionConfigurationListInput+xml: - schema: - $ref: '#/components/schemas/ActionConfigurationListInput' - example: | - - - Rewrite - refine_text - 1 - 25 - 1 - - required: false - deprecated: false - /ai/actions/{actionConfigurationIdentifier}/execute: - post: - operationId: ibexa.rest.ai.actions.execute - tags: - - Connector AI - responses: - 200: - description: Reworked text or generated alternative text - 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: | - - - - Sunlit home office with an open laptop, papers, and a blurred background. - - - 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: | - - - Hello, I hope you are well. How have you been spending your day? - - 400: - description: Error - if the provided input or action configuration is invalid - or the given action cannot be performed for any reason. - content: - application/vnd.ibexa.api.ai.ErrorMessage+json: - schema: - $ref: '#/components/schemas/ErrorMessage' - application/vnd.ibexa.api.ai.ErrorMessage+xml: - schema: - $ref: '#/components/schemas/ErrorMessage' - summary: Execute the given AI action - description: Executes the given AI Action using configured ActionConfiguration - or ActionHandler, if passed. Might consume AI agent resources. - parameters: - - name: actionConfigurationIdentifier - in: path - description: Configured action name (obtain by listing the configured actions - via GET `/api/ibexa/v2/ai/actions` endpoint). - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - examples: - rewrite_with_friendly_tone: - value: rewrite_with_friendly_tone - rewrite_with_professional_tone: - value: rewrite_with_professional_tone - summarize_text: - value: summarize_text - expand_text: - value: expand_text - shorten_text: - value: shorten_text - proofread: - value: proofread - improve_readability: - value: improve_readability - gen_alt_text: - value: gen_alt_text - - name: X-CSRF-Token - in: header - description: CSRF token obtained during the authentication. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: Input to execute the action. An Input type must match the action - type. - content: - application/vnd.ibexa.api.ai.GenerateAltText+json: - schema: - $ref: '#/components/schemas/GenerateAltText' - example: - GenerateAltText: - Image: - base64: data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wgARCACMANIDAREAAhEBAxEB/8QAGwAAAQUBAQAAAAAAAAAAAAAAAgABAwQFBgf/xAAaAQADAQEBAQAAAAAAAAAAAAAAAQIDBAUG/9oADAMBAAIQAxAAAAGj879HLORzrbyvP6FbydDfkx/Qx6rzu/uu/wAieoCWCoSmQ4nQ4iSrZ642HVm5vNCNvo7z6nbhq57ZvTpO5NpgjoZFcVZto06SueWpFMU2GgQnB5ThymXXyU628pQIrvr5NfXlr56H0qXSHarTpzptK56aucJoFTJiMQYECBwQ3Q0nnS6siKs5ykree/pXT5tp5Q52ukl0iCNPJ33ZWuL3n7TzxKIRimIC0mkJA4JN1UU15LezY06JZndw6fQ+ry5VATS6CS5FPis+/id5y9cO9xfdZyI2ELlNO5QISGhunnTp49u7GFmi1lfW479xv5pqRll1IqTtZ+PR5Ptvibc7Vn7Tw72nKcpy7lOUDNONISrDNOP2rHRnpaPN1eiYnTVyGpZE/bm7EKOL8/nr817OWrcd9z6+ic7Ny7l6lmmEmkCTZVy9aZF203jNZpXrnDehMEk0mn6XI7TS44rMz6PE+zPG2wmF7bwdGoS7lOU0zlgTEiNVwu2kBWeVQT6TDbouLphw6ZpTydd7Hh0MumMoaiKlwWhwnVyg56zLTvsGDmYnSUlSiFEEmuUGW/nXRpnjea1401sdLXF2LLe3FPJ3XvfOZfD2UTXn90CI5UbzuKbrmxUSubdRZcw1AptFDcZk6cxpdN1IVXL6Dn06TC7riQTiCbQCnFNZ7dDSLCkrytExtE5Koo2o6mGlCyNgjrlWIuSalnTTit6QmWHkTWJw+gLoRiMBDUC5zOrk0FnM5JoiVSz9AWnYgYdendTvZ001bl6SbyDNDLx+bujdQUqNRf0x0KjKx2y9cj1ynEmmadJgBqS1fueictLkY8t03TdU6GhjL5Hk9YiIbintjta87NC1dJnFMmhG07SAE4JdWXUmoQu1Ni5ussMJUIylmjhOP0yahqK9RVuWamFbJkcWUpQuwSgwRsEZCZNIYGQLbUSsVlpFma4/DrdyLkakhC0TmUUoics04p0WZcyaBgYcQxBJsN0IcBUDqNujLmAyRcu0Qk07mRowNJNAwWSpWJc8t0xHGANshxmnG6gKjbwanQgmQ7QOTFKKQTUjE4iAk0IKI2C1Yl2s2hiMBsxhwOq7daj/xAAnEAACAgICAgEFAAMBAAAAAAABAgADBBEFEhATIRQVICIwBiMxMv/aAAgBAQABBQKrJVa0yVi5C7+oSPeheq1N51qkYhHusYSg/wCv+N1nWW5aJHzXaM2/HF1/Diai8dTBx9M+30z7fVPtdM+10x+IoM+zUAni03WOq/x5i3qincBm4vy3HJpGmoPG9SzIrQZHM1JOK5L6s/0P/OZs3fXNzcoG2xhpT4Hi8bTLFi2sJh3nFy6rBZX/ADtOkzbO+Wp+O0BnHr2vq+K/A8GctjxhLZ/juZ3r3/PNfrU3dXD7gMScUu/zyq+9eUvptsMxcg4+TjWi2r+XIN+llQaW4021crcEcQuqvyac9jfq5hn+O5nwD/LOb9oZlddLjsBiAVVewT2ie0fgZlVeyvkKfReZjWmi/BvF9P8ABzpcm7dweZGSFlKNY+Ona659QOZ2M2YwaG1hBf8ANmUihc2p5zqewmtp6mnD5j48XLXr9ckpyxaRufMclRVaXljamS2qmPzZeTKadldLMD/3c27Vg8FhLE7yzHPU8Y2xiJQbKjkFeKUReMrlfH0w4eOIuHjiV0VpPiFfA0I+mmX8y7ASyLx/SeixYQRONX9acSlwMGufRVz6Oue2eyB9x9GWVK0+kqBFdaxbli2GMnY9IewBssEN9qg5NkN9hnuslmUSBepgYwWAz/swUDWeoQFlgsnsXxub8Hwy/ASIdTtN+CnYWYlkGDcZ9vun2y0x+MbqnCiyLwipPtw6/QfriYrUj58ECdRO0P8A1n1GyJi1vaGoRF9naW/Uh1fkJ25HW+VmuXnr5Qz6fkJ9DmtBxWWZTxAErrrpX3177E+d+dTUDzvGbcQ0o45OmNyOJYKszCrn11EXKqae9Z71nuWe5Z7hDfDfZGstMastFpKEXXLFyxFvVp2EBEZwIG3N+NxviH9oy6gG4qfIWBYHKwXRTvwTOzTRM9c6a8b8FRB2EF7LGsWyUsFntH46nWDwJqag+ILiItgPnc7eNzfk/MKCEETbxW3+WoPw1Os1AxEW2dgfGvx3DCZuVmL+Ag/gfG4rGA+NeTDCZuf/xAAnEQACAgICAQMEAwEAAAAAAAAAAQIRAxIQEyEUIDAxQEFhBCIyUf/aAAgBAwEBPwHuWosiFkQppjyI2RnmjA/7E34Mq/t8WPHt5YsZqlzneqIMsf8AJ/R6qR6uR6tnq/0eq/R3p/gWSP8Aw7Uybt/Fi8IsviHk/lSEWPirI4ZSFgivqycItXH4LLL5QuLGzH4RnfkXD4xOpErGXTJRp+6/dEvleWPxEyeZPl8IhLaIyRF7Ir4LL4iKRsNmMyOl78M6ZPwSYpaux/GuKPKMZnfj3xP9RGMxytUP4kLhkfBNOTo6mdTOp+xGORkVMZGVP40JmwhGBfVlI1RqhOIsSY8CFjNaZk8ocTVkX+OWyy+ckqYuLEIRi8RQuVFkJ6nanxp+RxNUUPloocRcThYuFyiWecT1kz1sz1uQ6jrHChWUzRmrGyzc2Gy/fYmJm1CyDUZDxnXLiubHxP6/JZZsbc2zZmvNk8up3N8Sx2dR1miNEao1RSLQ3xXvsvhjJ3+DrZpJDjI1kas62dbOtmjNGdZ1nWikUaGrK5RRXFj91cX8FFFcao0Os0NfsaK4r30X9jfw395//8QAJhEAAgIBAwQCAwEBAAAAAAAAAAECERIDEBMgITAxQVEEFCJAYf/aAAgBAgEBPwGehJyJfjsehI4ZEdKVEtOR+LpuzXX8Gmv6I+KcqGOxLbTWUiW1GBxnEcbOJiTj6G5MXYXiasaKKH2R+OvklshF0ch/TO8H5WJEyiiZpKoj2W00RqhEo5KhPyMS7DRRRL2Lskh7LaRHsxETVjTvyVbHEcKGiQlch70LaSId0JEo5Kiq7eOPvdxTJwaIrv1yNJ06FtrQ+fHBbolI9IyMjLdjH2NN2tmrRKNOvFGPYoxGT9Gp9Ds7nccZGbMmJSl6HCXyaXYssnDIwZgxwa6YKz53YzUJ+xj2lqoas9EdfAlruQp0c7OdnLJmbMn9llljZZDUrbMzMltqexQUj9dH6qP1UZmZkWKRyGRgYlFCRSEkYmKMUYDgUNFDVmJ6MzPwJ9S2sssyY7KKHErZ9FGAtKzhQ0Rml7OWByx+jmRzI5v+HM/oWq38Ccn8CW2aLsrpaMUVsiJZ2OxaM0jmic0Tmic0TmRznOczORnIxahmZFl9S2vazIyKsx6O21l9FmRkLUaJTsy6r6LL2xK8llleOyyyjErw0UP/AAteL//EADAQAAECAwUHAwQDAQAAAAAAAAEAAhEhMQMQEiAwBCIyQVFhcROBkTM0gqEjUHKS/9oACAEBAAY/AqX1VVVVuZPmhpSUzErd3Qp3R6mF9FRUVFwqimFIITMlDSEKnK3xHNvOCgzeKcHCDhrBvTIEfjKYJzXuJubaCnNBw56rz3yN7TQzYxf6LzvNpqO8Il2Rx9s5Cc03NtB7oOHPTIukpqSb3noY23+i40ppwv7oQQHQAaBCcOVzXjkmuGkboBYnpgTR755uC4hFRAuosDgYKJKqt2+KpeXFQaouuc7oEe0s0GlEvtCYqI4lhMAuK6gUCqBboF81S7DyUnEKRBXCphR6lR55aLoqrjKjjf8AK4nfKlFUKiRdIqBU1VVUnKDhFSfD/SjD3CrcRCUFK6ejCOXhiv4wSOhVMKo0e6m5qOJ4MOyiXPHkLctnqDnYvKlhCON4LuoGjiMmd0XOfABbk2qNiLMjo5fR2X9qTdlH4qVpYD8F9zZD8FPbB7MU9tf7Bff26nt1v/0o2207RadsUFBoAUAYnsuUNPFbNc7sqOUHxPkI+m3D4aqH4UlRUvopNUg1fUh4C3rRxUbO0cFPC/8AS3mlqkRnnq0U1XNJxW9dXVkp6siq/wBv/8QAJhAAAgEDBAEEAwEAAAAAAAAAAAERITFREEFhcYEgkbHBMKHw0f/aAAgBAQABPyF1qlkKqY3VIo9EG0SNJSqSRYpYe0jY2P1tpaBh49FJ8C4x5aWNkzYXgSaYFhgTgjftG12exgUsKVKJkjuJI7AbG/wMQaGDGIFq3V/2CaqGiVGJoeSel4Cv5bcDYx6Mb9bwxVayRtNpHt24Ka/i0RpQ1ZobQkhJ7siY2S6Oo4WUkobG9G/wSBWqlBALiRnAAWDxI/QWUU2gkkS6Jn5CWiSfwybAZAzLkWlHpOTd2i+RPFidEhECXyH+EE7HK0T9g1eUkkk/h7JQ2Yeq0jollC1Inbyf6+hMkkjVJRNCqtByd64JEL8DdCdfIkVNEcVEhgO5bHA2H7+henVjCnauh7VVOgw2O6oymZQiSfTJMsieKCIliTdNhGyEcnI+J2/vCHtxZDmIEolE1Ye4Mm1AI4XEJyLhkqikeWVPto3SCnaRasZ9G5ReGQ2JPPgXM1bkcGy5MRFBJIRFW+CnokhbNpwMtBbGMbQ818iRCcmeCarUWdSfQJcSWQbXCOBWox4qGthYBr2zSBb+2DR3LgcVF2UPJ8ITfJJsxB3ksUHELnoG6+A3lBTMkZYlQrjFi3cCfn3E3QP7DK4RyRKw5RUJxlFaWPoXUkWKMfRIwhdHa7UUpJOCVQ6lCJNlLjRi+C9OVyYRzEUHEYb0JZFNlSpFccO41IEwnJbGwNk6Lv2YdMmM/Yn7jKOw7yiVLUmk2LoP0DtOT3A3wDq38QnUGb3P0iQhvYKBJeScjG2jgOqrMZKHLWwpInS22hVjgVU2JZOG05FZaGX6Nmj+cktQeRIvazJ8BDaIG5fGCT8LPleHvlin6IQ3O/uWtxVDsF2MtZk6E1pAiZHKGEcGPeAJYi2EuCkZvDR40x33BOswY4+jCwswWJjVsyjcQf6G2Hkv4nzID8yvybUPcIU/dF6QnaBvDYux6E5oKFA4dJDJVBLWqYRRggFVHJlRClMqMVhiW5IaPcLabKolglO4zsjYwyobS3XkW/6OQkuNEIStVGqsNAnohpZ3tYOmnZjkpGG3MkyrRMRXHV1QUQWsiGUaEhSIYYkjfzKIkJjLJGxN6H1jRnGm3oI0WqIEGhMnR6ZjQxoNCGHHEz//2gAMAwEAAgADAAAAEIYi+VZ+Ndf03ptaHA3sA0vGKiAxcf0JgkWk4FIfyv686UM0LT4YtCOWtZiJ+LmoV1aIdpLEfJAVQ1isgFKPHwK+ZjftYRScC3SR1snp8vNuvxJgzsFsNzKOR6K8LGfMhsOMobK/QI2G8+02rSuJ49xArEzFZz1Is55eJrJyJfsqUM2T5P8Ak1kdG38bXJNr5ejJmIkgw7iIOt83GqzfS0wqf/1xs0+xWQw6Oes6WodtgWzgWehQzf8A/8QAJhEBAQEAAgICAQIHAAAAAAAAAQARECExQVFhILHwMHGBkaHB0f/aAAgBAwEBPxDGZPFmvdT3NtzzI6GCHO5BBBH4PBwAMOo9aXYNv6KWHXFTwJ+IvoL6yV7HE+XDukQ3ZQQR+WQ4DFu62U+/0nyLC8Lwxf6GmIeIIjg438BvA1lhlvIHZaE/ffDZzGS3d56jHbfD544IILZZm22ww3lHa3ZcJdEtZaI4Uzxg+8hG6N8nDJllttt4EGWSHmNPVrDXeNTruzhZtvN+G7ctuNZeyWWWWW222GGcdzd8kxOrw/mSTjbeFjL3+ycrtHqUssssttsMM5QyMy34wIep5CeCFk48crs5d7JZZZbbbbYZcDiKut5xOvzn9oT1PwX0THGxkYhpY+YHQwpJpA1LLASJFsSkSh4GU8ji/ffLJU5xjyId9wdgSEiGSsrAzU9Mc8wFvG6wyhhu5kzgdWXOYPcN9z/eI9S8y8S1wTdZjYWcEMcg13JPd4gl9N9Vpsb7gy6mKXYYiWWWXnvjLYeBDF2hL+UBwdIMMlyb4R3bsCETuJ6Tj3Y9tl7/AFn5D/P/AGz4Uf2WMPo4FwMMRbCtyylDNVjsEnzJW/u+2fn/AAaE+7PzAQXgkvmfiyVogjbHvkWeBdnhkmdlq3eAskODLHNlt6s+uBjgsssszLMySWW2xZyZwDjI6iAscFlm2WZnh4yzjYYm8jDDDDwG2WZ4Zmf4BFtvJFvH/8QAJREBAQEAAgIDAAIBBQAAAAAAAQARECExQSBRYXGxoTDR4fDx/9oACAECAQE/EPOrT5iEG+IXhE9Q9JN0lj6lt5yyyzhOhJf22sYGwRu6tlt8sbu/A9TKebyyExYepHPlklnGyyJ08p2P1P7hZCEgdyPUevqQGujKM/HLLLLJLwvfDm79Xc/b/X/vHIxbGz7AlB969DbbzllllkkkOrCbN1nBDYP4D/nkIhpLounDrvht+OWWWWSRgI06k8uA3SS1WeCCTbPsvK4gVSlqI4CyyyyySG7ttLwvUh3ZN+uHgLJhpduhBZuYiCD5N7JJIML0nVuj9yJNmAuuCu7ThiPJk4hHOWWTYRhHhhLE2zBKLNhTQ4SvEox0nQ2YuxdmcfkIGBsZ6jLtm4gslDYdBd3CFkES26QK7nGBdO3ll+XCe5H2WkG+WKG28Tj1dgyF3Yfuz7tPc4zz+F2m2nu19372/dj6jc/qwtpmXfrLd1jPuLhHmvSgcH5R9ZDySPGynmcXiNk8WsEebN3zkcHVuDJZEQPqT7LX6tfUM9Qx6OFL6lD0y182z1KJgXVt5jcQuz1YGrYORGT8L/sy/F/xfk/4/wBrfpcDwH9r0Qk93RIcT9JWWckGF5gXSQ+bJKvMIvynyiw9X5R9XE/XI9Ev0Ssp5j3EPuC+HjlsSb4lzgLPq7R1Grc4k7SPKzJnwbniMzq22WGQ4beAtWvAiI4PtZw7HBo+Z14lnG/6Itvi44IeRjv4EOJDMVd2/B4DkBJyckfEYbbBgk+ORBZf/8QAJhABAAIBBAEFAQADAQAAAAAAAQARITFBUWFxEIGRobHRweHw8f/aAAgBAQABPxBQcu1XMDcftL7RnciVogijUrXYhByZsaua7HJLPB9ccWEIQYMpSJMrtHvnC2FK/ae8XoTVW2FVXlgrH5jL+/UuKxycQQH4oL+EKMfET+MSxNsJaD2iKqnxEo59BAt2lYaCj1BYw9SXET0NjTVZl5VVdWYCOUSBnWDh6r86Pp+pcMctoMQywOiAkTW4XYLHH5hDm4bvlCSyVgLixehfqQhLF1DJwdHa/wCpjGO252RgdEPdhOFFg8D/AHMyMHEEf6wCbRaSKWbJaVFSDBcphgBEPVF9BYS5cGDBhtvaVdYU+2P7KKFoqC8TOM2L2MfdTmJt98/5mREzDUI1MDVJlo2hiK3kj2ZuHMMizSMsLcIJFJcuXBlQ7j9R2F5J2wNqcTLay2ljgFKx2v8AyEOwaHUyJcoII2JcEUahRIWvYhrFuAAG8DbFFeoety5fpcPtSkvMLl1Yuolb5yVQXxEHZXjGPt6Iw9BAVGXEVt/tEVuW3H3CrupxAJHDFfqsWXLlytPBM1cqFlimyWG0iHEYlRFinTvRf4jlEKNSdxAJR6A5hXmyokAQxmjjhDDc3gBQTrHKSkWLLl+jxlDurHDLlERpbwVCN2VptKoCBXgy/kZXVj5Fo+vkm7Y41TswTFs2jtW6pX6jd2I6C3WxLXMN8zBvG6dYpD+JP9NhTZt46QdmzRdJWm4IgZrvAMkSmEGLKYbEscA1mIVHLUV3GTCZ0sojvXTG0yvXnaCQEwJd9eX/AMZYy0C8go/UapE1LYQ2lTLyO0r1TUIXJVraB6mSkyjKyua7m34j+T7JmGC1p5YQuXuQKnHiJPt5LyhEWyNdQUZBFqIloKKbgEvtRYW2XTLwc5wYoFBvnKM30SJg873f0ZaRuYNu4Js0Vy/2C3fv+z/owXXN3BH+MfsqOZn5niCIceUbm/VkoSkvIjfgSCY3mJd3YrpDaIhgOIxbZGqW6OzMEB1slUiOCyZz1GyAe6K/qZcg2/oZWz1z7gs1bn5R/tCwntDEAOyXKibasBZ/jDLsWiqZj/HK+yBWh2Z9ELFSzOsyB1JY9yxqy+ILxg94TinmOzAVNIY3FcwOG/eLieIYmvVRA67XYNUfUkfI18PzO9BF1FYsuvyWC9C/eq/bikeAiPyMs3BRXrNAasJdNjfZz8wOjC11jxtUogDIlrwv6lAZsMiQUwc2qhgpXt13gmagGgp7mrD2nQ/MA4NPC6xGVDe37idTIt/iPFEv6lSvW7F667gMasAARhtpALjusRs/XUKd8ojA8s3/AFQtOFD/AFLJ8EYmhqf9tZX+KD/MTIzkI1BF2pPyMiA/42gtKapnzq+4WEzKbXlZfeKbWdh5rSIhea6kp/Awe5AbyxhlDF9idDBAC2HcmKxuHWNO8OGDdFfaOsCAKYK4IgIuTR+SvodQU7xBbA1uMUOhBEzK8BEbfxEbcoHHyEUwTqIP0pEXXcqf5MWA4A/bmU8047LLcgfkgNEm9P8ACOCrmqfJDjxl0wHb2iGEwi9zT59FSzUOzY5ltRUlEfDNKL7Q1dTvDq4sMuwbSjrDF44YihX3DMOYYZ0mSzZSTJiGfhhOa/MA0zyykreIaw6JUyGTkifEcLZFdrkg4YNKRuBR2ynR+YnmDSt41U5J1SiGZwy9SRvJGOGXaREatSVgLOZSZL9FB5RXoMYYk2xO2aaNTsuAURO4xwW6meedj5gBmPRi2SswsVMymAtxDqXaQDeK9ZbG2gzFkUwkllGuE6kT4YxpLmpADpEXDCRwywYFaynMwcxQuDEGEzGzKrga0mjiZwg1Moh2gwplxKJmELmevoDioiZjl5hBzG9zP//Z - RuntimeContext: [] - application/vnd.ibexa.api.ai.GenerateAltText+xml: - schema: - $ref: '#/components/schemas/GenerateAltText' - example: | - - - - 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 - - - - 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: | - - - - Hey, wassup. What you've been doing the whole day? - - - - required: false - deprecated: false - /ai/actions/{identifier}: - get: - operationId: ibexa.rest.ai.action - tags: - - Connector AI - 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: | - - - rewrite_with_friendly_tone - Rewrite in friendly tone - - 1 - - refine_text - Refine text - text - text - - - - openai-text-to-text - - 4000 - 1 - Rewrite text in friendly tone. Preserve meaning and crucial information. - gpt-4-turbo - - 2025-08-07T13:16:47+02:00 - 2025-08-07T13:16:47+02:00 - - 404: - description: Error - an action configuration of the given unique identifier - is not found. - 401: - description: "Error \u2013 the user doesn't have access to the given action - configuration" - summary: Get an action configuration by its unique identifier. - description: Returns an action configuration by its unique string identifier. - parameters: - - name: identifier - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - example: rewrite_with_friendly_tone - deprecated: false - /corporate: - get: - operationId: ibexa.rest.corporate_account.root - tags: - - Corporate Account - responses: - 200: - description: List of Link objects to specific Corporate Account REST resources - content: - application/vnd.ibexa.api.CorporateAccountRoot+json: - schema: - $ref: '#/components/schemas/CorporateAccountRootWrapper' - example: - CorporateAccountRoot: - _media-type: application/vnd.ibexa.api.CorporateAccountRoot+json - links: - - _media-type: application/vnd.ibexa.api.CompaniesList+json - _rel: ca-companies - _href: /api/ibexa/v2/corporate/companies - - _media-type: application/vnd.ibexa.api.ContentTypeGroup+json - _rel: ca-types - _href: /api/ibexa/v2/content/typegroups?identifier=corporate_account - - _media-type: application/vnd.ibexa.api.ContentType+json - _rel: ca-types-company - _href: /api/ibexa/v2/content/types/48 - - _media-type: application/vnd.ibexa.api.ContentType+json - _rel: ca-types-member - _href: /api/ibexa/v2/content/types/47 - - _media-type: application/vnd.ibexa.api.ContentType+json - _rel: ca-types-address - _href: /api/ibexa/v2/content/types/49 - - _media-type: application/vnd.ibexa.api.SalesRepresentativesList+json - _rel: ca-sales-representatives - _href: /api/ibexa/v2/corporate/sales-representatives - - _media-type: application/vnd.ibexa.api.Role+json - _rel: ca-role-admin - _href: /api/ibexa/v2/user/roles/14 - - _media-type: application/vnd.ibexa.api.Role+json - _rel: ca-role-buyer - _href: /api/ibexa/v2/user/roles/15 - application/vnd.ibexa.api.CorporateAccountRoot+xml: - schema: - $ref: '#/components/schemas/CorporateAccountRoot' - example: | - - - - - - - - - - - - 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: - schema: - $ref: '#/components/schemas/CompanyList' - example: | - - - - 66 - Ibexa AS - - - Ibexa AS - Ibexa AS - - - - - 593 - 1 - PUBLISHED - 2023-04-03T13:09:40+02:00 - - 2023-04-03T13:09:40+02:00 - eng-GB - eng-GB - - - eng-GB - - - - Ibexa AS - - - - - - 295 - active - eng-GB - ibexa_boolean - true - - - 296 - name - eng-GB - ibexa_string - Ibexa AS - - - 297 - vat - eng-GB - ibexa_string - 123 456 789 - - - 298 - website - eng-GB - ibexa_string - https://ibexa.co - - - 299 - customer_group - eng-GB - ibexa_customer_group - - 1 - - - - 300 - sales_rep - eng-GB - ibexa_object_relation - - 14 - /api/ibexa/v2/content/objects/14 - - - - 301 - contact - eng-GB - ibexa_object_relation - - 74 - /api/ibexa/v2/content/objects/74 - - - - 302 - default_address - eng-GB - ibexa_object_relation - - 69 - /api/ibexa/v2/content/objects/69 - - - - 303 - billing_address - eng-GB - ibexa_address - - HQ - PL - - Silesia - Katowice - Gliwicka 6/5 - 40-079 - company@email.invalid - +48 000 000 000 - - - - - 305 - members - eng-GB - ibexa_object_relation - - 67 - /api/ibexa/v2/content/objects/67 - - - - 304 - address_book - eng-GB - ibexa_object_relation - - 68 - /api/ibexa/v2/content/objects/68 - - - - - - /placeholder - - - image/svg+xml - - - -
- - - - 2023-04-03T13:09:40+02:00 - 2023-03-31T14:33:36+02:00 - eng-GB - 1 - true - false - PUBLISHED - - - HQ, Poland - 74 - 14 - 69 - 68 - 67 - - - /1/65/67/ - 1 - - - 75 - QNTM Group AB - - - QNTM Group AB - QNTM Group AB - - - - - 546 - 3 - PUBLISHED - 2023-03-31T15:24:49+02:00 - - 2023-03-31T15:24:49+02:00 - eng-GB - eng-GB - - - eng-GB - - - - QNTM Group AB - - - - - - 341 - active - eng-GB - ibexa_boolean - true - - - 342 - name - eng-GB - ibexa_string - QNTM Group AB - - - 343 - vat - eng-GB - ibexa_string - 123 456 789 - - - 344 - website - eng-GB - ibexa_string - https://ibexa.co - - - 345 - customer_group - eng-GB - ibexa_customer_group - - 1 - - - - 346 - sales_rep - eng-GB - ibexa_object_relation - - 14 - /api/ibexa/v2/content/objects/14 - - - - 347 - contact - eng-GB - ibexa_object_relation - - - - - - 348 - default_address - eng-GB - ibexa_object_relation - - - - - - 349 - billing_address - eng-GB - ibexa_address - - - - - - - - 351 - members - eng-GB - ibexa_object_relation - - 76 - /api/ibexa/v2/content/objects/76 - - - - 350 - address_book - eng-GB - ibexa_object_relation - - 77 - /api/ibexa/v2/content/objects/77 - - - - - - /placeholder - - - image/svg+xml - - - -
- - - - 2023-03-31T15:24:49+02:00 - 2023-03-31T15:24:48+02:00 - eng-GB - 3 - true - false - PUBLISHED - - - - - 14 - - 77 - 76 - - - /1/65/76/ - 1 - - - 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 - post: - operationId: ibexa.rest.corporate_account.companies.create - tags: - - Corporate Account - responses: - 201: - description: If set, the new company is returned in XML or JSON format. - content: - application/vnd.ibexa.api.Company+json: - schema: - $ref: '#/components/schemas/CompanyWrapper' - example: - Company: - _media-type: application/vnd.ibexa.api.Company+json - id: 66 - name: Ibexa AS - Content: - _media-type: application/vnd.ibexa.api.Content+json - _href: /api/ibexa/v2/content/objects/66 - _remoteId: 9f20fb03d0ab0a6aef9930f7e6720377 - _id: 66 - ContentType: - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/48 - Name: Ibexa AS - TranslatedName: Ibexa AS - Versions: - _media-type: application/vnd.ibexa.api.VersionList+json - _href: /api/ibexa/v2/content/objects/66/versions - CurrentVersion: - _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/66/currentversion - Version: - _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/66/versions/1 - VersionInfo: - id: 593 - versionNo: 1 - status: PUBLISHED - modificationDate: "2023-04-03T13:09:40+02:00" - Creator: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - creationDate: "2023-04-03T13:09:40+02:00" - initialLanguageCode: eng-GB - languageCodes: eng-GB - VersionTranslationInfo: - _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json - Language: - - languageCode: eng-GB - names: - value: - - _languageCode: eng-GB - '#text': Ibexa AS - Content: - _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/66 - Fields: - field: - - id: 295 - fieldDefinitionIdentifier: active - languageCode: eng-GB - fieldTypeIdentifier: ibexa_boolean - fieldValue: true - - id: 296 - fieldDefinitionIdentifier: name - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: Ibexa AS - - id: 297 - fieldDefinitionIdentifier: vat - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: 123 456 789 - - id: 298 - fieldDefinitionIdentifier: website - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: https://ibexa.co - - id: 299 - fieldDefinitionIdentifier: customer_group - languageCode: eng-GB - fieldTypeIdentifier: ibexa_customer_group - fieldValue: - customer_group_id: 1 - - id: 300 - fieldDefinitionIdentifier: sales_rep - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 14 - destinationContentHref: /api/ibexa/v2/content/objects/14 - - id: 301 - fieldDefinitionIdentifier: contact - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 74 - destinationContentHref: /api/ibexa/v2/content/objects/74 - - id: 302 - fieldDefinitionIdentifier: default_address - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 69 - destinationContentHref: /api/ibexa/v2/content/objects/69 - - id: 303 - fieldDefinitionIdentifier: billing_address - languageCode: eng-GB - fieldTypeIdentifier: ibexa_address - fieldValue: - name: Headquarters - country: "NO" - fields: - region: Company HQ location region - locality: Company HQ location city - street: Company HQ location street and building - postal_code: "00000" - email: company@email.invalid - phone_number: +47 000 000 000 - - id: 305 - fieldDefinitionIdentifier: members - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 67 - destinationContentHref: /api/ibexa/v2/content/objects/67 - - id: 304 - fieldDefinitionIdentifier: address_book - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 68 - destinationContentHref: /api/ibexa/v2/content/objects/68 - Relations: - _media-type: application/vnd.ibexa.api.RelationList+json - _href: /api/ibexa/v2/content/objects/66/versions/1/relations - Relation: [] - Thumbnail: - _media-type: application/vnd.ibexa.api.Thumbnail+json - resource: /placeholder - width: ~ - 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: - schema: - $ref: '#/components/schemas/Company' - example: | - - - 66 - Ibexa AS - - - Ibexa AS - Ibexa AS - - - - - 593 - 1 - PUBLISHED - 2023-04-03T13:09:40+02:00 - - 2023-04-03T13:09:40+02:00 - eng-GB - eng-GB - - - eng-GB - - - - Ibexa AS - - - - - - 295 - active - eng-GB - ibexa_boolean - true - - - 296 - name - eng-GB - ibexa_string - Ibexa AS - - - 297 - vat - eng-GB - ibexa_string - 123 456 789 - - - 298 - website - eng-GB - ibexa_string - https://ibexa.co - - - 299 - customer_group - eng-GB - ibexa_customer_group - - 1 - - - - 300 - sales_rep - eng-GB - ibexa_object_relation - - 14 - /api/ibexa/v2/content/objects/14 - - - - 301 - contact - eng-GB - ibexa_object_relation - - 74 - /api/ibexa/v2/content/objects/74 - - - - 302 - default_address - eng-GB - ibexa_object_relation - - 69 - /api/ibexa/v2/content/objects/69 - - - - 303 - billing_address - eng-GB - ibexa_address - - HQ - PL - - Silesia - Katowice - Gliwicka 6/5 - 40-079 - company@email.invalid - +48 000 000 000 - - - - - 305 - members - eng-GB - ibexa_object_relation - - 67 - /api/ibexa/v2/content/objects/67 - - - - 304 - address_book - eng-GB - ibexa_object_relation - - 68 - /api/ibexa/v2/content/objects/68 - - - - - - /placeholder - - - image/svg+xml - - - -
- - - - 2023-04-03T13:09:40+02:00 - 2023-03-31T14:33:36+02:00 - eng-GB - 1 - true - false - PUBLISHED - - - HQ, Poland - 74 - 80 - 69 - 68 - 67 - - - /1/65/67/ - 1 - - 400: - description: Error - the input does not match the input schema definition. - 401: - description: Error - the user is not authorized to create this Company. - summary: Create a company - description: Creates a CompanyCreateController resource. - parameters: - - name: X-CSRF-Token - in: header - description: Only needed for session's checking. The {csrfToken} needed on - all unsafe HTTP methods with session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The CompanyCreate schema encoded in XML or JSON format. - content: - application/vnd.ibexa.api.CompanyCreate+json: - schema: - $ref: '#/components/schemas/CompanyCreateWrapper' - example: - CompanyCreate: - fields: - field: - - fieldDefinitionIdentifier: active - fieldValue: true - - fieldDefinitionIdentifier: name - fieldValue: Ibexa Sp. z o. o. - - fieldDefinitionIdentifier: vat - fieldValue: 123 456 789 - - fieldDefinitionIdentifier: website - fieldValue: https://ibexa.co - - fieldDefinitionIdentifier: customer_group - fieldValue: - customer_group_id: 1 - - fieldDefinitionIdentifier: sales_rep - fieldValue: - destinationContentId: 14 - - fieldDefinitionIdentifier: billing_address - fieldValue: - name: HQ - country: PL - fields: - region: Silesia - locality: Katowice - street: Gliwicka 6/5 - postal_code: 40-079 - email: company@email.invalid - phone_number: +48 000 000 000 - application/vnd.ibexa.api.CompanyCreate+xml: - schema: - $ref: '#/components/schemas/CompanyCreate' - example: | - - - - - - active - true - - - name - Ibexa Sp. z o. o. - - - vat - 123 456 789 - - - website - https://ibexa.co - - - customer_group - - 1 - - - - sales_rep - - 14 - - - - billing_address - - HQ - PL - - Silesia - Katowice - Gliwicka 6/5 - 40-079 - company@email.invalid - +48 000 000 000 - - - - - - required: false - deprecated: false - x-badges: - - name: Experience - color: '#D3822B' - - name: Commerce - color: '#A32768' - position: after - /corporate/companies/{companyId}: - get: - operationId: ibexa.rest.corporate_account.companies.get - tags: - - Corporate Account - responses: - 200: - description: If set, the company is returned in XML or JSON format. - content: - application/vnd.ibexa.api.Company+json: - schema: - $ref: '#/components/schemas/CompanyWrapper' - example: - Company: - _media-type: application/vnd.ibexa.api.Company+json - id: 66 - name: Ibexa AS - Content: - _media-type: application/vnd.ibexa.api.Content+json - _href: /api/ibexa/v2/content/objects/66 - _remoteId: 9f20fb03d0ab0a6aef9930f7e6720377 - _id: 66 - ContentType: - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/48 - Name: Ibexa AS - TranslatedName: Ibexa AS - Versions: - _media-type: application/vnd.ibexa.api.VersionList+json - _href: /api/ibexa/v2/content/objects/66/versions - CurrentVersion: - _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/66/currentversion - Version: - _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/66/versions/1 - VersionInfo: - id: 593 - versionNo: 1 - status: PUBLISHED - modificationDate: "2023-04-03T13:09:40+02:00" - Creator: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - creationDate: "2023-04-03T13:09:40+02:00" - initialLanguageCode: eng-GB - languageCodes: eng-GB - VersionTranslationInfo: - _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json - Language: - - languageCode: eng-GB - names: - value: - - _languageCode: eng-GB - '#text': Ibexa AS - Content: - _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/66 - Fields: - field: - - id: 295 - fieldDefinitionIdentifier: active - languageCode: eng-GB - fieldTypeIdentifier: ibexa_boolean - fieldValue: true - - id: 296 - fieldDefinitionIdentifier: name - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: Ibexa AS - - id: 297 - fieldDefinitionIdentifier: vat - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: 123 456 789 - - id: 298 - fieldDefinitionIdentifier: website - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: https://ibexa.co - - id: 299 - fieldDefinitionIdentifier: customer_group - languageCode: eng-GB - fieldTypeIdentifier: ibexa_customer_group - fieldValue: - customer_group_id: 1 - - id: 300 - fieldDefinitionIdentifier: sales_rep - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 14 - destinationContentHref: /api/ibexa/v2/content/objects/14 - - id: 301 - fieldDefinitionIdentifier: contact - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 74 - destinationContentHref: /api/ibexa/v2/content/objects/74 - - id: 302 - fieldDefinitionIdentifier: default_address - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 69 - destinationContentHref: /api/ibexa/v2/content/objects/69 - - id: 303 - fieldDefinitionIdentifier: billing_address - languageCode: eng-GB - fieldTypeIdentifier: ibexa_address - fieldValue: - name: Headquarters - country: "NO" - fields: - region: Company HQ location region - locality: Company HQ location city - street: Company HQ location street and building - postal_code: "00000" - email: company@email.invalid - phone_number: +47 000 000 000 - - id: 305 - fieldDefinitionIdentifier: members - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 67 - destinationContentHref: /api/ibexa/v2/content/objects/67 - - id: 304 - fieldDefinitionIdentifier: address_book - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 68 - destinationContentHref: /api/ibexa/v2/content/objects/68 - Relations: - _media-type: application/vnd.ibexa.api.RelationList+json - _href: /api/ibexa/v2/content/objects/66/versions/1/relations - Relation: [] - Thumbnail: - _media-type: application/vnd.ibexa.api.Thumbnail+json - resource: /placeholder - width: ~ - 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: - schema: - $ref: '#/components/schemas/Company' - example: | - - - 66 - Ibexa AS - - - Ibexa AS - Ibexa AS - - - - - 593 - 1 - PUBLISHED - 2023-04-03T13:09:40+02:00 - - 2023-04-03T13:09:40+02:00 - eng-GB - eng-GB - - - eng-GB - - - - Ibexa AS - - - - - - 295 - active - eng-GB - ibexa_boolean - true - - - 296 - name - eng-GB - ibexa_string - Ibexa AS - - - 297 - vat - eng-GB - ibexa_string - 123 456 789 - - - 298 - website - eng-GB - ibexa_string - https://ibexa.co - - - 299 - customer_group - eng-GB - ibexa_customer_group - - 1 - - - - 300 - sales_rep - eng-GB - ibexa_object_relation - - 14 - /api/ibexa/v2/content/objects/14 - - - - 301 - contact - eng-GB - ibexa_object_relation - - 74 - /api/ibexa/v2/content/objects/74 - - - - 302 - default_address - eng-GB - ibexa_object_relation - - 69 - /api/ibexa/v2/content/objects/69 - - - - 303 - billing_address - eng-GB - ibexa_address - - HQ - PL - - Silesia - Katowice - Gliwicka 6/5 - 40-079 - company@email.invalid - +48 000 000 000 - - - - - 305 - members - eng-GB - ibexa_object_relation - - 67 - /api/ibexa/v2/content/objects/67 - - - - 304 - address_book - eng-GB - ibexa_object_relation - - 68 - /api/ibexa/v2/content/objects/68 - - - - - - /placeholder - - - image/svg+xml - - - -
- - - - 2023-04-03T13:09:40+02:00 - 2023-03-31T14:33:36+02:00 - eng-GB - 1 - true - false - PUBLISHED - - - HQ, Poland - 74 - 80 - 69 - 68 - 67 - - - /1/65/67/ - 1 - - 401: - description: Error - The user is not authorized to read this company. - 404: - description: Error - The company does not exist. - summary: Get company - description: Returns the company by given company ID. - parameters: - - name: If-None-match - in: header - description: ETag - required: false - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: companyId - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false - x-badges: - - name: Experience - color: '#D3822B' - - name: Commerce - color: '#A32768' - position: after - delete: - operationId: ibexa.rest.corporate_account.companies.delete - tags: - - Corporate Account - responses: - 204: - description: No Content - given company is deleted. - 401: - description: Error - the user is not authorized to delete this company. - 404: - description: Error - the company does not exist. - summary: Delete company - description: The given company is deleted. - parameters: - - name: X-CSRF-Token - in: header - description: Only needed for session's checking. The {csrfToken} needed on - all unsafe HTTP methods with session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: companyId - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false - x-badges: - - name: Experience - color: '#D3822B' - - name: Commerce - color: '#A32768' - position: after - patch: - operationId: ibexa.rest.corporate_account.companies.update - tags: - - Corporate Account - responses: - 200: - description: OK - company updated. - content: - application/vnd.ibexa.api.Company+json: - schema: - $ref: '#/components/schemas/CompanyWrapper' - example: - Company: - _media-type: application/vnd.ibexa.api.Company+json - id: 66 - name: Ibexa AS - Content: - _media-type: application/vnd.ibexa.api.Content+json - _href: /api/ibexa/v2/content/objects/66 - _remoteId: 9f20fb03d0ab0a6aef9930f7e6720377 - _id: 66 - ContentType: - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/48 - Name: Ibexa AS - TranslatedName: Ibexa AS - Versions: - _media-type: application/vnd.ibexa.api.VersionList+json - _href: /api/ibexa/v2/content/objects/66/versions - CurrentVersion: - _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/66/currentversion - Version: - _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/66/versions/1 - VersionInfo: - id: 593 - versionNo: 1 - status: PUBLISHED - modificationDate: "2023-04-03T13:09:40+02:00" - Creator: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - creationDate: "2023-04-03T13:09:40+02:00" - initialLanguageCode: eng-GB - languageCodes: eng-GB - VersionTranslationInfo: - _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json - Language: - - languageCode: eng-GB - names: - value: - - _languageCode: eng-GB - '#text': Ibexa AS - Content: - _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/66 - Fields: - field: - - id: 295 - fieldDefinitionIdentifier: active - languageCode: eng-GB - fieldTypeIdentifier: ibexa_boolean - fieldValue: true - - id: 296 - fieldDefinitionIdentifier: name - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: Ibexa AS - - id: 297 - fieldDefinitionIdentifier: vat - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: 123 456 789 - - id: 298 - fieldDefinitionIdentifier: website - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: https://ibexa.co - - id: 299 - fieldDefinitionIdentifier: customer_group - languageCode: eng-GB - fieldTypeIdentifier: ibexa_customer_group - fieldValue: - customer_group_id: 1 - - id: 300 - fieldDefinitionIdentifier: sales_rep - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 14 - destinationContentHref: /api/ibexa/v2/content/objects/14 - - id: 301 - fieldDefinitionIdentifier: contact - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 74 - destinationContentHref: /api/ibexa/v2/content/objects/74 - - id: 302 - fieldDefinitionIdentifier: default_address - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 69 - destinationContentHref: /api/ibexa/v2/content/objects/69 - - id: 303 - fieldDefinitionIdentifier: billing_address - languageCode: eng-GB - fieldTypeIdentifier: ibexa_address - fieldValue: - name: Headquarters - country: "NO" - fields: - region: Company HQ location region - locality: Company HQ location city - street: Company HQ location street and building - postal_code: "00000" - email: company@email.invalid - phone_number: +47 000 000 000 - - id: 305 - fieldDefinitionIdentifier: members - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 67 - destinationContentHref: /api/ibexa/v2/content/objects/67 - - id: 304 - fieldDefinitionIdentifier: address_book - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 68 - destinationContentHref: /api/ibexa/v2/content/objects/68 - Relations: - _media-type: application/vnd.ibexa.api.RelationList+json - _href: /api/ibexa/v2/content/objects/66/versions/1/relations - Relation: [] - Thumbnail: - _media-type: application/vnd.ibexa.api.Thumbnail+json - resource: /placeholder - width: ~ - 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: - schema: - $ref: '#/components/schemas/Company' - example: | - - - 66 - Ibexa AS - - - Ibexa AS - Ibexa AS - - - - - 593 - 1 - PUBLISHED - 2023-04-03T13:09:40+02:00 - - 2023-04-03T13:09:40+02:00 - eng-GB - eng-GB - - - eng-GB - - - - Ibexa AS - - - - - - 295 - active - eng-GB - ibexa_boolean - true - - - 296 - name - eng-GB - ibexa_string - Ibexa AS - - - 297 - vat - eng-GB - ibexa_string - 123 456 789 - - - 298 - website - eng-GB - ibexa_string - https://ibexa.co - - - 299 - customer_group - eng-GB - ibexa_customer_group - - 1 - - - - 300 - sales_rep - eng-GB - ibexa_object_relation - - 14 - /api/ibexa/v2/content/objects/14 - - - - 301 - contact - eng-GB - ibexa_object_relation - - 74 - /api/ibexa/v2/content/objects/74 - - - - 302 - default_address - eng-GB - ibexa_object_relation - - 69 - /api/ibexa/v2/content/objects/69 - - - - 303 - billing_address - eng-GB - ibexa_address - - HQ - PL - - Silesia - Katowice - Gliwicka 6/5 - 40-079 - company@email.invalid - +48 000 000 000 - - - - - 305 - members - eng-GB - ibexa_object_relation - - 67 - /api/ibexa/v2/content/objects/67 - - - - 304 - address_book - eng-GB - ibexa_object_relation - - 68 - /api/ibexa/v2/content/objects/68 - - - - - - /placeholder - - - image/svg+xml - - - -
- - - - 2023-04-03T13:09:40+02:00 - 2023-03-31T14:33:36+02:00 - eng-GB - 1 - true - false - PUBLISHED - - - HQ, Poland - 74 - 80 - 69 - 68 - 67 - - - /1/65/67/ - 1 - - 400: - description: Error - the input does not match the input schema definition. - 401: - description: Error - the user is not authorized to create this company. - summary: Update a company - description: Updates a company. PATCH or POST with header X-HTTP-Method-Override - PATCH. - parameters: - - name: 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: If-Match - in: header - description: ETag - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: companyId - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The company input schema encoded in XML or JSON. - content: - application/vnd.ibexa.api.CompanyUpdate+json: - schema: - $ref: '#/components/schemas/CompanyUpdateWrapper' - example: - CompanyUpdate: - fields: - field: - - fieldDefinitionIdentifier: contact - fieldValue: - destinationContentId: 144 - application/vnd.ibexa.api.CompanyUpdate+xml: - schema: - $ref: '#/components/schemas/CompanyUpdate' - example: | - - - - - contact - - 144 - - - - - required: false - deprecated: false - x-badges: - - name: Experience - color: '#D3822B' - - name: Commerce - color: '#A32768' - position: after - /corporate/companies/{companyId}/members: - get: - operationId: ibexa.rest.corporate_account.members.list - tags: - - Corporate Account - responses: - 200: - description: If set, helps to determine response format. - content: - application/vnd.ibexa.api.MemberList+json: - schema: - $ref: '#/components/schemas/MemberListWrapper' - example: - MemberList: - _media-type: application/vnd.ibexa.api.MemberList+json - _href: /api/ibexa/v2/corporate/companies/139/members - members: - - _media-type: application/vnd.ibexa.api.Member+json - _href: /api/ibexa/v2/corporate/companies/139/members/144 - id: 144 - name: Jay Kowalski - Company: - _media-type: application/vnd.ibexa.api.Company+json - id: 139 - name: Ibexa Sp. z o. o. - Content: - _media-type: application/vnd.ibexa.api.Content+json - _href: /api/ibexa/v2/content/objects/139 - _remoteId: b16d06d4c5ba7c37b26fa167b551dfc2 - _id: 139 - ContentType: - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/48 - Name: Ibexa Sp. z o. o. - TranslatedName: Ibexa Sp. z o. o. - Versions: - _media-type: application/vnd.ibexa.api.VersionList+json - _href: /api/ibexa/v2/content/objects/139/versions - CurrentVersion: - _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/139/currentversion - Version: - _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/139/versions/6 - VersionInfo: - id: 677 - versionNo: 6 - status: PUBLISHED - modificationDate: "2023-04-28T16:10:13+02:00" - Creator: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - creationDate: "2023-04-28T16:10:13+02:00" - initialLanguageCode: eng-GB - languageCodes: eng-GB - VersionTranslationInfo: - _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json - Language: - - languageCode: eng-GB - names: - value: - - _languageCode: eng-GB - '#text': Ibexa Sp. z o. o. - Content: - _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/139 - Fields: - field: - - id: 673 - fieldDefinitionIdentifier: active - languageCode: eng-GB - fieldTypeIdentifier: ibexa_boolean - fieldValue: true - - id: 674 - fieldDefinitionIdentifier: name - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: Ibexa Sp. z o. o. - - id: 675 - fieldDefinitionIdentifier: vat - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: 123 456 789 - - id: 676 - fieldDefinitionIdentifier: website - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: https://ibexa.co - - id: 677 - fieldDefinitionIdentifier: customer_group - languageCode: eng-GB - fieldTypeIdentifier: ibexa_customer_group - fieldValue: - customer_group_id: 1 - - id: 678 - fieldDefinitionIdentifier: sales_rep - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 14 - destinationContentHref: /api/ibexa/v2/content/objects/14 - - id: 679 - fieldDefinitionIdentifier: contact - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 144 - destinationContentHref: /api/ibexa/v2/content/objects/144 - - id: 680 - fieldDefinitionIdentifier: default_address - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 142 - destinationContentHref: /api/ibexa/v2/content/objects/142 - - id: 681 - fieldDefinitionIdentifier: billing_address - languageCode: eng-GB - fieldTypeIdentifier: ibexa_address - fieldValue: - name: HQ - country: PL - fields: - region: Silesia - locality: Katowice - street: Gliwicka 6/5 - postal_code: 40-079 - email: company@email.invalid - phone_number: +48 000 000 000 - - id: 683 - fieldDefinitionIdentifier: members - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 140 - destinationContentHref: /api/ibexa/v2/content/objects/140 - - id: 682 - fieldDefinitionIdentifier: address_book - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 141 - destinationContentHref: /api/ibexa/v2/content/objects/141 - Relations: - _media-type: application/vnd.ibexa.api.RelationList+json - _href: /api/ibexa/v2/content/objects/139/versions/6/relations - Relation: [] - Thumbnail: - _media-type: application/vnd.ibexa.api.Thumbnail+json - resource: /placeholder - width: ~ - 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: | - - - - 144 - Jay Kowalski - - 139 - Ibexa Sp. z o. o. - - - Ibexa Sp. z o. o. - Ibexa Sp. z o. o. - - - - - 677 - 6 - PUBLISHED - 2023-04-28T16:10:13+02:00 - - 2023-04-28T16:10:13+02:00 - eng-GB - eng-GB - - - eng-GB - - - - Ibexa Sp. z o. o. - - - - - - 673 - active - eng-GB - ibexa_boolean - true - - - 674 - name - eng-GB - ibexa_string - Ibexa Sp. z o. o. - - - 675 - vat - eng-GB - ibexa_string - 123 456 789 - - - 676 - website - eng-GB - ibexa_string - https://ibexa.co - - - 677 - customer_group - eng-GB - ibexa_customer_group - - 1 - - - - 678 - sales_rep - eng-GB - ibexa_object_relation - - 14 - /api/ibexa/v2/content/objects/14 - - - - 679 - contact - eng-GB - ibexa_object_relation - - 144 - /api/ibexa/v2/content/objects/144 - - - - 680 - default_address - eng-GB - ibexa_object_relation - - 142 - /api/ibexa/v2/content/objects/142 - - - - 681 - billing_address - eng-GB - ibexa_address - - HQ - PL - - Silesia - Katowice - Gliwicka 6/5 - 40-079 - company@email.invalid - +48 000 000 000 - - - - - 683 - members - eng-GB - ibexa_object_relation - - 140 - /api/ibexa/v2/content/objects/140 - - - - 682 - address_book - eng-GB - ibexa_object_relation - - 141 - /api/ibexa/v2/content/objects/141 - - - - - - /placeholder - - - image/svg+xml - - - -
- - - - 2023-04-28T16:10:13+02:00 - 2023-04-28T15:44:55+02:00 - eng-GB - 6 - true - false - PUBLISHED - - - HQ, Poland - 144 - 14 - 142 - 141 - 140 - - - /1/65/140/ - 1 - - - - Jay Kowalski - -
- - - - - 2023-04-28T16:10:03+02:00 - 2023-04-28T16:17:07+02:00 - eng-GB - true - - - 683 - 6 - PUBLISHED - 2023-04-28T16:17:07+02:00 - - 2023-04-28T16:17:06+02:00 - eng-GB - eng-GB - - - eng-GB - - - - Jay Kowalski - - - - - - 698 - first_name - eng-GB - ibexa_string - Jay - - - 699 - last_name - eng-GB - ibexa_string - Kowalski - - - 700 - phone_number - eng-GB - ibexa_string - +48 123 123 456 - - - 701 - user - eng-GB - ibexa_user - - true - 144 - jay.kowalski - jay.kowalski@email.invalid - 1682691427 - false - 5 - - - - - - - /user/default_profile_image/initials.svg?initials=JK#profile_image - - - image/svg+xml - - - jay.kowalski - jay.kowalski@email.invalid - false - - - - - Company Buyer - - - - - 400: - description: Returned when invalid Criterion or Sort clause is used. - content: - application/vnd.ibexa.api.ErrorMessage: - schema: - $ref: '#/components/schemas/ErrorMessage' - 404: - description: Error - The identifier do not match any company. - summary: Read list of company members - description: Returns paginated list of a given company members. - parameters: - - name: companyId - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: filter[DateMetadataCriterion][Target] - in: query - description: "" - required: false - deprecated: false - allowEmptyValue: false - schema: - type: string - enum: - - created - - modified - - published - style: form - explode: false - allowReserved: false - - name: filter[DateMetadataCriterion][Operator] - in: query - description: "" - required: false - deprecated: false - allowEmptyValue: false - schema: - type: string - enum: - - eq - - gt - - gte - - lt - - lte - style: form - explode: false - allowReserved: false - - name: filter[DateMetadataCriterion][Value] - in: query - description: DateTime as a UNIX timestamp - required: false - deprecated: false - allowEmptyValue: false - schema: - type: integer - style: form - explode: false - allowReserved: false - - name: sort[ContentName] - in: query - description: "" - required: false - deprecated: false - allowEmptyValue: false - schema: - type: string - enum: - - ascending - - descending - style: form - explode: false - allowReserved: false - - name: sort[DatePublished] - in: query - description: "" - required: false - deprecated: false - allowEmptyValue: false - schema: - type: string - enum: - - ascending - - descending - style: form - explode: false - allowReserved: false - - name: sort[DateModified] - in: query - description: "" - required: false - deprecated: false - allowEmptyValue: false - schema: - type: string - enum: - - ascending - - descending - style: form - explode: false - allowReserved: false - - name: offset - in: query - description: "" - required: false - deprecated: false - allowEmptyValue: false - schema: - type: integer - style: form - explode: false - allowReserved: false - - name: limit - in: query - description: "" - required: false - deprecated: false - allowEmptyValue: false - schema: - type: integer - style: form - explode: false - allowReserved: false - deprecated: false - x-badges: - - name: Experience - color: '#D3822B' - - name: Commerce - color: '#A32768' - position: after - post: - operationId: ibexa.rest.corporate_account.members.create - tags: - - Corporate Account - responses: - 201: - description: OK - company member created and returned. - content: - application/vnd.ibexa.api.Member+json: - schema: - $ref: '#/components/schemas/MemberWrapper' - example: - Member: - _media-type: application/vnd.ibexa.api.Member+json - _href: /api/ibexa/v2/corporate/companies/139/members/144 - id: 144 - name: Jay Kowalski - Company: - _media-type: application/vnd.ibexa.api.Company+json - id: 139 - name: Ibexa Sp. z o. o. - Content: - _media-type: application/vnd.ibexa.api.Content+json - _href: /api/ibexa/v2/content/objects/139 - _remoteId: b16d06d4c5ba7c37b26fa167b551dfc2 - _id: 139 - ContentType: - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/48 - Name: Ibexa Sp. z o. o. - TranslatedName: Ibexa Sp. z o. o. - Versions: - _media-type: application/vnd.ibexa.api.VersionList+json - _href: /api/ibexa/v2/content/objects/139/versions - CurrentVersion: - _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/139/currentversion - Version: - _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/139/versions/6 - VersionInfo: - id: 677 - versionNo: 6 - status: PUBLISHED - modificationDate: "2023-04-28T16:10:13+02:00" - Creator: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - creationDate: "2023-04-28T16:10:13+02:00" - initialLanguageCode: eng-GB - languageCodes: eng-GB - VersionTranslationInfo: - _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json - Language: - - languageCode: eng-GB - names: - value: - - _languageCode: eng-GB - '#text': Ibexa Sp. z o. o. - Content: - _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/139 - Fields: - field: - - id: 673 - fieldDefinitionIdentifier: active - languageCode: eng-GB - fieldTypeIdentifier: ibexa_boolean - fieldValue: true - - id: 674 - fieldDefinitionIdentifier: name - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: Ibexa Sp. z o. o. - - id: 675 - fieldDefinitionIdentifier: vat - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: 123 456 789 - - id: 676 - fieldDefinitionIdentifier: website - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: https://ibexa.co - - id: 677 - fieldDefinitionIdentifier: customer_group - languageCode: eng-GB - fieldTypeIdentifier: ibexa_customer_group - fieldValue: - customer_group_id: 1 - - id: 678 - fieldDefinitionIdentifier: sales_rep - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 14 - destinationContentHref: /api/ibexa/v2/content/objects/14 - - id: 679 - fieldDefinitionIdentifier: contact - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 144 - destinationContentHref: /api/ibexa/v2/content/objects/144 - - id: 680 - fieldDefinitionIdentifier: default_address - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 142 - destinationContentHref: /api/ibexa/v2/content/objects/142 - - id: 681 - fieldDefinitionIdentifier: billing_address - languageCode: eng-GB - fieldTypeIdentifier: ibexa_address - fieldValue: - name: HQ - country: PL - fields: - region: Silesia - locality: Katowice - street: Gliwicka 6/5 - postal_code: 40-079 - email: company@email.invalid - phone_number: +48 000 000 000 - - id: 683 - fieldDefinitionIdentifier: members - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 140 - destinationContentHref: /api/ibexa/v2/content/objects/140 - - id: 682 - fieldDefinitionIdentifier: address_book - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 141 - destinationContentHref: /api/ibexa/v2/content/objects/141 - Relations: - _media-type: application/vnd.ibexa.api.RelationList+json - _href: /api/ibexa/v2/content/objects/139/versions/6/relations - Relation: [] - Thumbnail: - _media-type: application/vnd.ibexa.api.Thumbnail+json - resource: /placeholder - width: ~ - 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: - schema: - $ref: '#/components/schemas/Member' - example: | - - - 144 - Jay Kowalski - - 139 - Ibexa Sp. z o. o. - - - Ibexa Sp. z o. o. - Ibexa Sp. z o. o. - - - - - 677 - 6 - PUBLISHED - 2023-04-28T16:10:13+02:00 - - 2023-04-28T16:10:13+02:00 - eng-GB - eng-GB - - - eng-GB - - - - Ibexa Sp. z o. o. - - - - - - 673 - active - eng-GB - ibexa_boolean - true - - - 674 - name - eng-GB - ibexa_string - Ibexa Sp. z o. o. - - - 675 - vat - eng-GB - ibexa_string - 123 456 789 - - - 676 - website - eng-GB - ibexa_string - https://ibexa.co - - - 677 - customer_group - eng-GB - ibexa_customer_group - - 1 - - - - 678 - sales_rep - eng-GB - ibexa_object_relation - - 14 - /api/ibexa/v2/content/objects/14 - - - - 679 - contact - eng-GB - ibexa_object_relation - - 144 - /api/ibexa/v2/content/objects/144 - - - - 680 - default_address - eng-GB - ibexa_object_relation - - 142 - /api/ibexa/v2/content/objects/142 - - - - 681 - billing_address - eng-GB - ibexa_address - - HQ - PL - - Silesia - Katowice - Gliwicka 6/5 - 40-079 - company@email.invalid - +48 000 000 000 - - - - - 683 - members - eng-GB - ibexa_object_relation - - 140 - /api/ibexa/v2/content/objects/140 - - - - 682 - address_book - eng-GB - ibexa_object_relation - - 141 - /api/ibexa/v2/content/objects/141 - - - - - - /placeholder - - - image/svg+xml - - - -
- - - - 2023-04-28T16:10:13+02:00 - 2023-04-28T15:44:55+02:00 - eng-GB - 6 - true - false - PUBLISHED - - - HQ, Poland - 144 - 14 - 142 - 141 - 140 - - - /1/65/140/ - 1 - - - - Jay Kowalski - -
- - - - - 2023-04-28T16:10:03+02:00 - 2023-04-28T16:10:03+02:00 - eng-GB - true - - - 676 - 1 - PUBLISHED - 2023-04-28T16:10:03+02:00 - - 2023-04-28T16:10:03+02:00 - eng-GB - eng-GB - - - eng-GB - - - - Jay Kowalski - - - - - - 698 - first_name - eng-GB - ibexa_string - Jay - - - 699 - last_name - eng-GB - ibexa_string - Kowalski - - - 700 - phone_number - eng-GB - ibexa_string - +48 123 123 456 - - - 701 - user - eng-GB - ibexa_user - - true - 144 - jay.kowalski - jay.kowalski@email.invalid - 1682691003 - true - 0 - - - - - - - /user/default_profile_image/initials.svg?initials=JK#profile_image - - - image/svg+xml - - - jay.kowalski - jay.kowalski@email.invalid - true - - - - - Company Admin - - - - 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: | - - - jay.kowalski - jay.kowalski@email.invalid - Ibexa123# - - - - first_name - Jay - - - last_name - Kowalski - - - phone_number - +48 123 123 456 - - - - 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: - _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: - schema: - $ref: '#/components/schemas/Member' - example: | - - - 144 - Jay Kowalski - - 139 - Ibexa Sp. z o. o. - - - Ibexa Sp. z o. o. - Ibexa Sp. z o. o. - - - - - 677 - 6 - PUBLISHED - 2023-04-28T16:10:13+02:00 - - 2023-04-28T16:10:13+02:00 - eng-GB - eng-GB - - - eng-GB - - - - Ibexa Sp. z o. o. - - - - - - 673 - active - eng-GB - ibexa_boolean - true - - - 674 - name - eng-GB - ibexa_string - Ibexa Sp. z o. o. - - - 675 - vat - eng-GB - ibexa_string - 123 456 789 - - - 676 - website - eng-GB - ibexa_string - https://ibexa.co - - - 677 - customer_group - eng-GB - ibexa_customer_group - - 1 - - - - 678 - sales_rep - eng-GB - ibexa_object_relation - - 14 - /api/ibexa/v2/content/objects/14 - - - - 679 - contact - eng-GB - ibexa_object_relation - - 144 - /api/ibexa/v2/content/objects/144 - - - - 680 - default_address - eng-GB - ibexa_object_relation - - 142 - /api/ibexa/v2/content/objects/142 - - - - 681 - billing_address - eng-GB - ibexa_address - - HQ - PL - - Silesia - Katowice - Gliwicka 6/5 - 40-079 - company@email.invalid - +48 000 000 000 - - - - - 683 - members - eng-GB - ibexa_object_relation - - 140 - /api/ibexa/v2/content/objects/140 - - - - 682 - address_book - eng-GB - ibexa_object_relation - - 141 - /api/ibexa/v2/content/objects/141 - - - - - - /placeholder - - - image/svg+xml - - - -
- - - - 2023-04-28T16:10:13+02:00 - 2023-04-28T15:44:55+02:00 - eng-GB - 6 - true - false - PUBLISHED - - - HQ, Poland - 144 - 14 - 142 - 141 - 140 - - - /1/65/140/ - 1 - - - - Jay Kowalski - -
- - - - - 2023-04-28T16:10:03+02:00 - 2023-04-28T16:10:03+02:00 - eng-GB - true - - - 676 - 1 - PUBLISHED - 2023-04-28T16:10:03+02:00 - - 2023-04-28T16:10:03+02:00 - eng-GB - eng-GB - - - eng-GB - - - - Jay Kowalski - - - - - - 698 - first_name - eng-GB - ibexa_string - Jay - - - 699 - last_name - eng-GB - ibexa_string - Kowalski - - - 700 - phone_number - eng-GB - ibexa_string - +48 123 123 456 - - - 701 - user - eng-GB - ibexa_user - - true - 144 - jay.kowalski - jay.kowalski@email.invalid - 1682691003 - true - 0 - - - - - - - /user/default_profile_image/initials.svg?initials=JK#profile_image - - - image/svg+xml - - - jay.kowalski - jay.kowalski@email.invalid - true - - - - - Company Admin - - - - 401: - description: Error - The user is not authorized to read this company. - 404: - description: Error - The company does not exist. - summary: Get company member - description: Returns the company member by given member ID. - parameters: - - name: companyId - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: memberId - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false - x-badges: - - name: Experience - color: '#D3822B' - - name: Commerce - color: '#A32768' - position: after - delete: - operationId: ibexa.rest.corporate_account.members.delete - tags: - - Corporate Account - responses: - 204: - description: No Content - given company member is deleted. - 401: - description: Error - the user is not authorized to delete this company member. - 404: - description: Error - the company member does not exist. - summary: Delete company member - description: The given company member is deleted. - parameters: - - name: X-CSRF-Token - in: header - description: Only needed for session's checking. The {csrfToken} needed on - all unsafe HTTP methods with session. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: companyId - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: memberId - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false - x-badges: - - name: Experience - color: '#D3822B' - - name: Commerce - color: '#A32768' - position: after - patch: - operationId: ibexa.rest.corporate_account.members.patch - tags: - - Corporate Account - responses: - 200: - description: OK - company member updated. - content: - application/vnd.ibexa.api.Member+json: - schema: - $ref: '#/components/schemas/MemberWrapper' - example: - Member: - _media-type: application/vnd.ibexa.api.Member+json - _href: /api/ibexa/v2/corporate/companies/139/members/144 - id: 144 - name: Jay Kowalski - Company: - _media-type: application/vnd.ibexa.api.Company+json - id: 139 - name: Ibexa Sp. z o. o. - Content: - _media-type: application/vnd.ibexa.api.Content+json - _href: /api/ibexa/v2/content/objects/139 - _remoteId: b16d06d4c5ba7c37b26fa167b551dfc2 - _id: 139 - ContentType: - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/48 - Name: Ibexa Sp. z o. o. - TranslatedName: Ibexa Sp. z o. o. - Versions: - _media-type: application/vnd.ibexa.api.VersionList+json - _href: /api/ibexa/v2/content/objects/139/versions - CurrentVersion: - _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/139/currentversion - Version: - _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/139/versions/6 - VersionInfo: - id: 677 - versionNo: 6 - status: PUBLISHED - modificationDate: "2023-04-28T16:10:13+02:00" - Creator: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - creationDate: "2023-04-28T16:10:13+02:00" - initialLanguageCode: eng-GB - languageCodes: eng-GB - VersionTranslationInfo: - _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json - Language: - - languageCode: eng-GB - names: - value: - - _languageCode: eng-GB - '#text': Ibexa Sp. z o. o. - Content: - _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/139 - Fields: - field: - - id: 673 - fieldDefinitionIdentifier: active - languageCode: eng-GB - fieldTypeIdentifier: ibexa_boolean - fieldValue: true - - id: 674 - fieldDefinitionIdentifier: name - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: Ibexa Sp. z o. o. - - id: 675 - fieldDefinitionIdentifier: vat - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: 123 456 789 - - id: 676 - fieldDefinitionIdentifier: website - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: https://ibexa.co - - id: 677 - fieldDefinitionIdentifier: customer_group - languageCode: eng-GB - fieldTypeIdentifier: ibexa_customer_group - fieldValue: - customer_group_id: 1 - - id: 678 - fieldDefinitionIdentifier: sales_rep - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 14 - destinationContentHref: /api/ibexa/v2/content/objects/14 - - id: 679 - fieldDefinitionIdentifier: contact - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 144 - destinationContentHref: /api/ibexa/v2/content/objects/144 - - id: 680 - fieldDefinitionIdentifier: default_address - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 142 - destinationContentHref: /api/ibexa/v2/content/objects/142 - - id: 681 - fieldDefinitionIdentifier: billing_address - languageCode: eng-GB - fieldTypeIdentifier: ibexa_address - fieldValue: - name: HQ - country: PL - fields: - region: Silesia - locality: Katowice - street: Gliwicka 6/5 - postal_code: 40-079 - email: company@email.invalid - phone_number: +48 000 000 000 - - id: 683 - fieldDefinitionIdentifier: members - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 140 - destinationContentHref: /api/ibexa/v2/content/objects/140 - - id: 682 - fieldDefinitionIdentifier: address_book - languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation - fieldValue: - destinationContentId: 141 - destinationContentHref: /api/ibexa/v2/content/objects/141 - Relations: - _media-type: application/vnd.ibexa.api.RelationList+json - _href: /api/ibexa/v2/content/objects/139/versions/6/relations - Relation: [] - Thumbnail: - _media-type: application/vnd.ibexa.api.Thumbnail+json - resource: /placeholder - width: ~ - 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: - schema: - $ref: '#/components/schemas/Member' - example: | - - - 144 - Jay Kowalski - - 139 - Ibexa Sp. z o. o. - - - Ibexa Sp. z o. o. - Ibexa Sp. z o. o. - - - - - 677 - 6 - PUBLISHED - 2023-04-28T16:10:13+02:00 - - 2023-04-28T16:10:13+02:00 - eng-GB - eng-GB - - - eng-GB - - - - Ibexa Sp. z o. o. - - - - - - 673 - active - eng-GB - ibexa_boolean - true - - - 674 - name - eng-GB - ibexa_string - Ibexa Sp. z o. o. - - - 675 - vat - eng-GB - ibexa_string - 123 456 789 - - - 676 - website - eng-GB - ibexa_string - https://ibexa.co - - - 677 - customer_group - eng-GB - ibexa_customer_group - - 1 - - - - 678 - sales_rep - eng-GB - ibexa_object_relation - - 14 - /api/ibexa/v2/content/objects/14 - - - - 679 - contact - eng-GB - ibexa_object_relation - - 144 - /api/ibexa/v2/content/objects/144 - - - - 680 - default_address - eng-GB - ibexa_object_relation - - 142 - /api/ibexa/v2/content/objects/142 - - - - 681 - billing_address - eng-GB - ibexa_address - - HQ - PL - - Silesia - Katowice - Gliwicka 6/5 - 40-079 - company@email.invalid - +48 000 000 000 - - - - - 683 - members - eng-GB - ibexa_object_relation - - 140 - /api/ibexa/v2/content/objects/140 - - - - 682 - address_book - eng-GB - ibexa_object_relation - - 141 - /api/ibexa/v2/content/objects/141 - - - - - - /placeholder - - - image/svg+xml - - - -
- - - - 2023-04-28T16:10:13+02:00 - 2023-04-28T15:44:55+02:00 - eng-GB - 6 - true - false - PUBLISHED - - - HQ, Poland - 144 - 14 - 142 - 141 - 140 - - - /1/65/140/ - 1 - - - - Jay Kowalski - -
- - - - - 2023-04-28T16:10:03+02:00 - 2023-04-28T16:10:03+02:00 - eng-GB - true - - - 676 - 1 - PUBLISHED - 2023-04-28T16:10:03+02:00 - - 2023-04-28T16:10:03+02:00 - eng-GB - eng-GB - - - eng-GB - - - - Jay Kowalski - - - - - - 698 - first_name - eng-GB - ibexa_string - Jay - - - 699 - last_name - eng-GB - ibexa_string - Kowalski - - - 700 - phone_number - eng-GB - ibexa_string - +48 123 123 456 - - - 701 - user - eng-GB - ibexa_user - - true - 144 - jay.kowalski - jay.kowalski@email.invalid - 1682691003 - true - 0 - - - - - - - /user/default_profile_image/initials.svg?initials=JK#profile_image - - - image/svg+xml - - - jay.kowalski - jay.kowalski@email.invalid - true - - - - - Company Admin - - - - 400: - description: Error - the input does not match the input schema definition. - 401: - description: Error - the user is not authorized to create this company member. - summary: Update a company member - description: Updates a company member. PATCH or POST with header X-HTTP-Method-Override - PATCH. - parameters: - - name: 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: If-Match - in: header - description: ETag - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: companyId - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: memberId - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The 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 - - fieldDefinitionIdentifier: phone_number - fieldValue: +48 123 123 456 - application/vnd.ibexa.api.MemberUpdate+xml: - schema: - $ref: '#/components/schemas/MemberUpdate' - example: | - - - jay.kowalski@updated.email - Publish123# - false - 5 - - - - first_name - Jay - - - last_name - Kowalski - - - phone_number - +48 123 123 456 - - - - required: false - deprecated: false - x-badges: - - name: Experience - color: '#D3822B' - - name: Commerce - color: '#A32768' - position: after - /corporate/sales-representatives: - get: - operationId: ibexa.rest.corporate_account.sales_representatives.get - tags: - - Corporate Account - responses: - 200: - description: Sales representatives list containing Company objects. - content: - application/vnd.ibexa.api.SalesRepresentativesList+json: - schema: - $ref: '#/components/schemas/SalesRepresentativesListWrapper' - example: - SalesRepresentativesList: - _media-type: application/vnd.ibexa.api.SalesRepresentativesList+json - users: - - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/75 - _id: 75 - _remoteId: f262e2fa12ae105b78a1b654e87a0874 - ContentType: - _media-type: application/vnd.ibexa.api.ContentType+json - _href: /api/ibexa/v2/content/types/4 - name: John Black - Versions: - _media-type: application/vnd.ibexa.api.VersionList+json - _href: /api/ibexa/v2/content/objects/75/versions - Section: - _media-type: application/vnd.ibexa.api.Section+json - _href: /api/ibexa/v2/content/sections/10 - MainLocation: - _media-type: application/vnd.ibexa.api.Location+json - _href: /api/ibexa/v2/content/locations/1/5/64/76 - Locations: - _media-type: application/vnd.ibexa.api.LocationList+json - _href: /api/ibexa/v2/content/objects/75/locations - Groups: - _media-type: application/vnd.ibexa.api.UserGroupRefList+json - _href: /api/ibexa/v2/user/users/75/groups - Owner: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - publishDate: "2023-06-20T07:33:17+00:00" - lastModificationDate: "2023-06-20T07:33:17+00:00" - mainLanguageCode: eng-GB - alwaysAvailable: true - Version: - _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/75/versions/1 - VersionInfo: - id: 536 - versionNo: 1 - status: PUBLISHED - modificationDate: "2023-06-20T07:33:17+00:00" - Creator: - _media-type: application/vnd.ibexa.api.User+json - _href: /api/ibexa/v2/user/users/14 - creationDate: "2023-06-20T07:33:17+00:00" - initialLanguageCode: eng-GB - languageCodes: eng-GB - VersionTranslationInfo: - _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json - Language: - - languageCode: eng-GB - names: - value: - - _languageCode: eng-GB - '#text': John Black - Content: - _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/75 - Fields: - field: - - id: 339 - fieldDefinitionIdentifier: first_name - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: John - - id: 340 - fieldDefinitionIdentifier: last_name - languageCode: eng-GB - fieldTypeIdentifier: ibexa_string - fieldValue: Black - - id: 341 - fieldDefinitionIdentifier: user_account - languageCode: eng-GB - fieldTypeIdentifier: ibexa_user - fieldValue: - hasStoredLogin: true - contentId: 75 - login: John Black - email: j.black@ibexa.co - passwordUpdatedAt: 1687246397 - enabled: true - maxLogin: 0 - plainPassword: ~ - - 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: - schema: - $ref: '#/components/schemas/SalesRepresentativesList' - example: | - - - - - John Black - -
- - - - - 2023-06-20T07:33:17+00:00 - 2023-06-20T07:33:17+00:00 - eng-GB - true - - - 536 - 1 - PUBLISHED - 2023-06-20T07:33:17+00:00 - - 2023-06-20T07:33:17+00:00 - eng-GB - eng-GB - - - eng-GB - - - - John Black - - - - - - 339 - first_name - eng-GB - ibexa_string - John - - - 340 - last_name - eng-GB - ibexa_string - Black - - - 341 - user_account - eng-GB - ibexa_user - - true - 75 - John Black - j.black@ibexa.co - 1687246397 - true - 0 - - - - - 342 - signature - eng-GB - ibexa_text - - - - 343 - image - eng-GB - ibexa_image - - - - - - /user/default_profile_image/initials.svg?initials=JB#profile_image - - - image/svg+xml - - - John Black - j.black@ibexa.co - true - - - - - 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 - parameters: - - name: offset - in: query - description: "" - required: false - deprecated: false - allowEmptyValue: false - schema: - type: integer - style: form - explode: false - allowReserved: false - example: 0 - - name: limit - in: query - description: "" - required: false - deprecated: false - allowEmptyValue: false - schema: - type: integer - style: form - explode: false - allowReserved: false - example: 25 - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - post: - operationId: 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. - 406: - description: Error - the input data is not valid. - summary: Create a discount - description: Creates a new discount - parameters: - - name: X-CSRF-Token - in: header - description: CSRF token obtained during the authentication. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The 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 - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - example: my_discount_identifier - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - delete: - operationId: 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. - 401: - description: Error - the user is not authorized to delete a discount item. - summary: Delete a discount item - description: Deletes an existing discount item by its unique identifier - parameters: - - name: identifier - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - example: my_discount_identifier - - name: X-CSRF-Token - in: header - description: CSRF token obtained during the authentication. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - patch: - operationId: ibexa.discounts.rest.update - tags: - - Discounts - responses: - 200: - description: The updated 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 update a discount item. - 406: - description: Error - the input data is not valid. - summary: Update a discount - description: Updates a new discount - parameters: - - name: identifier - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - example: my_discount_identifier - - name: X-CSRF-Token - in: header - description: CSRF token obtained during the authentication. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The DiscountUpdate schema - content: - application/vnd.ibexa.api.DiscountUpdate+json: - schema: - $ref: '#/components/schemas/DiscountUpdate' - example: - DiscountUpdate: - identifier: my_discount_identifier - priority: 1 - isEnabled: true - userId: 14 - lastContributorId: 14 - rule: - type: fixed_amount - amount: "20" - conditions: - - class: \Ibexa\Discounts\Value\DiscountCondition\IsInCurrency - parameters: - - PLN - startDate: "2025-08-01 00:00:00" - endDate: "2025-08-31 23:59:59" - createdAt: "2025-07-31 12:00:00" - updatedAt: "2025-07-31 12:10:02" - translations: - - languageCode: eng-GB - name: My Discount - description: My Discount description - label: My Discount label - labelDescription: My Discount description - context: - arbitrary_foo_key: arbitrary_foo_value - arbitrary_bar_key: - - arbitrary_bar_value1 - - arbitrary_bar_value2 - required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /discounts/{identifier}/disable: - post: - operationId: ibexa.discounts.rest.disable - tags: - - Discounts - responses: - 204: - description: The discount is disabled. - 404: - description: Error - a discount of the given unique identifier is not found. - 401: - description: Error - the user is not authorized to disable a discount item. - summary: Disables a discount - description: Disables a discount item by its unique identifier - parameters: - - name: identifier - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - example: my_discount_identifier - - name: X-CSRF-Token - in: header - description: CSRF token obtained during the authentication. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: 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 - tags: - - Discounts - responses: - 204: - description: The discount is enabled. - 404: - description: Error - a discount of the given unique identifier is not found. - 401: - description: Error - the user is not authorized to enable a discount item. - summary: Enables a discount - description: Enables a discount item by its unique identifier - parameters: - - name: identifier - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - example: my_discount_identifier - - name: X-CSRF-Token - in: header - description: CSRF token obtained during the authentication. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: No payload required - content: [] - required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /discounts/{id}: - get: - operationId: ibexa.discounts.rest.id - 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 ID is not found. - 401: - description: Error - the user is not authorized to read this discount item. - summary: Get a discount item - description: Returns a discount item by its ID. - parameters: - - name: id - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: integer - style: simple - explode: false - allowReserved: false - example: 1 - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /discounts_codes/{cartIdentifier}/apply: - post: - operationId: ibexa.rest.discounts_codes.apply - tags: - - Discounts - responses: - 200: - description: OK - The discount code has been applied and is returned. - content: - application/vnd.ibexa.api.DiscountCode+json: - schema: - $ref: '#/components/schemas/DiscountCodeWrapper' - example: - DiscountCode: - _media-type: application/vnd.ibexa.api.DiscountCode+json - id: 1 - code: summer10 - created_at: - date: "2025-06-10 14:14:06.000000" - timezone_type: 3 - timezone: UTC - 404: - description: Not Found - the cart does not exist, or, the requested discount - code has not been found or is already applied. - 429: - description: Too Many Requests - rate limit exceeded, next requests are - temporarily blocked as a security measure. - summary: Apply discount code - description: Apply a discount code on a cart given by its identifier. - parameters: - - name: X-CSRF-Token - in: header - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: cartIdentifier - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The discount code to apply - content: - application/vnd.ibexa.api.DiscountCode+json: - schema: - $ref: '#/components/schemas/DiscountCodeWrapper' - example: - DiscountCode: - code: summer10 - required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /discounts_codes/{cartIdentifier}/drop: - post: - operationId: ibexa.rest.discounts_codes.drop - tags: - - Discounts - responses: - 204: - description: No Content - the discount code has been dropped. - 404: - description: Not Found - the cart does not exist. - summary: Drop discount code - description: Unapply a discount code from a cart given by its identifier. - parameters: - - name: X-CSRF-Token - in: header - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: cartIdentifier - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - requestBody: - description: The discount code to drop - content: - application/vnd.ibexa.api.DiscountCode+json: - schema: - $ref: '#/components/schemas/DiscountCodeWrapper' - example: - DiscountCode: - code: summer10 - required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /languages: - get: - operationId: 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: + 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: schema: - $ref: '#/components/schemas/LanguageList' + $ref: '#/components/schemas/CompanyList' example: | - - - 2 - eng-GB - English (United Kingdom) - - - 4 - pol-PL - Polish (polski) - - - summary: Language list - description: Lists languages + + + 66 + Ibexa AS + + + Ibexa AS + Ibexa AS + + + + + 593 + 1 + PUBLISHED + 2023-04-03T13:09:40+02:00 + + 2023-04-03T13:09:40+02:00 + eng-GB + eng-GB + + + eng-GB + + + + Ibexa AS + + + + + + 295 + active + eng-GB + ibexa_boolean + true + + + 296 + name + eng-GB + ibexa_string + Ibexa AS + + + 297 + vat + eng-GB + ibexa_string + 123 456 789 + + + 298 + website + eng-GB + ibexa_string + https://ibexa.co + + + 299 + customer_group + eng-GB + ibexa_customer_group + + 1 + + + + 300 + sales_rep + eng-GB + ibexa_object_relation + + 14 + /api/ibexa/v2/content/objects/14 + + + + 301 + contact + eng-GB + ibexa_object_relation + + 74 + /api/ibexa/v2/content/objects/74 + + + + 302 + default_address + eng-GB + ibexa_object_relation + + 69 + /api/ibexa/v2/content/objects/69 + + + + 303 + billing_address + eng-GB + ibexa_address + + HQ + PL + + Silesia + Katowice + Gliwicka 6/5 + 40-079 + company@email.invalid + +48 000 000 000 + + + + + 305 + members + eng-GB + ibexa_object_relation + + 67 + /api/ibexa/v2/content/objects/67 + + + + 304 + address_book + eng-GB + ibexa_object_relation + + 68 + /api/ibexa/v2/content/objects/68 + + + + + + /placeholder + + + image/svg+xml + + + +
+ + + + 2023-04-03T13:09:40+02:00 + 2023-03-31T14:33:36+02:00 + eng-GB + 1 + true + false + PUBLISHED + + + HQ, Poland + 74 + 14 + 69 + 68 + 67 + + + /1/65/67/ + 1 + + + 75 + QNTM Group AB + + + QNTM Group AB + QNTM Group AB + + + + + 546 + 3 + PUBLISHED + 2023-03-31T15:24:49+02:00 + + 2023-03-31T15:24:49+02:00 + eng-GB + eng-GB + + + eng-GB + + + + QNTM Group AB + + + + + + 341 + active + eng-GB + ibexa_boolean + true + + + 342 + name + eng-GB + ibexa_string + QNTM Group AB + + + 343 + vat + eng-GB + ibexa_string + 123 456 789 + + + 344 + website + eng-GB + ibexa_string + https://ibexa.co + + + 345 + customer_group + eng-GB + ibexa_customer_group + + 1 + + + + 346 + sales_rep + eng-GB + ibexa_object_relation + + 14 + /api/ibexa/v2/content/objects/14 + + + + 347 + contact + eng-GB + ibexa_object_relation + + + + + + 348 + default_address + eng-GB + ibexa_object_relation + + + + + + 349 + billing_address + eng-GB + ibexa_address + + + + + + + + 351 + members + eng-GB + ibexa_object_relation + + 76 + /api/ibexa/v2/content/objects/76 + + + + 350 + address_book + eng-GB + ibexa_object_relation + + 77 + /api/ibexa/v2/content/objects/77 + + + + + + /placeholder + + + image/svg+xml + + + +
+ + + + 2023-03-31T15:24:49+02:00 + 2023-03-31T15:24:48+02:00 + eng-GB + 3 + true + false + PUBLISHED + + + + + 14 + + 77 + 76 + + + /1/65/76/ + 1 + + + 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 - /languages/{code}: - get: - operationId: ibexa.rest.languages.view + post: + operationId: ibexa.rest.corporate_account.companies.create tags: - - Language + - Corporate Account responses: - 200: - description: If set, the language is returned in XML or JSON format. + 201: + description: If set, the new company is returned in XML or JSON format. content: - application/vnd.ibexa.api.Language+json: + application/vnd.ibexa.api.Company+json: schema: - $ref: '#/components/schemas/LanguageWrapper' + $ref: '#/components/schemas/CompanyWrapper' 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: + 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: schema: - $ref: '#/components/schemas/Language' + $ref: '#/components/schemas/Company' example: | - - 2 - eng-GB - English (United Kingdom) - - summary: Get language - description: Retrieves a LanguageLoadByIdController resource. + + 66 + Ibexa AS + + + Ibexa AS + Ibexa AS + + + + + 593 + 1 + PUBLISHED + 2023-04-03T13:09:40+02:00 + + 2023-04-03T13:09:40+02:00 + eng-GB + eng-GB + + + eng-GB + + + + Ibexa AS + + + + + + 295 + active + eng-GB + ibexa_boolean + true + + + 296 + name + eng-GB + ibexa_string + Ibexa AS + + + 297 + vat + eng-GB + ibexa_string + 123 456 789 + + + 298 + website + eng-GB + ibexa_string + https://ibexa.co + + + 299 + customer_group + eng-GB + ibexa_customer_group + + 1 + + + + 300 + sales_rep + eng-GB + ibexa_object_relation + + 14 + /api/ibexa/v2/content/objects/14 + + + + 301 + contact + eng-GB + ibexa_object_relation + + 74 + /api/ibexa/v2/content/objects/74 + + + + 302 + default_address + eng-GB + ibexa_object_relation + + 69 + /api/ibexa/v2/content/objects/69 + + + + 303 + billing_address + eng-GB + ibexa_address + + HQ + PL + + Silesia + Katowice + Gliwicka 6/5 + 40-079 + company@email.invalid + +48 000 000 000 + + + + + 305 + members + eng-GB + ibexa_object_relation + + 67 + /api/ibexa/v2/content/objects/67 + + + + 304 + address_book + eng-GB + ibexa_object_relation + + 68 + /api/ibexa/v2/content/objects/68 + + + + + + /placeholder + + + image/svg+xml + + + +
+ + + + 2023-04-03T13:09:40+02:00 + 2023-03-31T14:33:36+02:00 + eng-GB + 1 + true + false + PUBLISHED + + + HQ, Poland + 74 + 80 + 69 + 68 + 67 + + + /1/65/67/ + 1 + + 400: + description: Error - the input does not match the input schema definition. + 401: + description: Error - the user is not authorized to create this Company. + summary: Create a company + description: Creates a CompanyCreateController resource. parameters: - - name: code - in: path - description: "" + - 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 - deprecated: false - /content/locations: + requestBody: + description: The CompanyCreate schema encoded in XML or JSON format. + content: + application/vnd.ibexa.api.CompanyCreate+json: + schema: + $ref: '#/components/schemas/CompanyCreateWrapper' + example: + CompanyCreate: + fields: + field: + - fieldDefinitionIdentifier: active + fieldValue: true + - fieldDefinitionIdentifier: name + fieldValue: Ibexa Sp. z o. o. + - fieldDefinitionIdentifier: vat + fieldValue: 123 456 789 + - fieldDefinitionIdentifier: website + fieldValue: https://ibexa.co + - fieldDefinitionIdentifier: customer_group + fieldValue: + customer_group_id: 1 + - fieldDefinitionIdentifier: sales_rep + fieldValue: + destinationContentId: 14 + - fieldDefinitionIdentifier: billing_address + fieldValue: + name: HQ + country: PL + fields: + region: Silesia + locality: Katowice + street: Gliwicka 6/5 + postal_code: 40-079 + email: company@email.invalid + phone_number: +48 000 000 000 + application/vnd.ibexa.api.CompanyCreate+xml: + schema: + $ref: '#/components/schemas/CompanyCreate' + example: | + + + + + + active + true + + + name + Ibexa Sp. z o. o. + + + vat + 123 456 789 + + + website + https://ibexa.co + + + customer_group + + 1 + + + + sales_rep + + 14 + + + + billing_address + + HQ + PL + + Silesia + Katowice + Gliwicka 6/5 + 40-079 + company@email.invalid + +48 000 000 000 + + + + + + required: false + /corporate/companies/{companyId}: get: - operationId: ibexa.rest.redirect_location + operationId: ibexa.rest.corporate_account.companies.get tags: - - Location + - Corporate Account responses: 200: - description: OK - returns the LocationList in XML or JSON format. + description: If set, the company is returned in XML or JSON format. content: - application/vnd.ibexa.api.LocationList+json: + application/vnd.ibexa.api.Company+json: schema: - $ref: '#/components/schemas/LocationWrapper' + $ref: '#/components/schemas/CompanyWrapper' 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 + 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/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: + _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/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: | - - - 58 - 0 - false - false - false - - /1/2/58/ - 2 - 3 - 0cfe62f27753448d79aaa8acd8d01699 - - - PATH - ASC - - - - - All Tips - All Tips - - -
- - - 2021-06-28T11:22:52+00:00 - 2021-06-28T11:22:52+00:00 - eng-GB - 1 - true - false - PUBLISHED - - - - - 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}: - get: - operationId: ibexa.rest.load_location - tags: - - Location - 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: + _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/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: + _href: /api/ibexa/v2/content/locations/1/65/67 + locationPath: /1/65/67/ + isActive: true + application/vnd.ibexa.api.Company+xml: schema: - $ref: '#/components/schemas/Location' + $ref: '#/components/schemas/Company' example: | - - 61 - 0 - false - false - - /1/2/61/ - 2 - 0 - 2cfa66027e3806b113d994c9c26d3a66 - - - NAME - ASC - - - - - 666 - - -
- - - 2018-11-09T14:49:52+01:00 - 2018-11-09T14:49:52+01:00 - eng-GB - 1 - false - - - - + + 66 + Ibexa AS + + + Ibexa AS + Ibexa AS + + + + + 593 + 1 + PUBLISHED + 2023-04-03T13:09:40+02:00 + + 2023-04-03T13:09:40+02:00 + eng-GB + eng-GB + + + eng-GB + + + + Ibexa AS + + + + + + 295 + active + eng-GB + ibexa_boolean + true + + + 296 + name + eng-GB + ibexa_string + Ibexa AS + + + 297 + vat + eng-GB + ibexa_string + 123 456 789 + + + 298 + website + eng-GB + ibexa_string + https://ibexa.co + + + 299 + customer_group + eng-GB + ibexa_customer_group + + 1 + + + + 300 + sales_rep + eng-GB + ibexa_object_relation + + 14 + /api/ibexa/v2/content/objects/14 + + + + 301 + contact + eng-GB + ibexa_object_relation + + 74 + /api/ibexa/v2/content/objects/74 + + + + 302 + default_address + eng-GB + ibexa_object_relation + + 69 + /api/ibexa/v2/content/objects/69 + + + + 303 + billing_address + eng-GB + ibexa_address + + HQ + PL + + Silesia + Katowice + Gliwicka 6/5 + 40-079 + company@email.invalid + +48 000 000 000 + + + + + 305 + members + eng-GB + ibexa_object_relation + + 67 + /api/ibexa/v2/content/objects/67 + + + + 304 + address_book + eng-GB + ibexa_object_relation + + 68 + /api/ibexa/v2/content/objects/68 + + + + + + /placeholder + + + image/svg+xml + + + +
+ + + + 2023-04-03T13:09:40+02:00 + 2023-03-31T14:33:36+02:00 + eng-GB + 1 + true + false + PUBLISHED + + + HQ, Poland + 74 + 80 + 69 + 68 + 67 + + + /1/65/67/ + 1 + 401: - description: Error - the user is not authorized to read this Location. + description: Error - The user is not authorized to read this company. 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 company does not exist. + summary: Get company + description: Returns the company by given company 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 - - name: path + - name: companyId in: path - description: "" + description: CompanyLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false delete: - operationId: ibexa.rest.delete_subtree + operationId: ibexa.rest.corporate_account.companies.delete tags: - - Location + - Corporate Account responses: 204: - description: No Content - deleted. + description: No Content - given company is deleted. 401: - description: Error - the user is not authorized to delete this subtree. + description: Error - the user is not authorized to delete this company. 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. + description: Error - the company does not exist. + summary: Delete company + description: The given company is deleted. parameters: - name: X-CSRF-Token in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + 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: path + - name: companyId in: path - description: "" + description: CompanyDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false patch: - operationId: ibexa.rest.update_location + operationId: ibexa.rest.corporate_account.companies.update tags: - - Location + - Corporate Account responses: 200: - description: If set, the Location is returned in XML or JSON format. + description: OK - company updated. content: - application/vnd.ibexa.api.Location+json: + application/vnd.ibexa.api.Company+json: schema: - $ref: '#/components/schemas/LocationWrapper' + $ref: '#/components/schemas/CompanyWrapper' 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 + 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/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: + _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/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/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: schema: - $ref: '#/components/schemas/Location' + $ref: '#/components/schemas/Company' example: | - - 58 - 0 - false - false - false - - /1/2/58/ - 2 - 3 - 0cfe62f27753448d79aaa8acd8d01699 - - - PATH - ASC - - - - - All Tips - All Tips - - -
- - - 2021-06-28T11:22:52+00:00 - 2021-06-28T11:22:52+00:00 - eng-GB - 1 - true - false - PUBLISHED - - - - + + 66 + Ibexa AS + + + Ibexa AS + Ibexa AS + + + + + 593 + 1 + PUBLISHED + 2023-04-03T13:09:40+02:00 + + 2023-04-03T13:09:40+02:00 + eng-GB + eng-GB + + + eng-GB + + + + Ibexa AS + + + + + + 295 + active + eng-GB + ibexa_boolean + true + + + 296 + name + eng-GB + ibexa_string + Ibexa AS + + + 297 + vat + eng-GB + ibexa_string + 123 456 789 + + + 298 + website + eng-GB + ibexa_string + https://ibexa.co + + + 299 + customer_group + eng-GB + ibexa_customer_group + + 1 + + + + 300 + sales_rep + eng-GB + ibexa_object_relation + + 14 + /api/ibexa/v2/content/objects/14 + + + + 301 + contact + eng-GB + ibexa_object_relation + + 74 + /api/ibexa/v2/content/objects/74 + + + + 302 + default_address + eng-GB + ibexa_object_relation + + 69 + /api/ibexa/v2/content/objects/69 + + + + 303 + billing_address + eng-GB + ibexa_address + + HQ + PL + + Silesia + Katowice + Gliwicka 6/5 + 40-079 + company@email.invalid + +48 000 000 000 + + + + + 305 + members + eng-GB + ibexa_object_relation + + 67 + /api/ibexa/v2/content/objects/67 + + + + 304 + address_book + eng-GB + ibexa_object_relation + + 68 + /api/ibexa/v2/content/objects/68 + + + + + + /placeholder + + + image/svg+xml + + + +
+ + + + 2023-04-03T13:09:40+02:00 + 2023-03-31T14:33:36+02:00 + eng-GB + 1 + true + false + PUBLISHED + + + HQ, Poland + 74 + 80 + 69 + 68 + 67 + + + /1/65/67/ + 1 + + 400: + description: Error - the input does not match the input schema definition. 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. + description: Error - the user is not authorized to create this company. + summary: Update a company + description: Updates a company. PATCH or POST with header X-HTTP-Method-Override + PATCH. parameters: - name: X-CSRF-Token in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + 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: If-Match in: header description: ETag required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: path + - name: companyId in: path - description: "" + description: CompanyUpdateController 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. + description: The company input schema encoded in XML or JSON. content: - application/vnd.ibexa.api.LocationUpdate+json: + application/vnd.ibexa.api.CompanyUpdate+json: schema: - $ref: '#/components/schemas/LocationUpdateStructWrapper' + $ref: '#/components/schemas/CompanyUpdateWrapper' example: - LocationUpdate: - priority: "3" - hidden: true - remoteId: remoteId-qwert999 - sortField: NAME - sortOrder: DESC - application/vnd.ibexa.api.LocationUpdate+xml: + CompanyUpdate: + fields: + field: + - fieldDefinitionIdentifier: contact + fieldValue: + destinationContentId: 144 + application/vnd.ibexa.api.CompanyUpdate+xml: schema: - $ref: '#/components/schemas/LocationUpdateStruct' + $ref: '#/components/schemas/CompanyUpdate' example: | - - 3 - true - remoteId-qwert999 - CLASS - DESC - + + + + contact + + 144 + + + + required: false - deprecated: false - /content/locations/{path}/children: - get: - operationId: ibexa.rest.load_location_children - tags: - - Location - 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: | - - - - - - - - 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: "" - 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: | - - - - - - 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 - in: path - description: "" - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - deprecated: false - /content/objectstategroups: + /corporate/companies/{companyId}/members: get: - operationId: ibexa.rest.load_object_state_groups + operationId: ibexa.rest.corporate_account.members.list tags: - - Object State Groups + - Corporate Account responses: 200: - description: OK - returns a list of Object state groups. - content: - application/vnd.ibexa.api.ObjectStateGroupList+json: - schema: - $ref: '#/components/schemas/ObjectStateGroupListWrapper' - example: - ObjectStateGroupList: - _media-type: application/vnd.ibexa.api.ObjectStateGroupList+json - _href: /api/ibexa/v2/content/objectstategroups - ObjectStateGroup: - - _media-type: application/vnd.ibexa.api.ObjectStateGroup+json - _href: /api/ibexa/v2/content/objectstategroups/2 - id: 2 - identifier: ibexa_lock - defaultLanguageCode: eng-GB - languageCodes: eng-GB - ObjectStates: - _media-type: application/vnd.ibexa.api.ObjectStateList+json - _href: /api/ibexa/v2/content/objectstategroups/2/objectstates - names: - value: - - _languageCode: eng-GB - '#text': Lock - descriptions: - value: - - _languageCode: eng-GB - '#text': "" - - _media-type: application/vnd.ibexa.api.ObjectStateGroup+json - _href: /api/ibexa/v2/content/objectstategroups/3 - id: 3 - identifier: accessibility - defaultLanguageCode: eng-GB - languageCodes: eng-GB - ObjectStates: - _media-type: application/vnd.ibexa.api.ObjectStateList+json - _href: /api/ibexa/v2/content/objectstategroups/3/objectstates - names: - value: - - _languageCode: eng-GB - '#text': Accessibility - descriptions: - value: - - _languageCode: eng-GB - '#text': "" - - _media-type: application/vnd.ibexa.api.ObjectStateGroup+json - _href: /api/ibexa/v2/content/objectstategroups/6 - id: 6 - identifier: custom-states - defaultLanguageCode: eng-GB - languageCodes: eng-GB - ObjectStates: - _media-type: application/vnd.ibexa.api.ObjectStateList+json - _href: /api/ibexa/v2/content/objectstategroups/6/objectstates - names: - value: - - _languageCode: eng-GB - '#text': Custom State - descriptions: - value: - - _languageCode: eng-GB - '#text': Custom Object state - application/vnd.ibexa.api.ObjectStateGroupList+xml: - schema: - $ref: '#/components/schemas/ObjectStateGroupList' - example: | - - - - 2 - ibexa_lock - eng-GB - eng-GB - - - Lock - - - - - - - 3 - accessibility - eng-GB - eng-GB - - - Accessibility - - - - - - - 6 - custom-states - eng-GB - eng-GB - - - Custom State - - - Custom Object state - - - - 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. + description: If set, helps to determine response format. content: - application/vnd.ibexa.api.ObjectStateGroup+json: + application/vnd.ibexa.api.MemberList+json: schema: - $ref: '#/components/schemas/ObjectStateGroupWrapper' + $ref: '#/components/schemas/MemberListWrapper' 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: + 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/ObjectStateGroup' + $ref: '#/components/schemas/MemberList' example: | - - 5 - custom-states - eng-GB - eng-GB - - - Custom State - - - Custom Object state - - - 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: 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 Object state group input schema encoded in XML or JSON format. - content: - application/vnd.ibexa.api.ObjectStateGroupCreate+json: - schema: - $ref: '#/components/schemas/ObjectStateGroupCreateWrapper' - example: - ObjectStateGroupCreate: - identifier: custom-states - defaultLanguageCode: eng-GB - names: - value: - - _languageCode: eng-GB - '#text': Custom State - descriptions: - value: - - _languageCode: eng-GB - '#text': Custom Object state - application/vnd.ibexa.api.ObjectStateGroupCreate+xml: - schema: - $ref: '#/components/schemas/ObjectStateGroupCreate' - example: |- - - - custom - eng-GB - - Custom State - - - Custom Object state - - - 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: + + + 144 + Jay Kowalski + + 139 + Ibexa Sp. z o. o. + + + Ibexa Sp. z o. o. + Ibexa Sp. z o. o. + + + + + 677 + 6 + PUBLISHED + 2023-04-28T16:10:13+02:00 + + 2023-04-28T16:10:13+02:00 + eng-GB + eng-GB + + + eng-GB + + + + Ibexa Sp. z o. o. + + + + + + 673 + active + eng-GB + ibexa_boolean + true + + + 674 + name + eng-GB + ibexa_string + Ibexa Sp. z o. o. + + + 675 + vat + eng-GB + ibexa_string + 123 456 789 + + + 676 + website + eng-GB + ibexa_string + https://ibexa.co + + + 677 + customer_group + eng-GB + ibexa_customer_group + + 1 + + + + 678 + sales_rep + eng-GB + ibexa_object_relation + + 14 + /api/ibexa/v2/content/objects/14 + + + + 679 + contact + eng-GB + ibexa_object_relation + + 144 + /api/ibexa/v2/content/objects/144 + + + + 680 + default_address + eng-GB + ibexa_object_relation + + 142 + /api/ibexa/v2/content/objects/142 + + + + 681 + billing_address + eng-GB + ibexa_address + + HQ + PL + + Silesia + Katowice + Gliwicka 6/5 + 40-079 + company@email.invalid + +48 000 000 000 + + + + + 683 + members + eng-GB + ibexa_object_relation + + 140 + /api/ibexa/v2/content/objects/140 + + + + 682 + address_book + eng-GB + ibexa_object_relation + + 141 + /api/ibexa/v2/content/objects/141 + + + + + + /placeholder + + + image/svg+xml + + + +
+ + + + 2023-04-28T16:10:13+02:00 + 2023-04-28T15:44:55+02:00 + eng-GB + 6 + true + false + PUBLISHED + + + HQ, Poland + 144 + 14 + 142 + 141 + 140 + + + /1/65/140/ + 1 + + + + Jay Kowalski + +
+ + + + + 2023-04-28T16:10:03+02:00 + 2023-04-28T16:17:07+02:00 + eng-GB + true + + + 683 + 6 + PUBLISHED + 2023-04-28T16:17:07+02:00 + + 2023-04-28T16:17:06+02:00 + eng-GB + eng-GB + + + eng-GB + + + + Jay Kowalski + + + + + + 698 + first_name + eng-GB + ibexa_string + Jay + + + 699 + last_name + eng-GB + ibexa_string + Kowalski + + + 700 + phone_number + eng-GB + ibexa_string + +48 123 123 456 + + + 701 + user + eng-GB + ibexa_user + + true + 144 + jay.kowalski + jay.kowalski@email.invalid + 1682691427 + false + 5 + + + + + + + /user/default_profile_image/initials.svg?initials=JK#profile_image + + + image/svg+xml + + + jay.kowalski + jay.kowalski@email.invalid + false + + + + + Company Buyer + + + + + 400: + description: Returned when invalid Criterion or Sort clause is used. + content: + application/vnd.ibexa.api.ErrorMessage: schema: - $ref: '#/components/schemas/ObjectStateGroup' - example: | - - - 7 - custom-states - eng-GB - eng-GB - - - Custom State - - - Custom Object state - - - 401: - description: Error - The user is not authorized to read this Object state - group. + $ref: '#/components/schemas/ErrorMessage' 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 identifier do not match any company. + summary: Read list of company members + description: Returns paginated list of a given company members. parameters: - - name: If-None-Match - in: header - description: ETag - required: false + - name: companyId + in: path + description: MembersLoadByCompanyIdController identifier + required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: objectStateGroupId - in: path + - name: filter[DateMetadataCriterion][Target] + in: query description: "" - required: true + required: false deprecated: false - allowEmptyValue: false schema: type: string - style: simple + enum: + - created + - modified + - published + style: form 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 + - name: filter[DateMetadataCriterion][Operator] + in: query + description: "" + required: false deprecated: false - allowEmptyValue: false schema: type: string - style: simple + enum: + - eq + - gt + - gte + - lt + - lte + style: form explode: false - allowReserved: false - - name: objectStateGroupId - in: path + - name: filter[DateMetadataCriterion][Value] + in: query + description: DateTime as a UNIX timestamp + required: false + deprecated: false + schema: + type: integer + style: form + explode: false + - name: sort[ContentName] + in: query description: "" - required: true + required: false deprecated: false - allowEmptyValue: false schema: type: string - style: simple + enum: + - ascending + - descending + style: form explode: false - allowReserved: false - deprecated: false - patch: - operationId: ibexa.rest.update_object_state_group - tags: - - Object State Groups - responses: - 200: - description: OK - Object stated group updated. - content: - application/vnd.ibexa.api.ObjectStateGroup+json: - schema: - $ref: '#/components/schemas/ObjectStateGroupWrapper' - example: - ObjectStateGroup: - _media-type: application/vnd.ibexa.api.ObjectStateGroup+json - _href: /api/ibexa/v2/content/objectstategroups/7 - id: 7 - identifier: custom-states - defaultLanguageCode: eng-GB - languageCodes: eng-GB - ObjectStates: - _media-type: application/vnd.ibexa.api.ObjectStateList+json - _href: /api/ibexa/v2/content/objectstategroups/7/objectstates - names: - value: - - _languageCode: eng-GB - '#text': New Custom State name - descriptions: - value: - - _languageCode: eng-GB - '#text': Custom Object state - application/vnd.ibexa.api.ObjectStateGroup+xml: - schema: - $ref: '#/components/schemas/ObjectStateGroup' - example: | - - - 7 - custom-states - eng-GB - eng-GB - - - New Custom State name - - - Custom Object state - - - 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 + - name: sort[DatePublished] + in: query + description: "" + required: false deprecated: false - allowEmptyValue: false schema: type: string - style: simple + enum: + - ascending + - descending + style: form explode: false - allowReserved: false - - name: If-Match - in: header - description: ETag - required: true + - name: sort[DateModified] + in: query + description: "" + required: false deprecated: false - allowEmptyValue: false schema: type: string - style: simple + enum: + - ascending + - descending + style: form explode: false - allowReserved: false - - name: objectStateGroupId - in: path + - name: offset + in: query description: "" - required: true + required: false deprecated: false - allowEmptyValue: false schema: - type: string - style: simple + type: integer + style: form 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: | - - - - New Custom State name - - + - name: limit + in: query + description: "" required: false - deprecated: false - /content/objectstategroups/{objectStateGroupId}/objectstates: - get: - operationId: ibexa.rest.load_object_states + deprecated: false + schema: + type: integer + style: form + explode: false + post: + operationId: ibexa.rest.corporate_account.members.create tags: - - Object State Groups + - Corporate Account responses: - 200: - description: OK - returns a list of Object states. + 201: + description: OK - company member created and returned. content: - application/vnd.ibexa.api.ObjectStateList+json: + application/vnd.ibexa.api.Member+json: schema: - $ref: '#/components/schemas/ObjectStateListWrapper' + $ref: '#/components/schemas/MemberWrapper' 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: + 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: schema: - $ref: '#/components/schemas/ObjectStateList' + $ref: '#/components/schemas/Member' example: | - - - 1 - not_locked - 0 - - eng-GB - eng-GB - - Not locked - - - - - - - 2 - locked - 1 - - eng-GB + + 144 + Jay Kowalski + + 139 + Ibexa Sp. z o. o. + + + Ibexa Sp. z o. o. + Ibexa Sp. z o. o. + + + + + 677 + 6 + PUBLISHED + 2023-04-28T16:10:13+02:00 + + 2023-04-28T16:10:13+02:00 + eng-GB + eng-GB + + + eng-GB + + + + Ibexa Sp. z o. o. + + + + + + 673 + active + eng-GB + ibexa_boolean + true + + + 674 + name + eng-GB + ibexa_string + Ibexa Sp. z o. o. + + + 675 + vat + eng-GB + ibexa_string + 123 456 789 + + + 676 + website + eng-GB + ibexa_string + https://ibexa.co + + + 677 + customer_group + eng-GB + ibexa_customer_group + + 1 + + + + 678 + sales_rep + eng-GB + ibexa_object_relation + + 14 + /api/ibexa/v2/content/objects/14 + + + + 679 + contact + eng-GB + ibexa_object_relation + + 144 + /api/ibexa/v2/content/objects/144 + + + + 680 + default_address + eng-GB + ibexa_object_relation + + 142 + /api/ibexa/v2/content/objects/142 + + + + 681 + billing_address + eng-GB + ibexa_address + + HQ + PL + + Silesia + Katowice + Gliwicka 6/5 + 40-079 + company@email.invalid + +48 000 000 000 + + + + + 683 + members + eng-GB + ibexa_object_relation + + 140 + /api/ibexa/v2/content/objects/140 + + + + 682 + address_book + eng-GB + ibexa_object_relation + + 141 + /api/ibexa/v2/content/objects/141 + + + + + + /placeholder + + + image/svg+xml + + + +
+ + + + 2023-04-28T16:10:13+02:00 + 2023-04-28T15:44:55+02:00 + eng-GB + 6 + true + false + PUBLISHED + + + HQ, Poland + 144 + 14 + 142 + 141 + 140 + + + /1/65/140/ + 1 + + + + Jay Kowalski + +
+ + + + + 2023-04-28T16:10:03+02:00 + 2023-04-28T16:10:03+02:00 + eng-GB + true + + + 676 + 1 + PUBLISHED + 2023-04-28T16:10:03+02:00 + + 2023-04-28T16:10:03+02:00 + eng-GB eng-GB + + + eng-GB + + - Locked + Jay Kowalski - - - - - - 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: | - - - 5 - new-state - 0 - - eng-GB - eng-GB - - New State - - - New Object State - - + + + + + 698 + first_name + eng-GB + ibexa_string + Jay + + + 699 + last_name + eng-GB + ibexa_string + Kowalski + + + 700 + phone_number + eng-GB + ibexa_string + +48 123 123 456 + + + 701 + user + eng-GB + ibexa_user + + true + 144 + jay.kowalski + jay.kowalski@email.invalid + 1682691003 + true + 0 + + + + + + + /user/default_profile_image/initials.svg?initials=JK#profile_image + + + image/svg+xml + + + jay.kowalski + jay.kowalski@email.invalid + true + + + + + Company Admin + + + 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. - 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 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: The CSRF Token needed on all unsafe HTTP methods with session. + 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: objectStateGroupId + - name: companyId in: path - description: "" + description: MemberCreateController 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: + deprecated: false + schema: + type: string + style: simple + explode: false + requestBody: + description: The MemberCreate schema encoded in XML or JSON format. + content: + application/vnd.ibexa.api.MemberCreate+json: schema: - $ref: '#/components/schemas/ObjectStateCreate' + $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: | - - new-state - 1 - eng-GB - - New State - - - New Object State - - + + jay.kowalski + jay.kowalski@email.invalid + Ibexa123# + + + + first_name + Jay + + + last_name + Kowalski + + + phone_number + +48 123 123 456 + + + required: false - deprecated: false - /content/objectstategroups/{objectStateGroupId}/objectstates/{objectStateId}: + /corporate/companies/{companyId}/members/{memberId}: get: - operationId: ibexa.rest.load_object_state + operationId: ibexa.rest.corporate_account.members.get tags: - - Object State Groups + - Corporate Account responses: 200: - description: OK - returns the Object state. + description: If set, the company member is returned in XML or JSON format. content: - application/vnd.ibexa.api.ObjectState+json: + application/vnd.ibexa.api.Member+json: schema: - $ref: '#/components/schemas/ObjectStateWrapper' + $ref: '#/components/schemas/MemberWrapper' 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: + 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: schema: - $ref: '#/components/schemas/ObjectState' + $ref: '#/components/schemas/Member' example: | - - 2 - locked - 1 - - eng-GB - eng-GB - - Locked - - - - - + + 144 + Jay Kowalski + + 139 + Ibexa Sp. z o. o. + + + Ibexa Sp. z o. o. + Ibexa Sp. z o. o. + + + + + 677 + 6 + PUBLISHED + 2023-04-28T16:10:13+02:00 + + 2023-04-28T16:10:13+02:00 + eng-GB + eng-GB + + + eng-GB + + + + Ibexa Sp. z o. o. + + + + + + 673 + active + eng-GB + ibexa_boolean + true + + + 674 + name + eng-GB + ibexa_string + Ibexa Sp. z o. o. + + + 675 + vat + eng-GB + ibexa_string + 123 456 789 + + + 676 + website + eng-GB + ibexa_string + https://ibexa.co + + + 677 + customer_group + eng-GB + ibexa_customer_group + + 1 + + + + 678 + sales_rep + eng-GB + ibexa_object_relation + + 14 + /api/ibexa/v2/content/objects/14 + + + + 679 + contact + eng-GB + ibexa_object_relation + + 144 + /api/ibexa/v2/content/objects/144 + + + + 680 + default_address + eng-GB + ibexa_object_relation + + 142 + /api/ibexa/v2/content/objects/142 + + + + 681 + billing_address + eng-GB + ibexa_address + + HQ + PL + + Silesia + Katowice + Gliwicka 6/5 + 40-079 + company@email.invalid + +48 000 000 000 + + + + + 683 + members + eng-GB + ibexa_object_relation + + 140 + /api/ibexa/v2/content/objects/140 + + + + 682 + address_book + eng-GB + ibexa_object_relation + + 141 + /api/ibexa/v2/content/objects/141 + + + + + + /placeholder + + + image/svg+xml + + + +
+ + + + 2023-04-28T16:10:13+02:00 + 2023-04-28T15:44:55+02:00 + eng-GB + 6 + true + false + PUBLISHED + + + HQ, Poland + 144 + 14 + 142 + 141 + 140 + + + /1/65/140/ + 1 + + + + Jay Kowalski + +
+ + + + + 2023-04-28T16:10:03+02:00 + 2023-04-28T16:10:03+02:00 + eng-GB + true + + + 676 + 1 + PUBLISHED + 2023-04-28T16:10:03+02:00 + + 2023-04-28T16:10:03+02:00 + eng-GB + eng-GB + + + eng-GB + + + + Jay Kowalski + + + + + + 698 + first_name + eng-GB + ibexa_string + Jay + + + 699 + last_name + eng-GB + ibexa_string + Kowalski + + + 700 + phone_number + eng-GB + ibexa_string + +48 123 123 456 + + + 701 + user + eng-GB + ibexa_user + + true + 144 + jay.kowalski + jay.kowalski@email.invalid + 1682691003 + true + 0 + + + + + + + /user/default_profile_image/initials.svg?initials=JK#profile_image + + + image/svg+xml + + + jay.kowalski + jay.kowalski@email.invalid + true + + + + + Company Admin + + + 401: - description: Error - The user is not authorized to read this Object state. + description: Error - The user is not authorized to read this company. 404: - description: Error - The Object state does not exist. - summary: Get Object state - description: Returns the Object state. + description: Error - The company does not exist. + summary: Get company member + description: Returns the company member by given member 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 + - name: companyId in: path - description: "" + description: MemberLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: objectStateId + - name: memberId in: path - description: "" + description: MemberLoadByIdController 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 + operationId: ibexa.rest.corporate_account.members.delete tags: - - Object State Groups + - Corporate Account responses: 204: - description: No Content - Object state deleted. + description: No Content - given company member is deleted. 401: - description: Error - The user is not authorized to delete an Object state. + description: Error - the user is not authorized to delete this company member. 404: - description: Error - The Object state does not exist. - summary: Delete Object state - description: Deletes provided Object state. + description: Error - the company member does not exist. + summary: Delete company member + description: The given company member is deleted. parameters: - name: X-CSRF-Token in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + 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: objectStateGroupId + - name: companyId in: path - description: "" + description: MemberDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: objectStateId + - name: memberId in: path - description: "" + description: MemberDeleteController 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 + operationId: ibexa.rest.corporate_account.members.patch tags: - - Object State Groups + - Corporate Account 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: | - - - 2 - locked - 1 - - eng-GB - eng-GB - - New Object State name - - - - - - 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: | - - - 3 - eng-GB - - New Object State name - - - 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. + description: OK - company member updated. content: - application/vnd.ibexa.api.Content+json: + application/vnd.ibexa.api.Member+json: schema: - $ref: '#/components/schemas/ContentWrapper' + $ref: '#/components/schemas/MemberWrapper' 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 + 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/109/versions/1 + _href: /api/ibexa/v2/content/objects/144/versions/6 VersionInfo: - id: 587 - versionNo: 1 - status: DRAFT - modificationDate: "2023-05-24T06:27:54+00:00" + 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-05-24T06:27:54+00:00" + creationDate: "2023-04-28T16:17:06+02:00" initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: @@ -11829,413 +7329,519 @@ paths: names: value: - _languageCode: eng-GB - '#text': draft article + '#text': Jay Kowalski Content: _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/109 + _href: /api/ibexa/v2/content/objects/144 Fields: field: - - id: 488 - fieldDefinitionIdentifier: title + - id: 698 + fieldDefinitionIdentifier: first_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string - fieldValue: draft article - - id: 489 - fieldDefinitionIdentifier: short_title + fieldValue: Jay + - id: 699 + fieldDefinitionIdentifier: last_name 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: | - -
draft draft
- xhtml5edit: | - -

draft draft

- - id: 492 - fieldDefinitionIdentifier: body - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - -
draft draft draft
- xhtml5edit: | - -

draft draft draft

- - id: 493 - fieldDefinitionIdentifier: enable_comments + fieldValue: Kowalski + - id: 700 + fieldDefinitionIdentifier: phone_number languageCode: eng-GB - fieldTypeIdentifier: ibexa_boolean - fieldValue: false - - id: 494 - fieldDefinitionIdentifier: image + fieldTypeIdentifier: ibexa_string + fieldValue: +48 123 123 456 + - id: 701 + fieldDefinitionIdentifier: user languageCode: eng-GB - fieldTypeIdentifier: ibexa_object_relation + fieldTypeIdentifier: ibexa_user fieldValue: - destinationContentId: ~ + 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/109/versions/1/relations + _href: /api/ibexa/v2/content/objects/144/versions/6/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json - resource: /placeholder + resource: /user/default_profile_image/initials.svg?initials=JK#profile_image 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: | - - - - draft article - draft article - - - - - 586 - 1 - DRAFT - 2023-05-24T06:24:46+00:00 - - 2023-05-24T06:24:46+00:00 - eng-GB - eng-GB - - - eng-GB - - - - draft article - - - - - - 481 - title - eng-GB - ibexa_string - draft article - - - 482 - short_title - eng-GB - ibexa_string - - - - 483 - author - eng-GB - ibexa_author - - - - 484 - intro - eng-GB - ibexa_richtext - - <?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> - - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft</p></section> - - - - - 485 - body - eng-GB - ibexa_richtext - - <?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> - - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft draft</p></section> - - - - - 486 - enable_comments - eng-GB - ibexa_boolean - false - - - 487 - image - eng-GB - ibexa_object_relation - - - - - - - - /placeholder - - - image/svg+xml - - - -
- - - eng-GB - 1 - true - false - DRAFT - - - 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: + 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/ContentInfo' + $ref: '#/components/schemas/Member' example: | - - - draft article - draft article - - -
- + + 144 + Jay Kowalski + + 139 + Ibexa Sp. z o. o. + + + Ibexa Sp. z o. o. + Ibexa Sp. z o. o. + + + + + 677 + 6 + PUBLISHED + 2023-04-28T16:10:13+02:00 + + 2023-04-28T16:10:13+02:00 + eng-GB + eng-GB + + + eng-GB + + + + Ibexa Sp. z o. o. + + + + + + 673 + active + eng-GB + ibexa_boolean + true + + + 674 + name + eng-GB + ibexa_string + Ibexa Sp. z o. o. + + + 675 + vat + eng-GB + ibexa_string + 123 456 789 + + + 676 + website + eng-GB + ibexa_string + https://ibexa.co + + + 677 + customer_group + eng-GB + ibexa_customer_group + + 1 + + + + 678 + sales_rep + eng-GB + ibexa_object_relation + + 14 + /api/ibexa/v2/content/objects/14 + + + + 679 + contact + eng-GB + ibexa_object_relation + + 144 + /api/ibexa/v2/content/objects/144 + + + + 680 + default_address + eng-GB + ibexa_object_relation + + 142 + /api/ibexa/v2/content/objects/142 + + + + 681 + billing_address + eng-GB + ibexa_address + + HQ + PL + + Silesia + Katowice + Gliwicka 6/5 + 40-079 + company@email.invalid + +48 000 000 000 + + + + + 683 + members + eng-GB + ibexa_object_relation + + 140 + /api/ibexa/v2/content/objects/140 + + + + 682 + address_book + eng-GB + ibexa_object_relation + + 141 + /api/ibexa/v2/content/objects/141 + + + + + + /placeholder + + + image/svg+xml + + + +
+ + + + 2023-04-28T16:10:13+02:00 + 2023-04-28T15:44:55+02:00 + eng-GB + 6 + true + false + PUBLISHED + + + HQ, Poland + 144 + 14 + 142 + 141 + 140 + + + /1/65/140/ + 1 + + + + Jay Kowalski + +
+ + + + 2023-04-28T16:10:03+02:00 + 2023-04-28T16:10:03+02:00 eng-GB - 1 true - false - DRAFT - - + + + 676 + 1 + PUBLISHED + 2023-04-28T16:10:03+02:00 + + 2023-04-28T16:10:03+02:00 + eng-GB + eng-GB + + + eng-GB + + + + Jay Kowalski + + + + + + 698 + first_name + eng-GB + ibexa_string + Jay + + + 699 + last_name + eng-GB + ibexa_string + Kowalski + + + 700 + phone_number + eng-GB + ibexa_string + +48 123 123 456 + + + 701 + user + eng-GB + ibexa_user + + true + 144 + jay.kowalski + jay.kowalski@email.invalid + 1682691003 + true + 0 + + + + + + + /user/default_profile_image/initials.svg?initials=JK#profile_image + + + image/svg+xml + + + jay.kowalski + jay.kowalski@email.invalid + true + + + + + Company Admin + + + 400: - description: Error - the input does not match the input schema definition - or the validation on a field fails. + description: Error - the input does not match the input schema definition. 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. + description: Error - the user is not authorized to create this company member. + summary: Update a company member + description: Updates a company member. PATCH or POST with header X-HTTP-Method-Override + PATCH. parameters: - name: X-CSRF-Token in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + 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 + - name: If-Match + in: header + description: ETag + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: companyId + in: path + description: MemberUpdateController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: memberId + in: path + description: MemberUpdateController identifier 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. + description: The company input schema encoded in XML or JSON. content: - application/vnd.ibexa.api.ContentCreate+json: + application/vnd.ibexa.api.MemberUpdate+json: schema: - $ref: '#/components/schemas/ContentCreateWrapper' + $ref: '#/components/schemas/MemberUpdateWrapper' 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" + 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: 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: + - fieldDefinitionIdentifier: first_name + fieldValue: Jay + - fieldDefinitionIdentifier: last_name + fieldValue: Kowalski + - fieldDefinitionIdentifier: phone_number + fieldValue: +48 123 123 456 + application/vnd.ibexa.api.MemberUpdate+xml: schema: - $ref: '#/components/schemas/ContentCreate' + $ref: '#/components/schemas/MemberUpdate' example: | - - - eng-GB - - - 0 - false - PATH - ASC - -
- true - - - - title - eng-GB - draft article - - - intro - eng-GB - -

draft draft

]]> - - - - body - eng-GB - -

draft draft draft

]]> - - - - + + jay.kowalski@updated.email + Publish123# + false + 5 + + + + first_name + Jay + + + last_name + Kowalski + + + phone_number + +48 123 123 456 + + + required: false - deprecated: false - /content/objects/{contentId}: + /corporate/sales-representatives: get: - operationId: ibexa.rest.load_content + operationId: ibexa.rest.corporate_account.sales_representatives.get tags: - - Objects + - Corporate Account responses: 200: - description: OK - returns the Content or ContentInfo in XML or JSON format. + description: Sales representatives list containing Company objects. content: - application/vnd.ibexa.api.Content+json: + application/vnd.ibexa.api.SalesRepresentativesList+json: schema: - $ref: '#/components/schemas/ContentWrapper' + $ref: '#/components/schemas/SalesRepresentativesListWrapper' 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 + SalesRepresentativesList: + _media-type: application/vnd.ibexa.api.SalesRepresentativesList+json + users: + - _media-type: application/vnd.ibexa.api.User+json + _href: /api/ibexa/v2/user/users/75 + _id: 75 + _remoteId: f262e2fa12ae105b78a1b654e87a0874 + ContentType: + _media-type: application/vnd.ibexa.api.ContentType+json + _href: /api/ibexa/v2/content/types/4 + name: John Black + Versions: + _media-type: application/vnd.ibexa.api.VersionList+json + _href: /api/ibexa/v2/content/objects/75/versions + Section: + _media-type: application/vnd.ibexa.api.Section+json + _href: /api/ibexa/v2/content/sections/10 + MainLocation: + _media-type: application/vnd.ibexa.api.Location+json + _href: /api/ibexa/v2/content/locations/1/5/64/76 + Locations: + _media-type: application/vnd.ibexa.api.LocationList+json + _href: /api/ibexa/v2/content/objects/75/locations + Groups: + _media-type: application/vnd.ibexa.api.UserGroupRefList+json + _href: /api/ibexa/v2/user/users/75/groups + Owner: + _media-type: application/vnd.ibexa.api.User+json + _href: /api/ibexa/v2/user/users/14 + publishDate: "2023-06-20T07:33:17+00:00" + lastModificationDate: "2023-06-20T07:33:17+00:00" + mainLanguageCode: eng-GB + alwaysAvailable: true Version: _media-type: application/vnd.ibexa.api.Version+json - _href: /api/ibexa/v2/content/objects/54/versions/1 + _href: /api/ibexa/v2/content/objects/75/versions/1 VersionInfo: - id: 514 + id: 536 versionNo: 1 status: PUBLISHED - modificationDate: "2018-09-17T06:48:13+00:00" + 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: "2018-09-17T06:48:13+00:00" + creationDate: "2023-06-20T07:33:17+00:00" initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: @@ -12245,95 +7851,91 @@ paths: names: value: - _languageCode: eng-GB - '#text': Forms + '#text': John Black Content: _media-type: application/vnd.ibexa.api.ContentInfo+json - _href: /api/ibexa/v2/content/objects/54 + _href: /api/ibexa/v2/content/objects/75 Fields: field: - - id: 249 - fieldDefinitionIdentifier: name + - id: 339 + fieldDefinitionIdentifier: first_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string - fieldValue: Forms - - id: 250 - fieldDefinitionIdentifier: short_name + fieldValue: John + - id: 340 + fieldDefinitionIdentifier: last_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string - fieldValue: ~ - - id: 251 - fieldDefinitionIdentifier: short_description + fieldValue: Black + - id: 341 + fieldDefinitionIdentifier: user_account languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext + fieldTypeIdentifier: ibexa_user fieldValue: - xml: | - -
- xhtml5edit: | - -
- - id: 252 - fieldDefinitionIdentifier: description + 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_richtext - fieldValue: - xml: | - -
- xhtml5edit: | - -
+ 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/54/versions/1/relations + _href: /api/ibexa/v2/content/objects/75/versions/1/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json - resource: /bundles/ezplatformadminui/img/ez-icons.svg#folder + resource: /user/default_profile_image/initials.svg?initials=JB#profile_image 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: + login: John Black + email: j.black@ibexa.co + enabled: true + UserGroups: + _media-type: application/vnd.ibexa.api.UserGroupList+json + _href: /api/ibexa/v2/user/users/75/groups + Roles: + _media-type: application/vnd.ibexa.api.RoleAssignmentList+json + _href: /api/ibexa/v2/user/users/75/roles + application/vnd.ibexa.api.SalesRepresentativesList+xml: schema: - $ref: '#/components/schemas/Content' + $ref: '#/components/schemas/SalesRepresentativesList' example: | - - - Forms - Forms - - - + + + + John Black + +
+ + + + + 2023-06-20T07:33:17+00:00 + 2023-06-20T07:33:17+00:00 + eng-GB + true + - 514 + 536 1 PUBLISHED - 2018-09-17T06:48:13+00:00 + 2023-06-20T07:33:17+00:00 - 2018-09-17T06:48:13+00:00 + 2023-06-20T07:33:17+00:00 eng-GB eng-GB @@ -12342,5909 +7944,5270 @@ paths: - Forms + John Black - + - 249 - name + 339 + first_name eng-GB ibexa_string - Forms + John - 250 - short_name + 340 + last_name eng-GB ibexa_string - + Black - 251 - short_description + 341 + user_account eng-GB - ibexa_richtext + ibexa_user - <?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"/> - - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - + true + 75 + John Black + j.black@ibexa.co + 1687246397 + true + 0 + - 252 - description + 342 + signature eng-GB - ibexa_richtext - - <?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"/> - - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - + ibexa_text + + + + 343 + image + eng-GB + ibexa_image + - + - /bundles/ezplatformadminui/img/ez-icons.svg#folder + /user/default_profile_image/initials.svg?initials=JB#profile_image image/svg+xml - -
- - - - 2018-09-17T06:48:13+00:00 - 2018-09-17T06:48:13+00:00 - eng-GB - 1 - false - false - PUBLISHED - - - application/vnd.ibexa.api.ContentInfo+json: + John Black + j.black@ibexa.co + true + + + + + 401: + description: Error - the user is not authorized to read Sales Representatives + List. + content: + application/vnd.ibexa.api.ErrorMessage: schema: - $ref: '#/components/schemas/ContentInfoWrapper' - application/vnd.ibexa.api.ContentInfo+xml: + $ref: '#/components/schemas/ErrorMessage' + summary: Read list of sales representatives + description: Returns paginated list of available sales representatives. + parameters: [] + /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/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 + $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: | + + + + 2 + eng-GB + English (United Kingdom) + + + 4 + pol-PL + Polish (polski) + + + summary: Language list + description: Lists languages + parameters: [] + /languages/{code}: + get: + operationId: ibexa.rest.languages.view tags: - - Objects + - Language 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. + 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: | + + + 2 + eng-GB + English (United Kingdom) + + summary: Get language + description: Retrieves a LanguageLoadByIdController resource. 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: LanguageLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - patch: - operationId: ibexa.rest.update_content_metadata + /content/locations: + get: + operationId: ibexa.rest.redirect_location tags: - - Objects + - Location responses: 200: - description: If set, all information for the content item (excluding the - current version) is returned in XML or JSON format. + description: OK - returns the LocationList in XML or JSON format. content: - application/vnd.ibexa.api.ContentInfo+json: + application/vnd.ibexa.api.LocationList+json: schema: - $ref: '#/components/schemas/ContentInfoWrapper' - application/vnd.ibexa.api.ContentInfo+xml: + $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/ContentInfo' + $ref: '#/components/schemas/Location' example: | - - - article1 - - -
- - - - 2019-02-19T15:00:34+01:00 - 2019-02-19T15:00:34+01:00 - eng-GB - 1 - false - - - 400: - description: Error - the input does not match the input schema definition. + + 58 + 0 + false + false + false + + /1/2/58/ + 2 + 3 + 0cfe62f27753448d79aaa8acd8d01699 + + + PATH + ASC + + + + + All Tips + All Tips + + +
+ + + 2021-06-28T11:22:52+00:00 + 2021-06-28T11:22:52+00:00 + eng-GB + 1 + true + false + PUBLISHED + + + + + 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: [] + /content/locations/{path}: + get: + operationId: ibexa.rest.load_location + tags: + - Location + 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 + 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/Location' + example: | + + + 61 + 0 + false + false + + /1/2/61/ + 2 + 0 + 2cfa66027e3806b113d994c9c26d3a66 + + + NAME + ASC + + + + + 666 + + +
+ + + 2018-11-09T14:49:52+01:00 + 2018-11-09T14:49:52+01:00 + eng-GB + 1 + false + + + + 401: - description: Error - the user is not authorized to update this object. + description: Error - the user is not authorized to read this Location. 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. + 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: X-CSRF-Token + - name: If-None-Match in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + description: ETag + required: false + deprecated: false + schema: + type: string + style: simple + explode: false + - name: path + in: path + description: LocationLoadByPathController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: If-match + 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: Causes to patch only if the specified ETag is the current one. - Otherwise a 412 is returned. + 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: path in: path - description: "" + description: LocationSubtreeDeleteController identifier 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: | - - - eng-GB -
- - - false - 69848aeb86164c35e5c98202eebe9e05 - - required: false - deprecated: false - /content/objects/{contentId}/currentversion: - get: - operationId: ibexa.rest.redirect_current_version + patch: + operationId: ibexa.rest.update_location tags: - - Objects + - Location responses: 200: - description: OK - returns the Version in XML or JSON format. + description: If set, the Location is returned in XML or JSON format. content: - application/vnd.ibexa.api.Version+json: + application/vnd.ibexa.api.Location+json: schema: - $ref: '#/components/schemas/VersionWrapper' + $ref: '#/components/schemas/LocationWrapper' 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 + 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/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: | - -
- xhtml5edit: | - -
- - id: 480 - fieldDefinitionIdentifier: description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - -
- xhtml5edit: | - -
- 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: + _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/Version' + $ref: '#/components/schemas/Location' example: | - - - 578 - 2 - PUBLISHED - 2023-05-24T05:59:09+00:00 - - 2023-05-24T05:59:02+00:00 - eng-GB - eng-GB - - - eng-GB - - - - Features - - - - - - 477 - name - eng-GB - ibexa_string - Features - - - 478 - short_name - eng-GB - ibexa_string - - - - 479 - short_description - eng-GB - ibexa_richtext - - <?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"/> - - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - - - - 480 - description - eng-GB - ibexa_richtext - - <?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"/> - - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - - - - - - /placeholder - - - image/svg+xml - - - 307: - description: Temporary redirect. + + 58 + 0 + false + false + false + + /1/2/58/ + 2 + 3 + 0cfe62f27753448d79aaa8acd8d01699 + + + PATH + ASC + + + + + All Tips + All Tips + + +
+ + + 2021-06-28T11:22:52+00:00 + 2021-06-28T11:22:52+00:00 + eng-GB + 1 + true + false + PUBLISHED + + + + + 401: + description: Error - the user is not authorized to update this Location. 404: - description: Error - the resource does not exist. - summary: Get current version - description: Redirects to the current version of the content item. + 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: contentId - 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 - 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: ~ - - id: 479 - fieldDefinitionIdentifier: short_description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - -
- xhtml5edit: | - -
- - id: 480 - fieldDefinitionIdentifier: description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - -
- xhtml5edit: | - -
- 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: | - - - - 581 - 5 - ARCHIVED - 2023-05-24T06:11:50+00:00 - - 2023-05-24T06:09:49+00:00 - eng-GB - eng-GB - - - eng-GB - - - - Features - - - - - - 477 - name - eng-GB - ibexa_string - Features - - - 478 - short_name - eng-GB - ibexa_string - - - - 479 - short_description - eng-GB - ibexa_richtext - - <?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"/> - - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - - - - 480 - description - eng-GB - ibexa_richtext - - <?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"/> - - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - - - - - - /placeholder - - - image/svg+xml - - - 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 + - name: If-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 - - name: contentId + - name: path in: path - description: "" + description: LocationUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: No payload required - content: [] + 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: | + + + 3 + true + remoteId-qwert999 + CLASS + DESC + required: false - deprecated: false - /content/objects/{contentId}/hide: - post: - operationId: ibexa.rest.hide_content + /content/locations/{path}/children: + get: + operationId: ibexa.rest.load_location_children tags: - - Objects + - Location responses: - 204: - description: OK - Object item is hidden. + 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: | + + + + + + + 401: - description: Error - The user has no permission to change Object item visibility. + description: Error - the user is not authorized to read this content item. 404: - description: Error - The content item was not found. - summary: Hide content item - description: Makes or keep the content item invisible + 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: X-CSRF-Token - in: header - description: The CSRF Token needed on all unsafe HTTP methods with session. + - name: path + in: path + description: LocationChildrenListController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: contentId + /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: | + + + + + + 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 in: path - description: "" + description: URLAliasListLocationController 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: + /content/objectstategroups: get: - operationId: ibexa.rest.load_locations_for_content + operationId: ibexa.rest.load_object_state_groups tags: - - Objects + - Object State Groups responses: 200: - description: If set, the Location list is returned in XML or JSON format. + description: OK - returns a list of Object state groups. content: - application/vnd.ibexa.api.LocationList+json: + application/vnd.ibexa.api.ObjectStateGroupList+json: schema: - $ref: '#/components/schemas/LocationListWrapper' + $ref: '#/components/schemas/ObjectStateGroupListWrapper' 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: + 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/LocationList' + $ref: '#/components/schemas/ObjectStateGroupList' example: | - - - + + + 2 + ibexa_lock + eng-GB + eng-GB + + + Lock + + + + + + + 3 + accessibility + eng-GB + eng-GB + + + Accessibility + + + + + + + 6 + custom-states + eng-GB + eng-GB + + + Custom State + + + Custom Object state + + + 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. + 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 - - 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 + operationId: ibexa.rest.create_object_state_group tags: - - Objects + - Object State Groups responses: 201: - description: If set, the new Location is returned in XML or JSON format. + description: Object state group created. content: - application/vnd.ibexa.api.Location+json: + application/vnd.ibexa.api.ObjectStateGroup+json: schema: - $ref: '#/components/schemas/LocationWrapper' + $ref: '#/components/schemas/ObjectStateGroupWrapper' 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: + 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/Location' + $ref: '#/components/schemas/ObjectStateGroup' example: | - - 96 - 0 - false - true - false - - /1/2/42/96/ - 3 - 0 - 58133c8c75230e5debe362a28b92d27a - - - PATH - ASC - - - - - Art3 - Art3 - - -
- - - 2021-06-28T11:34:17+00:00 - 2021-06-28T11:34:17+00:00 - eng-GB - 1 - false - false - PUBLISHED - - - - + + 5 + custom-states + eng-GB + eng-GB + + + Custom State + + + Custom Object state + + 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 Location. + description: Error - The user is not authorized to create an Object state + group. 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 - 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: 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. + description: The Object state group input schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.LocationCreate+json: + application/vnd.ibexa.api.ObjectStateGroupCreate+json: schema: - $ref: '#/components/schemas/LocationCreateWrapper' + $ref: '#/components/schemas/ObjectStateGroupCreateWrapper' 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: + 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/LocationCreate' - example: | + $ref: '#/components/schemas/ObjectStateGroupCreate' + example: |- - - - 0 - false - PATH - ASC - + + custom + eng-GB + + Custom State + + + Custom Object state + + required: false - deprecated: false - /content/objects/{contentId}/objectstates: + /content/objectstategroups/{objectStateGroupId}: get: - operationId: ibexa.rest.get_object_states_for_content + operationId: ibexa.rest.load_object_state_group tags: - - Objects + - Object State Groups responses: 200: - description: OK - returns the Object state. + description: OK - returns the Object state group. content: - application/vnd.ibexa.api.ContentObjectStates+json: + application/vnd.ibexa.api.ObjectStateGroup+json: schema: - $ref: '#/components/schemas/ContentObjectStates' + $ref: '#/components/schemas/ObjectStateGroupWrapper' 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: | - - - - - - - + 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: | + + + 7 + custom-states + eng-GB + eng-GB + + + Custom State + + + Custom Object state + + + 401: + description: Error - The user is not authorized to read this Object state + group. 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 + 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: contentId + - name: objectStateGroupId in: path - description: "" + description: ObjectStateGroupLoadByIdController 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 + delete: + operationId: ibexa.rest.delete_object_state_group tags: - - Objects + - Object State Groups responses: 204: - description: OK - Object state updated. + 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 + schema: + type: string + style: simple + explode: false + - 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: + - Object State Groups + responses: + 200: + description: OK - Object stated group updated. content: - application/vnd.ibexa.api.ContentObjectStates+json: + application/vnd.ibexa.api.ObjectStateGroup+json: schema: - $ref: '#/components/schemas/ContentObjectStatesWrapper' + $ref: '#/components/schemas/ObjectStateGroupWrapper' 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: + 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/ContentObjectStates' + $ref: '#/components/schemas/ObjectStateGroup' example: | - - - + + 7 + custom-states + eng-GB + eng-GB + + + New Custom State name + + + Custom Object state + + 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. + description: Error - The user is not authorized to update an Object state + group. 403: - description: Error - The input contains multiple Object states of the same - Object state group. + 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: 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. + 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: contentId + - name: objectStateGroupId in: path - description: "" + description: ObjectStateGroupUpdateController identifier 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 Object state group input schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.ContentObjectStates+json: + application/vnd.ibexa.api.ObjectStateGroupUpdate+json: schema: - $ref: '#/components/schemas/ContentObjectStatesWrapper' + $ref: '#/components/schemas/ObjectStateGroupUpdateWrapper' example: - ContentObjectStates: - ObjectState: - - _href: /api/ibexa/v2/content/objectstategroups/2/objectstates/2 - application/vnd.ibexa.api.ContentObjectStates+xml: + ObjectStateGroupUpdate: + names: + value: + - _languageCode: eng-GB + '#text': New Custom State name + application/vnd.ibexa.api.ObjectStateGroupUpdate+xml: schema: - $ref: '#/components/schemas/ContentObjectStates' + $ref: '#/components/schemas/ObjectStateGroupUpdate' example: | - - - + + + New Custom State name + + required: false - deprecated: false - /content/objects/{contentId}/relations: + /content/objectstategroups/{objectStateGroupId}/objectstates: 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 + operationId: ibexa.rest.load_object_states tags: - - Objects + - Object State Groups responses: - 204: - description: OK - Object item is revealed. + 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: | + + + + 1 + not_locked + 0 + + eng-GB + eng-GB + + Not locked + + + + + + + 2 + locked + 1 + + eng-GB + eng-GB + + Locked + + + + + + 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 + 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: X-CSRF-Token + - name: If-None-Match 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: [] + description: ETag 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 + - name: objectStateGroupId in: path - description: "" + description: ObjectStateListController 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 + post: + operationId: ibexa.rest.create_object_state tags: - - Objects + - Object State Groups responses: - 200: - description: If set, the version list is returned in XML or JSON format. + 201: + description: Object state created. content: - application/vnd.ibexa.api.VersionList+json: + application/vnd.ibexa.api.ObjectState+json: schema: - $ref: '#/components/schemas/VersionListWrapper' + $ref: '#/components/schemas/ObjectStateWrapper' 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: | - - - - - - 521 - 1 - PUBLISHED - 2021-06-28T11:33:49+00:00 - - 2021-06-28T11:33:31+00:00 - eng-GB - eng-GB - - - eng-GB - - - - Art1 - - - - - - - - 580 - 2 - DRAFT - 2021-07-26T08:10:02+00:00 - - 2021-07-26T08:10:02+00:00 - eng-GB - eng-GB - - - eng-GB - - - - Art1 - - - - - - - - 581 - 3 - DRAFT - 2021-07-26T08:16:50+00:00 - - 2021-07-26T08:16:50+00:00 - eng-GB - eng-GB - - - eng-GB - - - - Art1 - - - - - + 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: | + + + 5 + new-state + 0 + + eng-GB + eng-GB + + New State + + + New Object State + + + 400: + description: Error - The input does not match the input schema definition. 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 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: contentId + - 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: ObjectStateCreateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false - /content/objects/{contentId}/versions/{versionNo}: + 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: | + + + new-state + 1 + eng-GB + + New State + + + New Object State + + + required: false + /content/objectstategroups/{objectStateGroupId}/objectstates/{objectStateId}: get: - operationId: ibexa.rest.load_content_in_version + operationId: ibexa.rest.load_object_state tags: - - Objects + - Object State Groups responses: 200: - description: If set, the version list is returned in XML or JSON format. + description: OK - returns the Object state. content: - application/vnd.ibexa.api.Version+json: + application/vnd.ibexa.api.ObjectState+json: schema: - $ref: '#/components/schemas/VersionWrapper' + $ref: '#/components/schemas/ObjectStateWrapper' 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: | - -
- xhtml5edit: | - -
- - id: 480 - fieldDefinitionIdentifier: description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - -
- xhtml5edit: | - -
- 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: + 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/Version' + $ref: '#/components/schemas/ObjectState' example: | - - - 581 - 5 - ARCHIVED - 2023-05-24T06:11:50+00:00 - - 2023-05-24T06:09:49+00:00 - eng-GB - eng-GB - - - eng-GB - - - - Features - - - - - - 477 - name - eng-GB - ibexa_string - Features - - - 478 - short_name - eng-GB - ibexa_string - - - - 479 - short_description - eng-GB - ibexa_richtext - - <?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"/> - - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - - - - 480 - description - eng-GB - ibexa_richtext - - <?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"/> - - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - - - - - - /placeholder - - - image/svg+xml - - - 304: - description: Not Modified - the ETag matches the current one. + + 2 + locked + 1 + + eng-GB + eng-GB + + Locked + + + + + 401: - description: Error - the user is not authorized to read this content item. + description: Error - The user is not authorized to read this Object state. 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. + 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: Only return the version if the given ETag is the not current - one, otherwise a 304 is returned. + description: ETag required: false deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: contentId + - name: objectStateGroupId in: path - description: "" + description: ObjectStateLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: versionNo + - name: objectStateId in: path - description: "" + description: ObjectStateLoadByIdController identifier 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 + delete: + operationId: ibexa.rest.delete_object_state tags: - - Objects + - Object State Groups responses: - 201: - description: Created. + 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 + schema: + type: string + style: simple + explode: false + - name: objectStateGroupId + in: path + description: ObjectStateDeleteController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: objectStateId + in: path + description: ObjectStateDeleteController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + patch: + operationId: ibexa.rest.update_object_state + tags: + - Object State Groups + responses: + 200: + description: OK - Object State updated content: - application/vnd.ibexa.api.Version+json: + application/vnd.ibexa.api.ObjectState+json: schema: - $ref: '#/components/schemas/VersionWrapper' + $ref: '#/components/schemas/ObjectStateWrapper' 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: | - -
- xhtml5edit: | - -
- - id: 480 - fieldDefinitionIdentifier: description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - -
- xhtml5edit: | - -
- 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: | - - - - 581 - 5 - ARCHIVED - 2023-05-24T06:11:50+00:00 - - 2023-05-24T06:09:49+00:00 - eng-GB - eng-GB - - - eng-GB - - - - Features - - - - - - 477 - name - eng-GB - ibexa_string - Features - - - 478 - short_name - eng-GB - ibexa_string - - - - 479 - short_description - eng-GB - ibexa_richtext - - <?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"/> - - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - - - - 480 - description - eng-GB - ibexa_richtext - - <?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"/> - - <?xml version="1.0" encoding="UTF-8"?> - <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> - - - - - - - /placeholder - - - image/svg+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/ObjectState' + example: | + + + 2 + locked + 1 + + eng-GB + eng-GB + + New Object State name + + + + + + 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 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: contentId + - name: If-Match + in: header + description: ETag + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: objectStateGroupId in: path - description: "" + description: ObjectStateUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: versionNo + - name: objectStateId in: path - description: "" + description: ObjectStateUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: No payload required - content: [] + 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: | + + + 3 + eng-GB + + New Object State name + + required: false - deprecated: false - delete: - operationId: ibexa.rest.delete_content_version + /content/objects: + get: + operationId: ibexa.rest.redirect_content tags: - Objects responses: - 204: - description: No Content - the version is deleted. + 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 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. + 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: 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: "" + - name: remoteId + in: query + description: Remote ID of the content item. required: true deprecated: false - allowEmptyValue: false schema: type: string - style: simple + style: form explode: false - allowReserved: false - deprecated: false - patch: - operationId: ibexa.rest.update_version + post: + operationId: ibexa.rest.create_content tags: - Objects responses: - 200: - description: If set, the updated version is returned in XML or JSON format. + 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.Version+json: + application/vnd.ibexa.api.Content+json: schema: - $ref: '#/components/schemas/VersionWrapper' + $ref: '#/components/schemas/ContentWrapper' 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: | - -
- xhtml5edit: | - -
- - id: 480 - fieldDefinitionIdentifier: description - languageCode: eng-GB - fieldTypeIdentifier: ibexa_richtext - fieldValue: - xml: | - -
- xhtml5edit: | - -
- 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: + 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: | + +
draft draft
+ xhtml5edit: | + +

draft draft

+ - id: 492 + fieldDefinitionIdentifier: body + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + +
draft draft draft
+ xhtml5edit: | + +

draft draft draft

+ - 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/Version' + $ref: '#/components/schemas/Content' example: | - - - 45 - 4 + + + draft article + draft article + + + + + 586 + 1 + DRAFT + 2023-05-24T06:24:46+00:00 + + 2023-05-24T06:24:46+00:00 + eng-GB + eng-GB + + + eng-GB + + + + draft article + + + + + + 481 + title + eng-GB + ibexa_string + draft article + + + 482 + short_title + eng-GB + ibexa_string + + + + 483 + author + eng-GB + ibexa_author + + + + 484 + intro + eng-GB + ibexa_richtext + + <?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> + + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft</p></section> + + + + + 485 + body + eng-GB + ibexa_richtext + + <?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> + + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft draft</p></section> + + + + + 486 + enable_comments + eng-GB + ibexa_boolean + false + + + 487 + image + eng-GB + ibexa_object_relation + + + + + + + + /placeholder + + + image/svg+xml + + + +
+ + + eng-GB + 1 + true + false + DRAFT + + + 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: | + + + + draft article + draft article + + +
+ + + eng-GB + 1 + true + false DRAFT - 2012-02-20T12:00:00 - - 22012-02-20T12:00:00 - ger-DE - - Neuer Titel - - - - - - 1234 - title - ger-DE - Neuer Titel - - - 1235 - summary - ger-DE - Dies ist eine neuse Zusammenfassungy - - - authors - ger-DE - - - - - - - - - - - - COMMON - - - + + 400: - description: Error - the input does not match the input schema definition. + 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 update this version. - 403: - description: Error - the version is not allowed to change - i.e. version - is not a DRAFT. + description: Error - the user is not authorized to create this Object in + this Location. 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 - 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 - - 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. + description: The ContentCreate schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.VersionUpdate+json: + application/vnd.ibexa.api.ContentCreate+json: schema: - $ref: '#/components/schemas/VersionUpdateWrapper' - application/vnd.ibexa.api.VersionUpdate+xml: + $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/VersionUpdate' + $ref: '#/components/schemas/ContentCreate' example: | - - 2012-02-20T12:00:00 - ger-DE + + + eng-GB + + + 0 + false + PATH + ASC + +
+ true + - 1234 title - ger-DE - Neuer Titel + eng-GB + draft article - 1235 - summary - ger-DE - Dies ist eine neuse Zusammenfassungy + intro + eng-GB + +

draft draft

]]> + + + + body + eng-GB + +

draft draft draft

]]> + - + required: false - deprecated: false - /content/objects/{contentId}/versions/{versionNo}/relations: + /content/objects/{contentId}: get: - operationId: ibexa.rest.load_version_relations + operationId: ibexa.rest.load_content 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: | - - - - - - LINK - - - 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. + description: OK - returns the Content or ContentInfo in XML or JSON format. content: - application/vnd.ibexa.api.Relation+json: + application/vnd.ibexa.api.Content+json: schema: - $ref: '#/components/schemas/RelationWrapper' + $ref: '#/components/schemas/ContentWrapper' 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: + 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: ~ + - id: 251 + fieldDefinitionIdentifier: short_description + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + +
+ xhtml5edit: | + +
+ - id: 252 + fieldDefinitionIdentifier: description + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + +
+ xhtml5edit: | + +
+ 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/Relation' + $ref: '#/components/schemas/Content' example: | - - - - COMMON - - 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: | - - - - - 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: + + + Forms + Forms + + + + + 514 + 1 + PUBLISHED + 2018-09-17T06:48:13+00:00 + + 2018-09-17T06:48:13+00:00 + eng-GB + eng-GB + + + eng-GB + + + + Forms + + + + + + 249 + name + eng-GB + ibexa_string + Forms + + + 250 + short_name + eng-GB + ibexa_string + + + + 251 + short_description + eng-GB + ibexa_richtext + + <?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"/> + + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + + + + + 252 + description + eng-GB + ibexa_richtext + + <?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"/> + + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + + + + + + + /bundles/ezplatformadminui/img/ez-icons.svg#folder + + + image/svg+xml + + + +
+ + + + 2018-09-17T06:48:13+00:00 + 2018-09-17T06:48:13+00:00 + eng-GB + 1 + false + false + PUBLISHED + + + application/vnd.ibexa.api.ContentInfo+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: + $ref: '#/components/schemas/ContentInfoWrapper' + application/vnd.ibexa.api.ContentInfo+xml: schema: - $ref: '#/components/schemas/Relation' - example: | - - - - - COMMON - - 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. + $ref: '#/components/schemas/ContentInfo' 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. + 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 - 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 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: X-CSRF-Token + - name: If-None-Match in: header - description: The CSRF Token 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 - 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: "" + description: ContentLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: - type: string + type: integer style: simple explode: false - allowReserved: false - deprecated: false - /content/objects/{contentId}/versions/{versionNo}/translations/{languageCode}: delete: - operationId: ibexa.rest.delete_translation_from_draft + operationId: ibexa.rest.delete_content 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. + description: The content item is deleted. 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. + 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 - - 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: ~ - 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: "" + description: ContentDeleteController 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.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 + operationId: ibexa.rest.update_content_metadata tags: - - Orders + - Objects responses: 200: - description: OK - loads orders. + 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.OrderList+json: + application/vnd.ibexa.api.ContentInfo+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: + $ref: '#/components/schemas/ContentInfoWrapper' + application/vnd.ibexa.api.ContentInfo+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 + $ref: '#/components/schemas/ContentInfo' + example: | + + + + article1 + + +
+ + + + 2019-02-19T15:00:34+01:00 + 2019-02-19T15:00:34+01:00 + eng-GB + 1 + false + + 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 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. + 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 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 + - name: If-match in: header - description: The CSRF token. + 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 - 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: |- - - bank_transfer - offline - - Bank transfer - - - 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. + - name: contentId + in: path + description: ContentMetadataUpdateController 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: The ContentUpdate schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.PaymentMethodViewInput+json: + application/vnd.ibexa.api.ContentUpdate+json: schema: - $ref: '#/components/schemas/PaymentMethodViewInputWrapper' - example: - PaymentMethodViewInput: - identifier: example - PaymentMethodQuery: - offset: 0 - limit: 10 - application/vnd.ibexa.api.PaymentMethodViewInput+xml: + $ref: '#/components/schemas/ContentInfoWrapper' + application/vnd.ibexa.api.ContentUpdate+xml: schema: - $ref: '#/components/schemas/PaymentMethodViewInput' + $ref: '#/components/schemas/ContentInfo' + example: | + + + eng-GB +
+ + + false + 69848aeb86164c35e5c98202eebe9e05 + required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - /payment-method/{identifier}: + /content/objects/{contentId}/currentversion: get: - operationId: ibexa.rest.payment_method.get_by_identifier + operationId: ibexa.rest.redirect_current_version tags: - - Payments + - Objects responses: 200: - description: OK - loads the payment method. + description: OK - returns the Version in XML or JSON format. content: - application/vnd.ibexa.api.PaymentMethod+json: + application/vnd.ibexa.api.Version+json: schema: - $ref: '#/components/schemas/PaymentMethodWrapper' + $ref: '#/components/schemas/VersionWrapper' 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: + 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: | + +
+ xhtml5edit: | + +
+ - id: 480 + fieldDefinitionIdentifier: description + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + +
+ xhtml5edit: | + +
+ 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/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. + $ref: '#/components/schemas/Version' + example: | + + + + 578 + 2 + PUBLISHED + 2023-05-24T05:59:09+00:00 + + 2023-05-24T05:59:02+00:00 + eng-GB + eng-GB + + + eng-GB + + + + Features + + + + + + 477 + name + eng-GB + ibexa_string + Features + + + 478 + short_name + eng-GB + ibexa_string + + + + 479 + short_description + eng-GB + ibexa_richtext + + <?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"/> + + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + + + + + 480 + description + eng-GB + ibexa_richtext + + <?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"/> + + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + + + + + + + /placeholder + + + image/svg+xml + + + 307: + description: Temporary redirect. 404: - description: Error - the payment methods does not exist. - summary: Delete payment method - description: Removes the PaymentMethodDeleteController resource. + description: Error - the resource does not exist. + summary: Get current version + description: Redirects to the current version of the 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: identifier + - name: contentId in: path - description: "" + description: ContentCurrentVersionRedirectController 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.rest.payment_method.update + post: + operationId: ibexa.rest.content.create_draft_from_current_version tags: - - Payments + - Objects responses: - 200: - description: OK + 201: + description: Created content: - application/vnd.ibexa.api.PaymentMethod+json: + application/vnd.ibexa.api.Version+json: schema: - $ref: '#/components/schemas/PaymentMethodWrapper' + $ref: '#/components/schemas/VersionWrapper' 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: + 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: | + +
+ xhtml5edit: | + +
+ - id: 480 + fieldDefinitionIdentifier: description + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + +
+ xhtml5edit: | + +
+ 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/PaymentMethod' - 400: - description: Error - the input does not match the input schema definition. + $ref: '#/components/schemas/Version' + example: | + + + + 581 + 5 + ARCHIVED + 2023-05-24T06:11:50+00:00 + + 2023-05-24T06:09:49+00:00 + eng-GB + eng-GB + + + eng-GB + + + + Features + + + + + + 477 + name + eng-GB + ibexa_string + Features + + + 478 + short_name + eng-GB + ibexa_string + + + + 479 + short_description + eng-GB + ibexa_richtext + + <?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"/> + + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + + + + + 480 + description + eng-GB + ibexa_richtext + + <?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"/> + + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + + + + + + + /placeholder + + + image/svg+xml + + 401: - description: Error - the user is not authorized to update Payment Method. + 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 payment methods does not exist. - summary: Update payment method - description: Updates the PaymentMethodUpdateController resource. + 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. - required: true - deprecated: false - allowEmptyValue: false - schema: - type: string - style: simple - explode: false - allowReserved: false - - name: identifier - 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 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: |- - - - - Bank transfer (updated) - - - 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 + - name: contentId in: path - description: "" + description: ContentDraftCreateFromCurrentVersionController 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 - 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: ~ - 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: | - -
- xhtml5edit: | - -
- - 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 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 + requestBody: + description: No payload required + content: [] required: false - deprecated: false - /product/catalog/products/view: + /content/objects/{contentId}/hide: post: - operationId: ibexa.product_catalog.rest.products.view + operationId: ibexa.rest.hide_content tags: - - Product + - 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 + schema: + type: string + style: simple + explode: false + - name: contentId + in: path + description: ContentHideController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + requestBody: + description: No payload required + content: [] + required: false + /content/objects/{contentId}/locations: + get: + operationId: ibexa.rest.load_locations_for_content + tags: + - Objects responses: 200: - description: The view in XML or JSON format. + description: If set, the Location list is returned in XML or JSON format. content: - application/vnd.ibexa.api.ProductView+json: + application/vnd.ibexa.api.LocationList+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: ~ - - _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: | - -
- xhtml5edit: | - -
- - 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: | - -
- xhtml5edit: | - -
- - 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: + $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/ProductView' + $ref: '#/components/schemas/LocationList' + example: | + + + + + 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 + schema: + type: string + style: simple + explode: false + - name: contentId + in: path + description: LocationForContentListController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: 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: | + + + 96 + 0 + false + true + false + + /1/2/42/96/ + 3 + 0 + 58133c8c75230e5debe362a28b92d27a + + + PATH + ASC + + + + + Art3 + Art3 + + +
+ + + 2021-06-28T11:34:17+00:00 + 2021-06-28T11:34:17+00:00 + eng-GB + 1 + false + false + PUBLISHED + + + + 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. + 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 is required when passing user 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: contentId + in: path + description: LocationCreateController 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: The LocationCreate schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.ProductViewInput+json: + application/vnd.ibexa.api.LocationCreate+json: schema: - $ref: '#/components/schemas/ProductViewInputWrapper' + $ref: '#/components/schemas/LocationCreateWrapper' 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: + 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/ProductViewInput' + $ref: '#/components/schemas/LocationCreate' + example: | + + + + 0 + false + PATH + ASC + required: false - deprecated: false - /product/catalog/products/{code}: + /content/objects/{contentId}/objectstates: get: - operationId: ibexa.product_catalog.rest.product + operationId: ibexa.rest.get_object_states_for_content tags: - - Product + - Objects responses: 200: - description: If set, the products are returned in XML or JSON format. + description: OK - returns the Object state. content: - application/vnd.ibexa.api.Product+json: + application/vnd.ibexa.api.ContentObjectStates+json: schema: - $ref: '#/components/schemas/ProductWrapper' + $ref: '#/components/schemas/ContentObjectStates' 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: | - -
- xhtml5edit: | - -
- - 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: [] + 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: | + + + + + + + + 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 + schema: + type: string + style: simple + explode: false + - name: contentId + in: path + description: ObjectStatesForContentListController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: 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: | + + + + + 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 + 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: contentId + in: path + description: ObjectStatesForContentUpdateController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: 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: | + + + + + 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 view this product. + description: Error - the user is not authorized to read this content item. 404: - description: Error - no product with the given code exists. - summary: Load the given product - description: Loads the given product. + 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: code + - name: contentId in: path - description: "" + description: ContentCurrentVersionRelationsRedirectController identifier 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 + /content/objects/{contentId}/reveal: + post: + operationId: ibexa.rest.reveal_content tags: - - Product + - Objects 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: | - -
- xhtml5edit: | - -
- - 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. + 204: + description: OK - Object item is revealed. 401: - description: Error - the user is not authorized to update this product. - 403: - description: Error - a product with the same code already exists. + description: Error - The user has no permission to change Object item visibility. 404: - description: Error - no product with the given code exists. - summary: Update product - description: Updates product. + description: Error - The content item was not found. + summary: Reveal content item + description: Makes or keep the content item visible parameters: - - name: code - 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: contentId + in: path + description: ContentRevealController identifier 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 + description: No payload required + content: [] required: false - deprecated: false - /product/catalog/products/{code}/prices: - get: - operationId: ibexa.product_catalog.rest.prices.list + /content/objects/{contentId}/translations/{languageCode}: + delete: + operationId: ibexa.rest.delete_content_translation tags: - - Product + - Objects 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 + 204: + description: No Content 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 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: 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: contentId in: path - description: "" + description: ContentTranslationDeleteController 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 + - name: languageCode + in: path + description: ContentTranslationDeleteController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + /content/objects/{contentId}/versions: + get: + operationId: ibexa.rest.load_content_versions tags: - - Product + - Objects responses: 200: - description: OK - creates product price. + description: If set, the version list is returned in XML or JSON format. content: - application/vnd.ibexa.api.CustomPrice+json: + application/vnd.ibexa.api.VersionList+json: schema: - $ref: '#/components/schemas/CustomPriceWrapper' + $ref: '#/components/schemas/VersionListWrapper' 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: + 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/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. + $ref: '#/components/schemas/VersionList' + example: | + + + + + + 521 + 1 + PUBLISHED + 2021-06-28T11:33:49+00:00 + + 2021-06-28T11:33:31+00:00 + eng-GB + eng-GB + + + eng-GB + + + + Art1 + + + + + + + + 580 + 2 + DRAFT + 2021-07-26T08:10:02+00:00 + + 2021-07-26T08:10:02+00:00 + eng-GB + eng-GB + + + eng-GB + + + + Art1 + + + + + + + + 581 + 3 + DRAFT + 2021-07-26T08:16:50+00:00 + + 2021-07-26T08:16:50+00:00 + eng-GB + eng-GB + + + eng-GB + + + + Art1 + + + + + 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 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: code + - name: contentId 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: ContentVersionsListController identifier 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}: + /content/objects/{contentId}/versions/{versionNo}: get: - operationId: ibexa.product_catalog.rest.prices.get.base_price + operationId: ibexa.rest.load_content_in_version tags: - - Product + - Objects responses: 200: - description: OK - gets price in given currency. + description: If set, the version list is returned in XML or JSON format. content: - application/vnd.ibexa.api.Price+json: + application/vnd.ibexa.api.Version+json: schema: - $ref: '#/components/schemas/PriceWrapper' + $ref: '#/components/schemas/VersionWrapper' 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: + 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: | + +
+ xhtml5edit: | + +
+ - id: 480 + fieldDefinitionIdentifier: description + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + +
+ xhtml5edit: | + +
+ 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/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" + $ref: '#/components/schemas/Version' + example: | + + + + 581 + 5 + ARCHIVED + 2023-05-24T06:11:50+00:00 + + 2023-05-24T06:09:49+00:00 + eng-GB + eng-GB + + + eng-GB + + + + Features + + + + + + 477 + name + eng-GB + ibexa_string + Features + + + 478 + short_name + eng-GB + ibexa_string + + + + 479 + short_description + eng-GB + ibexa_richtext + + <?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"/> + + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + + + + + 480 + description + eng-GB + ibexa_richtext + + <?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"/> + + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + + + + + + + /placeholder + + + image/svg+xml + + + 304: + description: Not Modified - the ETag matches the current one. 401: - description: Error - the user has no permission to read prices. + description: Error - the user is not authorized to read this content item. 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 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: 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 + - 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 - 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 + - name: contentId in: path - description: "" + description: ContentInVersionLoadController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: id + - name: versionNo 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: ContentInVersionLoadController identifier 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 + post: + operationId: ibexa.rest.content.create_draft_from_version tags: - - Product + - Objects responses: - 200: - description: OK - updates product price. + 201: + description: Created. content: - application/vnd.ibexa.api.CustomPrice+json: + application/vnd.ibexa.api.Version+json: schema: - $ref: '#/components/schemas/CustomPriceWrapper' + $ref: '#/components/schemas/VersionWrapper' 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: + 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: | + +
+ xhtml5edit: | + +
+ - id: 480 + fieldDefinitionIdentifier: description + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + +
+ xhtml5edit: | + +
+ 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/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. + $ref: '#/components/schemas/Version' + example: | + + + + 581 + 5 + ARCHIVED + 2023-05-24T06:11:50+00:00 + + 2023-05-24T06:09:49+00:00 + eng-GB + eng-GB + + + eng-GB + + + + Features + + + + + + 477 + name + eng-GB + ibexa_string + Features + + + 478 + short_name + eng-GB + ibexa_string + + + + 479 + short_description + eng-GB + ibexa_richtext + + <?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"/> + + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + + + + + 480 + description + eng-GB + ibexa_richtext + + <?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"/> + + <?xml version="1.0" encoding="UTF-8"?> + <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> + + + + + + + /placeholder + + + image/svg+xml + + 401: - description: Error - the user is not authorized to update this price. - summary: Update product price - description: Updates product price. + 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: code - 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: id + - name: contentId in: path - description: "" + description: ContentDraftCreateFromVersionController 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: versionNo + in: path + description: ContentDraftCreateFromVersionController identifier 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 + description: No payload required + content: [] required: false - deprecated: false - /product/catalog/products/{identifier}: delete: - operationId: ibexa.product_catalog.rest.products.delete + operationId: ibexa.rest.delete_content_version tags: - - Product + - Objects responses: 204: - description: No content - the given product is deleted. + 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 product. - summary: Delete product - description: Deletes the given product. + 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: 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: contentId in: path - description: "" + description: ContentVersionDeleteController 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: versionNo + in: path + description: ContentVersionDeleteController 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 + patch: + operationId: ibexa.rest.update_version tags: - - Product + - Objects responses: - 201: - description: If set, the new product is returned in XML or JSON format. + 200: + description: If set, the updated version is returned in XML or JSON format. content: - application/vnd.ibexa.api.ProductCreate+json: + application/vnd.ibexa.api.Version+json: schema: - $ref: '#/components/schemas/ProductWrapper' + $ref: '#/components/schemas/VersionWrapper' 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: | - -
- xhtml5edit: | - -
- - 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: + 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 - 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 + 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: | + +
+ xhtml5edit: | + +
+ - id: 480 + fieldDefinitionIdentifier: description + languageCode: eng-GB + fieldTypeIdentifier: ibexa_richtext + fieldValue: + xml: | + +
+ xhtml5edit: | + +
+ 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: /bundles/ibexaadminui/img/ibexa-icons.svg#file + resource: /placeholder width: ~ height: ~ mimeType: image/svg+xml - created_at: 1645787815 - updated_at: 1645787815 - AttributesList: [] + application/vnd.ibexa.api.Version+xml: + schema: + $ref: '#/components/schemas/Version' + example: | + + + + 45 + 4 + DRAFT + 2012-02-20T12:00:00 + + 22012-02-20T12:00:00 + ger-DE + + Neuer Titel + + + + + + 1234 + title + ger-DE + Neuer Titel + + + 1235 + summary + ger-DE + Dies ist eine neuse Zusammenfassungy + + + authors + ger-DE + + + + + + + + + + + + COMMON + + + 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 update this version. 403: - description: Error - a product with the same name already exists. + description: Error - the version is not allowed to change - i.e. version + is not a DRAFT. 404: - description: Error - no product with the given code exists. - summary: Create product - description: Creates a new product. + 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: 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. + 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 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 + - name: If-match in: header - description: The CSRF token is required when passing user session. + 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 - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: The attribute schema encoded in XML or JSON format. + description: The VersionUpdate schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.AttributeCreate+json: + application/vnd.ibexa.api.VersionUpdate+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 + $ref: '#/components/schemas/VersionUpdateWrapper' + application/vnd.ibexa.api.VersionUpdate+xml: + schema: + $ref: '#/components/schemas/VersionUpdate' + example: | + + + 2012-02-20T12:00:00 + ger-DE + + + 1234 + title + ger-DE + Neuer Titel + + + 1235 + summary + ger-DE + Dies ist eine neuse Zusammenfassungy + + + required: false - deprecated: false - /product/catalog/attributes/translation/{id}/{languageCode}: - delete: - operationId: ibexa.product_catalog.rest.attributes.translation.delete + /content/objects/{contentId}/versions/{versionNo}/relations: + get: + operationId: ibexa.rest.load_version_relations tags: - - Product Attribute + - Objects responses: 200: - description: No Content. + 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: | + + + + + + LINK + + 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. + 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: id + - name: contentId in: path - description: "" + description: ContentVersionsRelationsListController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: languageCode + - name: versionNo 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: ContentVersionsRelationsListController identifier 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 + operationId: ibexa.rest.create_relation tags: - - Product Attribute + - Objects responses: - 200: - description: The view in XML or JSON format. + 201: + description: If set, the updated version is returned in XML or JSON format. content: - application/vnd.ibexa.api.AttributeView+json: + application/vnd.ibexa.api.Relation+json: schema: - $ref: '#/components/schemas/AttributeViewWrapper' + $ref: '#/components/schemas/RelationWrapper' 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: + 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/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. + $ref: '#/components/schemas/Relation' + example: | + + + + + COMMON + + 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 is required when passing user 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: contentId + in: path + description: ContentRelationCreateController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: versionNo + in: path + description: ContentRelationCreateController 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: The RelationCreate schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.AttributeViewInput+json: + application/vnd.ibexa.api.RelationCreate+json: schema: - $ref: '#/components/schemas/AttributeViewInputWrapper' + $ref: '#/components/schemas/RelationCreateWrapper' example: - ViewInput: - identifier: TitleView - AttributeQuery: - limit: "10" - offset: "0" - Query: - AttributeNameCriterion: measure - AttributeGroupIdentifierCriterion: test_attribute_group - application/vnd.ibexa.api.AttributeViewInput+xml: + RelationCreate: + Destination: + _href: /api/ibexa/v2/content/objects/59 + application/vnd.ibexa.api.RelationCreate+xml: schema: - $ref: '#/components/schemas/AttributeViewInput' + $ref: '#/components/schemas/RelationCreate' + example: | + + + + required: false - deprecated: false - /product/catalog/attributes/{id}: + /content/objects/{contentId}/versions/{versionNo}/relations/{relationId}: get: - operationId: ibexa.product_catalog.rest.attributes.get + operationId: ibexa.rest.load_version_relation tags: - - Product Attribute + - Objects responses: 200: - description: Attribute - If set, the given attribute is returned in XML - or JSON format. + description: OK - loads a Relation for the given content item. content: - application/vnd.ibexa.api.Attribute+json: + application/vnd.ibexa.api.Relation+json: schema: - $ref: '#/components/schemas/AttributeWrapper' + $ref: '#/components/schemas/RelationWrapper' 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: + 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/Attribute' + $ref: '#/components/schemas/Relation' + example: | + + + + + COMMON + 401: - description: Error - the user has no permission to read the attribute. - summary: Load attribute - description: Loads given attribute. + 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: id + - name: contentId in: path - description: "" + description: ContentVersionRelationLoadByIdController identifier 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 + - name: versionNo in: path - description: "" + description: ContentVersionRelationLoadByIdController 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: relationId + in: path + description: ContentVersionRelationLoadByIdController identifier 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 + delete: + operationId: ibexa.rest.remove_relation tags: - - Product Attribute + - Objects 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. + 204: + description: No Content - deleted a Relation of the given draft. 401: - description: Error - the user is not authorized to create this attribute. + description: Error - the user is not authorized to delete this Relation. 403: - description: Error - an attribute with the same name already exists. + description: Error - the Relation is not of type COMMON or the given version + is not a draft. 404: - description: Error - the attribute with the given ID does not exist. - summary: Update attribute - description: Updates an attribute. + 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: 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: contentId in: path - description: "" + description: ContentVersionRelationDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: group_id + - name: versionNo in: path - description: "" + description: ContentVersionRelationDeleteController 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: relationId + in: path + description: ContentVersionRelationDeleteController identifier 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 + /content/objects/{contentId}/versions/{versionNo}/translations/{languageCode}: + delete: + operationId: ibexa.rest.delete_translation_from_draft tags: - - Product Attribute Group + - Objects 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. + 204: + description: No Content - removes a translation from a version draft. 401: - description: Error - the user is not authorized to create this attribute - group. + description: Error - the user is not authorized to delete this translation. 403: - description: Error - an attribute group with the same identifier already - exists. - summary: Create attribute group - description: Creates a new attribute group. + 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 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 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 + - name: contentId + in: path + description: ContentDraftTranslationDeleteController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: versionNo in: path - description: "" + description: ContentDraftTranslationDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: languageCode in: path - description: "" + description: ContentDraftTranslationDeleteController 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 + /page/structure: + get: + operationId: ibexa.page_builder.rest.page_structure + tags: + - Page + responses: + 200: + description: The Page structure is returned in XML or JSON format. + content: + application/vnd.ibexa.api.PageStructure+json: + schema: + $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 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: 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: 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 - deprecated: false - /product/catalog/attribute_groups/view: + example: landing_page + /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: ~ + 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: | + +
+ xhtml5edit: | + +
+ - 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 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 + /product/catalog/products/view: post: - operationId: ibexa.product_catalog.rest.attribute_groups.view + operationId: ibexa.product_catalog.rest.products.view tags: - - Product Attribute Group + - Product responses: 200: description: The view in XML or JSON format. content: - application/vnd.ibexa.api.AttributeGroupView+json: + application/vnd.ibexa.api.ProductView+json: schema: - $ref: '#/components/schemas/AttributeGroupViewWrapper' + $ref: '#/components/schemas/ProductViewWrapper' example: - AttributeGroupView: - _media-type: application/vnd.ibexa.api.AttributeGroupView+json + ProductView: + _media-type: application/vnd.ibexa.api.ProductView+json identifier: TitleView - AttributeGroupQuery: - _media-type: application/vnd.ibexa.api.AttributeGroupQuery+json + ProductQuery: + _media-type: application/vnd.ibexa.api.ProductQuery+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: + 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: | + +
+ xhtml5edit: | + +
+ - 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: | + +
+ xhtml5edit: | + +
+ - 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/AttributeGroupView' + $ref: '#/components/schemas/ProductView' 400: description: Error - the input does not match the input schema definition. - summary: Filter attribute groups + 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: @@ -18253,1482 +13216,1289 @@ 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.AttributeGroupViewInput+json: + application/vnd.ibexa.api.ProductViewInput+json: schema: - $ref: '#/components/schemas/AttributeGroupViewInputWrapper' + $ref: '#/components/schemas/ProductViewInputWrapper' example: ViewInput: identifier: TitleView - AttributeGroupQuery: + ProductQuery: 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: + 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/AttributeGroupUpdate' + $ref: '#/components/schemas/ProductViewInput' 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}: + /product/catalog/products/{code}: get: - operationId: ibexa.product_catalog.rest.attribute_type + operationId: ibexa.product_catalog.rest.product tags: - - Product Attribute Type + - Product 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. + description: If set, the products are returned in XML or JSON format. content: - application/vnd.ibexa.api.CatalogCreate+json: + application/vnd.ibexa.api.Product+json: schema: - $ref: '#/components/schemas/CatalogWrapper' + $ref: '#/components/schemas/ProductWrapper' 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. + 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: | + +
+ xhtml5edit: | + +
+ - 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: [] 401: - description: Error - the user is not authorized to update this catalog. - 403: - description: Error - a catalog with the same name already exists. + description: Error - the user is not authorized to view this product. 404: - description: Error - no catalog with the given code exists. - summary: Create catalog - description: Creates a new catalog. + 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 is required when passing user session. + - name: code + in: path + description: ProductLoadByCodeController 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. + description: An optional product schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.CatalogCreate+json: + application/vnd.ibexa.api.ProductGet+json: schema: - $ref: '#/components/schemas/CatalogCreateWrapper' + $ref: '#/components/schemas/ProductGetWrapper' 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 + ProductGet: + languages: + - eng-GB required: false - deprecated: false - /product/catalog/catalogs/copy/{identifier}: - post: - operationId: ibexa.product_catalog.rest.catalogs.copy + patch: + operationId: ibexa.product_catalog.rest.products.update tags: - - Product Catalog + - Product responses: 201: - description: If set, the copied catalog 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.Catalog+json: + application/vnd.ibexa.api.Product+json: schema: - $ref: '#/components/schemas/CatalogWrapper' + $ref: '#/components/schemas/ProductWrapper' 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: '>=' + 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: | + +
+ xhtml5edit: | + +
+ - 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 copy this catalog. + description: Error - the user is not authorized to update this product. 403: - description: Error - a catalog with the same identifier already exists. + description: Error - a product 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 with the given code exists. + summary: Update product + description: Updates product. parameters: - - name: identifier + - name: code in: path - description: "" + description: ProductUpdateController 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: If set, the updated product is returned in XML or JSON format. content: - application/vnd.ibexa.api.CatalogCopy+json: + application/vnd.ibexa.api.ProductUpdate+json: schema: - $ref: '#/components/schemas/CatalogCopyWrapper' + $ref: '#/components/schemas/ProductUpdateWrapper' example: - CatalogCopy: - identifier: test_catalog_copied - creator_id: 14 + 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/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: + /product/catalog/products/{code}/prices: get: - operationId: ibexa.product_catalog.rest.catalog.sort_clauses + operationId: ibexa.product_catalog.rest.prices.list tags: - - Product Catalog + - Product responses: 200: - description: If set, the clauses are returned in XML or JSON format. + description: OK - loads the list of product prices. content: - application/vnd.ibexa.api.ProductSortClauseList+json: + application/vnd.ibexa.api.PriceList+json: schema: - $ref: '#/components/schemas/ProductSortClauseListWrapper' + $ref: '#/components/schemas/PriceListWrapper' 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: + 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: PriceLoadAllController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false post: - operationId: ibexa.product_catalog.rest.catalogs.view + operationId: ibexa.product_catalog.rest.prices.create tags: - - Product Catalog + - Product 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: + description: OK - creates product price. + content: + application/vnd.ibexa.api.CustomPrice+json: schema: - $ref: '#/components/schemas/CatalogView' + $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. - 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. + 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: PriceCreateController 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. + description: The product price schema encoded in JSON format. content: - application/vnd.ibexa.api.CatalogViewInput+json: + application/vnd.ibexa.api.CustomPriceCreateStruct+json: schema: - $ref: '#/components/schemas/CatalogViewInputWrapper' + $ref: '#/components/schemas/CustomPriceCreateStructWrapper' example: - ViewInput: - identifier: TitleView - CatalogQuery: - Query: - CatalogIdentifierCriterion: test - CatalogNameCriterion: test - application/vnd.ibexa.api.CatalogViewInput+xml: + CustomPriceCreateStruct: + customerGroup: test + amount: 2500 + customAmount: 1500 + currency: EUR + application/vnd.ibexa.api.PriceCreateStruct+json: schema: - $ref: '#/components/schemas/CatalogViewInput' + $ref: '#/components/schemas/PriceCreateStructWrapper' + example: + PriceCreateStruct: + amount: 9 + currency: CHF required: false - deprecated: false - /product/catalog/catalogs/{identifier}: + /product/catalog/products/{code}/prices/{currencyCode}: get: - operationId: ibexa.product_catalog.rest.catalogs.get + operationId: ibexa.product_catalog.rest.prices.get.base_price tags: - - Product Catalog + - Product responses: 200: - description: If set, the catalog is returned in XML or JSON format. + description: OK - gets price in given currency. content: - application/vnd.ibexa.api.Catalog+json: + application/vnd.ibexa.api.Price+json: schema: - $ref: '#/components/schemas/CatalogWrapper' + $ref: '#/components/schemas/PriceWrapper' 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' + 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 is not authorized to view this catalog. + description: Error - the user has no permission to read prices. 404: - description: Error - no catalog with the given identifier exists. - summary: Load catalog - description: Loads the given catalog. + description: Error - the price does not exist. + summary: Get price in given currency + description: Get price in given currency. parameters: - - name: identifier + - name: code in: path - description: "" + description: PriceLoadByProductCodeController 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 + - name: currencyCode + in: path + description: PriceLoadByProductCodeController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + /product/catalog/products/{code}/prices/{currencyCode}/customer-group/{customerGroupIdentifier}: + get: + operationId: ibexa.product_catalog.rest.prices.get.custom_price tags: - - Product Catalog + - Product responses: - 204: - description: No content - the given catalog is deleted. + 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 this catalog. - summary: Delete catalog - description: Deletes the given catalog. + 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: identifier + - name: code in: path - description: "" + description: PriceLoadByProductCodeController 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: currencyCode + in: path + description: PriceLoadByProductCodeController 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 + - name: customerGroupIdentifier + in: path + description: PriceLoadByProductCodeController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + /product/catalog/products/{code}/prices/{id}: + delete: + operationId: ibexa.product_catalog.rest.prices.delete tags: - - Product Catalog + - Product 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. + 200: + description: No content - the given price is deleted. 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. + description: Error - the user is not authorized to delete this price. + summary: Delete product price + description: Deletes product price. parameters: - - name: identifier + - name: code in: path - description: "" + 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 - 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 + patch: + operationId: ibexa.product_catalog.rest.prices.update tags: - - Product Catalog + - Product responses: 200: - description: The view in XML or JSON format. + description: OK - updates product price. content: - application/vnd.ibexa.api.ProductView+json: + application/vnd.ibexa.api.CustomPrice+json: schema: - $ref: '#/components/schemas/ProductViewWrapper' + $ref: '#/components/schemas/CustomPriceWrapper' 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: | - -
- xhtml5edit: | - -
- - 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: + 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/ProductView' + $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. - 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. + 401: + description: Error - the user is not authorized to update this price. + summary: Update product price + description: Updates product price. parameters: - - name: identifier + - name: code in: path - description: "" + description: PriceUpdateController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: id + in: path + description: PriceUpdateController 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 view input in XML or JSON format. + description: Update price or custom price for given currency. content: - application/vnd.ibexa.api.ProductViewInput+json: + application/vnd.ibexa.api.CustomPriceUpdateStruct+json: schema: - $ref: '#/components/schemas/ProductViewInputWrapper' + $ref: '#/components/schemas/CustomPriceUpdateStructWrapper' example: - ViewInput: - identifier: TitleView - ProductQuery: - Query: - ProductCodeCriterion: test - ProductAvailabilityCriterion: true - application/vnd.ibexa.api.ProductViewInput+xml: + CustomPriceUpdateStruct: + amount: 2500 + customAmount: 1700 + currency: USD + application/vnd.ibexa.api.PriceUpdateStruct+json: schema: - $ref: '#/components/schemas/ProductViewInput' + $ref: '#/components/schemas/PriceUpdateStructWrapper' + example: + PriceUpdateStruct: + amount: 3500 + currency: USD 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 + /product/catalog/products/{identifier}: + delete: + operationId: ibexa.product_catalog.rest.products.delete tags: - - Product Currency + - Product 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. + 204: + description: No content - the given product is deleted. 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 delete this product. + summary: Delete product + description: Deletes the given product. parameters: + - name: identifier + in: path + description: ProductDeleteController 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 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: + /product/catalog/products/{productTypeIdentifier}: post: - operationId: ibexa.product_catalog.rest.currencies.view + operationId: ibexa.product_catalog.rest.products.create tags: - - Product Currency + - Product responses: - 200: - description: The view in XML or JSON format. + 201: + description: If set, the new product is returned in XML or JSON format. content: - application/vnd.ibexa.api.CurrencyView+json: + application/vnd.ibexa.api.ProductCreate+json: schema: - $ref: '#/components/schemas/CurrencyViewWrapper' + $ref: '#/components/schemas/ProductWrapper' 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' + 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: | + +
+ xhtml5edit: | + +
+ - 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: [] 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. + 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: ProductCreateController 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. + description: The product schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.CurrencyViewInput+json: + application/vnd.ibexa.api.ProductCreate+json: schema: - $ref: '#/components/schemas/CurrencyViewInputWrapper' + $ref: '#/components/schemas/ProductCreateWrapper' example: - ViewInput: - identifier: TitleView - CurrencyQuery: - limit: "10" - offset: "0" - application/vnd.ibexa.api.CurrencyViewInput+xml: - schema: - $ref: '#/components/schemas/CurrencyViewInput' + 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/currencies/{id}: + /product/catalog/attributes: get: - operationId: ibexa.product_catalog.rest.currencies.get + operationId: ibexa.product_catalog.rest.attributes tags: - - Product Currency + - Product Attribute responses: 200: - description: OK - loads the currency. + description: AttributeList - If set, the attributes list is returned in + XML or JSON format. content: - application/vnd.ibexa.api.Currency+json: + application/vnd.ibexa.api.AttributeList+json: schema: - $ref: '#/components/schemas/CurrencyWrapper' + $ref: '#/components/schemas/AttributeListWrapper' example: - Currency: - _media-type: application/vnd.ibexa.api.Currency+json - id: 3 - code: ALL - subunits: 2 - enabled: false + 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 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 + 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 Currency + - Product Attribute responses: - 200: - description: No content - the given currency is deleted. + 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 delete this currency. - summary: Delete currency - description: Deletes the given currency. + 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: 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 + 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 Currency + - Product Attribute 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. + description: No Content. 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. + 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 - - name: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. + - name: languageCode + in: path + description: AttributeTranslationDeleteController 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. - 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: + /product/catalog/attributes/view: post: - operationId: ibexa.product_catalog.rest.customer_groups.view + operationId: ibexa.product_catalog.rest.attributes.view tags: - - Product Customer Group + - Product Attribute responses: 200: description: The view in XML or JSON format. content: - application/vnd.ibexa.api.CustomerGroupView+json: + application/vnd.ibexa.api.AttributeView+json: schema: - $ref: '#/components/schemas/CustomerGroupViewWrapper' + $ref: '#/components/schemas/AttributeViewWrapper' example: - CustomerGroupView: - _media-type: application/vnd.ibexa.api.CustomerGroupView+json + AttributeView: + _media-type: application/vnd.ibexa.api.AttributeView+json identifier: TitleView - CustomerGroupQuery: - _media-type: application/vnd.ibexa.api.CustomerGroupQuery+json + AttributeQuery: + _media-type: application/vnd.ibexa.api.AttributeQuery+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: + 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/CustomerGroupView' + $ref: '#/components/schemas/AttributeView' 400: description: Error - the input does not match the input schema definition. - summary: Filter customer groups + 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: @@ -19737,274 +14507,353 @@ 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.CustomerGroupViewInput+json: + application/vnd.ibexa.api.AttributeViewInput+json: schema: - $ref: '#/components/schemas/CustomerGroupViewInputWrapper' + $ref: '#/components/schemas/AttributeViewInputWrapper' example: ViewInput: identifier: TitleView - CustomerGroupQuery: + AttributeQuery: limit: "10" offset: "0" - application/vnd.ibexa.api.CustomerGroupViewInput+xml: + Query: + AttributeNameCriterion: measure + AttributeGroupIdentifierCriterion: test_attribute_group + application/vnd.ibexa.api.AttributeViewInput+xml: schema: - $ref: '#/components/schemas/CustomerGroupViewInput' + $ref: '#/components/schemas/AttributeViewInput' required: false - deprecated: false - /product/catalog/customer_groups/{identifier}: + /product/catalog/attributes/{id}: get: - operationId: ibexa.product_catalog.rest.customer_groups.identifier + operationId: ibexa.product_catalog.rest.attributes.get tags: - - Product Customer Group + - Product Attribute responses: 200: - description: If set, the customer group is returned in XML or JSON format. + description: Attribute - If set, the given attribute is returned in XML + or JSON format. content: - application/vnd.ibexa.api.CustomerGroup+json: + application/vnd.ibexa.api.Attribute+json: schema: - $ref: '#/components/schemas/CustomerGroupWrapper' + $ref: '#/components/schemas/AttributeWrapper' example: - CustomerGroup: - _media-type: application/vnd.ibexa.api.CustomerGroup+json - id: 1 - name: Resellers - identifier: resellers + Attribute: + _media-type: application/vnd.ibexa.api.Attribute+json + identifier: attrib2 + name: Attrib2 description: "" - users: [] - global_price_rate: "0.00" + 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 customer groups. - summary: Load customer group - description: Returns a customer group + description: Error - the user has no permission to read the attribute. + summary: Load attribute + description: Loads given attribute. parameters: - - name: identifier + - name: id in: path - description: "" + description: AttributeLoadByIdentifierController 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 + operationId: ibexa.product_catalog.rest.attributes.delete tags: - - Product Customer Group + - Product Attribute responses: - 204: - description: No content - the given customer group is deleted. + 200: + description: No Content. 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 delete this attribute. + summary: Delete attribute + description: The given attribute is removed from the attribute group. parameters: - - name: identifier + - name: id in: path - description: "" + description: AttributeDeleteController 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.customer_group.update + operationId: ibexa.product_catalog.rest.attributes.update tags: - - Product Customer Group + - Product Attribute responses: 201: - description: If set, the updated customer group is returned in XML or JSON - format. + description: If set, the updated attribute is returned in XML or JSON format. content: - application/vnd.ibexa.api.CustomerGroup+json: + application/vnd.ibexa.api.Attribute+json: schema: - $ref: '#/components/schemas/CustomerGroupWrapper' + $ref: '#/components/schemas/AttributeWrapper' 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" + 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 update a customer group. - summary: Update customer group - description: Updates the given customer group. + 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: identifier + - name: id in: path - description: "" + description: AttributeUpdateController identifier + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + - name: group_id + in: path + description: AttributeUpdateController 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 CustomerGroupUpdate 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.CustomerGroupUpdate+json: + application/vnd.ibexa.api.AttributeUpdate+json: schema: - $ref: '#/components/schemas/CustomerGroupUpdateWrapper' + $ref: '#/components/schemas/AttributeUpdateWrapper' example: - CustomerGroupUpdate: - identifier: customer_group + AttributeUpdate: + identifier: attr_group names: - eng-GB: Customer Group - global_price_rate: "1" + eng-GB: Attribute Group + descriptions: + eng-GB: description + position: 0 + options: + foo: bar required: false - deprecated: false - /product/catalog/customer_groups/{id}: + /product/catalog/attribute_groups: get: - operationId: ibexa.product_catalog.rest.customer_group + operationId: ibexa.product_catalog.rest.attribute_groups tags: - - Product Customer Group + - Product Attribute Group responses: 200: - description: If set, the customer group is returned in XML or JSON format. + description: AttributeGroupList - If set, the attribute group list is returned + in XML or JSON format. content: - application/vnd.ibexa.api.CustomerGroup+json: + application/vnd.ibexa.api.AttributeGroupList+json: schema: - $ref: '#/components/schemas/CustomerGroupWrapper' + $ref: '#/components/schemas/AttributeGroupListWrapper' 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" + 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 customer groups. - summary: Load customer group - description: Returns a customer group + 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 + 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: 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: integer + type: string style: simple explode: false - allowReserved: false - deprecated: false - /product/catalog/regions: - get: - operationId: ibexa.product_catalog.rest.regions + 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 + /product/catalog/attribute_groups/translation/{id}/{languageCode}: + delete: + operationId: ibexa.product_catalog.rest.attribute_groups.translation.delete tags: - - Product Region + - Product Attribute Group 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' + description: No content - the given attribute group translation is deleted. 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: + 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 is required when passing user session. + required: true + deprecated: false + schema: + type: string + style: simple + explode: false + /product/catalog/attribute_groups/view: post: - operationId: ibexa.product_catalog.rest.regions.view + operationId: ibexa.product_catalog.rest.attribute_groups.view tags: - - Product Region + - Product Attribute Group responses: 200: description: The view in XML or JSON format. content: - application/vnd.ibexa.api.RegionView+json: + application/vnd.ibexa.api.AttributeGroupView+json: schema: - $ref: '#/components/schemas/RegionViewWrapper' + $ref: '#/components/schemas/AttributeGroupViewWrapper' example: - RegionView: - _media-type: application/vnd.ibexa.api.RegionView+json + AttributeGroupView: + _media-type: application/vnd.ibexa.api.AttributeGroupView+json identifier: TitleView - RegionQuery: - _media-type: application/vnd.ibexa.api.RegionQuery+json + AttributeGroupQuery: + _media-type: application/vnd.ibexa.api.AttributeGroupQuery+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: + 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/RegionView' + $ref: '#/components/schemas/AttributeGroupView' 400: description: Error - the input does not match the input schema definition. - summary: Filter regions + 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: @@ -20013,4257 +14862,3792 @@ 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.RegionViewInput+json: + application/vnd.ibexa.api.AttributeGroupViewInput+json: schema: - $ref: '#/components/schemas/RegionViewInputWrapper' + $ref: '#/components/schemas/AttributeGroupViewInputWrapper' example: ViewInput: identifier: TitleView - RegionQuery: + AttributeGroupQuery: limit: "10" offset: "0" - application/vnd.ibexa.api.RegionViewInput+xml: + name_prefix: test + application/vnd.ibexa.api.AttributeGroupViewInput+xml: schema: - $ref: '#/components/schemas/RegionViewInput' + $ref: '#/components/schemas/AttributeGroupViewInput' required: false - deprecated: false - /product/catalog/regions/{identifier}: + /product/catalog/attribute_groups/{id}: get: - operationId: ibexa.product_catalog.rest.region + operationId: ibexa.product_catalog.rest.attribute_groups.get tags: - - Product Region + - Product Attribute Group responses: 200: - description: OK - loads region. + description: AttributeGroupGet - If set, the attribute group List is returned + in XML or JSON format. content: - application/vnd.ibexa.api.Region+json: + application/vnd.ibexa.api.AttributeGroup+json: schema: - $ref: '#/components/schemas/RegionWrapper' - application/vnd.ibexa.api.Region+xml: + $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/Region' - 404: - description: Error - the region does not exist. - summary: Load region - description: Loads a region by its identifier + $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: 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 - /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. + description: An optional AttributeGroupGet schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.ProductTypeListGet+json: + application/vnd.ibexa.api.AttributeGroupGet+json: schema: - $ref: '#/components/schemas/ProductTypeListGetWrapper' + $ref: '#/components/schemas/AttributeGroupGetWrapper' example: - ProductTypeListGet: - name_prefix: s - offset: 0 - limit: 10 - application/vnd.ibexa.api.ProductTypeListGet+xml: + AttributeGroupGet: + languages: + - eng-GB + application/vnd.ibexa.api.AttributeGroupGet+xml: schema: - $ref: '#/components/schemas/ProductTypeListGet' + $ref: '#/components/schemas/AttributeGroupGet' required: false - deprecated: false - post: - operationId: ibexa.product_catalog.rest.product_types.create + delete: + operationId: ibexa.product_catalog.rest.attribute_groups.delete tags: - - Product Type + - 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: AttributeGroupDeleteController 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.attribute_groups.update + tags: + - Product Attribute Group responses: 201: - description: If set, the new product type is returned in XML or JSON format. + description: If set, the updated attribute group is returned in XML or JSON + format. content: - application/vnd.ibexa.api.ProductType+json: + application/vnd.ibexa.api.AttributeGroup+json: schema: - $ref: '#/components/schemas/ProductTypeWrapper' + $ref: '#/components/schemas/AttributeGroupWrapper' 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: [] + 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 product type. + description: Error - the user is not authorized to create this attribute + group. 403: - description: Error - a product type with the same name already exists. + description: Error - an attribute group with the same identifier 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. + 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: AttributeGroupUpdateController 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 ProductType schema encoded in XML or JSON format. + description: The attribute group update schema is sent in XML or JSON format. content: - application/vnd.ibexa.api.ProductTypeCreate+json: + application/vnd.ibexa.api.AttributeGroupUpdate+json: schema: - $ref: '#/components/schemas/ProductTypeCreateWrapper' + $ref: '#/components/schemas/AttributeGroupUpdateWrapper' 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: - 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 + 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/product_types/is_used/{identifier}: + /product/catalog/attribute_types: get: - operationId: ibexa.product_catalog.rest.product_types.is_used + operationId: ibexa.product_catalog.rest.attribute_types tags: - - Product Type + - Product Attribute Type responses: 200: - description: OK - product type usage is returned. + description: OK - returns a list of Attribute Types content: - application/vnd.ibexa.api.ProductTypeUsage+json: + application/vnd.ibexa.api.AttributeTypeList+json: schema: - $ref: '#/components/schemas/ProductTypeUsageWrapper' - application/vnd.ibexa.api.ProductTypeUsage+xml: + $ref: '#/components/schemas/AttributeTypeListWrapper' + application/vnd.ibexa.api.AttributeTypeList+xml: schema: - $ref: '#/components/schemas/ProductTypeUsage' - example: | - - - 1 - - 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 + $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 Type + - Product Attribute Type responses: 200: - description: The view in XML or JSON format. + description: OK - returns the Attribute Type content: - application/vnd.ibexa.api.ProductTypeView+json: + application/vnd.ibexa.api.AttributeType+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: + $ref: '#/components/schemas/AttributeTypeWrapper' + application/vnd.ibexa.api.AttributeType+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. + $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: X-CSRF-Token - in: header - description: The CSRF token is required when passing user session. + - name: identifier + in: path + description: AttributeTypeLoadByIdentifierController 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.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 + /product/catalog/catalogs: + post: + operationId: ibexa.product_catalog.rest.catalogs.create tags: - - Product Type + - Product Catalog responses: - 200: - description: OK - load the product type + 201: + description: If set, the new catalog is returned in XML or JSON format. content: - application/vnd.ibexa.api.ProductType+json: + application/vnd.ibexa.api.CatalogCreate+json: schema: - $ref: '#/components/schemas/ProductTypeWrapper' + $ref: '#/components/schemas/CatalogWrapper' 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' + 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 type. + 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 - 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. + description: Error - no catalog with the given code exists. + summary: Create catalog + description: Creates a new catalog. 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 + 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 + /product/catalog/catalogs/copy/{identifier}: + post: + operationId: ibexa.product_catalog.rest.catalogs.copy tags: - - Product Type + - Product Catalog responses: 201: - description: If set, the updated product type is returned in XML or JSON - format. + description: If set, the copied catalog is returned in XML or JSON format. content: - application/vnd.ibexa.api.ProductType+json: + application/vnd.ibexa.api.Catalog+json: schema: - $ref: '#/components/schemas/ProductTypeWrapper' + $ref: '#/components/schemas/CatalogWrapper' 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: [] + 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 create this product type. + 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 - the product type with the given ID does not exist. - summary: Update product type - description: Updates product type. + description: Error - no catalog with the given identifier exists. + summary: Copy catalog + description: Copies a catalog. parameters: - - name: id + - name: identifier in: path - description: "" + description: CatalogCopyController 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. + description: If set, the copied catalog is returned in XML or JSON format. content: - application/vnd.ibexa.api.ProductTypeUpdate+json: + application/vnd.ibexa.api.CatalogCopy+json: schema: - $ref: '#/components/schemas/ProductTypeUpdateWrapper' + $ref: '#/components/schemas/CatalogCopyWrapper' 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 + CatalogCopy: + identifier: test_catalog_copied + creator_id: 14 required: false - deprecated: false - /product/catalog/product_variant/{code}: + /product/catalog/catalogs/filters: get: - operationId: ibexa.product_catalog.rest.product_variant + operationId: ibexa.product_catalog.rest.catalog.filters tags: - - Product Variant + - Product Catalog responses: 200: - description: OK - loads the product variant. + description: If set, the filters are returned in XML or JSON format. content: - application/vnd.ibexa.api.ProductVariant+json: + application/vnd.ibexa.api.ProductFilterList+json: schema: - $ref: '#/components/schemas/ProductVariantWrapper' + $ref: '#/components/schemas/ProductFilterListWrapper' 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: | - -
test
- xhtml5edit: | - -

test

- - 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}: + 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.product_variants.generate + operationId: ibexa.product_catalog.rest.catalogs.view tags: - - Product Variant + - Product Catalog responses: - 201: - description: No content - product variants are generated. + 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. - 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. + 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: 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. + description: The view input in XML or JSON format. content: - application/vnd.ibexa.api.ProductVariantGenerate+json: + application/vnd.ibexa.api.CatalogViewInput+json: schema: - $ref: '#/components/schemas/ProductVariantGenerateWrapper' + $ref: '#/components/schemas/CatalogViewInputWrapper' example: - ProductVariantGenerate: - attributes: - width: - - 123 - colors: - - '#000000' - - '#ffffff' - - '#d4d400' - - '#ff0000' + 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/product_variants/view/{baseProductCode}: - post: - operationId: ibexa.product_catalog.rest.product_variants.view + /product/catalog/catalogs/{identifier}: + get: + operationId: ibexa.product_catalog.rest.catalogs.get tags: - - Product Variant + - Product Catalog responses: 200: - description: The view in XML or JSON format. + description: If set, the catalog is returned in XML or JSON format. content: - application/vnd.ibexa.api.ProductVariantView+json: + application/vnd.ibexa.api.Catalog+json: schema: - $ref: '#/components/schemas/ProductVariantViewWrapper' + $ref: '#/components/schemas/CatalogWrapper' 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: | - -
test
- xhtml5edit: | - -

test

- - 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: | - -
test
- xhtml5edit: | - -

test

- - 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: + 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/ProductVariantView' - 400: - description: Error - the input does not match the input schema definition. + $ref: '#/components/schemas/Catalog' + 401: + description: Error - the user is not authorized to view this catalog. 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. + 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: baseProductCode + - name: identifier in: path - description: "" + description: CatalogDeleteController 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 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 + patch: + operationId: ibexa.product_catalog.rest.catalogs.update tags: - - Product Variant + - Product Catalog responses: 201: - description: No content - product variant is created. + 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 create this product variant. + description: Error - the user is not authorized to update this catalog. 403: - description: Error - a product variant with the same name already exists. + description: Error - a catalog with the same identifier already exists. 404: - description: Error - no base product with the given code exists. - summary: Create product variant - description: Creates a new product variant. + description: Error - no catalog with the given identifier exists. + summary: Update catalog + description: Updates a catalog. parameters: - - name: baseProductCode + - name: identifier in: path - description: "" + description: CatalogUpdateController 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 variant schema encoded in XML or JSON format. + description: If set, the updated catalog is returned in XML or JSON format. content: - application/vnd.ibexa.api.ProductVariantCreate+json: + application/vnd.ibexa.api.CatalogUpdate+json: schema: - $ref: '#/components/schemas/ProductVariantCreateWrapper' + $ref: '#/components/schemas/CatalogUpdateWrapper' example: - ProductVariantCreate: - attributes: - width: 100 - height: 50 - color: '#000000' - code: macbook_pro + 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/product_variants/{code}: - delete: - operationId: ibexa.product_catalog.rest.product_variants.delete + /product/catalog/catalogs/{identifier}/products/view: + post: + operationId: ibexa.product_catalog.rest.catalogs.products.view tags: - - Product Variant + - Product Catalog 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. + 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: | + +
+ xhtml5edit: | + +
+ - 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: + 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: code + - name: identifier in: path - description: "" + description: CatalogProductsViewController 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.product_variants.update + 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 + /product/catalog/currencies: + get: + operationId: ibexa.product_catalog.rest.currencies tags: - - Product Variant + - Product Currency responses: - 201: - description: If set, the updated product variant is returned in XML or JSON - format. + 200: + description: OK - loads currencies. content: - application/vnd.ibexa.api.ProductVariant+json: + application/vnd.ibexa.api.CurrencyList+json: schema: - $ref: '#/components/schemas/ProductVariantWrapper' + $ref: '#/components/schemas/CurrencyListWrapper' 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: | - -
test
- xhtml5edit: | - -

test

- - 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: [] + 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: [] + 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 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. + 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: 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 + /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 product variant update schema encoded in XML or JSON format. + description: The view input in XML or JSON format. content: - application/vnd.ibexa.api.ProductVariantUpdate+json: + application/vnd.ibexa.api.CurrencyViewInput+json: schema: - $ref: '#/components/schemas/ProductVariantUpdateWrapper' + $ref: '#/components/schemas/CurrencyViewInputWrapper' example: - ProductVariantUpdate: - code: test - attributes: - number: 2 - testattr: 10 + 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/vat/{region}: + /product/catalog/currencies/{id}: get: - operationId: ibexa.product_catalog.rest.vat.list + operationId: ibexa.product_catalog.rest.currencies.get tags: - - Product Vat + - Product Currency responses: 200: - description: OK - loads the VAT category list. + description: OK - loads the currency. content: - application/vnd.ibexa.api.VatCategoryList+json: + application/vnd.ibexa.api.Currency+json: schema: - $ref: '#/components/schemas/VatCategoryListWrapper' + $ref: '#/components/schemas/CurrencyWrapper' 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: ~ + Currency: + _media-type: application/vnd.ibexa.api.Currency+json + id: 3 + code: ALL + subunits: 2 + enabled: false 401: - description: Error - the user is not authorized to read this object. + description: Error - the user has no permission to read currencies. 404: - description: Error - the VAT category region does not exist. - summary: Load VAT region - description: Loads a VAT category for the given region. + description: Error - the currency does not exist. + summary: Load currency + description: Loads a currency. parameters: - - name: region + - 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 - /product/catalog/vat/{region}/{identifier}: - get: - operationId: ibexa.product_catalog.rest.vat + delete: + operationId: ibexa.product_catalog.rest.currencies.delete tags: - - Product Vat + - Product Currency responses: 200: - description: OK - loads the VAT category. + 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.VatCategory+json: + application/vnd.ibexa.api.Currency+json: schema: - $ref: '#/components/schemas/VatCategoryWrapper' + $ref: '#/components/schemas/CurrencyWrapper' example: - VatCategory: - _media-type: application/vnd.ibexa.api.VatCategory+json - identifier: standard - region: region_1 - vatValue: 18 + 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 read this object. + 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 VAT category for the given identifier not exists. - summary: Load VAT specific region - description: Loads a VAT category for the given identifier. + description: Error - the currency with the given ID does not exist. + summary: Update currency + description: Updates a currency. parameters: - - name: region + - name: id in: path - description: "" + description: CurrencyUpdateController 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 - /content/sections: + 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 + /product/catalog/customer_groups: get: - operationId: ibexa.rest.list_sections + operationId: ibexa.product_catalog.rest.customer_groups.list tags: - - Section + - Product Customer Group responses: 200: - description: If set, the Section list is returned in XML or JSON format. + description: If set, the customer groups list is returned in XML or JSON + format. content: - application/vnd.ibexa.api.SectionList+json: + application/vnd.ibexa.api.CustomerGroupList+json: schema: - $ref: '#/components/schemas/SectionListWrapper' + $ref: '#/components/schemas/CustomerGroupListWrapper' 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: + 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: [] + 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/SectionList' - example: | - - -
- 1 - standard - Standard -
-
- 2 - users - Users -
-
- 3 - media - Media -
-
- 6 - form - Form -
-
- 7 - template - Template -
-
- 8 - restricted - Restricted -
- + $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 has no permission to read the Section. - summary: Get Sections - description: Returns a list of all Sections. + 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: If-None-Match + - name: X-CSRF-Token in: header - description: ETag - required: false + 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 + 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.rest.create_section + operationId: ibexa.product_catalog.rest.customer_groups.view tags: - - Section + - Product Customer Group responses: - 201: - description: If set, the new Section is returned in XML or JSON format. + 200: + description: The view in XML or JSON format. content: - application/vnd.ibexa.api.Section+json: + application/vnd.ibexa.api.CustomerGroupView+json: schema: - $ref: '#/components/schemas/SectionWrapper' + $ref: '#/components/schemas/CustomerGroupViewWrapper' 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: + 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/Section' - example: | - -
- 7 - restricted - Restricted -
- summary: Create new Section - description: Creates a new Section. + $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 needed on all unsafe HTTP methods with session. + 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 Section input schema encoded in XML or JSON format. + description: The view input in XML or JSON format. content: - application/vnd.ibexa.api.SectionInput+json: + application/vnd.ibexa.api.CustomerGroupViewInput+json: schema: - $ref: '#/components/schemas/SectionInputWrapper' - example: - SectionInput: - identifier: restricted - name: Restricted - application/vnd.ibexa.api.SectionInput+xml: + $ref: '#/components/schemas/CustomerGroupViewInputWrapper' + example: + ViewInput: + identifier: TitleView + CustomerGroupQuery: + limit: "10" + offset: "0" + application/vnd.ibexa.api.CustomerGroupViewInput+xml: schema: - $ref: '#/components/schemas/SectionInput' - example: |- - - - restricted - Restricted - + $ref: '#/components/schemas/CustomerGroupViewInput' required: false - deprecated: false - /content/sections/{sectionId}: + /product/catalog/customer_groups/{identifier}: get: - operationId: ibexa.rest.load_section + operationId: ibexa.product_catalog.rest.customer_groups.identifier tags: - - Section + - Product Customer Group responses: 200: - description: If set, the Section is returned in XML or JSON format. + description: If set, the customer group is returned in XML or JSON format. content: - application/vnd.ibexa.api.Section+json: + application/vnd.ibexa.api.CustomerGroup+json: schema: - $ref: '#/components/schemas/SectionWrapper' + $ref: '#/components/schemas/CustomerGroupWrapper' 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: | - -
- 10 - design - Design -
+ 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 Section. - 404: - description: Error - The Section does not exist. - summary: Get Section - description: Returns the Section by given Section ID. + description: Error - the user has no permission to read customer groups. + summary: Load customer group + description: Returns a customer 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: sectionId + - name: identifier in: path - description: "" + description: CustomerGroupLoadByIdentifierController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false delete: - operationId: ibexa.rest.delete_section + operationId: ibexa.product_catalog.rest.customer_groups.delete tags: - - Section + - Product Customer Group responses: 204: - description: No Content - given Section is deleted. + description: No content - the given customer group 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. + description: Error - the user is not authorized to delete this customer + group. + summary: Delete customer group + description: Deletes the given customer 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: CustomerGroupDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: 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 - deprecated: false patch: - operationId: ibexa.rest.update_section + operationId: ibexa.product_catalog.rest.customer_group.update tags: - - Section + - Product Customer Group responses: - 200: - description: OK - Section updated. + 201: + description: If set, the updated customer group is returned in XML or JSON + format. content: - application/vnd.ibexa.api.Section+json: + application/vnd.ibexa.api.CustomerGroup+json: schema: - $ref: '#/components/schemas/SectionWrapper' + $ref: '#/components/schemas/CustomerGroupWrapper' 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: | - -
- 7 - template - Template -
+ CustomerGroup: + _media-type: application/vnd.ibexa.api.CustomerGroup+json + id: 1 + name: Customer Group + identifier: customer_group + description: "" + users: [] + global_price_rate: "1.00" 400: description: Error - the input does not match the input schema definition. 401: - description: Error - the user is not authorized to create this 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. + description: Error - the user is not authorized to update a customer group. + summary: Update customer group + description: Updates the given customer 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: CustomerGroupUpdateController 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 + 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: sectionId + 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 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: "" + description: CustomerGroupLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: - type: string + type: integer 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: | - - - template - Template - - required: false - deprecated: false - /segment_groups: + /product/catalog/regions: get: - operationId: ibexa.segmentation.rest.segment_groups.list + operationId: ibexa.product_catalog.rest.regions tags: - - Segmentation + - Product Region responses: 200: - description: OK - list the segment groups. + description: OK - loads regions. content: - application/vnd.ibexa.api.SegmentGroupList+json: + application/vnd.ibexa.api.RegionList+json: schema: - $ref: '#/components/schemas/SegmentGroupListWrapper' + $ref: '#/components/schemas/RegionListWrapper' 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: + 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/SegmentGroupList' - example: | - - - - 1 - corporate_accounts - Corporate Accounts - - + $ref: '#/components/schemas/RegionList' 401: - description: Error - the user is not authorized to list segment groups. + 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.ErrorMessage+json: + application/vnd.ibexa.api.RegionView+json: schema: - $ref: '#/components/schemas/ErrorMessage' - application/vnd.ibexa.api.ErrorMessage+xml: + $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/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}: + $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 + schema: + type: string + style: simple + explode: 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 + /product/catalog/regions/{identifier}: get: - operationId: ibexa.segmentation.rest.segment_groups.view + operationId: ibexa.product_catalog.rest.region tags: - - Segmentation + - Product Region responses: 200: - description: OK - return the segment group. + description: OK - loads region. content: - application/vnd.ibexa.api.SegmentGroup+json: + application/vnd.ibexa.api.Region+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: + $ref: '#/components/schemas/RegionWrapper' + application/vnd.ibexa.api.Region+xml: schema: - $ref: '#/components/schemas/SegmentGroup' - example: | - - - 1 - corporate_accounts - Corporate Accounts - - 401: - description: Error - the user is not authorized to load this segment group. + $ref: '#/components/schemas/Region' 404: - description: Error - the identifier doesn't match any segment group. - summary: Load segment group - description: Loads segment group. + description: Error - the region does not exist. + summary: Load region + description: Loads a region by its identifier parameters: - name: identifier in: path - description: "" + description: RegionLoadByIdentifierController 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 - /segment_groups/{identifier}/segments: + /product/catalog/product_types: get: - operationId: ibexa.segmentation.rest.segment_groups.list.segments + operationId: ibexa.product_catalog.rest.product_types tags: - - Segmentation + - Product Type responses: 200: - description: OK - list the group's segments. + description: ProductTypeList - If set, the product type list is returned + in XML or JSON format. content: - application/vnd.ibexa.api.SegmentList+json: + application/vnd.ibexa.api.ProductTypeList+json: schema: - $ref: '#/components/schemas/SegmentListWrapper' + $ref: '#/components/schemas/ProductTypeListWrapper' 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: + 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/SegmentList' - example: | - - + $ref: '#/components/schemas/ProductTypeList' 401: - description: Error - the user is not authorized to load this group's segments. + 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 identifier doesn't match any segment group. - summary: List segment group's segments - description: Lists segment group's segments. + description: Error - the product type with the given ID does not exist. + summary: Create product type + description: Creates a new product type. 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: Experience - color: '#D3822B' - - name: Commerce - color: '#A32768' - position: after - /segments/{identifier}: + 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: + 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 + /product/catalog/product_types/is_used/{identifier}: get: - operationId: ibexa.segmentation.rest.segments.view + operationId: ibexa.product_catalog.rest.product_types.is_used tags: - - Segmentation + - Product Type responses: 200: - description: OK - Return the segment. + description: OK - product type usage is returned. content: - application/vnd.ibexa.api.Segment+json: + application/vnd.ibexa.api.ProductTypeUsage+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: + $ref: '#/components/schemas/ProductTypeUsageWrapper' + application/vnd.ibexa.api.ProductTypeUsage+xml: schema: - $ref: '#/components/schemas/Segment' + $ref: '#/components/schemas/ProductTypeUsage' example: | - - 1 - corporate_account - Corporate Account - ibexa - 14 - 2026-06-30T12:00:00+00:00 - - - 401: - description: Error - the user is not authorized to load this group's segments. + + 1 + 404: - description: Error - the identifier doesn't match any segment group. - summary: Load segment - description: Loads the identified segment. + 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: "" + description: ProductTypeIsUsedController 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 - /orders/order/{orderIdentifier}/shipments: + /product/catalog/product_types/view: post: - operationId: ibexa.shipping.rest.shipment.create + operationId: ibexa.product_catalog.rest.product_types.view tags: - - Shipping + - Product Type 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.ProductTypeView+json: schema: - $ref: '#/components/schemas/ShipmentWrapper' + $ref: '#/components/schemas/ProductTypeViewWrapper' 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: + 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/Shipment' - example: | - - - 1 - new_identifier - prepared - - send-to-carrier - cancel - - - - 1922 - EUR - - 2023-06-26T15:40:28+02:00 - 2023-06-26T15:40:28+02:00 - - - + $ref: '#/components/schemas/ProductTypeView' 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 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. - 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 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.ProductTypeViewInput+json: schema: - $ref: '#/components/schemas/ShipmentCreateWrapper' + $ref: '#/components/schemas/ProductTypeViewInputWrapper' 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: + ViewInput: + identifier: TitleView + ProductTypeQuery: + limit: "10" + offset: "0" + name_prefix: new + application/vnd.ibexa.api.ProductTypeViewInput+xml: schema: - $ref: '#/components/schemas/ShipmentCreate' - example: | - - - abc - - - 1922 - EUR - - - - value1 - value2 - - + $ref: '#/components/schemas/ProductTypeViewInput' 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: | - - - - - - - - 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}: + /product/catalog/product_types/{identifier}: get: - operationId: ibexa.shipping.rest.shipment.get + operationId: ibexa.product_catalog.rest.product_type tags: - - Shipping + - Product Type responses: 200: - description: OK - loads the shipment. + description: OK - load the product type content: - application/vnd.ibexa.api.Shipment+json: + application/vnd.ibexa.api.ProductType+json: schema: - $ref: '#/components/schemas/ShipmentWrapper' + $ref: '#/components/schemas/ProductTypeWrapper' 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: + 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/Shipment' - example: | - - - 1 - ae741491-e80c-49f2-8a44-5163b4afa144 - pending - - prepare - cancel - - - - 2257 - EUR - - 2023-06-26T15:40:28+02:00 - 2023-06-26T15:40:28+02:00 - - - + $ref: '#/components/schemas/ProductType' 401: - description: Error - the user has no permission to read shipments. + description: Error - the user has no permission to read product type. 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. + description: Error - product type not found. + summary: Load product type + description: Returns the given product type. parameters: - name: identifier in: path - description: The shipment identifier. + description: ProductTypeLoadByIdentifierController 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/product_types/{id}: delete: - operationId: ibexa.shipping.rest.shipment.delete + operationId: ibexa.product_catalog.rest.product_types.delete tags: - - Shipping + - Product Type responses: 204: - description: No content - shipment is deleted. + description: No content - the given product type 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. + description: Error - the user is not authorized to delete this product type. + summary: Delete product type + description: Deletes the given product type. parameters: - - name: X-CSRF-Token - in: header - description: The CSRF token. + - name: id + in: path + description: ProductTypeDeleteController 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.shipping.rest.shipment.update + operationId: ibexa.product_catalog.rest.product_types.update tags: - - Shipping + - Product Type responses: - 200: - description: If set, the updated shipment is returned in XML or JSON format. + 201: + description: If set, the updated product type is returned in XML or JSON + format. content: - application/vnd.ibexa.api.Shipment+json: + application/vnd.ibexa.api.ProductType+json: schema: - $ref: '#/components/schemas/ShipmentWrapper' + $ref: '#/components/schemas/ProductTypeWrapper' 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: | - - - 1 - new_identifier - prepared - - send-to-carrier - cancel - - - - 2257 - EUR - - 2023-06-26T15:40:28+02:00 - 2023-06-26T15:40:28+02:00 - - - + 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 update this shipment. + description: Error - the user is not authorized to create this product type. 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. + description: Error - the product type with the given ID does not exist. + summary: Update product type + description: Updates product type. parameters: - - name: X-CSRF-Token - in: header - description: The CSRF token. + - name: id + in: path + description: ProductTypeUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - - name: identifier - in: path - description: The shipment identifier. + - 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 ShipmentUpdate schema encoded in XML or JSON format. + description: If set, the updated product type is returned in XML or JSON format. content: - application/vnd.ibexa.api.ShipmentUpdate+json: + application/vnd.ibexa.api.ProductTypeUpdate+json: schema: - $ref: '#/components/schemas/ShipmentUpdateWrapper' + $ref: '#/components/schemas/ProductTypeUpdateWrapper' 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: | - - - new_identifier - prepare - - - value1 - value2 - - + 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 - 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: | - - - - flat_rate - Flat rate - - - free - Free shipping - - - 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}: + /product/catalog/product_variant/{code}: get: - operationId: ibexa.shipping.rest.shipping_method.type.get + operationId: ibexa.product_catalog.rest.product_variant tags: - - Shipping + - Product Variant responses: 200: - description: OK - loads the shipping method. + description: OK - loads the product variant. content: - application/vnd.ibexa.api.ShippingMethodType+json: + application/vnd.ibexa.api.ProductVariant+json: schema: - $ref: '#/components/schemas/ShippingMethodTypeWrapper' + $ref: '#/components/schemas/ProductVariantWrapper' 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: | - - - flat_rate - Flat rate - + 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: | + +
test
+ xhtml5edit: | + +

test

+ - 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 has no permission to read shipping methods. + description: Error - the user is not authorized to view this product variant. 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. + description: Error - no product variant with the given code exists. + summary: Load product variant + description: Loads the given product variant. parameters: - - name: identifier + - name: code in: path - description: "" + description: ProductVariantLoadByCodeController 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 - /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: | - - - - - - 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 + /product/catalog/product_variants/generate/{baseProductCode}: + post: + operationId: ibexa.product_catalog.rest.product_variants.generate tags: - - Shipping + - Product Variant 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: | - - - method1 - AmE Method 1 - - AmE Method 1 - BrE Method 1 - - AmE Description of Method 1 - - AmE Description of Method 1 - BrE Description of Method 1 - - true - - 20.0000 - EUR - - - - - - + 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 has no permission to read shipping methods. + 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 - the shipping method does not exist. - summary: Load shipping method based on its identifier - description: Loads shipping method based on its identifier. + 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: identifier + - name: baseProductCode in: path - description: "" + description: ProductVariantGenereateController 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 - /shopping-list: - get: - operationId: ibexa.rest.shopping_list.list + - 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: - - Shopping List + - Product Variant 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.ProductVariantView+json: schema: - $ref: '#/components/schemas/ShoppingListCollectionWrapper' + $ref: '#/components/schemas/ProductVariantViewWrapper' 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: | - - - 2 - 2 - - 550e8400-e29b-41d4-a716-446655440000 - My Shopping List - 1 - - - 650e8400-e29b-41d4-a716-446655440001 - - PRODUCT-001 - Sample Product - - 2024-10-29T12:15:00+00:00 - - 2024-10-29T12:00:00+00:00 - 2024-10-29T12:00:00+00:00 - - - 660e8400-e29b-41d4-a716-446655440001 - Weekend Shopping - 0 - - - 2024-10-30T08:30:00+00:00 - 2024-10-30T08:30:00+00:00 - - - 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 + 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: | + +
test
+ xhtml5edit: | + +

test

+ - 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: | + +
test
+ xhtml5edit: | + +

test

+ - 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: ProductVariantViewController identifier + required: true deprecated: false - allowEmptyValue: false schema: type: string - format: date-time - style: form + style: simple explode: false - allowReserved: false - - name: updatedFrom - in: query - description: Filter shopping lists updated on or after this date (ISO 8601 - format). - 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 - format: date-time - style: form + style: simple explode: false - allowReserved: false - - name: updatedTo - in: query - description: Filter shopping lists updated on or before this date (ISO 8601 - format). + 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 - allowEmptyValue: false schema: type: string - format: date-time - style: form + style: simple 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 + - 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 - 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 + style: simple explode: false - allowReserved: false - - name: sort - in: query - description: 'Sort shopping lists by field. Available fields: name, is_default, - created_at, updated_at.' + 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 - allowEmptyValue: false schema: type: string - enum: - - name - - is_default - - created_at - - updated_at - style: form + style: simple explode: false - allowReserved: false - - name: order - in: query - description: Sort direction. Default is "asc". - 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 - enum: - - asc - - desc - default: asc - style: form + style: simple 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 + patch: + operationId: ibexa.product_catalog.rest.product_variants.update tags: - - Shopping List + - Product Variant responses: 201: - description: Shopping list created. + description: If set, the updated product variant is returned in XML or JSON + format. content: - application/vnd.ibexa.api.ShoppingList+json: + application/vnd.ibexa.api.ProductVariant+json: schema: - $ref: '#/components/schemas/ShoppingListWrapper' + $ref: '#/components/schemas/ProductVariantWrapper' 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: | - - - 550e8400-e29b-41d4-a716-446655440000 - My Shopping List - 0 - - - 650e8400-e29b-41d4-a716-446655440001 - - PRODUCT-001 - Sample Product - - 2024-10-29T12:15:00+00:00 - - 2024-10-29T12:00:00+00:00 - 2024-10-29T12:00:00+00:00 - + 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: | + +
test
+ xhtml5edit: | + +

test

+ - 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. + description: Error - the input does not match the input schema definition. 401: - description: Error - The user is not authorized to create a shopping list. + description: Error - the user is not authorized to update this product variant. 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. + 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: X-CSRF-Token - in: header - description: CSRF Token is needed to execute this unsafe request. + - name: code + in: path + description: ProductVariantUpdateController identifier 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: | - - - My Shopping List - - 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: | - - - 550e8400-e29b-41d4-a716-446655440000 - My Shopping List - 0 - - - 650e8400-e29b-41d4-a716-446655440001 - - PRODUCT-001 - Sample Product - - 2024-10-29T12:15:00+00:00 - - 2024-10-29T12:00:00+00:00 - 2024-10-29T12:00:00+00:00 - - 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. + 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: Entries to add to the default shopping list + description: The product variant update schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.ShoppingListEntriesAdd+json: + application/vnd.ibexa.api.ProductVariantUpdate+json: schema: - $ref: '#/components/schemas/ShoppingListEntriesAddWrapper' + $ref: '#/components/schemas/ProductVariantUpdateWrapper' example: - ShoppingListEntriesAdd: - entries: - - productCode: PRODUCT-001 - - productCode: PRODUCT-002 - application/vnd.ibexa.api.ShoppingListEntriesAdd+xml: - schema: - $ref: '#/components/schemas/ShoppingListEntriesAdd' - example: | - - - - - PRODUCT-001 - - - PRODUCT-002 - - - + ProductVariantUpdate: + code: test + attributes: + number: 2 + testattr: 10 required: false - deprecated: false - x-badges: - - name: Commerce - color: '#A32768' - position: after - - name: LTS Update - color: '#5DA7C0' - position: after - /shopping-list/{identifier}: + /product/catalog/vat/{region}: get: - operationId: ibexa.rest.shopping_list.get + operationId: ibexa.product_catalog.rest.vat.list tags: - - Shopping List + - Product Vat responses: 200: - description: OK - returns the shopping list + description: OK - loads the VAT category list. content: - application/vnd.ibexa.api.ShoppingList+json: + application/vnd.ibexa.api.VatCategoryList+json: schema: - $ref: '#/components/schemas/ShoppingListWrapper' + $ref: '#/components/schemas/VatCategoryListWrapper' 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: | - - - 550e8400-e29b-41d4-a716-446655440000 - My Shopping List - 0 - - - 650e8400-e29b-41d4-a716-446655440001 - - PRODUCT-001 - Sample Product - - 2024-10-29T12:15:00+00:00 - - - 650e8400-e29b-41d4-a716-446655440002 - - PRODUCT-002 - Another Product - - 2024-10-29T12:30:00+00:00 - - 2024-10-29T12:00:00+00:00 - 2024-10-29T12:00:00+00:00 - + 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 access this shopping - list. + description: Error - the user is not authorized to read this object. 404: - description: Error - the identifier does not match any shopping list. - summary: Get shopping list - description: Gets a shopping list by its identifier. + description: Error - the VAT category region does not exist. + summary: Load VAT region + description: Loads a VAT category for the given region. parameters: - - name: identifier + - name: region in: path - description: The shopping list identifier (UUID) + description: VatCategoriesListController 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 - delete: - operationId: ibexa.rest.shopping_list.delete + /product/catalog/vat/{region}/{identifier}: + get: + operationId: ibexa.product_catalog.rest.vat tags: - - Shopping List + - Product Vat responses: - 204: - description: No Content - shopping list deleted successfully. + 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 delete this shopping - list. - 403: - description: Error - Cannot delete the default shopping list. + description: Error - the user is not authorized to read this object. 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. + 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: identifier + - name: region in: path - description: The shopping list identifier (UUID). + description: VatCategoryLoadByIdentifierController 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. + - name: identifier + in: path + description: VatCategoryLoadByIdentifierController 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 - patch: - operationId: ibexa.rest.shopping_list.update + /content/sections: + get: + operationId: ibexa.rest.list_sections tags: - - Shopping List + - Section responses: 200: - description: Shopping list updated. + description: If set, the Section list is returned in XML or JSON format. content: - application/vnd.ibexa.api.ShoppingList+json: + application/vnd.ibexa.api.SectionList+json: schema: - $ref: '#/components/schemas/ShoppingListWrapper' + $ref: '#/components/schemas/SectionListWrapper' 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' + 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: | - - 550e8400-e29b-41d4-a716-446655440000 - Updated Shopping List Name - 0 - - - 650e8400-e29b-41d4-a716-446655440001 - - PRODUCT-001 - Sample Product - - 2024-10-29T12:15:00+00:00 - - 2024-10-29T12:00:00+00:00 - 2024-10-29T12:30:00+00:00 - - 204: - description: Shopping list updated (no content returned). - 400: - description: Error - The input does not match the input schema definition. + +
+ 1 + standard + Standard +
+
+ 2 + users + Users +
+
+ 3 + media + Media +
+
+ 6 + form + Form +
+
+ 7 + template + Template +
+
+ 8 + restricted + Restricted +
+ 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. + description: Error - The user has no permission to read the Section. + summary: Get Sections + description: Returns a list of all Sections. 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 + - name: If-None-Match in: header - description: CSRF Token is needed to execute this unsafe request. - required: true + description: ETag + required: false 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: | - - - Updated Shopping List Name - - 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 + operationId: ibexa.rest.create_section tags: - - Shopping List + - Section responses: - 200: - description: OK - returns the cart with added shopping list entries + 201: + description: If set, the new Section is returned in XML or JSON format. content: - application/vnd.ibexa.api.Cart+json: + application/vnd.ibexa.api.Section+json: schema: - $ref: '#/components/schemas/CartWrapper' - application/vnd.ibexa.api.Cart+xml: + $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/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). + $ref: '#/components/schemas/Section' + example: | + +
+ 7 + restricted + Restricted +
+ summary: Create new Section + description: Creates a new Section. 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 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 ShoppingListEntryIdentifiers schema encoded in XML or JSON - format. + description: The Section input schema encoded in XML or JSON format. content: - application/vnd.ibexa.api.ShoppingListEntryIdentifiers+json: + application/vnd.ibexa.api.SectionInput+json: schema: - $ref: '#/components/schemas/ShoppingListEntryIdentifiersWrapper' + $ref: '#/components/schemas/SectionInputWrapper' example: - ShoppingListEntryIdentifiers: - entries: - - identifier: entry-001 - - identifier: entry-003 - application/vnd.ibexa.api.ShoppingListEntryIdentifiers+xml: + SectionInput: + identifier: restricted + name: Restricted + application/vnd.ibexa.api.SectionInput+xml: schema: - $ref: '#/components/schemas/ShoppingListEntryIdentifiers' - example: | + $ref: '#/components/schemas/SectionInput' + example: |- - - - entry-001 - - - entry-003 - - + + restricted + Restricted + 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 + /content/sections/{sectionId}: + get: + operationId: ibexa.rest.load_section tags: - - Shopping List + - Section responses: 200: - description: OK - returns the cart with added shopping list entries + description: If set, the Section is returned in XML or JSON format. content: - application/vnd.ibexa.api.Cart+json: + application/vnd.ibexa.api.Section+json: schema: - $ref: '#/components/schemas/CartWrapper' - application/vnd.ibexa.api.Cart+xml: + $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/Cart' - 400: - description: Error - The input does not match the input schema definition. + $ref: '#/components/schemas/Section' + example: | + +
+ 10 + design + Design +
401: - description: Error - the user is not authorized to add shopping list entries - to cart. + description: Error - The user is not authorized to read this Section. 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. + description: Error - The Section does not exist. + summary: Get Section + description: Returns the Section by given Section ID. parameters: - - name: identifier - in: path - description: The Shopping List identifier - 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 - - name: cartIdentifier + - name: sectionId 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: SectionLoadByIdController 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: | - - - - entry-001 - - - entry-003 - - - 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 + delete: + operationId: ibexa.rest.delete_section tags: - - Shopping List + - Section 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 - given Section is deleted. 401: - description: Error - the user is not authorized to add shopping list to - cart. + description: Error - the user is not authorized to delete this Section. 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). + description: Error - the Section does not exist. + summary: Delete Section + description: The given Section is deleted. parameters: - - name: identifier - in: path - description: The Shopping List identifier + - 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: CSRF Token is needed to execute this unsafe request. + - name: sectionId + in: path + description: SectionDeleteController 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 - - 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 + patch: + operationId: ibexa.rest.update_section tags: - - Shopping List + - Section responses: 200: - description: OK - returns the cart with added shopping list entries + description: OK - Section updated. content: - application/vnd.ibexa.api.Cart+json: + application/vnd.ibexa.api.Section+json: schema: - $ref: '#/components/schemas/CartWrapper' - application/vnd.ibexa.api.Cart+xml: + $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/Cart' + $ref: '#/components/schemas/Section' + example: | + +
+ 7 + template + Template +
+ 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. - 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. + 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: identifier - in: path - description: The Shopping List identifier + - 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: cartIdentifier - in: path - description: The Cart identifier + - name: If-Match + in: header + description: ETag 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: sectionId + in: path + description: SectionUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: - description: No payload required - content: [] + 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: | + + + template + Template + 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 + /segment_groups: + get: + operationId: ibexa.segmentation.rest.segment_groups.list tags: - - Shopping List + - Segmentation responses: 200: - description: Shopping list cleared successfully. Returns the updated shopping - list with no entries. + description: OK - list the segment groups. content: - application/vnd.ibexa.api.ShoppingList+json: + application/vnd.ibexa.api.SegmentGroupList+json: schema: - $ref: '#/components/schemas/ShoppingListWrapper' + $ref: '#/components/schemas/SegmentGroupListWrapper' 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: + 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: | + + + + 1 + corporate_accounts + Corporate Accounts + + + 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: [] + /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/ShoppingList' + $ref: '#/components/schemas/SegmentGroup' example: | - - 550e8400-e29b-41d4-a716-446655440000 - My Shopping List - 0 - - - 2024-10-29T12:00:00+00:00 - 2024-10-29T12:15:00+00:00 - + + 1 + corporate_accounts + Corporate Accounts + 401: - description: Error - The user is not authorized to clear this shopping list. - 403: - description: Error - Invalid request. + description: Error - the user is not authorized to load this segment group. 404: - description: Error - Shopping list not found. - summary: Clear shopping list - description: Removes all entries from a shopping list while keeping the list - itself. + description: Error - the identifier doesn't match any segment group. + summary: Load segment group + description: Loads segment group. 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: SegmentGroupViewController 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 - - name: LTS Update - color: '#5DA7C0' - position: after - /shopping-list/{identifier}/entries: - post: - operationId: ibexa.rest.shopping_list.add_entries + /segment_groups/{identifier}/segments: + get: + operationId: ibexa.segmentation.rest.segment_groups.list.segments tags: - - Shopping List + - Segmentation responses: 200: - description: Entries added successfully. Returns the updated shopping list. + description: OK - list the group's segments. content: - application/vnd.ibexa.api.ShoppingList+json: + application/vnd.ibexa.api.SegmentList+json: schema: - $ref: '#/components/schemas/ShoppingListWrapper' + $ref: '#/components/schemas/SegmentListWrapper' 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' + 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: | - - 550e8400-e29b-41d4-a716-446655440000 - My Shopping List - 0 - - - 650e8400-e29b-41d4-a716-446655440001 - - PRODUCT-001 - Sample Product - - 2024-10-29T12:15:00+00:00 - - 2024-10-29T12:00:00+00:00 - 2024-10-29T12:00:00+00:00 - - 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. + description: Error - the user is not authorized to load this group's segments. 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. + 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: 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: SegmentListController identifier 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: | - - - - - PRODUCT-001 - - - PRODUCT-002 - - - - 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 + /segments/{identifier}: + get: + operationId: ibexa.segmentation.rest.segments.view tags: - - Shopping List + - Segmentation responses: 200: - description: Entries removed successfully. Returns the updated shopping - list. + description: OK - Return the segment. content: - application/vnd.ibexa.api.ShoppingList+json: + application/vnd.ibexa.api.Segment+json: schema: - $ref: '#/components/schemas/ShoppingListWrapper' + $ref: '#/components/schemas/SegmentWrapper' 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' + 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: | - - 550e8400-e29b-41d4-a716-446655440000 - My Shopping List - 0 - - - 650e8400-e29b-41d4-a716-446655440001 - - PRODUCT-001 - Sample Product - - 2024-10-29T12:15:00+00:00 - - 2024-10-29T12:00:00+00:00 - 2024-10-29T12:00:00+00:00 - - 400: - description: Error - The input does not match the input schema definition. + + 1 + corporate_account + Corporate Account + cohesivo + 14 + 2026-06-30T12:00:00+00:00 + + 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). + description: Error - the user is not authorized to load this group's segments. 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. + description: Error - the identifier doesn't match any segment group. + summary: Load segment + description: Loads the identified segment. 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: SegmentViewController identifier 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: | - - - - 650e8400-e29b-41d4-a716-446655440001 - 650e8400-e29b-41d4-a716-446655440002 - - - 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 @@ -24284,23 +18668,19 @@ paths: 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: TaxonomyEntryBulkRemoveController identifier 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: @@ -24316,7 +18696,6 @@ paths: schema: $ref: '#/components/schemas/TaxonomyEntryBulkRemove' required: false - deprecated: false /taxonomy/{taxonomyName}/entries/move: post: operationId: ibexa.taxonomy.rest.entries.move @@ -24339,23 +18718,19 @@ paths: 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: TaxonomyEntryBulkMoveController identifier 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: @@ -24375,7 +18750,6 @@ paths: schema: $ref: '#/components/schemas/TaxonomyEntryBulkMove' required: false - deprecated: false /taxonomy/{taxonomyName}/entry-assignment/{id}: get: operationId: ibexa.taxonomy.rest.entry_assignment.load_by_id @@ -24398,27 +18772,22 @@ paths: parameters: - name: taxonomyName in: path - description: "" + description: TaxonomyEntryAssignmentLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: id in: path - description: "" + description: TaxonomyEntryAssignmentLoadByIdController identifier 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 @@ -24439,23 +18808,19 @@ paths: 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: TaxonomyEntryAssignmentAssignController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: description: TaxonomyEntryAssignToContent schema encoded in JSON format. content: @@ -24469,7 +18834,6 @@ paths: - 2 - 3 required: false - deprecated: false /taxonomy/{taxonomyName}/entry-assignments/content-id/{contentId}: get: operationId: ibexa.taxonomy.rest.entry_assignments.load @@ -24641,27 +19005,22 @@ paths: parameters: - name: taxonomyName in: path - description: "" + description: TaxonomyEntryAssignmentLoadController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: contentId in: path - description: "" + description: TaxonomyEntryAssignmentLoadController identifier 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 @@ -24682,23 +19041,19 @@ paths: 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: TaxonomyEntryAssignmentUnassignController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: description: TaxonomyEntryUnassignFromContent schema encoded in JSON format. content: @@ -24712,7 +19067,6 @@ paths: - 2 - 3 required: false - deprecated: false /taxonomy/{taxonomyName}/entry/content-id/{contentId}: get: operationId: ibexa.taxonomy.rest.entry.load_by_content_id @@ -24737,27 +19091,22 @@ paths: parameters: - name: taxonomyName in: path - description: "" + description: TaxonomyEntryLoadByContentIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: contentId in: path - description: "" + description: TaxonomyEntryLoadByContentIdController identifier 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 @@ -24782,27 +19131,22 @@ paths: parameters: - name: taxonomyName in: path - description: "" + description: TaxonomyEntryLoadByIdentifierController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: identifier in: path - description: "" + description: TaxonomyEntryLoadByIdentifierController identifier 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 @@ -24827,27 +19171,22 @@ paths: parameters: - name: taxonomyName in: path - description: "" + description: TaxonomyEntryLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: id in: path - description: "" + description: TaxonomyEntryLoadByIdController identifier 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 @@ -25020,7 +19359,6 @@ paths: summary: List Trash items description: Returns a list of all items in the Trash. parameters: [] - deprecated: false delete: operationId: ibexa.rest.empty_trash tags: @@ -25039,13 +19377,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 - deprecated: false /content/trash/{trashItemid}: get: operationId: ibexa.rest.load_trash_item @@ -25162,16 +19497,13 @@ paths: parameters: - 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 delete: operationId: ibexa.rest.delete_trash_item tags: @@ -25191,24 +19523,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: trashItemid in: path - description: "" + description: TrashItemDeleteController identifier 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 @@ -26259,7 +20586,6 @@ paths: summary: List content types description: Returns a list of content types. parameters: [] - deprecated: false /content/types/view: post: operationId: ibexa.rest.content_types.view @@ -27310,12 +21636,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 view input in XML or JSON format. content: @@ -27364,7 +21688,6 @@ paths: required: false - deprecated: false /content/types/{contentTypeId}: get: operationId: ibexa.rest.load_content_type @@ -27792,24 +22115,19 @@ paths: description: ETag required: false deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: contentTypeId in: path - description: "" + description: ContentTypeLoadByIdController identifier 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: @@ -27899,23 +22217,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: contentTypeId in: path - description: "" + description: ContentTypeDraftCreateController identifier 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: @@ -27935,7 +22249,6 @@ paths: true required: false - deprecated: false delete: operationId: ibexa.rest.delete_content_type tags: @@ -27957,24 +22270,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: contentTypeId in: path - description: "" + description: ContentTypeDeleteController identifier 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 @@ -28268,16 +22576,13 @@ paths: parameters: - name: contentTypeId in: path - description: "" + description: ContentTypeDraftLoadController 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_draft tags: @@ -28298,24 +22603,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: contentTypeId in: path - description: "" + description: ContentTypeDraftDeleteController 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_draft tags: @@ -28412,23 +22712,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: contentTypeId in: path - description: "" + description: ContentTypeDraftUpdateController identifier 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: @@ -28460,7 +22756,6 @@ paths: required: false - deprecated: false /content/types/{contentTypeId}/draft/fieldDefinitions: get: operationId: ibexa.rest.load_content_type_draft_field_definition_list @@ -28483,16 +22778,13 @@ paths: parameters: - name: contentTypeId in: path - description: "" + description: ContentTypeDraftFieldDefinitionListController identifier 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: @@ -28576,23 +22868,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: contentTypeId in: path - description: "" + description: ContentTypeDraftFieldDefinitionAddController identifier 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: @@ -28616,7 +22904,6 @@ paths: required: false - deprecated: false /content/types/{contentTypeId}/draft/fieldDefinitions/{fieldDefinitionId}: get: operationId: ibexa.rest.load_content_type_draft_field_definition @@ -28695,27 +22982,22 @@ paths: parameters: - name: contentTypeId in: path - description: "" + description: ContentTypeDraftFieldDefinitionLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: fieldDefinitionId in: path - description: "" + description: ContentTypeDraftFieldDefinitionLoadByIdController identifier 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: @@ -28736,35 +23018,28 @@ 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: contentTypeId in: path - description: "" + description: ContentTypeDraftFieldDefinitionDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: fieldDefinitionId in: path - description: "" + description: ContentTypeDraftFieldDefinitionDeleteController 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_draft_field_definition tags: @@ -28843,34 +23118,28 @@ 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: contentTypeId in: path - description: "" + description: ContentTypeDraftFieldDefinitionUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: fieldDefinitionId in: path - description: "" + description: ContentTypeDraftFieldDefinitionUpdateController identifier 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: @@ -28887,7 +23156,6 @@ paths: 10 required: false - deprecated: false /content/types/{contentTypeId}/fieldDefinitions: get: operationId: ibexa.rest.load_content_type_field_definition_list @@ -28910,16 +23178,13 @@ paths: parameters: - name: contentTypeId in: path - description: "" + description: ContentTypeFieldDefinitionListController identifier 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 @@ -28997,27 +23262,22 @@ paths: parameters: - name: contentTypeId in: path - description: "" + description: ContentTypeFieldDefinitionLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - 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 /content/types/{contentTypeId}/groups: get: operationId: ibexa.rest.load_groups_of_content_type @@ -29055,16 +23315,13 @@ paths: parameters: - name: contentTypeId in: path - description: "" + description: ContentTypeGroupListController identifier 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: @@ -29123,40 +23380,33 @@ 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: contentTypeId in: path - description: "" + description: ContentTypeLinkToGroupController identifier 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 @@ -29216,35 +23466,28 @@ 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: contentTypeId in: path - description: "" + description: ContentTypeUnlinkFromGroupController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: id in: path - description: "" + description: ContentTypeUnlinkFromGroupController identifier 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 @@ -29352,7 +23595,6 @@ paths: 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: @@ -29411,12 +23653,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 content type group input schema encoded in XML or JSON. content: @@ -29435,7 +23675,6 @@ paths: newContentTypeGroup required: false - deprecated: false /content/typegroups/{contentTypeGroupId}: get: operationId: ibexa.rest.load_content_type_group @@ -31649,24 +25888,19 @@ paths: description: ETag required: false deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - 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_content_type_group tags: @@ -31689,24 +25923,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: contentTypeGroupId in: path - description: "" + description: ContentTypeGroupDeleteController 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 tags: @@ -31769,35 +25998,29 @@ 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: If-Match in: header description: ETag causes patching only if the specified ETag is the current one. Otherwise a 412 is returned. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: contentTypeGroupId in: path - description: "" + description: ContentTypeGroupUpdateController 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: @@ -31816,7 +26039,6 @@ paths: updatedIdentifer required: false - deprecated: false /content/typegroups/{contentTypeGroupId}/types: get: operationId: ibexa.rest.list_content_types_for_group @@ -34084,16 +28306,13 @@ paths: parameters: - 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: ibexa.rest.create_content_type tags: @@ -34179,23 +28398,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: 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 content type Create schema encoded in XML or JSON format. content: @@ -34317,7 +28532,6 @@ paths: required: false - deprecated: false /content/urlaliases: get: operationId: ibexa.rest.list_global_url_aliases @@ -34350,7 +28564,6 @@ paths: summary: List global URL aliases description: Returns the list of global URL aliases. parameters: [] - deprecated: false post: operationId: ibexa.rest.create_url_alias tags: @@ -34403,12 +28616,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 URL alias input schema encoded in XML or JSON format. content: @@ -34436,7 +28647,6 @@ paths: true required: false - deprecated: false /content/urlaliases/{urlAliasId}: get: operationId: ibexa.rest.load_url_alias @@ -34485,16 +28695,13 @@ paths: parameters: - 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.delete_url_alias tags: @@ -34514,24 +28721,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: urlAliasId in: path - description: "" + description: URLAliasDeleteController 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 @@ -34572,7 +28774,6 @@ paths: summary: List URL wildcards description: Returns a list of URL wildcards. parameters: [] - deprecated: false post: operationId: ibexa.rest.create_url_wildcard tags: @@ -34616,12 +28817,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 URL Wildcard input schema encoded in XML or JSON format. content: @@ -34640,7 +28839,6 @@ paths: \ \t/api/ibexa/v2/content/location/2\n \t/api/ibexa/v2/content/location/59\n \ \ttrue\n\n" required: false - deprecated: false /content/urlwildcards/{wildcardId}: get: operationId: ibexa.rest.load_url_wildcard @@ -34680,16 +28878,13 @@ paths: parameters: - name: wildcardId in: path - description: "" + description: URLWildcardLoadByIdController identifier 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: @@ -34709,24 +28904,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: 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/current: get: operationId: api_usercurrent_get @@ -34964,13 +29154,10 @@ paths: 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 @@ -35220,13 +29407,10 @@ paths: format. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false head: operationId: api_userusers_head tags: @@ -35239,7 +29423,6 @@ paths: summary: Verify Users description: Verifies if there are Users matching given filter. parameters: [] - deprecated: false /user/users/{userId}: get: operationId: api_userusers_userId_get @@ -35478,35 +29661,28 @@ paths: 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: "" + description: UserLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false delete: operationId: api_userusers_userId_delete tags: @@ -35525,16 +29701,13 @@ paths: parameters: - 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_userusers_userId_patch tags: @@ -35772,45 +29945,37 @@ paths: 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: "" + description: UserUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: description: The updated UserUpdateController resource content: @@ -35831,7 +29996,6 @@ paths: false required: false - deprecated: false /user/users/{userId}/drafts: get: operationId: api_userusers_userIddrafts_get @@ -35858,24 +30022,19 @@ paths: 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: "" + description: UserDraftListController identifier 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 @@ -35883,7 +30042,7 @@ paths: - User responses: 200: - description: "200" + description: OK - list of the User Groups the User belongs to. content: application/vnd.ibexa.api.UserGroupRefList+json: schema: @@ -35923,31 +30082,26 @@ paths: format. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: userId in: path - description: "" + description: UserGroupsOfUserListController identifier 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" + description: OK - the User has been assigned to the User Group. content: application/vnd.ibexa.api.UserGroupRefList+json: schema: @@ -35988,28 +30142,23 @@ paths: format. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: userId in: path - description: "" + description: UserAssignToUserGroupController 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 @@ -36017,7 +30166,7 @@ paths: - User responses: 200: - description: "200" + description: OK - the User has been unassigned from the User Group. content: application/vnd.ibexa.api.UserGroupRefList+json: schema: @@ -36059,35 +30208,28 @@ paths: format. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: userId in: path - description: "" + description: UserUnassignFromUserGroupController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: groupId in: path - description: "" + description: UserUnassignFromUserGroupController identifier 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 @@ -36139,16 +30281,13 @@ paths: parameters: - 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 tags: @@ -36223,23 +30362,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: 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: @@ -36274,7 +30409,6 @@ paths: required: false - deprecated: false /user/users/{userId}/roles/{roleId}: get: operationId: ibexa.rest.load_role_assignment_for_user @@ -36320,27 +30454,22 @@ paths: parameters: - 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 tags: @@ -36397,35 +30526,28 @@ 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: userId in: path - description: "" + description: RoleUnassignFromUserController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: roleId in: path - description: "" + description: RoleUnassignFromUserController identifier 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 @@ -36448,7 +30570,7 @@ paths: id: 1 identifier: corporate_account name: Corporate Account - source: ibexa + source: cohesivo lastUpdatedBy: "14" updatedAt: "2026-06-30T12:00:00+00:00" SegmentGroup: @@ -36467,7 +30589,7 @@ paths: 1 corporate_account Corporate Account - ibexa + cohesivo 14 2026-06-30T12:00:00+00:00 @@ -36481,16 +30603,13 @@ paths: parameters: - name: userId in: path - description: "" + description: UserSegmentListController identifier 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: @@ -36511,23 +30630,19 @@ paths: 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: UserSegmentAssignController identifier 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: @@ -36546,7 +30661,6 @@ paths: corporate_account required: false - deprecated: false /user/users/{userId}/segments/{segmentIdentifier}: delete: operationId: ibexa.segmentation.rest.user.segments.unnassign @@ -36569,35 +30683,28 @@ paths: 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: UserSegmentUnassignController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - 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: get: operationId: api_usergroups_get @@ -36605,7 +30712,7 @@ paths: - User Group responses: 200: - description: "200" + description: OK - list of User Groups. content: application/vnd.ibexa.api.UserGroupList+json: schema: @@ -36857,13 +30964,10 @@ paths: 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 @@ -36875,7 +30979,6 @@ paths: summary: Get root User Group description: Redirects to the root User Group. parameters: [] - deprecated: false /user/groups/subgroups: post: operationId: api_usergroupssubgroups_post @@ -37055,23 +31158,19 @@ paths: 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: @@ -37112,7 +31211,6 @@ paths: required: false - deprecated: false /user/groups/{path}: get: operationId: api_usergroups_path_get @@ -37291,35 +31389,28 @@ paths: 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: "" + description: UserGroupLoadByPathController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false delete: operationId: api_usergroups_path_delete tags: @@ -37336,16 +31427,13 @@ paths: parameters: - name: path in: path - description: "" + description: UserGroupDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false patch: operationId: api_usergroups_path_patch tags: @@ -37527,46 +31615,38 @@ paths: 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: "" + description: UserGroupUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: description: The updated UserGroupUpdateController resource content: @@ -37583,7 +31663,6 @@ paths: example: "\n\n\t
\n\n" required: false - deprecated: false /user/groups/{path}/roles: get: operationId: ibexa.rest.load_role_assignments_for_user_group @@ -37619,16 +31698,13 @@ paths: parameters: - name: path in: path - description: "" + description: RoleAssignmentForUserGroupListController 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 tags: @@ -37694,23 +31770,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: path in: path - description: "" + description: RoleAssignToUserGroupController 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: @@ -37745,7 +31817,6 @@ paths: required: false - deprecated: false /user/groups/{path}/roles/{roleId}: get: operationId: ibexa.rest.load_role_assignment_for_user_group @@ -37780,27 +31851,22 @@ paths: parameters: - name: path in: path - description: "" + description: RoleAssignmentForUserGroupLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - 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 delete: operationId: ibexa.rest.unassign_role_from_user_group tags: @@ -37854,35 +31920,28 @@ 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: path in: path - description: "" + description: RoleUnassignFromUserGroupController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: roleId in: path - description: "" + description: RoleUnassignFromUserGroupController identifier 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 @@ -38144,31 +32203,26 @@ paths: 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: UserSubGroupListController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false post: operationId: api_usergroups_pathsubgroups_post tags: - User Group responses: 201: - description: "201" + description: Created - the User Group has been created. content: application/vnd.ibexa.api.UserGroup+json: schema: @@ -38340,34 +32394,28 @@ paths: 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: "" + description: UserGroupCreateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: description: The new UserGroupCreateController resource content: @@ -38408,7 +32456,6 @@ paths: required: false - deprecated: false /user/groups/{path}/users: get: operationId: api_usergroups_pathusers_get @@ -38457,31 +32504,26 @@ paths: 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: UserGroupUsersListController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false post: operationId: api_usergroups_pathusers_post tags: - User Group responses: 201: - description: "201" + description: Created - the User has been created. content: application/vnd.ibexa.api.User+json: schema: @@ -38711,34 +32753,28 @@ paths: description: If set, the new User is returned in XML or JSON format. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: Content-Type in: header description: The UserCreate schema encoded in XML or JSON format. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: path in: path - description: "" + description: UserCreateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: description: The new UserCreateController resource content: @@ -38806,7 +32842,6 @@ paths: required: false - deprecated: false /user/policies: get: operationId: ibexa.rest.list_policies_for_user @@ -38940,7 +32975,6 @@ paths: summary: List Policies for User description: Search all Policies which are applied to a given User. parameters: [] - deprecated: false /user/roles: get: operationId: ibexa.rest.list_roles @@ -39040,7 +33074,6 @@ paths: summary: Load Roles description: Returns a list of all Roles. parameters: [] - deprecated: false post: operationId: ibexa.rest.create_role tags: @@ -39082,12 +33115,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 RoleInput schema encoded in XML or JSON. content: @@ -39106,7 +33137,6 @@ paths: NewRole required: false - deprecated: false /user/roles/{id}: get: operationId: ibexa.rest.load_role @@ -39148,24 +33178,19 @@ paths: description: ETag required: false deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: id in: path - description: "" + description: RoleLoadByIdController 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 tags: @@ -39205,28 +33230,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: id in: path - description: "" + description: RoleDraftCreateController 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 tags: @@ -39245,24 +33265,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: id in: path - description: "" + description: RoleDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false patch: operationId: ibexa.rest.update_role tags: @@ -39307,35 +33322,29 @@ 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: If-Match in: header description: ETag Causes to patch only if the specified ETag is the current one. Otherwise a 412 is returned. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: id in: path - description: "" + description: RoleUpdateController 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. content: @@ -39354,7 +33363,6 @@ paths: NewIdentifier required: false - deprecated: false /user/roles/{id}/draft: get: operationId: ibexa.rest.load_role_draft @@ -39396,24 +33404,19 @@ paths: description: ETag required: false deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: id in: path - description: "" + description: RoleDraftLoadByRoleIdController identifier 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: @@ -39431,24 +33434,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: id in: path - description: "" + description: RoleDraftDeleteController 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 tags: @@ -39495,35 +33493,29 @@ 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: If-Match in: header description: Performs a PATCH only if the specified ETag is the current one. Otherwise a 412 is returned. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: id in: path - description: "" + description: RoleDraftUpdateController 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. content: @@ -39542,7 +33534,6 @@ paths: UpdatedIdentifier required: false - deprecated: false /user/roles/{id}/policies: get: operationId: ibexa.rest.load_policies @@ -39680,16 +33671,13 @@ paths: parameters: - name: id in: path - description: "" + description: RolePolicyListController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false post: operationId: ibexa.rest.add_policy tags: @@ -39744,23 +33732,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: id in: path - description: "" + description: RolePolicyCreateController 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: @@ -39789,7 +33773,6 @@ paths: required: false - deprecated: false delete: operationId: ibexa.rest.delete_policies tags: @@ -39807,24 +33790,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: id in: path - description: "" + description: RolePolicyDeleteAllFromRoleController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false /user/roles/{roleId}/policies/{policyId}: get: operationId: ibexa.rest.load_policy @@ -39879,35 +33857,28 @@ paths: description: ETag required: false deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: policyId in: path - description: "" + description: RolePolicyLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: roleId in: path description: RolePolicyLoadByIdController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false delete: operationId: ibexa.rest.delete_policy tags: @@ -39927,35 +33898,28 @@ 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: policyId in: path - description: "" + description: RolePolicyDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: roleId in: path description: RolePolicyDeleteController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false patch: operationId: ibexa.rest.update_policy tags: @@ -40014,46 +33978,38 @@ 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: 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: "" + description: RolePolicyUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: roleId in: path description: RolePolicyUpdateController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: description: If set, the updated Policy is returned in XML or JSON format. content: @@ -40080,7 +34036,6 @@ paths: required: false - deprecated: false /user/sessions: post: operationId: api_usersessions_post @@ -40156,46 +34111,38 @@ paths: description: If set, the session is returned in XML or JSON format. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: Content-Type in: header description: The SessionInput schema encoded in XML or JSON format. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: Cookie in: header description: Only needed for session's checking {sessionName}={sessionID}. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: X-CSRF-Token in: header description: Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: description: The new SessionCreateController resource content: @@ -40216,7 +34163,6 @@ paths: secret required: false - deprecated: false /user/sessions/current: get: operationId: api_usersessionscurrent_get @@ -40259,24 +34205,19 @@ paths: description: Only needed for session's checking {sessionName}={sessionID}. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: Accept in: header description: If set, the session is returned in XML or JSON format. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - deprecated: false /user/sessions/{sessionId}: delete: operationId: api_usersessions_sessionId_delete @@ -40295,35 +34236,28 @@ paths: description: '{sessionName}={sessionID}' required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: X-CSRF-Token in: header description: The {csrfToken} needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: sessionId in: path - description: "" + description: SessionDeleteController 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 @@ -40331,7 +34265,7 @@ paths: - User Session responses: 200: - description: "200" + description: OK - session refreshed. content: application/vnd.ibexa.api.Session+json: schema: @@ -40367,50 +34301,41 @@ paths: description: '{sessionName}={sessionID}' required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: X-CSRF-Token in: header description: The {csrfToken} needed on all unsafe HTTP methods with session. required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: Accept in: header description: "" required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false - name: sessionId in: path - description: "" + description: SessionRefreshController identifier required: true deprecated: false - allowEmptyValue: false schema: type: string style: simple explode: false - allowReserved: false requestBody: description: The new SessionRefreshController resource content: [] required: false - deprecated: false /user/token/jwt: post: operationId: api_usertokenjwt_post @@ -40445,7 +34370,6 @@ paths: username: admin password: publish required: false - deprecated: false /views: post: operationId: ibexa.rest.views.create @@ -40539,12 +34463,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 view input in XML or JSON format. content: @@ -40601,7 +34523,6 @@ paths: required: false - deprecated: false components: schemas: BaseObject: @@ -45325,1517 +39246,939 @@ components: type: integer languages: type: array - items: - type: string - ProductListGetWrapper: - type: object - required: - - ProductListGet - properties: - ProductListGet: - $ref: '#/components/schemas/ProductListGet' - ProductGet: - description: This class represents a product GET. - type: object - required: - - languages - properties: - languages: - type: array - items: - type: string - ProductGetWrapper: - type: object - required: - - ProductGet - properties: - ProductGet: - $ref: '#/components/schemas/ProductGet' - ProductFilter: - type: object - required: - - name - properties: - name: - type: string - ProductFilterList: - description: This class represents a product filter list. - type: object - required: - - ProductFilter - properties: - ProductFilter: - type: array - items: - $ref: '#/components/schemas/ProductFilter' - ProductFilterListWrapper: - type: object - required: - - ProductFilterList - properties: - ProductFilterList: - $ref: '#/components/schemas/ProductFilterList' - Price: - allOf: - - $ref: '#/components/schemas/BaseObject' - - description: This class represents a price. - type: object - required: - - amount - - Currency - properties: - amount: - type: string - base_amount: - type: string - Currency: - $ref: '#/components/schemas/Currency' - money: - type: string - base_money: - type: string - PriceWrapper: - type: object - required: - - Price - properties: - Price: - $ref: '#/components/schemas/Price' - PriceCreateStruct: - description: This class represents a price creation structure. - type: object - required: - - amount - - currency - properties: - amount: - type: integer - currency: - type: string - PriceCreateStructWrapper: - type: object - required: - - PriceCreateStruct - properties: - PriceCreateStruct: - $ref: '#/components/schemas/PriceCreateStruct' - RestPrice: - type: object - required: - - Price - - formatted - properties: - Price: - $ref: '#/components/schemas/Price' - formatted: - type: string - RestPriceWrapper: - allOf: - - $ref: '#/components/schemas/BaseObject' - - type: object - required: - - RestPrice - properties: - RestPrice: - $ref: '#/components/schemas/RestPrice' - CustomPrice: - allOf: - - $ref: '#/components/schemas/BaseObject' - - description: This class represents a custom price. - type: object - required: - - amount - - base_amount - - Currency - - money - - base_money - - custom_money - - custom_amount - properties: - amount: - type: string - base_amount: - type: string - Currency: - $ref: '#/components/schemas/Currency' - money: - type: string - base_money: - type: string - custom_money: - type: string - custom_amount: - type: string - custom_rule: - type: - - string - - "null" - CustomPriceWrapper: - type: object - required: - - CustomPrice - properties: - CustomPrice: - $ref: '#/components/schemas/CustomPrice' - CustomPriceCreateStruct: - description: This class represents a custom price creation structure. - type: object - required: - - amount - - currency - - customAmount - - customerGroup - properties: - amount: - type: integer - currency: - type: string - customAmount: - type: integer - customerGroup: - type: string - CustomPriceCreateStructWrapper: - type: object - required: - - CustomPriceCreateStruct - properties: - CustomPriceCreateStruct: - $ref: '#/components/schemas/CustomPriceCreateStruct' - CustomPriceUpdateStruct: - description: This class represents a custom price updating structure. - type: object - required: - - amount - - currency - - customAmount - properties: - amount: - type: integer - currency: - type: string - customAmount: - type: integer - CustomPriceUpdateStructWrapper: - type: object - required: - - CustomPriceUpdateStruct - properties: - CustomPriceUpdateStruct: - $ref: '#/components/schemas/CustomPriceUpdateStruct' - PriceUpdateStruct: - description: This class represents a price updating structure. - type: object - required: - - amount - - currency - properties: - amount: - type: integer - currency: - type: string - PriceUpdateStructWrapper: - type: object - required: - - PriceUpdateStruct - properties: - PriceUpdateStruct: - $ref: '#/components/schemas/PriceUpdateStruct' - PriceList: - description: This class represents a price list. - type: object - required: - - prices - properties: - prices: - type: array - items: - $ref: '#/components/schemas/Price' - PriceListWrapper: - type: object - required: - - PriceList - properties: - PriceList: - $ref: '#/components/schemas/PriceList' - Thumbnail: - description: This class represents a thumbnail that can be a target URL or a - Base64 data. - type: object - required: - - resource - - width - - height - - mimeType - properties: - resource: - type: string - width: - type: - - integer - - "null" - height: - type: - - integer - - "null" - mimeType: - type: string - VatCategory: - description: This class represents a VAT category. - type: object - required: - - identifier - - region - - vatValue - properties: - identifier: - type: string - region: - type: string - vatValue: - type: - - number - - "null" - VatCategoryWrapper: - type: object - required: - - VatCategory - properties: - VatCategory: - $ref: '#/components/schemas/VatCategory' - VatCategoryList: - description: This class represents a VAT category list. - type: object - required: - - VatCategory - properties: - VatCategory: - type: array - items: - $ref: '#/components/schemas/VatCategory' - VatCategoryListWrapper: - type: object - required: - - VatCategoryList - properties: - VatCategoryList: - $ref: '#/components/schemas/VatCategoryList' - VatCategorySummary: - allOf: - - $ref: '#/components/schemas/BaseObject' - - description: This class represents a VAT category summary. - type: object - required: - - VatCategory - - RestPrice - properties: - VatCategory: - $ref: '#/components/schemas/VatCategory' - RestPrice: - $ref: '#/components/schemas/RestPrice' - TaxonomyEntry: - allOf: - - $ref: '#/components/schemas/BaseObject' - - description: This class represents a taxonomy entry. - type: object - required: - - id - - identifier - - name - - content - - taxonomy - properties: - id: - type: integer - identifier: - type: string - name: - type: string - content: - $ref: '#/components/schemas/Ref' - taxonomy: - type: string - TaxonomyEntryWrapper: - type: object - required: - - TaxonomyEntry - properties: - TaxonomyEntry: - $ref: '#/components/schemas/TaxonomyEntry' - TaxonomyEntryBulkRemove: - description: This class is used to bulk remove taxonomy entries. - type: object - required: - - entries - properties: - entries: - type: array - items: - type: integer - TaxonomyEntryBulkRemoveWrapper: - type: object - required: - - TaxonomyEntryBulkRemove - properties: - TaxonomyEntryBulkRemove: - $ref: '#/components/schemas/TaxonomyEntryBulkRemove' - TaxonomyEntryMove: - type: object - required: - - entry - - sibling - - position - properties: - entry: - type: integer - sibling: - type: integer - position: - type: string - TaxonomyEntryBulkMove: - description: This class is used to bulk move taxonomy entries. - type: object - required: - - entries - properties: - entries: - type: array - items: - $ref: '#/components/schemas/TaxonomyEntryMove' - TaxonomyEntryBulkMoveWrapper: - type: object - required: - - TaxonomyEntryBulkMove - properties: - TaxonomyEntryBulkMove: - $ref: '#/components/schemas/TaxonomyEntryBulkMove' - TaxonomyEntryAssignment: - description: This class represents a taxonomy entry assignment. - type: object - required: - - id - - content - - entry - properties: - id: - type: integer - content: - allOf: - - $ref: '#/components/schemas/BaseObject' - - type: object - required: - - Content - properties: - Content: - $ref: '#/components/schemas/Content' - entry: - allOf: - - $ref: '#/components/schemas/BaseObject' - - type: object - required: - - TaxonomyEntry - properties: - TaxonomyEntry: - $ref: '#/components/schemas/TaxonomyEntry' - TaxonomyEntryAssignmentWrapper: + items: + type: string + ProductListGetWrapper: type: object required: - - TaxonomyEntryAssignment + - ProductListGet properties: - TaxonomyEntryAssignment: - $ref: '#/components/schemas/TaxonomyEntryAssignment' - TaxonomyEntryAssignToContent: - description: This class is used to assign taxonomy entry to content. + ProductListGet: + $ref: '#/components/schemas/ProductListGet' + ProductGet: + description: This class represents a product GET. type: object required: - - content - - entries + - languages properties: - content: - type: integer - entries: + languages: type: array items: - type: integer - TaxonomyEntryAssignToContentWrapper: + type: string + ProductGetWrapper: type: object required: - - TaxonomyEntryAssignToContent + - ProductGet properties: - TaxonomyEntryAssignToContent: - $ref: '#/components/schemas/TaxonomyEntryAssignToContent' - TaxonomyEntryUnassignFromContent: - description: This class is used to unassign taxonomy entry from content. + ProductGet: + $ref: '#/components/schemas/ProductGet' + ProductFilter: type: object required: - - content - - entries + - name properties: - content: - type: integer - entries: - type: array - items: - type: integer - TaxonomyEntryUnassignFromContentWrapper: + name: + type: string + ProductFilterList: + description: This class represents a product filter list. type: object required: - - TaxonomyEntryUnassignFromContent + - ProductFilter 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: + ProductFilter: + type: array + items: + $ref: '#/components/schemas/ProductFilter' + ProductFilterListWrapper: type: object required: - - EntryAssignmentCollection + - ProductFilterList properties: - EntryAssignmentCollection: - $ref: '#/components/schemas/EntryAssignmentCollection' - Segment: + ProductFilterList: + $ref: '#/components/schemas/ProductFilterList' + Price: allOf: - $ref: '#/components/schemas/BaseObject' - - description: This class represents a segment. + - description: This class represents a price. type: object required: - - id - - identifier - - name - - source - - SegmentGroup + - amount + - Currency properties: - id: - type: integer - identifier: - type: string - name: + amount: type: string - source: + base_amount: type: string - lastUpdatedBy: + Currency: + $ref: '#/components/schemas/Currency' + money: type: string - nullable: true - updatedAt: + base_money: type: string - format: date-time - nullable: true - SegmentGroup: - $ref: '#/components/schemas/SegmentGroup' - SegmentWrapper: + PriceWrapper: type: object required: - - Segment + - Price 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: + Price: + $ref: '#/components/schemas/Price' + PriceCreateStruct: + description: This class represents a price creation structure. type: object required: - - SegmentList + - amount + - currency 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: + amount: + type: integer + currency: + type: string + PriceCreateStructWrapper: type: object required: - - SegmentGroup + - PriceCreateStruct 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: + PriceCreateStruct: + $ref: '#/components/schemas/PriceCreateStruct' + RestPrice: 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 + - Price + - formatted properties: - id: - type: integer - identifier: - type: string - name: - type: string - source: - type: string - lastUpdatedBy: - type: string - nullable: true - updatedAt: + Price: + $ref: '#/components/schemas/Price' + formatted: 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. + RestPriceWrapper: allOf: - $ref: '#/components/schemas/BaseObject' - type: object + required: + - RestPrice properties: - UserSegment: - type: array - items: - $ref: '#/components/schemas/UserSegment' - UserSegmentListWrapper: - type: object - required: - - UserSegmentList - properties: - UserSegmentList: - $ref: '#/components/schemas/SegmentList' - UserSegmentAssignInput: - type: object - properties: - segments: - type: array - items: - type: string - UserSegmentAssignInputWrapper: - type: object - required: - - UserSegmentAssignInput - properties: - UserSegmentAssignInput: - $ref: '#/components/schemas/UserSegmentAssignInput' - CorporateAccountRoot: - description: This class represents Corporate Account Root resource information. - type: object - required: - - links - properties: - links: - xml: - wrapped: false - type: array - items: - $ref: '#/components/schemas/Link' - CorporateAccountRootWrapper: - type: object - required: - - CorporateAccountRoot - properties: - CorporateAccountRoot: - $ref: '#/components/schemas/CorporateAccountRoot' - Link: + RestPrice: + $ref: '#/components/schemas/RestPrice' + CustomPrice: allOf: - $ref: '#/components/schemas/BaseObject' - - description: This class represents REST resource information. + - description: This class represents a custom price. type: object required: - - _rel + - amount + - base_amount + - Currency + - money + - base_money + - custom_money + - custom_amount properties: - _rel: - description: Unique identifier of a resource. - xml: - attribute: true - name: rel + amount: type: string - Company: - description: This class represents a company. + 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: - - id - - name - - Content - - billingAddress - - contactId - - salesRepresentativeId - - defaultAddressId - - addressBookId - - membersId - - MemberList - - Location - - locationPath - - isActive + - CustomPrice properties: - id: + CustomPrice: + $ref: '#/components/schemas/CustomPrice' + CustomPriceCreateStruct: + description: This class represents a custom price creation structure. + type: object + required: + - amount + - currency + - customAmount + - customerGroup + properties: + amount: type: integer - name: + currency: 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. + customAmount: 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. + customerGroup: type: string - isActive: - type: boolean - CompanyWrapper: + CustomPriceCreateStructWrapper: type: object required: - - Company + - CustomPriceCreateStruct properties: - Company: - $ref: '#/components/schemas/Company' - CompanyCreate: - description: This class is used to create a company. + CustomPriceCreateStruct: + $ref: '#/components/schemas/CustomPriceCreateStruct' + CustomPriceUpdateStruct: + description: This class represents a custom price updating structure. type: object required: - - fields + - amount + - currency + - customAmount properties: - fields: - type: object - required: - - field - properties: - field: - description: Fields of a Company content item. - type: array - items: - $ref: '#/components/schemas/Field' - CompanyCreateWrapper: + amount: + type: integer + currency: + type: string + customAmount: + type: integer + CustomPriceUpdateStructWrapper: type: object required: - - CompanyCreate + - CustomPriceUpdateStruct properties: - CompanyCreate: - $ref: '#/components/schemas/CompanyCreate' - CompanyUpdate: - description: This class is used to update a Company. + CustomPriceUpdateStruct: + $ref: '#/components/schemas/CustomPriceUpdateStruct' + PriceUpdateStruct: + description: This class represents a price updating structure. type: object required: - - fields + - amount + - currency properties: - fields: - type: object - required: - - field - properties: - field: - description: Fields of a Company content item. - type: array - items: - $ref: '#/components/schemas/Field' - CompanyUpdateWrapper: + amount: + type: integer + currency: + type: string + PriceUpdateStructWrapper: type: object required: - - CompanyUpdate + - PriceUpdateStruct properties: - CompanyUpdate: - $ref: '#/components/schemas/CompanyUpdate' - CompanyList: - description: This class represents a list of companies. + PriceUpdateStruct: + $ref: '#/components/schemas/PriceUpdateStruct' + PriceList: + description: This class represents a price list. type: object required: - - companies + - prices properties: - companies: + prices: type: array items: - $ref: '#/components/schemas/Company' - CompanyListWrapper: - type: object - required: - - CompanyList - properties: - CompanyList: - $ref: '#/components/schemas/CompanyList' - Member: - description: This class represents a company member. - type: object - required: - - id - - name - - Company - - User - - Role - properties: - id: - type: integer - name: - type: string - Company: - $ref: '#/components/schemas/Company' - User: - description: Underlying User object of a member. - $ref: '#/components/schemas/User' - Role: - description: Reference to the member role in a Company resource. - $ref: '#/components/schemas/BaseObject' - MemberWrapper: - type: object - required: - - Member - properties: - Member: - $ref: '#/components/schemas/Member' - MemberCreate: - description: This class is used to create a member. + $ref: '#/components/schemas/Price' + PriceListWrapper: type: object required: - - login - - email - - password - - Role - - fields + - PriceList properties: - login: - type: string - email: - type: string - password: - type: string - Role: - description: Reference to a Role resource company member should be given. - $ref: '#/components/schemas/BaseObject' - fields: - type: object - required: - - field - properties: - field: - description: Fields of a Member content item. - type: array - items: - $ref: '#/components/schemas/Field' - MemberCreateWrapper: + 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: - - MemberCreate + - resource + - width + - height + - mimeType properties: - MemberCreate: - $ref: '#/components/schemas/MemberCreate' - MemberUpdate: - description: This class is used to update a member. + resource: + type: string + width: + type: + - integer + - "null" + height: + type: + - integer + - "null" + mimeType: + type: string + VatCategory: + description: This class represents a VAT category. type: object required: - - email - - password - - enabled - - maxLogin - - Role - - fields + - identifier + - region + - vatValue properties: - email: + identifier: type: string - password: + region: type: string - enabled: - type: boolean - maxLogin: - description: Max number of failed login attempts. - type: integer - Role: - description: Reference to a Role resource company member should be given. - $ref: '#/components/schemas/BaseObject' - fields: - type: object - required: - - field - properties: - field: - description: Fields of a Member content item. - type: array - items: - $ref: '#/components/schemas/Field' - MemberUpdateWrapper: + vatValue: + type: + - number + - "null" + VatCategoryWrapper: type: object required: - - MemberUpdate + - VatCategory properties: - MemberUpdate: - $ref: '#/components/schemas/MemberUpdate' - MemberList: - description: This class represents a list of company members. + VatCategory: + $ref: '#/components/schemas/VatCategory' + VatCategoryList: + description: This class represents a VAT category list. type: object required: - - members + - VatCategory properties: - members: + VatCategory: type: array items: - $ref: '#/components/schemas/Member' - MemberListWrapper: + $ref: '#/components/schemas/VatCategory' + VatCategoryListWrapper: type: object required: - - MemberList + - VatCategoryList properties: - MemberList: - $ref: '#/components/schemas/MemberList' - SalesRepresentativesList: + VatCategoryList: + $ref: '#/components/schemas/VatCategoryList' + VatCategorySummary: allOf: - $ref: '#/components/schemas/BaseObject' - - description: This class represents a list of sales representatives. + - description: This class represents a VAT category summary. type: object required: - - users + - VatCategory + - RestPrice properties: - users: - type: array - items: - $ref: '#/components/schemas/User' - SalesRepresentativesListWrapper: + 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: - - SalesRepresentativesList + - TaxonomyEntry properties: - SalesRepresentativesList: - $ref: '#/components/schemas/SalesRepresentativesList' - BillingAddress: + TaxonomyEntry: + $ref: '#/components/schemas/TaxonomyEntry' + TaxonomyEntryBulkRemove: + description: This class is used to bulk remove taxonomy entries. type: object required: - - name - - country - - fields + - entries properties: - name: - type: - - string - - "null" - country: - type: - - string - - "null" - fields: - type: - - object - - array - ActivityLog: - description: This class represents an activity log entry. + entries: + type: array + items: + type: integer + TaxonomyEntryBulkRemoveWrapper: type: object - ActivityLogGroup: + required: + - TaxonomyEntryBulkRemove + properties: + TaxonomyEntryBulkRemove: + $ref: '#/components/schemas/TaxonomyEntryBulkRemove' + TaxonomyEntryMove: type: object required: - - user_id - - logged_at - - ActivityLogEntries + - entry + - sibling + - position properties: - user_id: - description: The ID of the user performing the logged actions + entry: type: integer - logged_at: - description: Timestamp representing when the group has been logged + sibling: type: integer - ActivityLogEntries: - description: Log entries from the group + position: + type: string + TaxonomyEntryBulkMove: + description: This class is used to bulk move taxonomy entries. + type: object + required: + - entries + properties: + entries: type: array items: - $ref: '#/components/schemas/ActivityLog' - ActivityLogGroupListInput: - description: This class represents the activity log group search query's criteria - and sort clauses. + $ref: '#/components/schemas/TaxonomyEntryMove' + TaxonomyEntryBulkMoveWrapper: + type: object + required: + - TaxonomyEntryBulkMove + properties: + TaxonomyEntryBulkMove: + $ref: '#/components/schemas/TaxonomyEntryBulkMove' + TaxonomyEntryAssignment: + description: This class represents a taxonomy entry assignment. type: object + required: + - id + - content + - entry properties: - 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 + id: type: integer - criteria: - description: Search criteria for activity log groups - type: array - items: - description: Search criterion for activity log groups - type: object + content: + allOf: + - $ref: '#/components/schemas/BaseObject' + - type: object required: - - type + - Content 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 + Content: + $ref: '#/components/schemas/Content' + entry: + allOf: + - $ref: '#/components/schemas/BaseObject' + - type: object required: - - type + - TaxonomyEntry 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: + TaxonomyEntry: + $ref: '#/components/schemas/TaxonomyEntry' + TaxonomyEntryAssignmentWrapper: type: object required: - - ActivityLogGroupListInput + - TaxonomyEntryAssignment properties: - ActivityLogGroupListInput: - $ref: '#/components/schemas/ActivityLogGroupListInput' - ActivityLogGroupList: - description: This class represents activity log context groups + TaxonomyEntryAssignment: + $ref: '#/components/schemas/TaxonomyEntryAssignment' + TaxonomyEntryAssignToContent: + description: This class is used to assign taxonomy entry to content. type: object required: - - ActivityLogGroups + - content + - entries properties: - ActivityLogGroups: + content: + type: integer + entries: type: array items: - $ref: '#/components/schemas/ActivityLogGroup' - ActivityLogGroupListWrapper: + type: integer + TaxonomyEntryAssignToContentWrapper: type: object required: - - ActivityLogGroupList + - TaxonomyEntryAssignToContent properties: - ActivityLogGroupList: - $ref: '#/components/schemas/ActivityLogGroupList' - Cart: - description: This class represents a Cart + TaxonomyEntryAssignToContent: + $ref: '#/components/schemas/TaxonomyEntryAssignToContent' + TaxonomyEntryUnassignFromContent: + description: This class is used to unassign taxonomy entry from content. type: object required: - - id - - identifier - - owner - - Currency + - content - entries properties: - id: - description: Cart ID + content: type: integer - identifier: - description: Cart unique identifier - type: string - owner: - description: User reference - $ref: '#/components/schemas/Ref' - Currency: - $ref: '#/components/schemas/Currency' entries: type: array items: - $ref: '#/components/schemas/CartEntry' - CartWrapper: + type: integer + TaxonomyEntryUnassignFromContentWrapper: type: object required: - - Cart + - TaxonomyEntryUnassignFromContent properties: - Cart: - $ref: '#/components/schemas/Cart' - CartCreate: - description: This class represents a new Cart to create + 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: - - name - - currencyCode + - EntryAssignmentCollection properties: - name: - description: the name of the new Cart + EntryAssignmentCollection: + $ref: '#/components/schemas/EntryAssignmentCollection' + BulkTranslationSetupSectionInput: + type: object + properties: + search: type: string - currencyCode: - description: the currency code such as `EUR` + default: "" + contentType: type: string - context: - description: associative array of scalars describing additional, contextual - data attached to the cart - type: object - CartCreateWrapper: + default: "" + page: + type: integer + minimum: 1 + default: 1 + BulkTranslationSetupActionResource: type: object required: - - CartCreate + - href + - method + - enabled properties: - CartCreate: - $ref: '#/components/schemas/CartCreate' - CartProduct: - description: This class represents a cart entry product + href: + type: string + method: + type: string + enabled: + type: boolean + BulkTranslationSetupLanguageChoiceResource: type: object required: - code + - name properties: code: - description: product's code type: string - CartView: - description: This class represents a cart view. + name: + type: string + BulkTranslationSetupProviderChoiceResource: type: object required: - identifier - - Result + - name properties: identifier: type: string - Result: - $ref: '#/components/schemas/CartListViewResult' - CartViewWrapper: - type: object - required: - - CartView - properties: - CartView: - $ref: '#/components/schemas/CartView' - CartViewInput: - description: This class represents a cart view input. + name: + type: string + BulkTranslationSetupContentTypeChoiceResource: type: object required: - identifier - - CartQuery + - name properties: identifier: type: string - CartQuery: - $ref: '#/components/schemas/CartViewInput' - CartViewInputWrapper: - type: object - required: - - CartViewInput - properties: - CartViewInput: - $ref: '#/components/schemas/CartViewInput' - CartQuery: + name: + type: string + BulkTranslationSetupRowResource: type: object required: - - offset - - limit - - ownerId + - id + - name + - contentTypeIdentifier + - contentTypeName + - duplicated properties: - offset: - type: integer - limit: - type: integer - ownerId: + id: type: integer - CartEntry: + name: + type: string + contentTypeIdentifier: + type: string + contentTypeName: + type: string + duplicated: + type: boolean + BulkTranslationSetupFiltersResource: type: object required: - - identifier - - id - - names - - quantity - - Price + - search + - contentType + - contentTypeChoices properties: - identifier: + search: type: string - id: - type: integer - names: + contentType: + type: string + contentTypeChoices: type: array items: - type: object - quantity: - type: integer - Price: - $ref: '#/components/schemas/Price' - CartEntryAdd: - description: This class represents a cart entry + $ref: '#/components/schemas/BulkTranslationSetupContentTypeChoiceResource' + BulkTranslationSetupPaginationResource: type: object required: - - quantity - - Product + - page + - pageSize + - totalPages properties: - quantity: - description: the quantity of entry items + page: type: integer - Product: - description: product data - context: - description: associative array of scalars describing additional, contextual - data attached to the cart entry - type: object - CartEntryAddWrapper: - type: object - required: - - CartEntryAdd - properties: - CartEntryAdd: - $ref: '#/components/schemas/CartEntryAdd' - CartEntryUpdate: + pageSize: + type: integer + totalPages: + type: integer + BulkTranslationSetupSectionResource: type: object required: - - quantity + - count + - rows + - filters + - pagination properties: - quantity: + count: type: integer - context: - description: associative array of scalars describing additional, contextual - data attached to the cart entry - type: object - CartEntryUpdateWrapper: + rows: + type: array + items: + $ref: '#/components/schemas/BulkTranslationSetupRowResource' + filters: + $ref: '#/components/schemas/BulkTranslationSetupFiltersResource' + pagination: + $ref: '#/components/schemas/BulkTranslationSetupPaginationResource' + BulkTranslationSetupSectionsResource: type: object required: - - CartEntryUpdate + - duplicates + - items properties: - CartEntryUpdate: - $ref: '#/components/schemas/CartEntryUpdate' - CartMetadataUpdate: - description: This class represents the update of cart metadata. + duplicates: + $ref: '#/components/schemas/BulkTranslationSetupSectionResource' + items: + $ref: '#/components/schemas/BulkTranslationSetupSectionResource' + BulkTranslationSetupConfigurationResource: type: object required: - - identifier - - defaultLanguageCode - - names - - descriptions + - sourceLanguage + - sourceLanguageChoices + - targetLanguage + - targetLanguageChoices + - provider + - providerChoices properties: - identifier: + sourceLanguage: type: string - defaultLanguageCode: + sourceLanguageChoices: + type: array + items: + $ref: '#/components/schemas/BulkTranslationSetupLanguageChoiceResource' + targetLanguage: type: string - names: + targetLanguageChoices: type: array items: - $ref: '#/components/schemas/Value' - descriptions: + $ref: '#/components/schemas/BulkTranslationSetupLanguageChoiceResource' + provider: + type: string + providerChoices: type: array items: - $ref: '#/components/schemas/Value' - CartMetadataUpdateWrapper: + $ref: '#/components/schemas/BulkTranslationSetupProviderChoiceResource' + BulkTranslationSetupSummaryResource: type: object required: - - CartMetadataUpdate + - totalItems + - duplicates + - itemsToTranslate properties: - CartMetadataUpdate: - $ref: '#/components/schemas/CartMetadataUpdate' - CartSummary: - description: This class represents a cart summary. + totalItems: + type: integer + duplicates: + type: integer + itemsToTranslate: + type: integer + BulkTranslationSetupSelectionResource: type: object required: - - id - - identifier - - name - - createdAt - - updatedAt - - Owner - - SummaryEntryCollection - - TotalPrice - - TotalPriceInclVat - - vatCategorySummary - - Currency + - selectedContentIds properties: - id: - type: integer - identifier: - type: string - name: - type: string - createdAt: - type: string - format: date-time - updatedAt: - type: string - format: date-time - Owner: - $ref: '#/components/schemas/Ref' - SummaryEntryCollection: - $ref: '#/components/schemas/SummaryEntryCollection' - TotalPrice: - $ref: '#/components/schemas/RestPriceWrapper' - TotalPriceInclVat: - $ref: '#/components/schemas/RestPriceWrapper' - vatCategorySummary: + selectedContentIds: type: array items: - $ref: '#/components/schemas/VatCategorySummary' - Currency: - $ref: '#/components/schemas/Currency' - CartSummaryWrapper: + type: integer + BulkTranslationSetupActionsResource: type: object required: - - CartSummary + - start properties: - CartSummary: - $ref: '#/components/schemas/CartSummary' - CartListViewResult: + start: + $ref: '#/components/schemas/BulkTranslationSetupActionResource' + BulkTranslationSetupResource: type: object required: - - count - - Result + - configuration + - summary + - sections + - selection + - actions properties: - count: - type: integer - Result: - $ref: '#/components/schemas/CartList' - SummaryEntryCollection: - description: This class represents a summary entry collection. + 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: - - count - - SummaryEntry + - contentId + - name + - contentTypeIdentifier + - contentTypeName + - missingLanguages properties: - count: + contentId: + type: integer + name: type: string - SummaryEntry: - type: array - items: - $ref: '#/components/schemas/SummaryEntry' - ShoppingListEntryIdentifiers: - description: This class represents a list of shopping list entry identifiers - to add to cart - type: object - required: - - entries - properties: - entries: - description: Array of entry identifiers + contentTypeIdentifier: + type: string + contentTypeName: + type: string + missingLanguages: type: array items: - type: object - required: - - identifier - properties: - identifier: - description: Entry identifier - type: string - ShoppingListEntryIdentifiersWrapper: - type: object - required: - - ShoppingListEntryIdentifiers - properties: - ShoppingListEntryIdentifiers: - $ref: '#/components/schemas/ShoppingListEntryIdentifiers' - CartEntryIdentifiers: - description: This class represents a list of cart entry identifiers + type: string + mainLocationId: + type: integer + nullable: true + MissingTranslationsResource: type: object required: - - entries + - totalCount + - page + - limit + - rows properties: - entries: - description: Array of entry identifiers - type: array - items: - type: object - required: - - identifier - properties: - identifier: - description: Entry identifier - type: string - CartEntryIdentifiersWrapper: + totalCount: + type: integer + page: + type: integer + limit: + type: integer + rows: + type: array + items: + $ref: '#/components/schemas/MissingTranslationsRowResource' + MissingTranslationIdsResource: type: object required: - - CartEntryIdentifiers + - ids + - returnedCount + - totalCount + - limited properties: - CartEntryIdentifiers: - $ref: '#/components/schemas/CartEntryIdentifiers' - TimezoneDate: + ids: + type: array + items: + type: integer + returnedCount: + type: integer + totalCount: + type: integer + limited: + type: boolean + BulkTranslationContextResource: type: object required: - - date - - timezone_type - - timezone + - jobItemId + - jobId + - jobItemStatus + - jobCreatorId properties: - date: + jobItemId: + type: integer + jobId: + type: integer + jobItemStatus: + type: string + jobTitle: type: string - timezone_type: + nullable: true + jobCreatorId: type: integer - timezone: + 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 - Order: - description: This class represents order. + 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: - - id - - identifier - - created - - modified - - status - - OrderUser - - OrderCurrency - - OrderValue - - OrderItemsList - - context + - autoTranslationId + - contentId + - versionNo + - sourceLanguageCode + - targetLanguageCode + - providerIdentifier + - reviewStatus + - origin properties: - id: + autoTranslationId: type: integer - identifier: + contentId: + type: integer + contentName: type: string - created: - $ref: '#/components/schemas/TimezoneDate' - modified: - $ref: '#/components/schemas/TimezoneDate' - status: + nullable: true + contentTypeIdentifier: type: string - source: + nullable: true + versionNo: + type: integer + sourceLanguageCode: 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: + 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: - - Order + - totalCount + - page + - limit + - rows properties: - Order: - $ref: '#/components/schemas/Order' - OrderList: - description: This class represents an orders list. + totalCount: + type: integer + page: + type: integer + limit: + type: integer + rows: + type: array + items: + $ref: '#/components/schemas/ReviewItemRowResource' + TranslatedResource: type: object required: - - Order + - totalCount + - page + - limit + - rows properties: - Order: + totalCount: + type: integer + page: + type: integer + limit: + type: integer + rows: type: array items: - $ref: '#/components/schemas/Order' - OrderListWrapper: + $ref: '#/components/schemas/ReviewItemRowResource' + BulkTranslationStartResource: type: object required: - - OrderList + - started + - totalItems + - requestedCount + - acceptedCount + - skippedCount properties: - OrderList: - $ref: '#/components/schemas/OrderList' - OrderUser: - description: This class represents order user. + started: + type: boolean + jobId: + type: integer + nullable: true + totalItems: + type: integer + requestedCount: + type: integer + acceptedCount: + type: integer + skippedCount: + type: integer + HistoryRowResource: type: object required: - id - - name - - email + - title + - createdAt + - targetLanguageCodes + - creatorId + - status + - totalItems + - successfulItems + - reviewItems + - failedItems properties: id: - type: - - "null" - - integer - name: + type: integer + title: type: string - email: + description: The job title, or a "#" label when the job was created + without one. + createdAt: type: string - OrderCurrency: - description: This class represents order currency. - type: object - required: - - id - - code - properties: - id: + format: date-time + targetLanguageCodes: + type: array + items: + type: string + creatorId: type: integer - code: + creatorName: type: string - OrderValue: - description: This class represents order value. - type: object - required: - - vat - - total_gross - - total_net - properties: - vat: - oneOf: - - type: string - - $ref: '#/components/schemas/OrderPrice' - total_gross: - oneOf: - - type: string - - $ref: '#/components/schemas/OrderPrice' - total_net: - oneOf: - - type: string - - $ref: '#/components/schemas/OrderPrice' - OrderCompany: - description: This class represents order company. + 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: - id @@ -46845,1014 +40188,977 @@ components: type: integer name: type: string - OrderPrice: + HistoryResource: type: object required: - - amount - - currency + - totalCount + - page + - limit + - rows + - creatorChoices properties: - amount: - type: string - currency: - type: string - OrderCreate: - description: This class is used to create order. + totalCount: + type: integer + 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: - - source - - OrderUser - - OrderCurrency - - OrderValue - - OrderCompany - - items + - _media-type + - layouts + - blocks properties: - source: + _media-type: type: string - OrderUser: - $ref: '#/components/schemas/OrderUser' - OrderCurrency: - $ref: '#/components/schemas/OrderCurrency' - OrderValue: - $ref: '#/components/schemas/OrderValue' - OrderCompany: - $ref: '#/components/schemas/OrderCompany' - items: + layouts: + description: Page layouts available for building Pages. type: array items: - $ref: '#/components/schemas/OrderItemWrapper' - OrderCreateWrapper: - type: object - required: - - OrderCreate - properties: - OrderCreate: - $ref: '#/components/schemas/OrderCreate' - OrderItem: - description: This class represents order item. - type: object - required: - - OrderItemValue - - OrderItemProduct - properties: - OrderItemValue: - $ref: '#/components/schemas/OrderItemValue' - OrderItemProduct: - $ref: '#/components/schemas/OrderItemProduct' - quantity: - type: integer - context: - type: object - OrderItemWrapper: + $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 required: - - OrderItem + - PageStructure properties: - OrderItem: - $ref: '#/components/schemas/OrderItem' - OrderItemValue: - description: This class represents order item value. + PageStructure: + $ref: '#/components/schemas/PageStructure' + PageStructureLayout: + description: Page layout, together with the zones it is divided into. type: object required: - - unit_price_gross - - unit_price_net - - vat_rate - - subtotal_price_gross - - subtotal_price_net + - _media-type + - identifier + - name + - description + - zones properties: - unit_price_gross: - oneOf: - - type: string - - $ref: '#/components/schemas/OrderPrice' - unit_price_net: - oneOf: - - type: string - - $ref: '#/components/schemas/OrderPrice' - vat_rate: + _media-type: 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. + 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 required: - - id - - code + - _media-type + - identifier - name + - description properties: - id: - type: integer - code: + _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 - OrderUpdate: - description: This class is used to update order. + PageStructureBlock: + description: Page block, together with its views and attributes. type: object required: - - status - - transition + - _media-type + - identifier + - name + - description + - category + - views + - attributes properties: - status: + _media-type: type: string - transition: + identifier: + description: Unique block identifier, as used in configuration. type: string - OrderUpdateWrapper: - type: object - required: - - OrderUpdate - properties: - OrderUpdate: - $ref: '#/components/schemas/OrderUpdate' - PaymentMethod: + 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/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: - - id + - _media-type - identifier - - enabled - name - description properties: - id: - type: integer + _media-type: + type: string identifier: + description: Unique view identifier within its block. type: string - enabled: - type: boolean name: + description: Human-readable view name. type: string description: + description: Human-readable view description. Empty string when the view + declares no description. type: string - PaymentMethodWrapper: - type: object - required: - - PaymentMethod - properties: - PaymentMethod: - $ref: '#/components/schemas/PaymentMethod' - PaymentMethodCreateStruct: + PageStructureAttribute: + description: Attribute of a Page block. type: object required: + - _media-type - identifier + - name - type - - names + - category + - options properties: + _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 - names: - description: If set this array of names with languageCode keys replace the - complete name collection. - type: object - descriptions: - description: An array of descriptions with languageCode keys. - type: array - items: - type: string - enabled: - type: boolean - options: - type: object - PaymentMethodCreateStructWrapper: - type: object - required: - - PaymentMethodCreateStruct - properties: - PaymentMethodCreateStruct: - $ref: '#/components/schemas/PaymentMethodCreateStruct' - PaymentMethodUpdateStruct: - type: object - properties: - identifier: + category: + description: Identifier of the category the attribute is grouped under in + the block edit form. type: string - names: - description: If set this array of names with languageCode keys replace the - complete name collection. + 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 - descriptions: - description: An array of descriptions with languageCode keys. - type: array - items: + 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 - enabled: - type: boolean - options: - type: array - items: - type: [] - PaymentMethodUpdateStructWrapper: + 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: - - PaymentMethodUpdateStructParser + - Segment properties: - PaymentMethodUpdateStructParser: - $ref: '#/components/schemas/PaymentMethodUpdateStruct' - PaymentMethodView: + Segment: + $ref: '#/components/schemas/Segment' + SegmentList: + allOf: + - $ref: '#/components/schemas/BaseObject' + - description: This class lists segments. + type: object + required: + - Segment + properties: + Segment: + type: array + items: + $ref: '#/components/schemas/Segment' + SegmentListWrapper: type: object required: - - identifier - - Result + - SegmentList properties: - identifier: - type: string - Result: - $ref: '#/components/schemas/PaymentMethodList' - PaymentMethodViewWrapper: + 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: - - PaymentMethodView + - createGroup properties: - PaymentMethodView: - $ref: '#/components/schemas/PaymentMethodView' - PaymentMethodViewInput: + 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 required: - - identifier - - PaymentMethodQuery + - update + - delete + - createSegment properties: - identifier: - type: string - PaymentMethodQuery: - type: object - PaymentMethodViewInputWrapper: + 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: - - PaymentMethodViewInput + - update + - delete properties: - PaymentMethodViewInput: - $ref: '#/components/schemas/PaymentMethodViewInput' - PaymentMethodList: + 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 required: - - count - - PaymentMethodList + - id + - identifier + - name + - permissions properties: - count: + id: type: integer - PaymentMethodList: - type: array - items: - $ref: '#/components/schemas/PaymentMethod' - Shipment: - description: This class represents a single shipment. + identifier: + type: string + 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 - - status - - transitions - - Order - - Amount - - createdAt - - updatedAt - - Owner - - Method + - name + - source + - blocksCount + - permissions properties: id: 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: + source: type: string - format: date-time + 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 + nullable: true + lastUpdatedBy: + type: string + nullable: true updatedAt: type: string format: date-time - Owner: - $ref: '#/components/schemas/Ref' - Method: - $ref: '#/components/schemas/Ref' - ShipmentWrapper: - type: object - required: - - Shipment - properties: - Shipment: - $ref: '#/components/schemas/Shipment' - ShipmentRefList: - description: This class represents a list of Shipments + 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 required: - - shipmentRefList + - group + - segments properties: - shipmentRefList: + group: + $ref: '#/components/schemas/SegmentViewGroupInfo' + segments: type: array items: - $ref: '#/components/schemas/Ref' - ShipmentRefListWrapper: - type: object - required: - - ShipmentRefList - properties: - ShipmentRefList: - $ref: '#/components/schemas/ShipmentRefList' - ShipmentUpdate: - description: This class represents the update of a shipment. + $ref: '#/components/schemas/SegmentViewSegment' + SegmentViewGroupFilterOption: + description: This class represents a segment group filter value with its segment + count. type: object required: + - id - identifier - - transition - - Owner - - Context + - name + - count properties: + id: + type: integer identifier: type: string - transition: + name: type: string - Owner: - $ref: '#/components/schemas/Ref' - Context: - type: object - ShipmentUpdateWrapper: + count: + type: integer + SegmentViewSourceFilterOption: + description: This class represents a segment source filter value with its segment + count. type: object required: - - ShipmentUpdate + - value + - count properties: - ShipmentUpdate: - $ref: '#/components/schemas/ShipmentUpdate' - ShipmentCreate: - description: This class represents the creation of a shipment. + value: + type: string + count: + type: integer + SegmentViewMetadataFilterOption: + description: This class represents a segment metadata value with its segment + count. type: object required: - - identifier - - ShippingMethod - - Owner - - Context + - value + - count properties: - identifier: + value: type: string - ShippingMethod: - $ref: '#/components/schemas/Ref' - Owner: - $ref: '#/components/schemas/Ref' - Context: - type: object - ShipmentCreateWrapper: + count: + type: integer + SegmentViewFilters: + description: This class represents the available filter options of the segment + view. type: object required: - - ShipmentCreate + - groups + - source + - metadata properties: - ShipmentCreate: - $ref: '#/components/schemas/ShipmentCreate' - ShippingMethod: - description: This class represents a shipping method. + 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 required: - - identifier - - name - - names - - description - - descriptions - - enabled - - options - - regions - - type + - totalCount + - permissions + - filters + - groups properties: - identifier: - type: string - name: - type: string - names: - type: object - required: - - value - properties: - value: - type: array - items: - $ref: '#/components/schemas/MultilingualValue' - description: - type: string - descriptions: - type: object - required: - - value - properties: - value: - type: array - items: - $ref: '#/components/schemas/MultilingualValue' - enabled: - type: boolean - options: - type: object - required: - - option - properties: - option: - type: array - items: - $ref: '#/components/schemas/KeyValue' - regions: - type: object - required: - - RegionRefList - properties: - RegionRefList: - type: array - items: - $ref: '#/components/schemas/Ref' - type: - $ref: '#/components/schemas/Ref' - ShippingMethodWrapper: + totalCount: + type: integer + permissions: + $ref: '#/components/schemas/SegmentViewPermissions' + filters: + $ref: '#/components/schemas/SegmentViewFilters' + groups: + type: array + items: + $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: - - ShippingMethod + - SegmentGroup properties: - ShippingMethod: - $ref: '#/components/schemas/ShippingMethod' - ShippingMethodType: - description: This class represents a shipping method type. + 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: - - identifier - - name + - SegmentGroupList + properties: + SegmentGroupList: + $ref: '#/components/schemas/SegmentGroupList' + UserSegment: + description: This class represents a segment and a user it's associate to. + type: object properties: + id: + type: integer identifier: type: string name: type: string - ShippingMethodTypeWrapper: + 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: type: object required: - - ShippingMethodType + - UserSegmentList properties: - ShippingMethodType: - $ref: '#/components/schemas/ShippingMethodType' - ShippingMethodTypesList: - description: This class represents a list of shipping method types. + UserSegmentList: + $ref: '#/components/schemas/SegmentList' + UserSegmentAssignInput: type: object - required: - - ShippingMethodTypes properties: - ShippingMethodTypes: + segments: type: array items: - $ref: '#/components/schemas/ShippingMethodType' - ShippingMethodTypesListWrapper: + type: string + UserSegmentAssignInputWrapper: type: object required: - - ShippingMethodTypesList + - UserSegmentAssignInput properties: - ShippingMethodTypesList: - $ref: '#/components/schemas/ShippingMethodTypesList' - ShippingMethodRefList: - description: This class represents a list of shipping methods + UserSegmentAssignInput: + $ref: '#/components/schemas/UserSegmentAssignInput' + CorporateAccountRoot: + description: This class represents Corporate Account Root resource information. type: object required: - - ShippingMethodRefs + - links properties: - ShippingMethodRefs: + links: + xml: + wrapped: false type: array items: - $ref: '#/components/schemas/Ref' - ShippingMethodRefListWrapper: + $ref: '#/components/schemas/Link' + CorporateAccountRootWrapper: type: object required: - - ShippingMethodRefList + - CorporateAccountRoot properties: - ShippingMethodRefList: - $ref: '#/components/schemas/ShippingMethodRefList' - ExampleSessionCreate: + CorporateAccountRoot: + $ref: '#/components/schemas/CorporateAccountRoot' + Link: + allOf: + - $ref: '#/components/schemas/BaseObject' + - description: This class represents REST resource information. + type: object + required: + - _rel + properties: + _rel: + description: Unique identifier of a resource. + xml: + attribute: true + name: rel + type: string + Company: + description: This class represents a company. type: object - 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 + - id + - name + - Content + - billingAddress + - contactId + - salesRepresentativeId + - defaultAddressId + - addressBookId + - membersId + - MemberList + - Location + - locationPath + - isActive 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: + id: + type: integer + name: + type: string + Content: + $ref: '#/components/schemas/Content' + billingAddress: + $ref: '#/components/schemas/BillingAddress' + contactId: + type: + - integer + - "null" + salesRepresentativeId: + type: integer + defaultAddressId: + type: + - integer + - "null" + addressBookId: + description: Address book Folder Content ID. + type: integer + membersId: + description: Members Folder Content ID. + type: integer + MemberList: + description: Reference to Members List resource. + $ref: '#/components/schemas/BaseObject' + Location: + description: Reference to Location resource. + $ref: '#/components/schemas/BaseObject' + locationPath: + description: Company content item Location path string. + type: string + isActive: + type: boolean + CompanyWrapper: type: object - 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 + - Company 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: + Company: + $ref: '#/components/schemas/Company' + CompanyCreate: + description: This class is used to create a company. type: object - description: Schema for creating a new invitation + required: + - fields properties: - InvitationCreate: + fields: 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 + - field + properties: + field: + description: Fields of a Company content item. + type: array + items: + $ref: '#/components/schemas/Field' + CompanyCreateWrapper: + type: object required: - - InvitationCreate - additionalProperties: false - ParticipantListCreate: + - CompanyCreate + properties: + CompanyCreate: + $ref: '#/components/schemas/CompanyCreate' + CompanyUpdate: + description: This class is used to update a Company. type: object - description: Schema for creating a list of participants + required: + - fields properties: - ParticipantListCreate: + fields: type: object + required: + - field properties: - ParticipantCreate: + field: + description: Fields of a Company content item. 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: + $ref: '#/components/schemas/Field' + CompanyUpdateWrapper: 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 + - CompanyUpdate properties: - _media-type: - type: string - description: Media type identifier for external participant creation - enum: - - application/vnd.ibexa.api.ExternalParticipantCreate+json - email: - type: string - description: Email address of the external participant - format: email - scope: - type: string - description: Permission scope for the participant - enum: - - view - - edit - - admin - required: - - _media-type - - email - - scope - additionalProperties: false - UserReference: + CompanyUpdate: + $ref: '#/components/schemas/CompanyUpdate' + CompanyList: + description: This class represents a list of companies. type: object - description: Reference to a user resource - properties: - _media-type: - type: string - description: Media type identifier for the user reference - enum: - - application/vnd.ibexa.api.User+json - _href: - type: string - description: REST API URL reference to the user resource - format: uri - pattern: ^/api/ibexa/v2/user/users/[0-9]+$ required: - - _media-type - - _href - additionalProperties: false - ExampleSessionWrapper: - type: object - description: Wrapper object containing a collaboration session + - companies properties: - CollaborationSession: - $ref: '#/components/schemas/CollaborationSession' - description: The collaboration session object + companies: + type: array + items: + $ref: '#/components/schemas/Company' + CompanyListWrapper: + type: object required: - - CollaborationSession - additionalProperties: false - CollaborationSession: + - CompanyList + properties: + CompanyList: + $ref: '#/components/schemas/CompanyList' + Member: + description: This class represents a company member. type: object - description: A collaboration session representing a shared workspace for participants + required: + - id + - name + - Company + - User + - Role 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: + name: 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: + Company: + $ref: '#/components/schemas/Company' + User: + description: Underlying User object of a member. + $ref: '#/components/schemas/User' + Role: + description: Reference to the member role in a Company resource. + $ref: '#/components/schemas/BaseObject' + MemberWrapper: type: object - description: Owner of a collaboration session - properties: - _media-type: - type: string - description: Media type identifier for the owner - _href: - type: string - description: REST API URL reference to the owner resource - format: uri required: - - _media-type - - _href - additionalProperties: false - ExternalParticipantWrapper: - type: object - description: Wrapper object containing an external participant + - Member properties: - Participant: - $ref: '#/components/schemas/ExternalParticipant' - description: The external participant object - required: - - Participant - additionalProperties: false - ExternalParticipant: + Member: + $ref: '#/components/schemas/Member' + MemberCreate: + description: This class is used to create a member. type: object - description: An external participant in a collaboration session (not a registered - user) + required: + - login + - email + - password + - Role + - fields properties: - _media-type: - type: string - description: Media type identifier for the external participant - id: - type: integer - description: Unique identifier of the participant - name: - type: string - description: Display name of the external participant - scope: + login: type: string - description: Permission scope for the participant (e.g., 'read', 'write', - 'admin') email: type: string - description: Email address of the external participant - format: email - createdAt: - type: string - description: ISO 8601 timestamp when the participant was added - format: date-time - updatedAt: + password: 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: + 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 - description: Wrapper object containing an internal participant - properties: - Participant: - $ref: '#/components/schemas/InternalParticipant' - description: The internal participant object required: - - Participant - additionalProperties: false - InternalParticipant: + - MemberCreate + properties: + MemberCreate: + $ref: '#/components/schemas/MemberCreate' + MemberUpdate: + description: This class is used to update a member. type: object - description: An internal participant in a collaboration session (registered - user) + required: + - email + - password + - enabled + - maxLogin + - Role + - fields properties: - _media-type: - type: string - description: Media type identifier for the internal participant - id: - type: integer - description: Unique identifier of the participant - name: - type: string - description: Display name of the internal participant - scope: - type: string - description: Permission scope for the participant (e.g., 'read', 'write', - 'admin') - User: - $ref: '#/components/schemas/User' - description: Reference to the associated user account - createdAt: + email: type: string - description: ISO 8601 timestamp when the participant was added - format: date-time - updatedAt: + password: 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: + enabled: + type: boolean + maxLogin: + description: Max number of failed login attempts. + type: integer + Role: + description: Reference to a Role resource company member should be given. + $ref: '#/components/schemas/BaseObject' + fields: + type: object + required: + - field + properties: + field: + description: Fields of a Member content item. + type: array + items: + $ref: '#/components/schemas/Field' + MemberUpdateWrapper: type: object - description: Wrapper object containing a list of participants - properties: - ParticipantList: - $ref: '#/components/schemas/ParticipantListObject' - description: The participant list object required: - - ParticipantList - additionalProperties: false - ParticipantListObject: + - MemberUpdate + properties: + MemberUpdate: + $ref: '#/components/schemas/MemberUpdate' + MemberList: + description: This class represents a list of company members. type: object - description: A list of participants in a collaboration session + required: + - members properties: - _media-type: - type: string - description: Media type identifier for the participant list - Participants: + members: type: array - description: Array of participants in the collaboration session items: - $ref: '#/components/schemas/ParticipantItem' + $ref: '#/components/schemas/Member' + MemberListWrapper: + type: object required: - - _media-type - - Participants - additionalProperties: false - ParticipantItem: + - MemberList + properties: + MemberList: + $ref: '#/components/schemas/MemberList' + SalesRepresentativesList: + allOf: + - $ref: '#/components/schemas/BaseObject' + - description: This class represents a list of sales representatives. + type: object + required: + - users + properties: + users: + type: array + items: + $ref: '#/components/schemas/User' + SalesRepresentativesListWrapper: type: object - description: A participant item that can be either internal or external + required: + - SalesRepresentativesList properties: - _media-type: - type: string - description: Media type identifier for the participant - id: - type: integer - description: Unique identifier of the participant - name: - type: string - description: Display name of the participant - scope: - type: string - description: Permission scope for the participant (e.g., 'read', 'write', - 'admin') - User: - $ref: '#/components/schemas/User' - description: Reference to the associated user account (for internal participants - only) - email: - type: string - description: Email address of the participant (for external participants - only) - format: email - createdAt: - type: string - description: ISO 8601 timestamp when the participant was added - format: date-time - updatedAt: - type: string - description: ISO 8601 timestamp when the participant was last updated - format: date-time + SalesRepresentativesList: + $ref: '#/components/schemas/SalesRepresentativesList' + BillingAddress: + type: object required: - - _media-type - - id - name - - scope - - createdAt - - updatedAt - additionalProperties: false - InvitationWrapper: - type: object - description: Wrapper object containing an invitation + - country + - fields properties: - Invitation: - $ref: '#/components/schemas/Invitation' - description: The invitation object + name: + type: + - string + - "null" + country: + type: + - string + - "null" + fields: + type: + - object + - array + ActivityLog: + description: This class represents an activity log entry. + type: object + ActivityLogGroup: + type: object required: - - Invitation - additionalProperties: false - Invitation: + - 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 - description: An invitation to join a collaboration session properties: - _media-type: - type: string - description: Media type identifier for the invitation - id: + offset: + description: The offset of the first item to return 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 + 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 +41350,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 +41885,78 @@ 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 + description: Resource 'Segmentation' operations. - name: Corporate Account + description: Resource 'Corporate Account' 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: [] ...