diff --git a/docs/api/rest_api/rest_api_reference/input/examples/cart/summary/CartSummary.json.example b/docs/api/rest_api/rest_api_reference/input/examples/cart/summary/CartSummary.json.example new file mode 100644 index 0000000000..41f2a8b2ee --- /dev/null +++ b/docs/api/rest_api/rest_api_reference/input/examples/cart/summary/CartSummary.json.example @@ -0,0 +1,377 @@ +{ + "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": "€1.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": "€123.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": "€200.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": "€246.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": "ezstring", + "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": "ezrichtext", + "fieldValue": { + "xml": "\n
\n", + "xhtml5edit": "\n
\n" + } + }, + { + "id": 303, + "fieldDefinitionIdentifier": "image", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ezimageasset", + "fieldValue": { + "destinationContentId": null, + "alternativeText": null, + "source": null + } + }, + { + "id": 304, + "fieldDefinitionIdentifier": "category", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_taxonomy_entry_assignment", + "fieldValue": { + "taxonomy_entries": [ + 3 + ], + "taxonomy": "product_categories" + } + }, + { + "id": 305, + "fieldDefinitionIdentifier": "field_63bd5d67f1817", + "languageCode": "eng-GB", + "fieldTypeIdentifier": "ibexa_seo", + "fieldValue": "" + } + ] + }, + "Relations": { + "_media-type": "application\/vnd.ibexa.api.RelationList+json", + "_href": "\/api\/ibexa\/v2\/content\/objects\/67\/versions\/1\/relations", + "Relation": [] + }, + "Thumbnail": { + "_media-type": "application\/vnd.ibexa.api.Thumbnail+json", + "resource": "\/placeholder", + "width": null, + "height": null, + "mimeType": "image\/svg+xml" + } + } + }, + "Section": { + "_media-type": "application\/vnd.ibexa.api.Section+json", + "_href": "\/api\/ibexa\/v2\/content\/sections\/1" + }, + "Locations": { + "_media-type": "application\/vnd.ibexa.api.LocationList+json", + "_href": "\/api\/ibexa\/v2\/content\/objects\/67\/locations" + }, + "Owner": { + "_media-type": "application\/vnd.ibexa.api.User+json", + "_href": "\/api\/ibexa\/v2\/user\/users\/14" + }, + "lastModificationDate": "2023-01-10T12:44:41+00:00", + "publishedDate": "2023-01-10T12:44:41+00:00", + "mainLanguageCode": "eng-GB", + "currentVersionNo": 1, + "alwaysAvailable": true, + "isHidden": false, + "status": "PUBLISHED", + "ObjectStates": { + "_media-type": "application\/vnd.ibexa.api.ContentObjectStates+json", + "_href": "\/api\/ibexa\/v2\/content\/objects\/67\/objectstates" + } + }, + "Thumbnail": { + "_media-type": "application\/vnd.ibexa.api.Thumbnail+json", + "resource": "\/placeholder", + "width": null, + "height": null, + "mimeType": "image\/svg+xml" + }, + "created_at": 1673354681, + "updated_at": 1673354681, + "AttributesList": [], + "Availability": { + "_media-type": "application\/vnd.ibexa.api.Availability+json", + "is_available": true, + "stock": 100, + "is_infinite": false + }, + "Price": { + "_media-type": "application\/vnd.ibexa.api.Price+json", + "amount": "100.00", + "base_amount": "100.00", + "Currency": { + "_media-type": "application\/vnd.ibexa.api.Currency+json", + "id": 2, + "code": "EUR", + "subunits": 2, + "enabled": true + }, + "money": "10000", + "base_money": "10000" + } + } + } + ] + }, + "TotalPrice": { + "_media-type": "application\/vnd.ibexa.api.Price+json", + "RestPrice": { + "_media-type": "application\/vnd.ibexa.api.RestPrice+json", + "Price": { + "_media-type": "application\/vnd.ibexa.api.Price+json", + "amount": "20000", + "Currency": { + "_media-type": "application\/vnd.ibexa.api.Currency+json", + "id": 2, + "code": "EUR", + "subunits": 2, + "enabled": true + } + }, + "formatted": "€200.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": "€246.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": "€46.00" + } + } + ], + "Currency": { + "_media-type": "application\/vnd.ibexa.api.Currency+json", + "id": 2, + "code": "EUR", + "subunits": 2, + "enabled": true + } + } +} diff --git a/docs/api/rest_api/rest_api_reference/input/examples/cart/view/CartViewInput.json.example b/docs/api/rest_api/rest_api_reference/input/examples/cart/view/CartViewInput.json.example new file mode 100644 index 0000000000..4d7e162e58 --- /dev/null +++ b/docs/api/rest_api/rest_api_reference/input/examples/cart/view/CartViewInput.json.example @@ -0,0 +1,10 @@ +{ + "CartViewInput": { + "identifier": "loadUserCarts", + "CartQuery": { + "offset": 0, + "limit": 10, + "ownerId": 123 + } + } +} diff --git a/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/GET/EntryAssignmentCollection.json.example b/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/GET/EntryAssignmentCollection.json.example new file mode 100644 index 0000000000..1f4da980d3 --- /dev/null +++ b/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/GET/EntryAssignmentCollection.json.example @@ -0,0 +1,118 @@ +{ + "EntryAssignmentCollection": { + "_media-type": "application/vnd.ibexa.api.EntryAssignmentCollection+json", + "content": { + "_media-type": "application/vnd.ibexa.api.Content+json", + "Content": { + "_media-type": "application/vnd.ibexa.api.ContentInfo+json", + "_href": "/api/ibexa/v2/content/objects/1", + "_remoteId": "9459d3c29e15006e45197295722c7ade", + "_id": 1, + "ContentType": { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/1" + }, + "Name": "Ibexa Platform", + "TranslatedName": "Ibexa Platform", + "Versions": { + "_media-type": "application/vnd.ibexa.api.VersionList+json", + "_href": "/api/ibexa/v2/content/objects/1/versions" + }, + "CurrentVersion": { + "_media-type": "application/vnd.ibexa.api.Version+json", + "_href": "/api/ibexa/v2/content/objects/1/currentversion" + }, + "Section": { + "_media-type": "application/vnd.ibexa.api.Section+json", + "_href": "/api/ibexa/v2/content/sections/1" + }, + "Locations": { + "_media-type": "application/vnd.ibexa.api.LocationList+json", + "_href": "/api/ibexa/v2/content/objects/1/locations" + }, + "Owner": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "lastModificationDate": "2023-01-01T00:00:00+00:00", + "publishedDate": "2015-11-30T13:10:46+00:00", + "mainLanguageCode": "eng-GB", + "currentVersionNo": 10, + "alwaysAvailable": true, + "isHidden": false, + "status": "PUBLISHED", + "ObjectStates": { + "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", + "_href": "/api/ibexa/v2/content/objects/1/objectstates" + } + } + }, + "assignments": [ + { + "_media-type": "application/vnd.ibexa.api.TaxonomyEntryAssignment+json", + "id": 1, + "content": { + "_media-type": "application/vnd.ibexa.api.Content+json", + "Content": { + "_media-type": "application/vnd.ibexa.api.ContentInfo+json", + "_href": "/api/ibexa/v2/content/objects/1", + "_remoteId": "9459d3c29e15006e45197295722c7ade", + "_id": 1, + "ContentType": { + "_media-type": "application/vnd.ibexa.api.ContentType+json", + "_href": "/api/ibexa/v2/content/types/1" + }, + "Name": "Ibexa Platform", + "TranslatedName": "Ibexa Platform", + "Versions": { + "_media-type": "application/vnd.ibexa.api.VersionList+json", + "_href": "/api/ibexa/v2/content/objects/1/versions" + }, + "CurrentVersion": { + "_media-type": "application/vnd.ibexa.api.Version+json", + "_href": "/api/ibexa/v2/content/objects/1/currentversion" + }, + "Section": { + "_media-type": "application/vnd.ibexa.api.Section+json", + "_href": "/api/ibexa/v2/content/sections/1" + }, + "Locations": { + "_media-type": "application/vnd.ibexa.api.LocationList+json", + "_href": "/api/ibexa/v2/content/objects/1/locations" + }, + "Owner": { + "_media-type": "application/vnd.ibexa.api.User+json", + "_href": "/api/ibexa/v2/user/users/14" + }, + "lastModificationDate": "2023-01-01T00:00:00+00:00", + "publishedDate": "2015-11-30T13:10:46+00:00", + "mainLanguageCode": "eng-GB", + "currentVersionNo": 10, + "alwaysAvailable": true, + "isHidden": false, + "status": "PUBLISHED", + "ObjectStates": { + "_media-type": "application/vnd.ibexa.api.ContentObjectStates+json", + "_href": "/api/ibexa/v2/content/objects/1/objectstates" + } + } + }, + "entry": { + "_media-type": "application/vnd.ibexa.api.TaxonomyEntry+json", + "TaxonomyEntry": { + "_media-type": "application/vnd.ibexa.api.TaxonomyEntry+json", + "id": 3, + "identifier": "example", + "name": "Example", + "contentId": 65, + "content": { + "_media-type": "application/vnd.ibexa.api.Content+json", + "_href": "/api/ibexa/v2/content/objects/65" + }, + "taxonomy": "tags" + } + } + } + ] + } +} diff --git a/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/GET/EntryAssignmentCollection.xml.example b/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/GET/EntryAssignmentCollection.xml.example new file mode 100644 index 0000000000..08ed4e57a0 --- /dev/null +++ b/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/GET/EntryAssignmentCollection.xml.example @@ -0,0 +1,56 @@ + + + + + + Ibexa Platform + Ibexa Platform + + +
+ + + 2023-01-01T00:00:00+00:00 + 2015-11-30T13:10:46+00:00 + eng-GB + 10 + true + false + PUBLISHED + + + + + 1 + + + + Ibexa Platform + Ibexa Platform + + +
+ + + 2023-01-01T00:00:00+00:00 + 2015-11-30T13:10:46+00:00 + eng-GB + 10 + true + false + PUBLISHED + + + + + + 3 + example + Example + 65 + + tags + + + + \ No newline at end of file diff --git a/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/entries/DELETE/TaxonomyEntryBulkRemove.json.example b/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/entries/DELETE/TaxonomyEntryBulkRemove.json.example new file mode 100644 index 0000000000..d2cb465ee3 --- /dev/null +++ b/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/entries/DELETE/TaxonomyEntryBulkRemove.json.example @@ -0,0 +1,5 @@ +{ + "TaxonomyEntryBulkRemove": { + "entries": [ 2, 3 ] + } +} diff --git a/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/entries/move/POST/TaxonomyEntryBulkMove.json.example b/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/entries/move/POST/TaxonomyEntryBulkMove.json.example new file mode 100644 index 0000000000..a602a973d7 --- /dev/null +++ b/docs/api/rest_api/rest_api_reference/input/examples/taxonomy/entries/move/POST/TaxonomyEntryBulkMove.json.example @@ -0,0 +1,16 @@ +{ + "TaxonomyEntryBulkMove": { + "entries": [ + [ + entry: 2, + sibling: 1, + position: 'next' + ], + [ + entry: 3, + sibling: 1, + position: 'prev' + ], + ] + } +} diff --git a/docs/api/rest_api/rest_api_reference/input/ez-cart.raml b/docs/api/rest_api/rest_api_reference/input/ez-cart.raml new file mode 100644 index 0000000000..25be7609a1 --- /dev/null +++ b/docs/api/rest_api/rest_api_reference/input/ez-cart.raml @@ -0,0 +1,132 @@ +displayName: Managing Commerce carts +post: + displayName: Create Cart + description: Creates Cart from payload. + headers: + Content-Type: + description: The CartCreateStruct schema encoded in XML or JSON format. + example: | + application/vnd.ibexa.api.CartCreateStruct+xml + application/vnd.ibexa.api.CartCreateStruct+json + #body: + # application/vnd.ibexa.api.CartCreateStruct+xml: + # type: CartCreateStruct + # example: !include examples/cart/POST/CartCreateStruct.json.example + #responses: + # 200: + # body: + # application/vnd.ibexa.api.Cart+json: + # type: Cart + # example: !include examples/cart/POST/Cart.json.example + # 400: + # description: Error - The input does not match the input schema definition. +/view: + post: + displayName: Filter carts + description: Executes a query and returns a View including the results. + headers: + Accept: + description: The CartView schema is returned in XML or JSON format. + example: | + application/vnd.ibexa.api.CartView+xml + application/vnd.ibexa.api.CartView+json + Content-Type: + description: The CartViewInput schema is posted in XML or JSON format. + example: | + application/vnd.ibexa.api.CartViewInput+xml + application/vnd.ibexa.api.CartViewInput+json + body: + application/vnd.ibexa.api.CartViewInput+json: + type: CartViewInput + example: !include examples/cart/view/CartViewInput.json.example + responses: + 200: + description: OK - returns a view and its results + #body: + # application/vnd.ibexa.api.CartView+xml: + # application/vnd.ibexa.api.CartView+json: +/{identifier}: + get: + displayName: Get Cart + description: Gets Cart by its identifier. + responses: + 200: + description: OK - return the cart + #body: + # application/vnd.ibexa.api.Cart+json: + # type: Cart + # example: !include examples/cart/POST/Cart.json.example + 401: + description: Error - the user is not authorized to get this cart. + 404: + description: Error - The identifier do not match any Cart. + delete: + displayName: Delete Cart + description: Deletes Cart by its identifier. + patch: + displayName: Update Cart's metadata + description: Updates identified Cart's metadata from payload. + headers: + Content-Type: + description: The CartMetadataUpdateStruct schema encoded in XML or JSON format. + example: | + application/vnd.ibexa.api.CartMetadataUpdateStruct+xml + application/vnd.ibexa.api.CartMetadataUpdateStruct+json + /entry: + post: + displayName: Add Entry to Cart + description: Adds an the posted entry to the cart passed by identifier + headers: + Content-Type: + description: The EntryAddStruct schema encoded in XML or JSON format. + example: | + application/vnd.ibexa.api.EntryAddStruct+xml + application/vnd.ibexa.api.EntryAddStruct+json + #body: + # application/vnd.ibexa.api.EntryAddStruct+xml: + # type: EntryAddStruct + # example: !include examples/cart/entry/POST/EntryAddStruct.json.example + /{entryId}: + delete: + displayName: Remove Entry from Cart + description: Removes the given entry from the given Cart. + patch: + displayName: Update Entry from Cart + description: Updates the given entry from the given Cart. + headers: + Content-Type: + description: The EntryUpdateStruct schema encoded in XML or JSON format. + example: | + application/vnd.ibexa.api.EntryUpdateStruct+xml + application/vnd.ibexa.api.EntryUpdateStruct+json + /empty: + post: + displayName: Empty Cart + description: Empties the given 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: + get: + displayName: Cart Summary + description: Gets a summary of the given Cart. + headers: + Accept: + description: If set, the Cart Summary is returned in XML or JSON format. + example: | + application/vnd.ibexa.api.CartSummary+xml + application/vnd.ibexa.api.CartSummary+json + responses: + 200: + body: + application/vnd.ibexa.api.CountriesLis+json: + type: CartSummary + example: !include examples/cart/summary/CartSummary.json.example + 401: + description: Error - The user is not authorized to read this Cart. + 404: + description: Error - Cart not found. diff --git a/docs/api/rest_api/rest_api_reference/input/ez-commerce.raml b/docs/api/rest_api/rest_api_reference/input/ez-commerce.raml index 1f0504876a..7229c834f8 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-commerce.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-commerce.raml @@ -1,10 +1,11 @@ -displayName: eCommerce API (deprecated as of Ibexa DXP 4.4) +displayName: eCommerce API (removed) /basket: get: - displayName: Read list of baskets (deprecated as of Ibexa DXP 4.4) + displayName: Read list of baskets (removed) description: | Returns baskets for the current user. Only "storedBasket" and "wishList" types are handled. Others will return validation error. + Removed as of Ibexa DXP 4.4. queryParameters: type: description: Either "storedBasket" or "wishList". "storedBasket" is assumed if not passed. @@ -21,9 +22,10 @@ displayName: eCommerce API (deprecated as of Ibexa DXP 4.4) /current: get: - displayName: Get current basket (deprecated as of Ibexa DXP 4.4) + displayName: Get current basket (removed) description: | Returns a Basket instance for the current session. If there isn't one, a new one will be created. + Removed as of Ibexa DXP 4.4. headers: Accept: example: application/vnd.ibexa.api.Basket+json @@ -36,10 +38,10 @@ displayName: eCommerce API (deprecated as of Ibexa DXP 4.4) /{basketId}: copy: - displayName: Copy basket to user session (deprecated as of Ibexa DXP 4.4) + displayName: Copy basket to user session (removed) description: |- - Adds basket lines into current basket in user session, if any, using basket stored in permanent - storage. + Adds basket lines into current basket in user session, if any, using basket stored in permanent storage. + Removed as of Ibexa DXP 4.4. responses: 200: body: @@ -54,16 +56,18 @@ displayName: eCommerce API (deprecated as of Ibexa DXP 4.4) /referencenumber: patch: - displayName: Save the external reference number in basket (deprecated as of Ibexa DXP 4.4) + displayName: Save the external reference number in basket (removed) + description: Removed as of Ibexa DXP 4.4. /remark: patch: - displayName: Save the remark in basket (deprecated as of Ibexa DXP 4.4) + displayName: Save the remark in basket (removed) + description: Removed as of Ibexa DXP 4.4. /party/{partyType}: patch: - displayName: Update party information in the basket (deprecated as of Ibexa DXP 4.4) - description: Updates party (buyer, delivery, invoice) information in the basket. + displayName: Update party information in the basket (removed) + description: Updates party (buyer, delivery, invoice) information in the basket. Removed as of Ibexa DXP 4.4. body: application/vnd.ibexa.api.PartyInvoice+json: type: PartyTypeInput @@ -81,8 +85,8 @@ displayName: eCommerce API (deprecated as of Ibexa DXP 4.4) /shippingmethod: patch: - displayName: Update shipping information in current basket (deprecated as of Ibexa DXP 4.4) - description: Updates shipping information in the current basket. + displayName: Update shipping information in current basket (removed) + description: Updates shipping information in the current basket. Removed as of Ibexa DXP 4.4. body: application/vnd.ibexa.api.ShippingMethodData+json: type: ShippingMethodData @@ -100,8 +104,8 @@ displayName: eCommerce API (deprecated as of Ibexa DXP 4.4) /paymentmethod: patch: - displayName: Update payment information in current basket (deprecated as of Ibexa DXP 4.4) - description: Updates payment information in the current basket. + displayName: Update payment information in current basket (removed) + description: Updates payment information in the current basket. Removed as of Ibexa DXP 4.4. body: application/vnd.ibexa.api.PaymentMethodData.json: type: PaymentMethodData @@ -119,8 +123,8 @@ displayName: eCommerce API (deprecated as of Ibexa DXP 4.4) /voucher: patch: - displayName: Update and check voucher in current basket (deprecated as of Ibexa DXP 4.4) - description: Updates and checks voucher in current basket. + displayName: Update and check voucher in current basket (removed) + description: Updates and checks voucher in current basket. Removed as of Ibexa DXP 4.4. body: application/vnd.ibexa.api.VoucherData.json: type: VoucherData @@ -138,8 +142,8 @@ displayName: eCommerce API (deprecated as of Ibexa DXP 4.4) /line: post: - displayName: Add products to current basket (deprecated as of Ibexa DXP 4.4) - description: Adds products to the current basket. + displayName: Add products to current basket (removed) + description: Adds products to the current basket. Removed as of Ibexa DXP 4.4. body: application/vnd.ibexa.api.BasketLineData+json: type: BasketLineData @@ -158,20 +162,31 @@ displayName: eCommerce API (deprecated as of Ibexa DXP 4.4) /{basketId}: get: - displayName: Get Basket by ID (deprecated as of Ibexa DXP 4.4) - description: Gets basket by ID. + displayName: Get Basket by ID (removed) + description: Gets basket by ID. Removed as of Ibexa DXP 4.4, use GET /cart/{identifier} instead responses: 200: body: application/vnd.ibexa.api.Basket+json: type: Basket example: !include examples/commerce/basket/_id_/GET/Basket.json.example + delete: + displayName: Delete Basket by ID (removed) + description: Deletes basket by ID. Removed as of Ibexa DXP 4.4, use DELETE /cart/{identifier} instead. + responses: + 200: + description: OK - The basket has been deleted + 400: + description: Error - The basket does not exist + 403: + description: Error - Access denied /name: patch: - displayName: Update the name of the stored basket (deprecated as of Ibexa DXP 4.4) + displayName: Update the name of the stored basket (removed) description: | Updates the name of the stored basket. + Removed as of Ibexa DXP 4.4, use PATCH /cart/{identifier} instead. body: application/vnd.ibexa.api.BasketHeaderData+json: type: BasketHeaderData @@ -185,9 +200,10 @@ displayName: eCommerce API (deprecated as of Ibexa DXP 4.4) /note: patch: - displayName: Update the note of the stored basket (deprecated as of Ibexa DXP 4.4) + displayName: Update the note of the stored basket (removed) description: | Updates the note of the stored basket. + Removed as of Ibexa DXP 4.4. body: application/vnd.ibexa.api.BasketHeaderData+json: type: BasketHeaderData @@ -201,8 +217,8 @@ displayName: eCommerce API (deprecated as of Ibexa DXP 4.4) /line: post: - displayName: Add products to stored basket (deprecated as of Ibexa DXP 4.4) - description: Adds products to the stored basket. + displayName: Add products to stored basket (removed) + description: Adds products to the stored basket. Removed as of Ibexa DXP 4.4, use POST /cart/{identifier}/entry instead. body: application/vnd.ibexa.api.BasketLineData+json: type: BasketLineData @@ -221,7 +237,8 @@ displayName: eCommerce API (deprecated as of Ibexa DXP 4.4) /line/{lineId}: delete: - displayName: Delete a line from a stored basket (deprecated as of Ibexa DXP 4.4) + displayName: Delete a line from a stored basket (removed) + description: Removed as of Ibexa DXP 4.4, use DELETE /cart/{identifier}/entry/{entryId} instead. responses: 200: body: @@ -236,8 +253,8 @@ displayName: eCommerce API (deprecated as of Ibexa DXP 4.4) /{basketName}: post: - displayName: Create a new persisted basket (deprecated as of Ibexa DXP 4.4) - description: Creates a new persisted basket. + displayName: Create a new persisted basket (removed) + description: Creates a new persisted basket. Removed as of Ibexa DXP 4.4. responses: 200: body: @@ -253,7 +270,8 @@ displayName: eCommerce API (deprecated as of Ibexa DXP 4.4) /checkout: /paymentmethods: get: - displayName: Get list of payment methods (deprecated as of Ibexa DXP 4.4) + displayName: Get list of payment methods (removed) + description: Removed as of Ibexa DXP 4.4. responses: 200: body: @@ -263,7 +281,8 @@ displayName: eCommerce API (deprecated as of Ibexa DXP 4.4) /shippingmethods: get: - displayName: Get list of shipping methods (deprecated as of Ibexa DXP 4.4) + displayName: Get list of shipping methods (removed) + description: Removed as of Ibexa DXP 4.4. responses: 200: body: @@ -273,7 +292,8 @@ displayName: eCommerce API (deprecated as of Ibexa DXP 4.4) /customer/addresses/shipping: get: - displayName: Get list of shipping addresses (deprecated as of Ibexa DXP 4.4) + displayName: Get list of shipping addresses (removed) + description: Removed as of Ibexa DXP 4.4. responses: 200: body: @@ -283,8 +303,8 @@ displayName: eCommerce API (deprecated as of Ibexa DXP 4.4) /customerprice: post: - displayName: Get customer prices for products (deprecated as of Ibexa DXP 4.4) - description: Gets customer prices for the requested products. + displayName: Get customer prices for products (removed) + description: Gets customer prices for the requested products. Removed as of Ibexa DXP 4.4. body: application/json: type: CustomerPriceData @@ -297,14 +317,15 @@ displayName: eCommerce API (deprecated as of Ibexa DXP 4.4) example: !include examples/commerce/customerprice/POST/PriceResponse.json.example -/common/check_sku_file:/{mode}: +/common/check_sku_file/{mode}: post: - displayName: Add to basket from CSV or Excel (deprecated as of Ibexa DXP 4.4) - description: Adds to basket a line from a CSV or Excel file. + displayName: Add to basket from CSV or Excel (removed) + description: Adds to basket a line from a CSV or Excel file. Removed as of Ibexa DXP 4.4. /country: get: - displayName: Get list of countries (deprecated as of Ibexa DXP 4.4) + displayName: Get list of countries (removed) + description: Removed as of Ibexa DXP 4.4, use GET /services/countries instead. responses: 200: body: diff --git a/docs/api/rest_api/rest_api_reference/input/ez-content-location.raml b/docs/api/rest_api/rest_api_reference/input/ez-content-locations.raml similarity index 100% rename from docs/api/rest_api/rest_api_reference/input/ez-content-location.raml rename to docs/api/rest_api/rest_api_reference/input/ez-content-locations.raml diff --git a/docs/api/rest_api/rest_api_reference/input/ez-content-object.raml b/docs/api/rest_api/rest_api_reference/input/ez-content-objects.raml similarity index 97% rename from docs/api/rest_api/rest_api_reference/input/ez-content-object.raml rename to docs/api/rest_api/rest_api_reference/input/ez-content-objects.raml index c0002996f4..972b7e4687 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-content-object.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-content-objects.raml @@ -592,3 +592,25 @@ get: 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. + /hide: + post: + displayName: Hide Content item + description: Makes or keep the Content item invisible + 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. + /reveal: + post: + displayName: Reveal Content item + description: Makes or keep the Content item visible + 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. diff --git a/docs/api/rest_api/rest_api_reference/input/ez-content-section.raml b/docs/api/rest_api/rest_api_reference/input/ez-content-sections.raml similarity index 100% rename from docs/api/rest_api/rest_api_reference/input/ez-content-section.raml rename to docs/api/rest_api/rest_api_reference/input/ez-content-sections.raml diff --git a/docs/api/rest_api/rest_api_reference/input/ez-content-types.raml b/docs/api/rest_api/rest_api_reference/input/ez-content-types.raml index d9c222fc64..5e4db23fdc 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-content-types.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-content-types.raml @@ -119,6 +119,14 @@ get: 404: description: Error - The Content Type does not exist. /fieldDefinitions: + get: + displayName: Get Field definition list + description: Returns all Field definitions of the provided Content Type. + responses: + 200: + description: OK - return a list of Field definitions. + 404: + description: Error - The Content Type does not exist. /{fieldDefinitionId}: get: displayName: Get Field definition @@ -144,6 +152,27 @@ get: 404: description: Error - The Content Type does not exist. /draft: + get: + displayName: Get Content Type draft + description: Returns the draft of the Content Type with the provided ID. + headers: + Accept: + description: If set, the Content Type is returned in XML or JSON format. + example: | + application/vnd.ibexa.api.ContentType+xml + application/vnd.ibexa.api.ContentType+json + responses: + 200: + body: + application/vnd.ibexa.api.ContentType+xml: + type: ContentType + application/vnd.ibexa.api.ContentType+json: + type: ContentType + description: OK - returns the Content Type. + 401: + description: Error - The user is not authorized to read this Content Type. + 404: + description: Error - The Content Type does not exist or does not have a draft. patch: displayName: Update Content Type draft description: Updates metadata of a draft. This method does not handle Field definitions. PATCH or POST with header X-HTTP-Method-Override PATCH. @@ -211,6 +240,14 @@ get: 404: description: Error - The Content Type draft does not exist. /fieldDefinitions: + get: + displayName: Get Draft Field definition list + description: Returns all Field definitions of the provided Content Type Draft. + responses: + 200: + description: OK - return a list of Field definitions. + 404: + description: Error - The Content Type draft does not exist. post: displayName: Add Content Type Draft Field definition description: Creates a new Field definition for the given Content Type. diff --git a/docs/api/rest_api/rest_api_reference/input/ez-content-views.raml b/docs/api/rest_api/rest_api_reference/input/ez-content-views.raml index 40c8963d7c..cea800be55 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-content-views.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-content-views.raml @@ -1,6 +1,6 @@ post: - displayName: Create View - description: Executes a query and returns View including the results. The View input reflects the criteria model of the public API. Will respond with a 301, as the resource has been moved to /views (Platform 1.0) - DEPRECATED. + displayName: Create View (deprecated) + description: Executes a query and returns View including the results. The View input reflects the criteria model of the public API. Deprecated as of eZ Platform 1.0 and will respond 301, use POST /views instead. headers: Accept: description: The View in XML or JSON format. diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-attributegroups.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-attributegroups.raml index fd37319087..fc0714733f 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-attributegroups.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-attributegroups.raml @@ -1,6 +1,6 @@ get: - displayName: Load attribute groups (deprecated as of Ibexa DXP 4.3, use /view instead) - description: Returns a list of attribute groups. + displayName: 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. body: application/vnd.ibexa.api.AttributeGroupList+json: type: AttributeGroup @@ -145,7 +145,7 @@ post: responses: 200: body: - application/vnd.ibexa.api.AttributeGroupView+json; + application/vnd.ibexa.api.AttributeGroupView+json: type: AttributeGroupView example: !include examples/product/catalog/attribute_groups/POST/AttributeGroupView.json.example 400: diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-attributes.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-attributes.raml index f2421cdf42..427ad47044 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-attributes.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-attributes.raml @@ -100,8 +100,8 @@ post: 401: description: Error - the user is not authorized to delete this translation. get: - displayName: Load attributes (deprecated as of Ibexa DXP 4.3, use /view instead) - description: Loads list of all attributes. + displayName: Load attributes (deprecated) + description: Loads list of all attributes. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/attributes/view instead. headers: Accept: description: AttributeList - If set, the attributes list is returned in XML or JSON format. @@ -145,7 +145,7 @@ get: responses: 200: body: - application/vnd.ibexa.api.AttributeView+json; + application/vnd.ibexa.api.AttributeView+json: type: AttributeView example: !include examples/product/catalog/attributes/POST/AttributeView.json.example 400: diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-attributetypes.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-attributetypes.raml new file mode 100644 index 0000000000..edfd5a1a7e --- /dev/null +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-attributetypes.raml @@ -0,0 +1,33 @@ +get: + displayName: List Attribute Types + description: Lists all Attribute Types. + headers: + Accept: + description: If set, the list is returned in XML or JSON format. + example: application/vnd.ibexa.api.AttributeTypeList+json + responses: + 200: + description: OK - returns a list of Attribute Types + body: + application/vnd.ibexa.api.AttributeTypeList+xml: + type: AttributeTypeList + application/vnd.ibexa.api.AttributeTypeList+json: + type: AttributeTypeList +/{identifier}: + get: + displayName: Get Attribute Type + description: Gets an Attribute Type by its identifier. + headers: + Accept: + description: If set, the Attribute Type is returned in XML or JSON format. + example: application/vnd.ibexa.api.AttributeType+json + responses: + 200: + description: OK - returns the Attribute Type + body: + application/vnd.ibexa.api.AttributeType+xml: + type: AttributeType + application/vnd.ibexa.api.AttributeType+json: + type: AttributeType + 404: + description: Error - The Attribute Type does not exist. diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-catalogs.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-catalogs.raml index 46a154ab1e..c64668e346 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-catalogs.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-catalogs.raml @@ -142,7 +142,7 @@ post: responses: 200: body: - application/vnd.ibexa.api.CatalogView+json; + application/vnd.ibexa.api.CatalogView+json: type: ProductView example: !include examples/product/catalog/catalog/POST/CatalogView.json.example 400: @@ -170,7 +170,7 @@ post: responses: 200: body: - application/vnd.ibexa.api.ProductView+json; + application/vnd.ibexa.api.ProductView+json: type: ProductView example: !include examples/product/catalog/catalog/POST/CatalogProductsView.json.example 400: diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-currency.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-currency.raml index 3b962227a2..266f1d5a3c 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-currency.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-currency.raml @@ -128,7 +128,7 @@ get: responses: 200: body: - application/vnd.ibexa.api.CurrencyView+json; + application/vnd.ibexa.api.CurrencyView+json: type: CurrencyView example: !include examples/product/catalog/currency/POST/CurrencyView.json.example 400: diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-customergroups.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-customergroups.raml index ef504aa74c..cb6f157610 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-customergroups.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-customergroups.raml @@ -125,7 +125,7 @@ post: responses: 200: body: - application/vnd.ibexa.api.CustomerGroupView+json; + application/vnd.ibexa.api.CustomerGroupView+json: type: CustomerGroupView example: !include examples/product/catalog/customer_groups/POST/CustomerGroupView.json.example 400: diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-products.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-products.raml index b735fdc28b..f33e6d013e 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-products.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-products.raml @@ -96,8 +96,8 @@ 404: description: Error - no product with the given code exists. get: - displayName: Load products list (deprecated as of Ibexa DXP 4.3, use /view instead) - description: Returns a list of products. + displayName: Load products list (deprecated) + description: Returns a list of products. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/products/view instead. headers: Accept: description: If set, the products are returned in XML or JSON format. @@ -141,7 +141,7 @@ get: responses: 200: body: - application/vnd.ibexa.api.ProductView+json; + application/vnd.ibexa.api.ProductView+json: type: ProductView example: !include examples/product/catalog/product/POST/ProductView.json.example 400: diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-producttypes.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-producttypes.raml index 491ce8d8ec..a1f43433ad 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-producttypes.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-producttypes.raml @@ -29,8 +29,8 @@ post: 404: description: Error - the product type with the given ID does not exist. get: - displayName: Load product types (deprecated as of Ibexa DXP 4.3, use /view instead) - description: Returns a list of product types. + displayName: 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. headers: Accept: description: ProductTypeListGet - If set, the product type list is returned in XML or JSON format. @@ -143,7 +143,7 @@ get: responses: 200: body: - application/vnd.ibexa.api.ProductTypeView+json; + application/vnd.ibexa.api.ProductTypeView+json: type: ProductTypeView example: !include examples/product/catalog/product_types/POST/ProductTypeView.json.example 400: diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-productvariants.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-productvariants.raml index b503c98617..8be923f0d7 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-productvariants.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-productvariants.raml @@ -93,7 +93,7 @@ description: Error - a product variant with the same code already exists. 404: description: Error - no product variant with the given code exists. -/view: +/view/{baseProductCode}: post: displayName: Filter product variants description: Executes a query and returns a View including the results. The View input reflects the criteria model of the public API. @@ -115,8 +115,10 @@ responses: 200: body: - application/vnd.ibexa.api.ProductVariantView+json; + application/vnd.ibexa.api.ProductVariantView+json: type: ProductVariantView example: !include examples/product/catalog/product_variants/POST/ProductVariantView.json.example 400: description: Error - the input does not match the input schema definition. + 404: + description: Error - the base product does not exist. diff --git a/docs/api/rest_api/rest_api_reference/input/ez-product-regions.raml b/docs/api/rest_api/rest_api_reference/input/ez-product-regions.raml index c013130829..a1441a26e0 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-product-regions.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-product-regions.raml @@ -15,8 +15,16 @@ get: example: !include examples/product/catalog/regions/GET/RegionList.json.example 401: description: Error - the user has no permission to read regions. - 404: - description: Error - the region does not exist. + +/{identifier}: + get: + displayName: Load region + description: Loads a region by its identifier + responses: + 200: + description: OK - loads region. + 404: + description: Error - the region does not exist. /view: post: @@ -40,7 +48,7 @@ get: responses: 200: body: - application/vnd.ibexa.api.RegionView+json; + application/vnd.ibexa.api.RegionView+json: type: RegionView example: !include examples/product/catalog/regions/POST/RegionView.json.example 400: diff --git a/docs/api/rest_api/rest_api_reference/input/ez-services.raml b/docs/api/rest_api/rest_api_reference/input/ez-services.raml index ab215567cb..da187f65cc 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-services.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-services.raml @@ -7,8 +7,8 @@ displayName: Services Accept: description: If set, the country list is returned in XML or JSON format. example: | - application/vnd.ibexa.api.CountriesLis+xml - application/vnd.ibexa.api.CountriesLis+json + application/vnd.ibexa.api.CountriesList+xml + application/vnd.ibexa.api.CountriesList+json responses: 200: body: diff --git a/docs/api/rest_api/rest_api_reference/input/ez-taxonomy.raml b/docs/api/rest_api/rest_api_reference/input/ez-taxonomy.raml index 70521e9f43..17622f321b 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-taxonomy.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-taxonomy.raml @@ -1,45 +1,202 @@ displayName: Taxonomy -/{taxonomyName}/entry-assignments/assign-to-content: - post: - displayName: Assign entry - description: Assigns taxonomy entry to a Content item. - headers: - Accept: - example: | - application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json - Content-Type: - example: | - application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json - body: - application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json: - type: TaxonomyEntryAssignToContent - example: !include examples/taxonomy/POST/TaxonomyEntryAssignToContent.json.example - responses: - 201: - description: No Content. - 400: - description: Error - the input does not match the input schema definition. - 401: - description: Error - the user is not authorized to assign this Entry. -/{taxonomyName}/entry-assignments/unassign-from-content: - post: - displayName: Unassign entry - description: Unassigns taxonomy entry from a Content item. - headers: - Accept: - example: | - aapplication/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json - Content-Type: - example: | - application/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json - body: - application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json: - type: TaxonomyEntryUnassignFromContent - example: !include examples/taxonomy/POST/TaxonomyEntryUnassignFromContent.json.example - responses: - 201: - description: No Content. - 400: - description: Error - the input does not match the input schema definition. - 401: - description: Error - the user is not authorized to unassign this entry. \ No newline at end of file +/{taxonomyName}: + /entry: + /{id}: + get: + displayName: Get Entry by ID + description: Loads taxonomy Entry by its Entry ID. + headers: + Accept: + description: If set, the Taxonomy Entry is returned in XML or JSON format. + example: | + application/vnd.ibexa.api.TaxonomyEntry+json + responses: + 200: + description: OK - returns the taxonomy Entry. + body: + application/vnd.ibexa.api.TaxonomyEntry+xml: + type: TaxonomyEntry + application/vnd.ibexa.api.TaxonomyEntry+json: + type: TaxonomyEntry + 401: + description: Error - the user is not authorized to read this Entry. + 404: + description: Error - the Entry does not exists. + /identifier/{identifier}: + get: + displayName: Get Entry by identifier + description: Loads taxonomy Entry by its Entry identifier. + headers: + Accept: + description: If set, the Taxonomy Entry is returned in XML or JSON format. + example: | + application/vnd.ibexa.api.TaxonomyEntry+json + responses: + 200: + description: OK - returns the taxonomy Entry. + body: + application/vnd.ibexa.api.TaxonomyEntry+xml: + type: TaxonomyEntry + application/vnd.ibexa.api.TaxonomyEntry+json: + type: TaxonomyEntry + 401: + description: Error - the user is not authorized to read this Entry. + 404: + description: Error - the Entry does not exists. + /content-id/{contentId}: + get: + displayName: Get Entry by Content ID + description: Loads taxonomy Entry by its Content ID. + headers: + Accept: + description: If set, the Taxonomy Entry is returned in XML or JSON format. + example: | + application/vnd.ibexa.api.TaxonomyEntry+json + responses: + 200: + description: OK - returns the taxonomy Entry. + body: + application/vnd.ibexa.api.TaxonomyEntry+xml: + type: TaxonomyEntry + application/vnd.ibexa.api.TaxonomyEntry+json: + type: TaxonomyEntry + 401: + description: Error - the user is not authorized to read this Entry. + 404: + description: Error - the Entry does not exists. + /entries: + delete: + displayName: Delete Entries + description: Bulk removes several taxonomy entries. + headers: + Content-Type: + description: Target Entries schema encoded in XML or JSON format. + example: | + application/vnd.ibexa.api.TaxonomyEntryBulkRemove+xml + application/vnd.ibexa.api.TaxonomyEntryBulkRemove+json + body: + application/vnd.ibexa.api.TaxonomyEntryBulkRemove+xml: + type: TaxonomyEntryBulkRemove + application/vnd.ibexa.api.TaxonomyEntryBulkRemove+json: + type: TaxonomyEntryBulkRemove + example: !include examples/taxonomy/entries/DELETE/TaxonomyEntryBulkRemove.json.example + responses: + 204: + description: No Content - The entries have been deleted. + 400: + description: Error - The input does not match the input schema definition. + 401: + description: Error - The user is not authorized to delete some of the entries. + /move: + post: + displayName: Move Entries + description: Bulk move several taxonomy entries relative to sibling. + headers: + Content-Type: + description: The Entry moves schema encoded in XML or JSON format. + example: | + application/vnd.ibexa.api.TaxonomyEntryBulkMove+xml + application/vnd.ibexa.api.TaxonomyEntryBulkMove+json + body: + application/vnd.ibexa.api.TaxonomyEntryBulkMove+xml: + type: TaxonomyEntryBulkRemove + application/vnd.ibexa.api.TaxonomyEntryBulkMove+json: + type: TaxonomyEntryBulkRemove + example: !include examples/taxonomy/entries/move/POST/TaxonomyEntryBulkMove.json.example + responses: + 204: + description: No Content - The entries have been moved. + 400: + description: Error - The input does not match the input schema definition. + 401: + description: Error - The user is not authorized to move some of the entries. + 404: + description: Error - Some to-be-moved or sibling entries do not exist. + /entry-assignment/{id}: + get: + displayName: Get Assignment by ID + description: Gets taxonomy entry Assignment by its ID. + headers: + Accept: + description: If set, the Assignment is returned in XML or JSON format. + example: | + application/vnd.ibexa.api.TaxonomyEntryAssignment+json + responses: + 200: + description: OK - returns the taxonomy entry Assignment. + body: + application/vnd.ibexa.api.TaxonomyEntryAssignment+xml: + type: TaxonomyEntryAssignment + application/vnd.ibexa.api.TaxonomyEntryAssignment+json: + type: TaxonomyEntryAssignment + 404: + description: Error - the assignment does not exist. + /entry-assignments: + /assign-to-content: + post: + displayName: Assign entry + description: Assigns taxonomy entry to a Content item. + headers: + Accept: + example: | + application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json + Content-Type: + example: | + application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json + body: + application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json: + type: TaxonomyEntryAssignToContent + example: !include examples/taxonomy/POST/TaxonomyEntryAssignToContent.json.example + responses: + 201: + description: No Content. + 400: + description: Error - the input does not match the input schema definition. + 401: + description: Error - the user is not authorized to assign this Entry. + /unassign-from-content: + post: + displayName: Unassign entry + description: Unassigns taxonomy entry from a Content item. + headers: + Accept: + example: | + aapplication/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json + Content-Type: + example: | + application/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json + body: + application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json: + type: TaxonomyEntryUnassignFromContent + example: !include examples/taxonomy/POST/TaxonomyEntryUnassignFromContent.json.example + responses: + 201: + description: No Content. + 400: + description: Error - the input does not match the input schema definition. + 401: + description: Error - the user is not authorized to unassign this entry. + /content-id/{contentId}: + get: + displayName: Get Assignments to a Content + description: Gets taxonomy entries assigned to a Content item by its ID. + headers: + Accept: + description: If set, the assignments are returned in XML or JSON format. + example: | + application/vnd.ibexa.api.EntryAssignmentCollection+xml + application/vnd.ibexa.api.EntryAssignmentCollection+json + responses: + 200: + description: OK - returns the assigment collection. + body: + application/vnd.ibexa.api.EntryAssignmentCollection+xml: + description: Contains metadata about the content itself and a list of taxonomy entry assignments to this content, in XML format. + type: EntryAssignmentCollection + example: !include examples/taxonomy/GET/EntryAssignmentCollection.xml.example + application/vnd.ibexa.api.EntryAssignmentCollection+json: + description: Contains metadata about the content itself and a list of taxonomy entry assignments to this content, in JSON format. + type: EntryAssignmentCollection + example: !include examples/taxonomy/GET/EntryAssignmentCollection.json.example + 404: + description: Error - the Content does not exists. diff --git a/docs/api/rest_api/rest_api_reference/input/ez-types.raml b/docs/api/rest_api/rest_api_reference/input/ez-types.raml index 85e45bfa17..6019382d71 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-types.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-types.raml @@ -2268,6 +2268,12 @@ BasketLinesData: PriceResponse: type: BaseCommerceResponse +CartSummary: + type: object + +CartViewInput: + type: object + Catalog: type: object @@ -2306,6 +2312,9 @@ CurrencyCreate: CurrencyUpdate: type: object +CurrencyView: + type: object + Region: type: object description: '' @@ -2334,6 +2343,10 @@ AttributeGroupViewInput: type: object description: '' +AttributeGroupView: + type: object + description: '' + Attribute: type: object description: '' @@ -2354,6 +2367,18 @@ AttributeViewInput: type: object description: '' +AttributeView: + type: object + description: '' + +AttributeType: + type: object + description: '' + +AttributeTypeList: + type: object + description: '' + CustomerGroup: type: object description: '' @@ -2374,6 +2399,9 @@ CustomerGroupViewInput: type: object description: '' +CustomerGroupView: + type: object + CurrencyViewInput: type: object description: '' @@ -2398,6 +2426,10 @@ ProductTypeViewInput: type: object description: '' +ProductTypeView: + type: object + description: '' + Product: type: object description: '' @@ -2426,6 +2458,10 @@ ProductViewInput: type: object description: '' +ProductView: + type: object + description: '' + ProductVariant: type: object description: '' @@ -2446,14 +2482,35 @@ ProductVariantViewInput: type: object description: '' +ProductVariantView: + type: object + RegionViewInput: type: object description: '' +RegionView: + type: object + ProductTypeList: type: object description: +TaxonomyEntry: + type: object + +TaxonomyEntryAssignment: + type: object + +EntryAssignmentCollection: + type: object + +TaxonomyEntryBulkRemove: + type: object + +TaxonomyEntryBulkMove: + type: object + TaxonomyEntryAssignToContent: type: object description: '' @@ -2465,6 +2522,7 @@ TaxonomyEntryUnassignFromContent: VatCategoryList: type: object description: '' + VatCategory: type: object description: '' diff --git a/docs/api/rest_api/rest_api_reference/input/ez-user-current.raml b/docs/api/rest_api/rest_api_reference/input/ez-user-current.raml new file mode 100644 index 0000000000..b4da5d615f --- /dev/null +++ b/docs/api/rest_api/rest_api_reference/input/ez-user-current.raml @@ -0,0 +1,21 @@ +get: + displayName: Load current User + description: Loads the current user. + headers: + Accept: + description: If set, the User is returned in XML or JSON format. + example: | + application/vnd.ibexa.api.User+xml + application/vnd.ibexa.api.User+json + responses: + 200: + description: OK - the User with the given ID. + body: + application/vnd.ibexa.api.User+xml: + type: UserList + example: !include examples/user/users/user_id/GET/User.xml.example + application/vnd.ibexa.api.User+json: + type: UserList + example: !include examples/user/users/user_id/GET/User.json.example + 401: + description: Error - the user has no permission to read Users. For example, Anonymous user can't load oneself. diff --git a/docs/api/rest_api/rest_api_reference/input/ez-user-groups.raml b/docs/api/rest_api/rest_api_reference/input/ez-user-groups.raml index fa8bed22a0..7ce15737c7 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-user-groups.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-user-groups.raml @@ -35,6 +35,42 @@ get: responses: 301: description: Moved permanently. +/subgroups: + post: + displayName: Create a top level User Group + description: Creates a top level User Group under the root. To create a child group under a parent group use '/user/groups/{path}/subgroups'. + headers: + Accept: + description: If set, the new User Group is returned in XML or JSON format. + example: | + application/vnd.ibexa.api.UserGroup+xml + application/vnd.ibexa.api.UserGroup+json + Content-Type: + description: The UserGroupCreate schema encoded in XML or JSON format. + example: | + application/vnd.ibexa.api.UserGroupCreate+json + application/vnd.ibexa.api.UserGroupCreate+xml + body: + application/vnd.ibexa.api.UserGroupCreate+xml: + type: UserGroupCreate + example: !include examples/user/groups/path/subgroups/POST/UserGroupCreate.xml.example + application/vnd.ibexa.api.UserGroupCreate+json: + type: UserGroupCreate + example: !include examples/user/groups/path/subgroups/POST/UserGroupCreate.json.example + responses: + 201: + description: Created - the User Group has been created + body: + application/vnd.ibexa.api.UserGroup+xml: + type: UserGroup + example: !include examples/user/groups/path/subgroups/POST/UserGroup.xml.example + application/vnd.ibexa.api.UserGroup+json: + type: UserGroup + example: !include examples/user/groups/path/subgroups/POST/UserGroup.json.example + 400: + description: Error - the input does not match the input schema definition. + 401: + description: Error - the user is not authorized to create this User Group./{path}: /{path}: get: displayName: Load User Group diff --git a/docs/api/rest_api/rest_api_reference/input/ez-user-users.raml b/docs/api/rest_api/rest_api_reference/input/ez-user-users.raml index bb24deaf5b..ad84cd9ad1 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-user-users.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-user-users.raml @@ -321,3 +321,46 @@ head: example: !include examples/user/users/user_id/roles/role_id/DELETE/RoleAssignmentList.json.example 401: description: Error - the user is not authorized to delete this Content Type. + /segments: + get: + displayName: View user segments + description: TODO + headers: + Accept: + description: If set, the user's segment list is returned in XML or JSON format. + example: | + application/vnd.ibexa.api.UserSegmentList+xml + application/vnd.ibexa.api.UserSegmentList+json + post: + displayName: Assign Segments to User + description: Assigns Segments from payload to User given by ID. + headers: + Content-Type: + description: The UserSegmentAssignInput schema encoded in XML or JSON format. + example: | + application/vnd.ibexa.api.UserSegmentAssignInput+xml + application/vnd.ibexa.api.UserSegmentAssignInput+json + /{segmentIdentifier}: + delete: + displayName: Unassign Segment from User + description: The Segment designated by its identifier is unassigned from the User given by ID. + /drafts: + get: + displayName: Load user drafts + description: Loads user's drafts + headers: + Accept: + description: If set, the version list is returned in XML or JSON format. + example: | + application/vnd.ibexa.api.VersionList+xml + application/vnd.ibexa.api.VersionList+json + responses: + 200: + description: OK - List the draft versions + body: + application/vnd.ibexa.api.VersionList+xml: + type: VersionList + application/vnd.ibexa.api.VersionList+json: + type: VersionList + 401: + description: Error - the current user is not authorized to list the drafts of the given user. diff --git a/docs/api/rest_api/rest_api_reference/input/ez-views.raml b/docs/api/rest_api/rest_api_reference/input/ez-views.raml index cd2c9e6a43..625021b790 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez-views.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez-views.raml @@ -1,4 +1,6 @@ displayName: Views +#get: +# displayName: List Views post: displayName: Create View description: | @@ -37,3 +39,9 @@ post: example: !include examples/views/POST/View.xml.v11.example 400: description: Error - the input does not match the input schema definition. +#/{id}: +# get: +# displayName: Get View +# /results: +# get: +# displayName: Get View results diff --git a/docs/api/rest_api/rest_api_reference/input/ez.raml b/docs/api/rest_api/rest_api_reference/input/ez.raml index 0544797dba..bab16f31a9 100644 --- a/docs/api/rest_api/rest_api_reference/input/ez.raml +++ b/docs/api/rest_api/rest_api_reference/input/ez.raml @@ -10,17 +10,18 @@ version: v3.3.2 /content: displayName: Managing content - /objects: !include ez-content-object.raml + /objects: !include ez-content-objects.raml /objectstategroups: !include ez-objectstategroups.raml - /locations: !include ez-content-location.raml + /locations: !include ez-content-locations.raml /views: !include ez-content-views.raml - /sections: !include ez-content-section.raml + /sections: !include ez-content-sections.raml /trash: !include ez-content-trash.raml /urlaliases: !include ez-content-urlaliases.raml /urlwildcards: !include ez-content-urlwildcards.raml /typegroups: !include ez-content-typegroups.raml /types: !include ez-content-types.raml /assets: !include ez-content-assets.raml + #/binary: !include ez-content-binary.raml /calendar: !include ez-calendar.raml @@ -28,6 +29,7 @@ version: v3.3.2 /user: displayName: Managing users + /current: !include ez-user-current.raml /groups: !include ez-user-groups.raml /users: !include ez-user-users.raml /roles: !include ez-user-roles.raml @@ -35,10 +37,17 @@ version: v3.3.2 /sessions: !include ez-user-sessions.raml /token: !include ez-user-token.raml +#/segments: !include ez-segment_groups.raml +#/segment_groups: !include ez-segment_groups.raml + +#/personalization/v1: !include ez-personalization.raml + /services: !include ez-services.raml /languages: !include ez-languages.raml +/cart: !include ez-cart.raml + /commerce: !include ez-commerce.raml /product/catalog: @@ -46,6 +55,7 @@ version: v3.3.2 /catalogs: !include ez-product-catalogs.raml /currencies: !include ez-product-currency.raml /regions: !include ez-product-regions.raml + /attribute_types: !include ez-product-attributetypes.raml /attribute_groups: !include ez-product-attributegroups.raml /attributes: !include ez-product-attributes.raml /customer_groups: !include ez-product-customergroups.raml diff --git a/docs/api/rest_api/rest_api_reference/rest_api_reference.html b/docs/api/rest_api/rest_api_reference/rest_api_reference.html index 31dc746d78..cb3acf0bed 100644 --- a/docs/api/rest_api/rest_api_reference/rest_api_reference.html +++ b/docs/api/rest_api/rest_api_reference/rest_api_reference.html @@ -58,7 +58,7 @@

-
+

/

    @@ -516,7 +516,7 @@

    -
    +

    /bookmark

      @@ -1285,7 +1285,7 @@
      Types
    -
    +

    /bookmark/{locationId}

      @@ -5210,7 +5210,7 @@
      Possible responses
    -
    +

    /content/objects/{contentId}

      @@ -6537,7 +6537,7 @@
      Possible responses
    -
    +

    /content/objects/{contentId}/translations/{languageCode}

      @@ -6636,7 +6636,7 @@
      Possible responses
    -
    +

    /content/objects/{contentId}/currentversion

      @@ -8042,7 +8042,7 @@
      Types
    -
    +

    /content/objects/{contentId}/versions

      @@ -8580,7 +8580,7 @@
      Types
    -
    +

    /content/objects/{contentId}/versions/{versionNo}

      @@ -10889,7 +10889,7 @@
      Possible responses
    -
    +

    /content/objects/{contentId}/versions/{versionNo}/translations/{languageCode}

      @@ -10996,7 +10996,7 @@
      Possible responses
    -
    +

    /content/objects/{contentId}/versions/{versionNo}/relations

      @@ -12137,7 +12137,7 @@
      Types
    -
    +

    /content/objects/{contentId}/versions/{versionNo}/relations/{relationId}

      @@ -12353,7 +12353,7 @@
      Possible responses
    -
    +

    /content/objects/{contentId}/relations

      @@ -12436,7 +12436,7 @@
      Possible responses
    -
    +

    /content/objects/{contentId}/locations

      @@ -13525,7 +13525,7 @@
      Types
    -
    +

    /content/objects/{contentId}/objectstates

      @@ -14160,6 +14160,172 @@
      Types
    +
+
+
+

/content/objects/{contentId}/hide

+ +
+
+
+
+
+
+ Hide Content item + +
+
+
+

+ POST + /content/objects/{contentId}/hide +

+

Makes or keep the Content item invisible

+

+ + +
+
Possible responses
+
+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
+ 204 + +

OK - Object item is hidden.

+
+ 401 + +

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

+
+ 404 + +

Error - The Content item was not found.

+
+
+
+ + +
+
+ +
+
+
+
+
+
+
+

/content/objects/{contentId}/reveal

+ +
+
+
+
+
+
+ Reveal Content item + +
+
+
+

+ POST + /content/objects/{contentId}/reveal +

+

Makes or keep the Content item visible

+

+ + +
+
Possible responses
+
+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
+ 204 + +

OK - Object item is revealed.

+
+ 401 + +

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

+
+ 404 + +

Error - The Content item was not found.

+
+
+
+ + +
+
+ +
+
+
+

/content/objectstategroups

@@ -15339,7 +15505,7 @@
Types
-
+

/content/objectstategroups/{objectStateGroupId}

    @@ -16318,7 +16484,7 @@
    Possible responses
-
+

/content/objectstategroups/{objectStateGroupId}/objectstates

    @@ -17463,7 +17629,7 @@
    Types
-
+

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

    @@ -19160,7 +19326,7 @@
    Types
-
+

/content/locations/{path}

    @@ -20800,7 +20966,7 @@
    Possible responses
-
+

/content/locations/{path}/children

    @@ -21120,7 +21286,7 @@
    Types
-
+

/content/locations/{path}/urlaliases

-
+
-
- Create View - + data-search="create-view-deprecated"> + Create View (deprecated) +
@@ -21342,7 +21508,7 @@

/content/views

POST /content/views

-

Executes a query and returns View including the results. The View input reflects the criteria model of the public API. Will respond with a 301, as the resource has been moved to /views (Platform 1.0) - DEPRECATED.

+

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

Header parameters
@@ -22506,7 +22672,7 @@
Types
-
+

/content/sections/{sectionId}

    @@ -24200,7 +24366,7 @@
    Possible responses
-
+

/content/trash/{trashItemid}

    @@ -25791,7 +25957,7 @@
    Types
-
+

/content/urlaliases/{urlAliasId}

    @@ -27168,7 +27334,7 @@
    Types
-
+

/content/urlwildcards/{wildcardId}

    @@ -28673,7 +28839,7 @@
    Types
-
+

/content/typegroups/{contentTypeGroupId}

    @@ -32402,7 +32568,7 @@
    Possible responses
-
+

/content/typegroups/{contentTypeGroupId}/types

    @@ -37079,7 +37245,7 @@
    Types
-
+

/content/types/{contentTypeId}

    @@ -38753,6 +38919,81 @@
    Possible responses
+
+
+
+

/content/types/{contentTypeId}/fieldDefinitions

+ +
+
+
+
+
+
+ Get Field definition list + +
+
+
+

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

+

Returns all Field definitions of the provided Content Type.

+

+ + +
+
Possible responses
+
+ + + + + + + + + + + + + + + + + +
CodeDescription
+ 200 + +

OK - return a list of Field definitions.

+
+ 404 + +

Error - The Content Type does not exist.

+
+
+
+ + +
+
+ +
+
+
+
@@ -39190,11 +39431,18 @@
Types
-
+

/content/types/{contentTypeId}/draft

+
+
+
+
+ Get Content Type draft + +
+
+
+

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

+

Returns the draft of the Content Type with the provided ID.

+

+
+
Header parameters
+
+

Accept

+

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

+
+ + + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
Examples + application/vnd.ibexa.api.ContentType+xml +application/vnd.ibexa.api.ContentType+json + +
+
+
+
+ + +
+
Possible responses
+
+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
+ + 200 + + +

OK - returns the Content Type.

+
+ 401 + +

Error - The user is not authorized to read this Content Type.

+
+ 404 + +

Error - The Content Type does not exist or does not have a draft.

+
+
+
+ +
+
Types
+
+ + + + + + + + + + + + + +
TypeDescription
+ + ContentType + +
+
+
+ +
+
+ +
+
+
+
+
+
    +
+
+
+
+
+
+
@@ -40249,11 +40639,18 @@
Possible responses
-
+

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

@@ -40725,7 +41183,7 @@
Types
-
+

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

    @@ -41690,7 +42148,7 @@
    Possible responses
-
+

/content/types/{contentTypeId}/groups

    @@ -42349,7 +42807,7 @@
    Types
-
+

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

    @@ -42739,7 +43197,7 @@
    Types

    /content/assets

    -
    +

    /content/assets/images/{assetId}/{assetSource}

      @@ -43024,7 +43482,7 @@
      Types
    -
+

Calendar @@ -43469,7 +43927,7 @@

Types
-
+

/calendar/event/grouped-by-day

    @@ -44273,7 +44731,7 @@
    Types
-
+

/calendar/event/{eventType}

    @@ -44521,7 +44979,7 @@

    Views

    -
    +

    /views

      @@ -45186,14 +45644,14 @@

      -

      /user/groups

      +

      /user/current

      -

      /user/groups

      +

      /user/current

      -
      +
      -
      - Load User Groups - + data-search="load-current-user"> + Load current User +

      GET - /user/groups + /user/current

      -

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

      +

      Loads the current user.

      Header parameters

      Accept

      -

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

      +

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

      @@ -45249,10 +45707,8 @@
      Header parameters
      @@ -45262,74 +45718,7 @@
      Header parameters
      -
      -
      Query parameters
      -
      -
      Examples - application/vnd.ibexa.api.UserGroupList+xml -application/vnd.ibexa.api.UserGroupList+json -application/vnd.ibexa.api.UserGroupRefList+xml -application/vnd.ibexa.api.UserGroupRefList+json + application/vnd.ibexa.api.User+xml +application/vnd.ibexa.api.User+json
      - - - - - - - - - - - - - - - - - - - - - - - - -
      PropertyTypeValue
      - roleId - - - - string - - - - - - Lists User Groups assigned to the given Role (e.g. GET /user/groups?roleId=1). -
      - id - - - - string - - - - - - Retrieves the User Groups for the given ID. -
      - remoteID - - - - string - - - - - - Retrieves the User Groups for the given remote ID. -
      -
      -
      - +
      Possible responses
      @@ -45343,13 +45732,13 @@
      Possible responses
      - 200 -

      +

      OK - the User with the given ID.

      @@ -45357,7 +45746,7 @@
      Possible responses
      401 -

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

      +

      Error - the user has no permission to read Users. For example, Anonymous user can't load oneself.

      @@ -45378,11 +45767,11 @@
      Types
      - - UserGroupList + + UserList - + This class represents a list of users. @@ -45395,28 +45784,28 @@
      Types
      -
      +
      -
      -
      -
      +
      +

      file_copy

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

      file_copy

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

- Services - -

-
+
+

/user/sessions

+
+
-

/services/countries

+

/user/sessions

-
+
-
- Countries list - + data-search="create-session-login-a-user"> + Create session (login a User) +

- GET - /services/countries + POST + /user/sessions

-

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

+

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

Header parameters

Accept

-

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

+

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

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

Content-Type

+

The SessionInput schema encoded in XML or JSON format.

@@ -65134,10 +65099,66 @@
Header parameters
+ + +
Examples - application/vnd.ibexa.api.CountriesLis+xml -application/vnd.ibexa.api.CountriesLis+json + application/vnd.ibexa.api.SessionInput+xml +application/vnd.ibexa.api.SessionInput+json
+
+
+
+

Cookie

+

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

+
+ + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
+
+
+
+

X-CSRF-Token

+

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

+
+ + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
@@ -65159,13 +65180,48 @@
Possible responses
- 200 -

+

Session already exists.

+ + + + + + 201 + + + +

Session is created.

+ + + + + 400 + + +

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

+ + + + + 401 + + +

Error - the authorization failed.

+ + + + + 409 + + +

Error - header contained a session cookie but different user was authorized.

@@ -65186,11 +65242,19 @@
Types
- - CountryList + + SessionInput - This class is representing an ISO-3166 formatted list of world countries. + + + + + + Session + + + Value for session. @@ -65201,84 +65265,90 @@
Types
-
-
-
-
- -
- Code: 200 -
-
-
-
-
-
-

- file_copy - -

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

+            

+                
+            

+                                        

+    

+                                                    

+                                                                                            

+                                                        

+                                file_copy
+                                
+                            

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

                         

-                        View more
+                        View more
+                                    

+                                            

+                                                                                            

+                                                        

+                                file_copy
+                                
+                            

+                            
+                                {
+  "SessionInput": {
+    "login": "admin",
+    "password": "secret"
+  }
+}
+
+                            

+                        

+                        View more
                                     

                         

 

-                        
+    

+                                                                    

+                                                        

+                    

+                        
+                                                    

+                                Code: 200
+                            

+                                            

+                                                                

+    

+                                                    

+                                                                                            

+                                                        

+                                file_copy
+                                
+                            

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

+                        

+                        View more
+                                    

+                                            

+                                                                                            

+                                                        

+                                file_copy
+                                
+                            

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

+                        

+                        View more
+                                    

+                        

+

+                        
+                                                                            

+                    

+                        
+                                                    

+                                Code: 201
+                            

+                                            

+                                                                

+    

+                                                    

+                                                                                            

+                                                        

+                                file_copy
+                                
+                            

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

+                        

+                        View more
+                                    

+                                            

+                                                                                            

+                                                        

+                                file_copy
+                                
+                            

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

+                        

+                        View more
+                                    

+                        

+

+                        
+                                    

+                                                            

+                                    

+
+
+
+
+

/user/sessions/current

+ +
+
+
+
+
+
+ Get current session + +
+
+
+

+ GET + /user/sessions/current +

+

Get current user session, if any.

+

+
+
Header parameters
+
+

Cookie

+

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

+
+ + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
+
+
+
+

Accept

+

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

+
+ + + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
Examples + application/vnd.ibexa.api.Session+xml +application/vnd.ibexa.api.Session+json + +
+
+
+
+ + +
+
Possible responses
+
+ + + + + + + + + + + + + + + + + +
CodeDescription
+ + 200 + + +

User is currently logged in and has a valid session.

+
+ 404 + +

User does not have a valid session, or it has expired.

+
+
+
+ +
+
Types
+
+ + + + + + + + + + + + + +
TypeDescription
+ + Session + + Value for session.
+
+
+ +
+
+ +
+
+
+
+
+ +
+ Code: 200 +
+
+
+
+
+
+

+ file_copy + +

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

+ file_copy + +

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

/user/sessions/{sessionId}

+ +
+
+
+
+
+
+ Delete session (logout a User) + +
+
+
+

+ DELETE + /user/sessions/{sessionId} +

+

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

+

+
+
Header parameters
+
+

Cookie

+

{sessionName}={sessionID}

+
+ + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
+
+
+
+

X-CSRF-Token

+

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

+
+ + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
+
+
+
+ + +
+
Possible responses
+
+ + + + + + + + + + + + + + + + + +
CodeDescription
+ 204 + +

OK - session deleted.

+
+ 404 + +

Error - the session does not exist.

+
+
+
+ + +
+
+ +
+
+
+
+
+
+
+
+
+

/user/sessions/{sessionId}/refresh

+ +
+
+
+
+
+
+ Refresh session + +
+
+
+

+ POST + /user/sessions/{sessionId}/refresh +

+

Get the session's User information.

+

+
+
Header parameters
+
+

Cookie

+

{sessionName}={sessionID}

+
+ + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
+
+
+
+

X-CSRF-Token

+

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

+
+ + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
+
+
+
+ + +
+
Possible responses
+
+ + + + + + + + + + + + + + + + + +
CodeDescription
+ + 200 + + +

+
+ 404 + +

Error - the session does not exist.

+
+
+
+ +
+
Types
+
+ + + + + + + + + + + + + +
TypeDescription
+ + Session + + Value for session.
+
+
+ +
+
+ +
+
+
+
+
+ +
+ Code: 200 +
+
+
+
+
+
+

+ file_copy + +

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

+ file_copy + +

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

/user/token

+
+
+
+

/user/token/jwt

+ +
+
+
+
+
+
+ Create JWT token + +
+
+
+

+ POST + /user/token/jwt +

+

Creates JWT authentication token.

+

+
+
Header parameters
+
+

Accept

+

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

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

Content-Type

+

The SessionInput schema encoded in XML or JSON format.

+
+ + + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
Examples + application/vnd.ibexa.api.JWTInput+xml +application/vnd.ibexa.api.JWTInput+json + +
+
+
+
+ + +
+
Possible responses
+
+ + + + + + + + + + + + + + + + + +
CodeDescription
+ + 200 + + +

+
+ 401 + +

Error - Unauthorized

+
+
+
+ +
+
Types
+
+ + + + + + + + + + + + + + + + + +
TypeDescription
+ + JWTInput + + This class represents the input for a JWT authentication token
+ + JWT + + This class represents the JWT authentication token
+
+
+ +
+
+ +
+
+
+ +
+
+
+
+
+

+ file_copy + +

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

+ file_copy + +

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

+ file_copy + +

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

+ file_copy + +

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

+ Services + +

+
+
+

/services/countries

+ +
+
+
+
+
+
+ Countries list + +
+
+
+

+ GET + /services/countries +

+

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

+

+
+
Header parameters
+
+

Accept

+

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

+
+ + + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
Examples + application/vnd.ibexa.api.CountriesList+xml +application/vnd.ibexa.api.CountriesList+json + +
+
+
+
+ + +
+
Possible responses
+
+ + + + + + + + + + + + + +
CodeDescription
+ + 200 + + +

+
+
+
+ +
+
Types
+
+ + + + + + + + + + + + + +
TypeDescription
+ + CountryList + + This class is representing an ISO-3166 formatted list of world countries.
+
+
+ +
+
+ +
+
+
+
+
+ +
+ Code: 200 +
+
+
+
+
+
+

+ file_copy + +

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

+ Languages + +

+
+
+

/languages

+ +
+
+
+
+
+
+ Language list + +
+
+
+

+ GET + /languages +

+

Lists languages

+

+
+
Header parameters
+
+

Accept

+

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

+
+ + + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
Examples + application/vnd.ibexa.api.LanguageList+xml +application/vnd.ibexa.api.LanguageList+json + +
+
+
+
+ + +
+
Possible responses
+
+ + + + + + + + + + + + + +
CodeDescription
+ + 200 + + +

+
+
+
+ +
+
Types
+
+ + + + + + + + + + + + + +
TypeDescription
+ + LanguageList + + List of languages.
+
+
+ +
+
+ +
+
+
+
+
+ +
+ Code: 200 +
+
+
+
+
+
+

+ file_copy + +

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

+ file_copy + +

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

/languages/{code}

+ +
+
+
+
+
+
+ Get language + +
+
+
+

+ GET + /languages/{code} +

+

+
+
Header parameters
+
+

Accept

+

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

+
+ + + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
Examples + application/vnd.ibexa.api.Language+xml +application/vnd.ibexa.api.Language+json + +
+
+
+
+ + +
+
Possible responses
+
+ + + + + + + + + + + + + +
CodeDescription
+ + 200 + + +

+
+
+
+ +
+
Types
+
+ + + + + + + + + + + + + +
TypeDescription
+ + Language + + This class represents a language in the Repository.
+
+
+ +
+
+ +
+
+
+
+
+ +
+ Code: 200 +
+
+
+
+
+
+

+ file_copy + +

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

+ file_copy + +

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

+ Managing Commerce carts + +

+
+
+

/cart

+ +
+
+
+
+
+
+ Create Cart + +
+
+
+

+ POST + /cart +

+

Creates Cart from payload.

+

+
+
Header parameters
+
+

Content-Type

+

The CartCreateStruct schema encoded in XML or JSON format.

+
+ + + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
Examples + application/vnd.ibexa.api.CartCreateStruct+xml +application/vnd.ibexa.api.CartCreateStruct+json + +
+
+
+
+ + + + +
+
+ +
+
+
+
+
+
+

/cart/view

+
+
+
+

/cart/view

+ +
+
+
+
+
+
+ Filter carts + +
+
+
+

+ POST + /cart/view +

+

Executes a query and returns a View including the results.

+

+
+
Header parameters
+
+

Accept

+

The CartView schema is returned in XML or JSON format.

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

Content-Type

+

The CartViewInput schema is posted in XML or JSON format.

+
+ + + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
Examples + application/vnd.ibexa.api.CartViewInput+xml +application/vnd.ibexa.api.CartViewInput+json + +
+
+
+
+ + +
+
Possible responses
+
+ + + + + + + + + + + + + +
CodeDescription
+ 200 + +

OK - returns a view and its results

+
+
+
+ +
+
Types
+
+ + + + + + + + + + + + + +
TypeDescription
+ + CartViewInput + +
+
+
+ +
+
+ +
+
+
+ +
+
+
+
+
+

+ file_copy + +

+ 
+                                {
+    "CartViewInput": {
+        "identifier": "loadUserCarts",
+        "CartQuery": {
+            "offset": 0,
+            "limit": 10,
+            "ownerId": 123
+        }
+    }
+}
+
+
+
+ View more +
+
+
+ +
+
+
+
-
-
-

- Languages - -

-
+
+

/cart/{identifier}

+
+
-

/languages

+

/cart/{identifier}

-
+
-
- Language list - + data-search="get-cart"> + Get Cart +

GET - /languages + /cart/{identifier}

-

Lists languages

+

Gets Cart by its identifier.

+

+ + +
+
Possible responses
+
+ + + + + + + + + + + + + + + + + + + + + +
CodeDescription
+ 200 + +

OK - return the cart

+
+ 401 + +

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

+
+ 404 + +

Error - The identifier do not match any Cart.

+
+
+
+ + +
+
+ +
+
+
+
+
+
+
+
+
+ Delete Cart + +
+
+
+

+ DELETE + /cart/{identifier} +

+

Deletes Cart by its identifier.

+

+ + + + +
+
+ +
+
+
+
+
+
+
+ Update Cart's metadata + +
+
+
+

+ PATCH + /cart/{identifier} +

+

Updates identified Cart's metadata from payload.

Header parameters
-

Accept

-

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

+

Content-Type

+

The CartMetadataUpdateStruct schema encoded in XML or JSON format.

+
+ + + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
Examples + application/vnd.ibexa.api.CartMetadataUpdateStruct+xml +application/vnd.ibexa.api.CartMetadataUpdateStruct+json + +
+
+
+
+ + + + +
+
+ +
+
+
+
+
+
+
+

/cart/{identifier}/entry

+ +
+
+
+
+
+
+ Add Entry to Cart + +
+
+
+

+ POST + /cart/{identifier}/entry +

+

Adds an the posted entry to the cart passed by identifier

+

+
+
Header parameters
+
+

Content-Type

+

The EntryAddStruct schema encoded in XML or JSON format.

+
+ + + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
Examples + application/vnd.ibexa.api.EntryAddStruct+xml +application/vnd.ibexa.api.EntryAddStruct+json + +
+
+
+
+ + + + +
+
+ +
+
+
+
+
+
+
+

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

+ +
+
+
+
+
+
+ Remove Entry from Cart + +
+
+
+

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

+

Removes the given entry from the given Cart.

+

+ + + + +
+
+ +
+
+
+
+
+
+
+ Update Entry from Cart + +
+
+
+

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

+

Updates the given entry from the given Cart.

+

+
+
Header parameters
+
+

Content-Type

+

The EntryUpdateStruct schema encoded in XML or JSON format.

@@ -66886,8 +70469,8 @@
Header parameters
@@ -66898,6 +70481,50 @@
Header parameters
+ + + +
+ +
+
+
+ + +
+
+

/cart/{identifier}/empty

+ +
+
+
+
+
+
+ Empty Cart + +
+
+
+

+ POST + /cart/{identifier}/empty +

+

Empties the given Cart.

+

+ +
Possible responses
@@ -66911,291 +70538,48 @@
Possible responses
- -
Examples - application/vnd.ibexa.api.LanguageList+xml -application/vnd.ibexa.api.LanguageList+json + application/vnd.ibexa.api.EntryUpdateStruct+xml +application/vnd.ibexa.api.EntryUpdateStruct+json
- - 200 - + 204 -

+

No Content - Cart emptied.
-
-
- -
-
Types
-
- - - - - - - - + + + + + -
TypeDescription
- - LanguageList - + 401 + +

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

+
+ 404 + +

Error - Cart not found.

List of languages.
+
-
-
-
-
-
- -
- Code: 200 -
-
-
-
-
-
-

- file_copy - -

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

- file_copy - -

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

/languages/{code}

+

/cart/{identifier}/summary

-
+
-
- Get language - + data-search="cart-summary"> + Cart Summary +

GET - /languages/{code} + /cart/{identifier}/summary

-

+

Gets a summary of the given Cart.

+

Header parameters

Accept

-

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

+

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

@@ -67250,8 +70635,8 @@
Header parameters
@@ -67275,7 +70660,7 @@
Possible responses
+ + + + + + + +
Examples - application/vnd.ibexa.api.Language+xml -application/vnd.ibexa.api.Language+json + application/vnd.ibexa.api.CartSummary+xml +application/vnd.ibexa.api.CartSummary+json
- 200 @@ -67283,6 +70668,22 @@
Possible responses

+ 401 + +

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

+
+ 404 + +

Error - Cart not found.

+
@@ -67302,11 +70703,11 @@
Types
- - Language + + CartSummary - This class represents a language in the Repository. + @@ -67319,29 +70720,19 @@
Types
-
+
-
-
-
-
-

- file_copy - -

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

file_copy

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

- eCommerce API (deprecated as of Ibexa DXP 4.4) - +

+ eCommerce API (removed) +

/commerce/basket

@@ -67530,7 +71244,7 @@

/commerce/basket

/commerce/basket

-
+
-
- Read list of baskets (deprecated as of Ibexa DXP 4.4) - + data-search="read-list-of-baskets-removed"> + Read list of baskets (removed) +
@@ -67555,7 +71269,8 @@

/commerce/basket

GET /commerce/basket

-

Returns baskets for the current user. Only "storedBasket" and "wishList" types are handled. Others will return validation error.

+

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

@@ -67746,7 +71461,7 @@
Types
-
+
+
+

/commerce/basket/current

+ +
+
+
+
+
+
+ Get current basket (removed) + +
+
+
+

+ GET + /commerce/basket/current +

+

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

+

+
+
Header parameters
+
+

Accept

+

+
+ + + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
Examples + application/vnd.ibexa.api.Basket+json +
+
+
+
+ + +
+
Possible responses
+
+ + + + + + + + + + + + + +
CodeDescription
+ + 200 + + +

+
+
+
+ +
+
Types
+
+ + + + + + + + + + + + + +
TypeDescription
+ + Basket + +
+
+
+ +
+
+ +
+
+
+
+
+ +
+ Code: 200 +
+
+
+
+
+
+

+ file_copy + +

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

/commerce/basket/current

+

/commerce/basket/current/{basketId}

-
+
-
- Get current basket (deprecated as of Ibexa DXP 4.4) - + data-search="copy-basket-to-user-session-removed"> + Copy basket to user session (removed) +

- GET - /commerce/basket/current + COPY + /commerce/basket/current/{basketId}

-

Returns a Basket instance for the current session. If there isn't one, a new one will be created.

+

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

-
-
Header parameters
-
-

Accept

-

-
- - - - - - - - - - - - - - - - - -
PropertyValue
Type - - - string - - -
Examples - application/vnd.ibexa.api.Basket+json -
-
-
-
- -
Possible responses
@@ -67943,7 +72111,7 @@
Possible responses
- 200 @@ -67951,6 +72119,17 @@
Possible responses

+ + + + + 400 + + + +

+ @@ -67975,6 +72154,14 @@
Types
+ + + + + ValidationResponse + + + @@ -67984,21 +72171,19 @@
Types
-
-
-
-
+
+
-
-
-
+
+

file_copy

- 
+                            
                                 {
   "Basket": {
     "_media-type": "application\/vnd.ibexa.api.Basket+json",
@@ -68063,17 +72248,17 @@ 
Types
- View more + View more
- +
+
+ +
+ Code: 400 +
+
+
+
+
+
+

+ file_copy + +

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

+ Product catalog + +

+
+

/product/catalog/catalogs

-

/commerce/customer/addresses/shipping

+

/product/catalog/catalogs

-
+
-
- Get list of shipping addresses (deprecated as of Ibexa DXP 4.4) - + data-search="create-catalog"> + Create catalog +

- GET - /commerce/customer/addresses/shipping + POST + /product/catalog/catalogs

-

+

Creates a new catalog.

+

+
+
Header parameters
+
+

Accept

+

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

+
+ + + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + + +
Examples + application/vnd.ibexa.api.CatalogCreate+json + +
+
+
+
+

Content-Type

+

The catalog schema encoded in XML or JSON format.

+
+ + + + + + + + + + + + + + + + + +
PropertyValue
Type + + + string + + + +
Examples + application/vnd.ibexa.api.CatalogCreate+json + +
+
+
+
+
Possible responses
@@ -76030,14 +80883,46 @@
Possible responses
- - 200 + 201

+ + + + 400 + + +

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

+ + + + + 401 + + +

Error - the user is not authorized to update this catalog.

+ + + + + 403 + + +

Error - a catalog with the same name already exists.

+ + + + + 404 + + +

Error - no catalog with the given code exists.

+ @@ -76057,8 +80942,16 @@
Types
- - ShippingAddressesResponse + + CatalogCreate + + + + + + + + Catalog @@ -76067,88 +80960,249 @@
Types
- -
-
- -
-
+ +
+
+ +
+
+
+ +
+
+
+
+
+

+ file_copy + +

+ 
+                                {
+    "CatalogCreate": {
+        "identifier": "test_catalog",
+        "criteria": {
+            "ProductCodeCriterion": ["ski", "snowboard"],
+            "ProductAvailabilityCriterion": true,
+            "ColorAttributeCriterion": {
+                "identifier": "color",
+                "value": ["#000000", "#FFFFFF"]
+            },
+            "CreatedAtCriterion": {
+                "operator": ">=",
+                "created_at": "12-09-2022"
+            },
+            "FloatAttributeCriterion": {
+                "identifier": "width",
+                "value": 16.6
+            },
+            "IntegerAttributeRangeCriterion": {
+                "identifier": "length",
+                "min": 180,
+                "max": 230
+            }
+        },
+        "names": {
+            "eng-GB": "Snow Equipment"
+        },
+        "status": "draft"
+    }
+}
+
+
+
+ View more +
+
+
+ +
+
+
+
-
-
-
+
+

file_copy

- 
-                                {
-  "ShippingAddressesResponse": {
-    "_media-type": "application\/vnd.ibexa.api.ShippingAddressesResponse+json",
-    "Parties": [
-      {
-        "_media-type": "application\/vnd.ibexa.api.Party+json",
-        "PartyIdentification": [],
-        "PartyName": [],
-        "PostalAddress": {
-          "_media-type": "application\/vnd.ibexa.api.PartyPostalAddress+json",
-          "StreetName": null,
-          "AdditionalStreetName": null,
-          "BuildingNumber": null,
-          "CityName": null,
-          "PostalZone": null,
-          "CountrySubentity": null,
-          "CountrySubentityCode": null,
-          "AddressLine": [],
-          "Country": {
-            "_media-type": "application\/vnd.ibexa.api.PartyPostalAddressCountry+json",
-            "IdentificationCode": null,
-            "Name": null
-          },
-          "Department": null,
-          "SesExtension": {}
+                            
+                                {
+    "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"
         },
-        "Contact": {
-          "_media-type": "application\/vnd.ibexa.api.Contact+json",
-          "ID":
+        "created": 1666090438,
+        "modified": 1666090438,
+        "status": "draft",
+        "Criteria": [
+            {
+                "_media-type": "application/vnd.ibexa.api.ProductCode+json",
+                "ProductCodeCriterion": {
+                    "_media-type": "application/vnd.ibexa.api.ProductCodeCriterion+json",
+                    "codes": [
+                        "ski",
+                        "snowboard"
+                    ]
+                }
+            },
+            {
+                "_media-type": "application/vnd.ibexa.api.ProductAvailability+json",
+                "ProductAvailabilityCriterion": {
+                    "_media-type":
- View more + View more
-
-
-

- Product catalog - -

-
-

/product/catalog/catalogs

-
-
+
-

/product/catalog/catalogs

+

/product/catalog/catalogs/copy/{identifier}

-
+
-
- Create catalog - + data-search="copy-catalog"> + Copy catalog +

POST - /product/catalog/catalogs + /product/catalog/catalogs/copy/{identifier}

-

Creates a new catalog.

+

Copies a catalog.

Header parameters

Accept

-

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

+

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

@@ -77023,7 +82368,7 @@
Header parameters
@@ -77033,7 +82378,7 @@
Header parameters

Content-Type

-

The catalog schema encoded in XML or JSON format.

+

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

Examples - application/vnd.ibexa.api.CatalogCreate+json + application/vnd.ibexa.api.CatalogCopy+json
@@ -77058,7 +82403,7 @@
Header parameters
@@ -77082,7 +82427,7 @@
Possible responses
@@ -77112,7 +82457,7 @@
Possible responses
403 @@ -77120,7 +82465,7 @@
Possible responses
404 @@ -77141,16 +82486,8 @@
Types
- - - - @@ -77164,18 +82501,18 @@
Types
-
+
-
-
-
+
+

file_copy

- 
+                            
                                 {
-    "CatalogCreate": {
-        "identifier": "test_catalog",
-        "criteria": {
-            "ProductCodeCriterion": ["ski", "snowboard"],
-            "ProductAvailabilityCriterion": true,
-            "ColorAttributeCriterion": {
-                "identifier": "color",
-                "value": ["#000000", "#FFFFFF"]
-            },
-            "CreatedAtCriterion": {
-                "operator": ">=",
-                "created_at": "12-09-2022"
-            },
-            "FloatAttributeCriterion": {
-                "identifier": "width",
-                "value": 16.6
-            },
-            "IntegerAttributeRangeCriterion": {
-                "identifier": "length",
-                "min": 180,
-                "max": 230
-            }
-        },
-        "names": {
-            "eng-GB": "Snow Equipment"
-        },
-        "status": "draft"
+    "CatalogCopy": {
+        "identifier": "test_catalog_copied",
+        "creator_id": 14 //optional
     }
 }
- View more + View more
-
Examples - application/vnd.ibexa.api.CatalogCreate+json + application/vnd.ibexa.api.CatalogCopy+json
- 201 @@ -77104,7 +82449,7 @@
Possible responses
401 		-

Error - the user is not authorized to update this catalog.

+

Error - the user is not authorized to copy this catalog.
-

Error - a catalog with the same name already exists.

+

Error - a catalog with the same identifier already exists.
-

Error - no catalog with the given code exists.

+

Error - no catalog with the given identifier exists.
- - CatalogCreate - -
- - Catalog + + CatalogCopy
- - - - - - - - - - - - - - - - -
CodeDescription
- 204 - -

No content - the given catalog is deleted.

-
- 401 - -

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

-
-
-
- - -
-
- -
-
-
-
-
-
+
-
- Load catalog - + data-search="filter-catalogs"> + Filter catalogs +

- GET - /product/catalog/catalogs/{identifier} + POST + /product/catalog/catalogs/view

-

Loads the given catalog.

+

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

Header parameters

Accept

-

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

+

The view in XML or JSON format.

@@ -77673,7 +82857,8 @@
Header parameters
@@ -77683,7 +82868,7 @@
Header parameters

Content-Type

-

The catalog schema encoded in XML or JSON format.

+

The view input in XML or JSON format.

Examples - application/vnd.ibexa.api.CatalogGet+json + application/vnd.ibexa.api.CatalogView+xml +application/vnd.ibexa.api.CatalogView+json
@@ -77708,7 +82893,8 @@
Header parameters
@@ -77732,7 +82918,7 @@
Possible responses
- - - - @@ -77775,8 +82953,16 @@
Types
+ + + + @@ -77790,20 +82976,142 @@
Types
+
+
+ +
+
+
+
+
+

+ file_copy + +

+ 
+                                {
+    "ViewInput": {
+        "identifier": "TitleView",
+        "CatalogQuery": {
+            "Query": {
+                "CatalogIdentifierCriterion": "test",
+                "CatalogNameCriterion": "test"
+            }
+        }
+    }
+}
+
+
+
+ View more +
+
+
+ +
-
+
-
-
-
+
+

file_copy

- 
+                            
                                 {
-    "Catalog": {
-        "_media-type": "application/vnd.ibexa.api.Catalog+json",
-        "identifier": "test_catalog",
-        "name": "Snow Equipment",
-        "description": "",
-        "User": {
-            "_media-type": "application/vnd.ibexa.api.User+json",
-            "_href": "/api/ibexa/v2/user/users/14"
+    "CatalogView": {
+        "_media-type": "application/vnd.ibexa.api.CatalogView+json",
+        "identifier": "TitleView",
+        "CatalogQuery": {
+            "_media-type": "application/vnd.ibexa.api.CatalogQuery+json"
         },
-        "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":
+        "Result": {
+            "_media-type": "application/vnd.ibexa.api.ViewResult+json",
+            "count": 1,
+            "CatalogList": {
+                "_media-type": "application/vnd.ibexa.api.CatalogList+json",
+                "Catalog": [
+                    {
+                        "_media-type": "application/vnd.ibexa.api.Catalog+json",
+                        "identifier": "test",
+                        "name": "test",
+                        "description": "",
+                        "User": {
+                            "_media-type": "application/vnd.ibexa.api.User+json",
+                            "_href": "/api/ibexa/v2/user/users/14"
+                        },
+                        "created": 1665479475,
+
- View more + View more
-
Examples - application/vnd.ibexa.api.CatalogGet+json + application/vnd.ibexa.api.CatalogViewInput+xml +application/vnd.ibexa.api.CatalogViewInput+json
- 200 @@ -77743,18 +82929,10 @@
Possible responses
- 401 - -

Error - the user is not authorized to view this catalog.

-
- 404 + 400 -

Error - no catalog with the given identifier exists.

+

Error - the input does not match the input schema definition.
- - Catalog + + CatalogViewInput + +
+ + ProductView
@@ -78050,7 +83336,8 @@
Header parameters
@@ -78060,7 +83347,7 @@
Header parameters

Content-Type

-

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

+

The view input in XML or JSON format.

Examples - application/vnd.ibexa.api.CatalogUpdate+json + application/vnd.ibexa.api.ProductView+xml +application/vnd.ibexa.api.ProductView+json
@@ -78085,7 +83372,8 @@
Header parameters
@@ -78109,9 +83397,9 @@
Possible responses
- - - - - - - - - - - -
Examples - application/vnd.ibexa.api.CatalogUpdate+json + application/vnd.ibexa.api.ProductViewInput+xml +application/vnd.ibexa.api.ProductViewInput+json
- - 201 + 200 @@ -78125,30 +83413,6 @@
Possible responses

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

- 401 - -

Error - the user is not authorized to update this catalog.

-
- 403 - -

Error - a catalog with the same identifier already exists.

-
- 404 - -

Error - no catalog with the given identifier exists.

-
@@ -78168,8 +83432,16 @@
Types
- - CatalogUpdate + + ProductViewInput + + + + + + + + ProductView @@ -78183,18 +83455,18 @@
Types
-
+
-
-
-
+
+

file_copy

- 
+                            
                                 {
-    "CatalogUpdate": {
-        "identifier": "test_catalog_updated",
-        "criteria": {
-            "ProductCodeCriterion": ["ski"],
-            "ProductAvailabilityCriterion": false,
-            "CreatedAtCriterion": {
-                "operator": ">=",
-                "created_at": "12-12-2022"
+    "ViewInput": {
+        "identifier": "TitleView",
+        "ProductQuery": {
+            "Query": {
+                "ProductCodeCriterion": "test",
+                "ProductAvailabilityCriterion": true
             }
-        },
-        "names": {
-            "eng-GB": "Snow Equipment updated"
-        },
-        "descriptions": {
-            "eng-GB": "Snow Equipment catalog for 2022"
-        },
-        "transition": "publish"
+        }
     }
 }
- View more + View more
-