openapi: 3.1.0 info: title: Cohesivo SaaS REST API description: '' version: '' x-logo: url: https://doc.ibexa.co/en/saas/images/cohesivo-logo-alt.svg servers: - url: /api/ibexa/v2 description: Current server security: [] tags: - name: Section description: Resource 'Section' operations. - name: Objects description: Resource 'Objects' operations. - name: Type Groups description: Resource 'Type Groups' operations. - name: Type description: Resource 'Type' operations. - name: User description: Resource 'User' operations. - name: User Group description: Resource 'User Group' operations. - name: User Role description: Resource 'User Role' operations. - name: User Policy description: Resource 'User Policy' operations. - name: Language description: Resource 'Language' operations. - name: Location description: Resource 'Location' operations. - name: Object State Groups description: Resource 'Object State Groups' operations. - name: Trash description: Resource 'Trash' operations. - name: Url Alias description: Resource 'Url Alias' operations. - name: Views description: Controller for Repository Views (Search, mostly). - name: User Session description: Resource 'User Session' operations. - name: Bookmark description: Resource 'Bookmark' operations. - name: Calendar description: Resource 'Calendar' operations. - name: Product Attribute description: Resource 'Product Attribute' operations. - name: Product Attribute Type description: Resource 'Product Attribute Type' operations. - name: Product Attribute Group description: Resource 'Product Attribute Group' operations. - name: Product Catalog description: Resource 'Product Catalog' operations. - name: Product Currency description: Resource 'Product Currency' operations. - name: Product Customer Group description: Resource 'Product Customer Group' operations. - name: Product description: Resource 'Product' operations. - name: Product Type description: Resource 'Product Type' operations. - name: Product Variant description: Resource 'Product Variant' operations. - name: Product Region description: Resource 'Product Region' operations. - name: Product Vat description: Resource 'Product Vat' operations. - name: Taxonomy description: Resource 'Taxonomy' operations. - name: Page description: Resource 'Page' operations. - name: Segmentation description: Resource 'Segmentation' operations. - name: Activity Log description: Resource 'Activity Log' operations. - name: Connector AI description: Resource 'Connector AI' operations. - name: Collaboration Sessions description: Resource 'Collaboration Sessions' operations. paths: /activity-log-group/list: get: operationId: ibexa.activity_log.rest.activity_log_group.list.get tags: - Activity Log responses: '200': description: If set, the list is returned in XML or JSON format. content: application/vnd.ibexa.api.ActivityLogGroupList+json: schema: $ref: '#/components/schemas/ActivityLogGroupListWrapper' example: ActivityLogGroupList: _media-type: application/vnd.ibexa.api.ActivityLogGroupList+json _href: /api/ibexa/v2/activity-log-group/list ActivityLogGroups: - _media-type: application/vnd.ibexa.api.ActivityLogGroup+json user_id: 14 logged_at: 1707478796 ActivityLogEntries: - _media-type: application/vnd.ibexa.api.ActivityLog+json object_id: '396' object_class: Ibexa\Contracts\Core\Repository\Values\Content\Content action: create data: [] - _media-type: application/vnd.ibexa.api.ActivityLog+json object_id: '396' object_class: Ibexa\Contracts\Core\Repository\Values\Content\Content action: publish data: [] - _media-type: application/vnd.ibexa.api.ActivityLogGroup+json user_id: 14 logged_at: 1707475048 ActivityLogEntries: - _media-type: application/vnd.ibexa.api.ActivityLog+json object_id: '395' object_class: Ibexa\Contracts\Core\Repository\Values\Content\Content action: create data: [] - _media-type: application/vnd.ibexa.api.ActivityLog+json object_id: '395' object_class: Ibexa\Contracts\Core\Repository\Values\Content\Content action: publish data: [] application/vnd.ibexa.api.ActivityLogGroupList+xml: schema: $ref: '#/components/schemas/ActivityLogGroupList' example: | 14 1707478796 396 Ibexa\Contracts\Core\Repository\Values\Content\Content create 396 Ibexa\Contracts\Core\Repository\Values\Content\Content publish 14 1707475048 395 Ibexa\Contracts\Core\Repository\Values\Content\Content create 395 Ibexa\Contracts\Core\Repository\Values\Content\Content publish '401': description: Error - the user is not authorized to list activities. summary: List of activity log groups description: Lists last activity log groups and their entries. parameters: [] post: operationId: ibexa.activity_log.rest.activity_log_group.list.post tags: - Activity Log responses: '200': description: If set, the list is returned in XML or JSON format. content: application/vnd.ibexa.api.ActivityLogGroupList+json: schema: $ref: '#/components/schemas/ActivityLogGroupListWrapper' example: ActivityLogGroupList: _media-type: application/vnd.ibexa.api.ActivityLogGroupList+json _href: /api/ibexa/v2/activity-log-group/list ActivityLogGroups: - _media-type: application/vnd.ibexa.api.ActivityLogGroup+json user_id: 14 logged_at: 1707478796 ActivityLogEntries: - _media-type: application/vnd.ibexa.api.ActivityLog+json object_id: '396' object_class: Ibexa\Contracts\Core\Repository\Values\Content\Content action: create data: [] - _media-type: application/vnd.ibexa.api.ActivityLog+json object_id: '396' object_class: Ibexa\Contracts\Core\Repository\Values\Content\Content action: publish data: [] - _media-type: application/vnd.ibexa.api.ActivityLogGroup+json user_id: 14 logged_at: 1707475048 ActivityLogEntries: - _media-type: application/vnd.ibexa.api.ActivityLog+json object_id: '395' object_class: Ibexa\Contracts\Core\Repository\Values\Content\Content action: create data: [] - _media-type: application/vnd.ibexa.api.ActivityLog+json object_id: '395' object_class: Ibexa\Contracts\Core\Repository\Values\Content\Content action: publish data: [] application/vnd.ibexa.api.ActivityLogGroupList+xml: schema: $ref: '#/components/schemas/ActivityLogGroupList' example: | 14 1707478796 396 Ibexa\Contracts\Core\Repository\Values\Content\Content create 396 Ibexa\Contracts\Core\Repository\Values\Content\Content publish 14 1707475048 395 Ibexa\Contracts\Core\Repository\Values\Content\Content create 395 Ibexa\Contracts\Core\Repository\Values\Content\Content publish '401': description: Error - the user is not authorized to list activities. summary: List of activity log groups description: Lists last activity log groups and their entries. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The query to filter activity log groups. content: application/vnd.ibexa.api.ActivityLogGroupListInput+json: schema: $ref: '#/components/schemas/ActivityLogGroupListInputWrapper' example: ActivityLogGroupListInput: offset: 0 limit: 10 criteria: - type: object_class class: Ibexa\Contracts\Core\Repository\Values\Content\Content - type: action value: - create - type: logged_at value: '- 1 hour' operator: '>=' sortClauses: - type: logged_at direction: DESC application/vnd.ibexa.api.ActivityLogGroupListInput+xml: schema: $ref: '#/components/schemas/ActivityLogGroupListInput' example: | 0 10 Ibexa\Contracts\Core\Repository\Values\Content\Content create - 1 hour >= DESC required: false /bookmark: get: operationId: ibexa.rest.load_bookmarks tags: - Bookmark responses: '200': description: If set, the list is returned in XML or JSON format. content: application/vnd.ibexa.api.BookmarkList+json: schema: $ref: '#/components/schemas/BookmarkListWrapper' example: BookmarkList: _media-type: application/vnd.ibexa.api.BookmarkList+json count: 3 items: - _media-type: application/vnd.ibexa.api.Bookmark+json __href: /api/ibexa/v2/bookmark/65 Location: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/2/57/65 id: 65 priority: 0 hidden: false invisible: false explicitlyHidden: false ParentLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/2/57 pathString: /1/2/57/65/ depth: 3 childCount: 0 remoteId: aa538e305aea472eb221ce23d1cc4b50 Children: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/locations/1/2/57/65/children Content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/63 sortField: PATH sortOrder: ASC UrlAliases: _media-type: application/vnd.ibexa.api.UrlAliasRefList+json _href: /api/ibexa/v2/content/locations/1/2/57/65/urlaliases ContentInfo: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/63 Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/63 _remoteId: 211e99934c8fef5900e4813b96ec5c87 _id: 63 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2 Name: Art3 TranslatedName: Art3 Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/63/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/63/currentversion Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/63/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 lastModificationDate: '2021-06-28T11:34:17+00:00' publishedDate: '2021-06-28T11:34:17+00:00' mainLanguageCode: eng-GB currentVersionNo: 1 alwaysAvailable: false isHidden: false status: PUBLISHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/63/objectstates - _media-type: application/vnd.ibexa.api.Bookmark+json __href: /api/ibexa/v2/bookmark/68 Location: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/2/58/68 id: 68 priority: 0 hidden: false invisible: false explicitlyHidden: false ParentLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/2/58 pathString: /1/2/58/68/ depth: 3 childCount: 0 remoteId: b8cc4627dbc3ca693c85b6b06a8f7492 Children: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/locations/1/2/58/68/children Content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/67 sortField: PUBLISHED sortOrder: DESC UrlAliases: _media-type: application/vnd.ibexa.api.UrlAliasRefList+json _href: /api/ibexa/v2/content/locations/1/2/58/68/urlaliases ContentInfo: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/67 Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/67 _remoteId: 180adb876af5755d65c1a362fcd619c8 _id: 67 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/45 Name: Tip1 TranslatedName: Tip1 Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/67/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/67/currentversion Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/67/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 lastModificationDate: '2021-06-28T11:36:21+00:00' publishedDate: '2021-06-28T11:36:21+00:00' mainLanguageCode: eng-GB currentVersionNo: 1 alwaysAvailable: true isHidden: false status: PUBLISHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/67/objectstates - _media-type: application/vnd.ibexa.api.Bookmark+json __href: /api/ibexa/v2/bookmark/59 Location: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/2/59 id: 59 priority: 0 hidden: false invisible: false explicitlyHidden: false ParentLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/2 pathString: /1/2/59/ depth: 2 childCount: 3 remoteId: fd949fc2eed1fff847d73021ff1a6ea9 Children: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/locations/1/2/59/children Content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/58 sortField: PATH sortOrder: ASC UrlAliases: _media-type: application/vnd.ibexa.api.UrlAliasRefList+json _href: /api/ibexa/v2/content/locations/1/2/59/urlaliases ContentInfo: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/58 Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/58 _remoteId: 00b513aae54036a16e00fb3365c4b5f3 _id: 58 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/1 Name: Dog Breed Catalog TranslatedName: Dog Breed Catalog Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/58/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/58/currentversion Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/58/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 lastModificationDate: '2021-06-28T11:23:10+00:00' publishedDate: '2021-06-28T11:23:10+00:00' mainLanguageCode: eng-GB currentVersionNo: 1 alwaysAvailable: true isHidden: false status: PUBLISHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/58/objectstates application/vnd.ibexa.api.BookmarkList+xml: schema: $ref: '#/components/schemas/BookmarkList' example: | 3 65 0 false false false /1/2/57/65/ 3 0 aa538e305aea472eb221ce23d1cc4b50 PATH ASC Art3 Art3
2021-06-28T11:34:17+00:00 2021-06-28T11:34:17+00:00 eng-GB 1 false false PUBLISHED 68 0 false false false /1/2/58/68/ 3 0 b8cc4627dbc3ca693c85b6b06a8f7492 PUBLISHED DESC Tip1 Tip1
2021-06-28T11:36:21+00:00 2021-06-28T11:36:21+00:00 eng-GB 1 true false PUBLISHED 59 0 false false false /1/2/59/ 2 3 fd949fc2eed1fff847d73021ff1a6ea9 PATH ASC Dog Breed Catalog Dog Breed Catalog
2021-06-28T11:23:10+00:00 2021-06-28T11:23:10+00:00 eng-GB 1 true false PUBLISHED '401': description: Error - the user is not authorized to list bookmarks. summary: List of bookmarks description: Lists bookmarked Locations for the current user. parameters: [] /bookmark/{locationId}: get: operationId: ibexa.rest.is_bookmarked.get tags: - Bookmark responses: '200': description: OK - the given Location is bookmarked. '204': description: BookmarkIsBookmarkedController resource '401': description: Error - the user is not authorized for the given Location. '404': description: Error - the given Location is not bookmarked or does not exist. summary: Check if Location is bookmarked description: Checks if the given Location is bookmarked by the current user. parameters: - name: locationId in: path description: BookmarkIsBookmarkedController identifier required: true deprecated: false schema: type: integer style: simple explode: false post: operationId: ibexa.rest.create_bookmark tags: - Bookmark responses: '201': description: Created. '401': description: Error - the user is not authorized to given Location. '404': description: Error - the given Location does not exist. '409': description: Error - Location is already bookmarked. summary: Create bookmark description: Add given Location to bookmarks of the current user. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: locationId in: path description: BookmarkCreateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: No payload required content: {} required: false delete: operationId: ibexa.rest.delete_bookmark tags: - Bookmark responses: '204': description: Deleted - no content. '401': description: Error - the user is not authorized for the given Location. '404': description: Error - the given Location does not exist / is not bookmarked. summary: Delete bookmark description: Deletes the given Location from bookmarks of the current user. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: locationId in: path description: BookmarkDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false head: operationId: ibexa.rest.is_bookmarked.head tags: - Bookmark responses: '200': description: OK - the given Location is bookmarked. '401': description: Error - the user is not authorized for the given Location. '404': description: Error - the given Location is not bookmarked or does not exist. summary: Check if Location is bookmarked description: Checks if the given Location is bookmarked by the current user. parameters: - name: locationId in: path description: BookmarkIsBookmarkedController identifier required: true deprecated: false schema: type: integer style: simple explode: false /calendar/event: get: operationId: ibexa.calendar.rest.event.list tags: - Calendar responses: '200': description: If set, the calendar event list is returned in XML or JSON format. content: application/vnd.ibexa.api.EventList+json: schema: $ref: '#/components/schemas/EventListWrapper' example: EventList: _media-type: application/vnd.ibexa.api.EventList+json _currentPage: /api/ibexa/v2/calendar/event?start=1597104000&end=1598745600&count=10 totalCount: 5 events: [] application/vnd.ibexa.api.EventList+xml: schema: $ref: '#/components/schemas/EventList' example: | 5 '400': description: Error - the query is invalid. `start` or `end` is missing or in invalid format, or another filter is malformed. summary: Calendar list description: Calendar event list. parameters: - name: start in: query description: timestamp (seconds since the Unix Epoch). required: true deprecated: false schema: $ref: '#/components/schemas/UnixTimestamp' style: form explode: false - name: end in: query description: timestamp. required: true deprecated: false schema: $ref: '#/components/schemas/UnixTimestamp' style: form explode: false - name: count in: query description: Maximum number of events returned (10 by default). required: false deprecated: false schema: type: integer style: form explode: false - name: types in: query description: Comma-separated list of type identifiers. required: false deprecated: false schema: type: array items: type: string style: form explode: false example: - future_publication - future_hide - page_block_reveal - page_block_hide - name: languages in: query description: comma-separated list of language codes. required: false deprecated: false schema: type: array items: type: string style: form explode: false example: - eng-GB - fre-FR - name: cursor in: query description: Pagination cursor. It's the representation of the event to start the page afterward, as the concatenation of the timestamp, the event type, and the event identifier with a colon separator ("::"), encoded in base64. For example "1778264040:future_hide:future_hide:2" ("future_hide:2" is the ID) encoded as "MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy" required: false deprecated: false schema: type: string style: form explode: false example: MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy /calendar/event/grouped-by-day: get: operationId: ibexa.calendar.rest.event.list.group_by_day tags: - Calendar responses: '200': description: If set, the calendar event list grouped by day is returned in XML or JSON format. content: application/vnd.ibexa.api.EventGroupList+json: schema: $ref: '#/components/schemas/EventGroupListWrapper' example: EventGroupList: _media-type: application/vnd.ibexa.api.EventGroupList+json groups: - _media-type: application/vnd.ibexa.api.EventGroup+json _currentPage: /api/ibexa/v2/calendar/event?start=1597104000&end=1597190400&count=10 DateRange: _media-type: application/vnd.ibexa.api.DateRange+json startDate: '1597104000' endDate: '1597190400' totalCount: 0 events: [] - _media-type: application/vnd.ibexa.api.EventGroup+json _currentPage: /api/ibexa/v2/calendar/event?start=1597190400&end=1597276800&count=10 DateRange: _media-type: application/vnd.ibexa.api.DateRange+json startDate: '1597190400' endDate: '1597276800' totalCount: 0 events: [] - _media-type: application/vnd.ibexa.api.EventGroup+json _currentPage: /api/ibexa/v2/calendar/event?start=1597276800&end=1597363200&count=10 DateRange: _media-type: application/vnd.ibexa.api.DateRange+json startDate: '1597276800' endDate: '1597363200' totalCount: 1 events: [] - _media-type: application/vnd.ibexa.api.EventGroup+json _currentPage: /api/ibexa/v2/calendar/event?start=1597363200&end=1597449600&count=10 DateRange: _media-type: application/vnd.ibexa.api.DateRange+json startDate: '1597363200' endDate: '1597449600' totalCount: 1 events: [] - _media-type: application/vnd.ibexa.api.EventGroup+json _currentPage: /api/ibexa/v2/calendar/event?start=1597449600&end=1597536000&count=10 DateRange: _media-type: application/vnd.ibexa.api.DateRange+json startDate: '1597449600' endDate: '1597536000' totalCount: 1 events: [] - _media-type: application/vnd.ibexa.api.EventGroup+json _currentPage: /api/ibexa/v2/calendar/event?start=1597536000&end=1597622400&count=10 DateRange: _media-type: application/vnd.ibexa.api.DateRange+json startDate: '1597536000' endDate: '1597622400' totalCount: 1 events: [] - _media-type: application/vnd.ibexa.api.EventGroup+json _currentPage: /api/ibexa/v2/calendar/event?start=1597622400&end=1597708800&count=10 DateRange: _media-type: application/vnd.ibexa.api.DateRange+json startDate: '1597622400' endDate: '1597708800' totalCount: 0 events: [] - _media-type: application/vnd.ibexa.api.EventGroup+json _currentPage: /api/ibexa/v2/calendar/event?start=1597708800&end=1597795200&count=10 DateRange: _media-type: application/vnd.ibexa.api.DateRange+json startDate: '1597708800' endDate: '1597795200' totalCount: 0 events: [] - _media-type: application/vnd.ibexa.api.EventGroup+json _currentPage: /api/ibexa/v2/calendar/event?start=1597795200&end=1597881600&count=10 DateRange: _media-type: application/vnd.ibexa.api.DateRange+json startDate: '1597795200' endDate: '1597881600' totalCount: 1 events: [] - _media-type: application/vnd.ibexa.api.EventGroup+json _currentPage: /api/ibexa/v2/calendar/event?start=1597881600&end=1597968000&count=10 DateRange: _media-type: application/vnd.ibexa.api.DateRange+json startDate: '1597881600' endDate: '1597968000' totalCount: 0 events: [] - _media-type: application/vnd.ibexa.api.EventGroup+json _currentPage: /api/ibexa/v2/calendar/event?start=1597968000&end=1598054400&count=10 DateRange: _media-type: application/vnd.ibexa.api.DateRange+json startDate: '1597968000' endDate: '1598054400' totalCount: 0 events: [] - _media-type: application/vnd.ibexa.api.EventGroup+json _currentPage: /api/ibexa/v2/calendar/event?start=1598054400&end=1598140800&count=10 DateRange: _media-type: application/vnd.ibexa.api.DateRange+json startDate: '1598054400' endDate: '1598140800' totalCount: 0 events: [] - _media-type: application/vnd.ibexa.api.EventGroup+json _currentPage: /api/ibexa/v2/calendar/event?start=1598140800&end=1598227200&count=10 DateRange: _media-type: application/vnd.ibexa.api.DateRange+json startDate: '1598140800' endDate: '1598227200' totalCount: 0 events: [] - _media-type: application/vnd.ibexa.api.EventGroup+json _currentPage: /api/ibexa/v2/calendar/event?start=1598227200&end=1598313600&count=10 DateRange: _media-type: application/vnd.ibexa.api.DateRange+json startDate: '1598227200' endDate: '1598313600' totalCount: 0 events: [] - _media-type: application/vnd.ibexa.api.EventGroup+json _currentPage: /api/ibexa/v2/calendar/event?start=1598313600&end=1598400000&count=10 DateRange: _media-type: application/vnd.ibexa.api.DateRange+json startDate: '1598313600' endDate: '1598400000' totalCount: 0 events: [] - _media-type: application/vnd.ibexa.api.EventGroup+json _currentPage: /api/ibexa/v2/calendar/event?start=1598400000&end=1598486400&count=10 DateRange: _media-type: application/vnd.ibexa.api.DateRange+json startDate: '1598400000' endDate: '1598486400' totalCount: 0 events: [] - _media-type: application/vnd.ibexa.api.EventGroup+json _currentPage: /api/ibexa/v2/calendar/event?start=1598486400&end=1598572800&count=10 DateRange: _media-type: application/vnd.ibexa.api.DateRange+json startDate: '1598486400' endDate: '1598572800' totalCount: 0 events: [] - _media-type: application/vnd.ibexa.api.EventGroup+json _currentPage: /api/ibexa/v2/calendar/event?start=1598572800&end=1598659200&count=10 DateRange: _media-type: application/vnd.ibexa.api.DateRange+json startDate: '1598572800' endDate: '1598659200' totalCount: 0 events: [] - _media-type: application/vnd.ibexa.api.EventGroup+json _currentPage: /api/ibexa/v2/calendar/event?start=1598659200&end=1598745600&count=10 DateRange: _media-type: application/vnd.ibexa.api.DateRange+json startDate: '1598659200' endDate: '1598745600' totalCount: 0 events: [] application/vnd.ibexa.api.EventGroupList+xml: schema: $ref: '#/components/schemas/EventGroupList' example: | 1597104000 1597190400 0 1597190400 1597276800 0 1597276800 1597363200 1 1597363200 1597449600 1 1597449600 1597536000 1 1597536000 1597622400 1 1597622400 1597708800 0 1597708800 1597795200 0 1597795200 1597881600 1 1597881600 1597968000 0 1597968000 1598054400 0 1598054400 1598140800 0 1598140800 1598227200 0 1598227200 1598313600 0 1598313600 1598400000 0 1598400000 1598486400 0 1598486400 1598572800 0 1598572800 1598659200 0 1598659200 1598745600 0 '400': description: Error - the query is invalid. `start` or `end` is missing or in invalid format, or another filter is malformed. summary: Calendar list grouped by day description: Calendar event list grouped by day. parameters: - name: start in: query description: timestamp (seconds since the Unix Epoch). required: true deprecated: false schema: $ref: '#/components/schemas/UnixTimestamp' style: form explode: false - name: end in: query description: timestamp. required: true deprecated: false schema: $ref: '#/components/schemas/UnixTimestamp' style: form explode: false - name: count in: query description: Maximum number of events returned (10 by default). required: false deprecated: false schema: type: integer style: form explode: false - name: types in: query description: Comma-separated list of type identifiers. required: false deprecated: false schema: type: array items: type: string style: form explode: false example: - future_publication - future_hide - page_block_reveal - page_block_hide - name: languages in: query description: comma-separated list of language codes. required: false deprecated: false schema: type: array items: type: string style: form explode: false example: - eng-GB - fre-FR - name: cursor in: query description: Pagination cursor. It's the representation of the event to start the page afterward, as the concatenation of the timestamp, the event type, and the event identifier with a colon separator ("::"), encoded in base64. For example "1778264040:future_hide:future_hide:2" ("future_hide:2" is the ID) encoded as "MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy" required: false deprecated: false schema: type: string style: form explode: false example: MTc3ODI2NDA0MDpmdXR1cmVfaGlkZTpmdXR1cmVfaGlkZToy /calendar/event/{eventType}: post: operationId: ibexa.calendar.rest.event.action tags: - Calendar responses: '204': description: No Content - the action has been rescheduled or unscheduled. summary: Calendar action description: A calendar action that e.g. reschedules or unschedules calendar events. The event type should always be copied from an event. parameters: - name: eventType in: path description: The type of event to execute an action on. required: true deprecated: false schema: type: string enum: - future_publication - future_hide style: simple explode: false requestBody: description: Data for the calendar action to execute content: application/vnd.ibexa.api.calendar.future_publication.RescheduleAction+json: schema: $ref: '#/components/schemas/RescheduleActionWrapper' application/vnd.ibexa.api.calendar.future_hide.RescheduleAction+json: schema: $ref: '#/components/schemas/RescheduleActionWrapper' example: RescheduleAction: events: - hide_publication:123 dateTime: '1775556271' application/vnd.ibexa.api.calendar.future_publication.UnscheduleAction+json: schema: $ref: '#/components/schemas/UnscheduleActionWrapper' example: UnscheduleAction: events: - future_publication:2 application/vnd.ibexa.api.calendar.future_hide.UnscheduleAction+json: schema: $ref: '#/components/schemas/UnscheduleActionWrapper' required: true /collaboration/sessions: post: operationId: api_collaborationsessions_post tags: - Collaboration Sessions responses: '201': description: Session created content: application/vnd.ibexa.api.ExampleSession+xml: schema: $ref: '#/components/schemas/ExampleSessionWrapper' example: |+ 123 abc123def456ghi789 2023-11-15T10:30:00+00:00 2023-11-15T14:45:00+00:00 1 John Doe edit 2023-11-15T10:30:00+00:00 2023-11-15T10:30:00+00:00 2 guest@example.com view guest@example.com 2023-11-15T11:00:00+00:00 2023-11-15T11:00:00+00:00 Project Collaboration Session true false application/vnd.ibexa.api.ExampleSession+json: schema: $ref: '#/components/schemas/ExampleSessionWrapper' example: CollaborationSession: _media-type: application/vnd.ibexa.api.ExampleSession+json createdAt: '2023-11-15T10:30:00+00:00' id: 123 token: abc123def456ghi789 updatedAt: '2023-11-15T14:45:00+00:00' ParticipantList: _media-type: application/vnd.ibexa.api.ParticipantList+json Participants: - User: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 _media-type: application/vnd.ibexa.api.InternalParticipant+json createdAt: '2023-11-15T10:30:00+00:00' id: 1 name: John Doe scope: edit updatedAt: '2023-11-15T10:30:00+00:00' - _media-type: application/vnd.ibexa.api.ExternalParticipant+json createdAt: '2023-11-15T11:00:00+00:00' email: guest@example.com id: 2 name: guest@example.com scope: view updatedAt: '2023-11-15T11:00:00+00:00' Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 subject: Project Collaboration Session isActive: true hasPublicLink: false '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to create sessions. summary: Create collaboration session description: Creates a new collaboration session with participants and returns the session details. parameters: [] requestBody: description: Session creation payload content: application/vnd.ibexa.api.ExampleSessionCreate+xml: schema: $ref: '#/components/schemas/ExampleSessionCreate' example: |+ view user@link.invalid view example application/vnd.ibexa.api.ExampleSessionCreate+json: schema: $ref: '#/components/schemas/ExampleSessionCreate' example: ExampleSessionCreate: Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 ParticipantListCreate: _media-type: application/vnd.ibexa.api.ParticipantListCreate+json ParticipantCreate: - _media-type: application/vnd.ibexa.api.InternalParticipantCreate+json User: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 scope: view - _media-type: application/vnd.ibexa.api.ExternalParticipantCreate+json email: user@link.invalid scope: view subject: example required: false /collaboration/sessions/{sessionToken}: get: operationId: api_collaborationsessions_sessionToken_get tags: - Collaboration Sessions responses: '200': description: Session content: application/vnd.ibexa.api.ExampleSession+xml: schema: $ref: '#/components/schemas/ExampleSessionWrapper' example: |+ 123 abc123def456ghi789 2023-11-15T10:30:00+00:00 2023-11-15T14:45:00+00:00 1 John Doe edit 2023-11-15T10:30:00+00:00 2023-11-15T10:30:00+00:00 2 guest@example.com view guest@example.com 2023-11-15T11:00:00+00:00 2023-11-15T11:00:00+00:00 Project Collaboration Session true false application/vnd.ibexa.api.ExampleSession+json: schema: $ref: '#/components/schemas/ExampleSessionWrapper' example: CollaborationSession: _media-type: application/vnd.ibexa.api.ExampleSession+json createdAt: '2023-11-15T10:30:00+00:00' id: 123 token: abc123def456ghi789 updatedAt: '2023-11-15T14:45:00+00:00' ParticipantList: _media-type: application/vnd.ibexa.api.ParticipantList+json Participants: - User: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 _media-type: application/vnd.ibexa.api.InternalParticipant+json createdAt: '2023-11-15T10:30:00+00:00' id: 1 name: John Doe scope: edit updatedAt: '2023-11-15T10:30:00+00:00' - _media-type: application/vnd.ibexa.api.ExternalParticipant+json createdAt: '2023-11-15T11:00:00+00:00' email: guest@example.com id: 2 name: guest@example.com scope: view updatedAt: '2023-11-15T11:00:00+00:00' Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 subject: Project Collaboration Session isActive: true hasPublicLink: false '401': description: Error - the user is not authorized to access this session. '404': description: Error - the session does not exist. summary: Get collaboration session description: Retrieves a collaboration session by its token. parameters: - name: sessionToken in: path description: The session token to retrieve. required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: api_collaborationsessions_sessionToken_delete tags: - Collaboration Sessions responses: '204': description: Session deleted '401': description: Error - the user is not authorized to delete this session. '404': description: Error - the session does not exist. summary: Delete collaboration session description: Deletes a collaboration session and removes all associated data. parameters: - name: sessionToken in: path description: The session token to delete. required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: api_collaborationsessions_sessionToken_patch tags: - Collaboration Sessions responses: '200': description: Updated session content: application/vnd.ibexa.api.ExampleSession+xml: schema: $ref: '#/components/schemas/ExampleSessionWrapper' example: |+ 123 abc123def456ghi789 2023-11-15T10:30:00+00:00 2023-11-15T14:45:00+00:00 1 John Doe edit 2023-11-15T10:30:00+00:00 2023-11-15T10:30:00+00:00 2 guest@example.com view guest@example.com 2023-11-15T11:00:00+00:00 2023-11-15T11:00:00+00:00 Project Collaboration Session true false application/vnd.ibexa.api.ExampleSession+json: schema: $ref: '#/components/schemas/ExampleSessionWrapper' example: CollaborationSession: _media-type: application/vnd.ibexa.api.ExampleSession+json createdAt: '2023-11-15T10:30:00+00:00' id: 123 token: abc123def456ghi789 updatedAt: '2023-11-15T14:45:00+00:00' ParticipantList: _media-type: application/vnd.ibexa.api.ParticipantList+json Participants: - User: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 _media-type: application/vnd.ibexa.api.InternalParticipant+json createdAt: '2023-11-15T10:30:00+00:00' id: 1 name: John Doe scope: edit updatedAt: '2023-11-15T10:30:00+00:00' - _media-type: application/vnd.ibexa.api.ExternalParticipant+json createdAt: '2023-11-15T11:00:00+00:00' email: guest@example.com id: 2 name: guest@example.com scope: view updatedAt: '2023-11-15T11:00:00+00:00' Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 subject: Project Collaboration Session isActive: true hasPublicLink: false '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to update this session. '404': description: Error - the session does not exist. summary: Update collaboration session description: Updates collaboration session properties. parameters: - name: sessionToken in: path description: The session token to update. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: Session update payload content: application/vnd.ibexa.api.ExampleSessionUpdate+xml: schema: $ref: '#/components/schemas/ExampleSessionUpdate' example: |+ true application/vnd.ibexa.api.ExampleSessionUpdate+json: schema: $ref: '#/components/schemas/ExampleSessionUpdate' example: ExampleSessionUpdate: hasPublicLink: true required: false /collaboration/sessions/{sessionToken}/invitations: post: operationId: api_collaborationsessions_sessionTokeninvitations_post tags: - Collaboration Sessions responses: '201': description: Invitation created content: application/vnd.ibexa.api.Invitation+xml: schema: $ref: '#/components/schemas/InvitationWrapper' application/vnd.ibexa.api.Invitation+json: schema: $ref: '#/components/schemas/InvitationWrapper' '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to create invitations for this session. '404': description: Error - the session does not exist. summary: Create invitation in collaboration session description: Creates an invitation for a participant to join a collaboration session. parameters: - name: sessionToken in: path description: The session token. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: Invitation creation payload content: application/vnd.ibexa.api.InvitationCreate+xml: schema: $ref: '#/components/schemas/InvitationCreate' example: |+ anonymous@link.invalid test value1 value2 value3 value4 value5 value bar_value baz_value foo_value application/vnd.ibexa.api.InvitationCreate+json: schema: $ref: '#/components/schemas/InvitationCreate' example: InvitationCreate: email: external.user@example.com Sender: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 context: single_value: value simple_array: - test - value1 - value2 - value3 - value4 - value5 extended_array: foo: foo_value bar: bar_value baz: baz_value required: false /collaboration/sessions/{sessionToken}/participants: get: operationId: api_collaborationsessions_sessionTokenparticipants_get tags: - Collaboration Sessions responses: '200': description: Participants list content: application/vnd.ibexa.api.ParticipantList+xml: schema: $ref: '#/components/schemas/ParticipantListWrapper' example: |+ 1 John Doe edit 2023-11-15T10:30:00+00:00 2023-11-15T10:30:00+00:00 2 guest@example.com view guest@example.com 2023-11-15T11:00:00+00:00 2023-11-15T11:00:00+00:00 application/vnd.ibexa.api.ParticipantList+json: schema: $ref: '#/components/schemas/ParticipantListWrapper' example: ParticipantList: Participants: - User: _href: /api/ibexa/v2/user/users/14 _media-type: application/vnd.ibexa.api.User+json _media-type: application/vnd.ibexa.api.InternalParticipant+json createdAt: '2023-11-15T10:30:00+00:00' id: 1 name: John Doe scope: edit updatedAt: '2023-11-15T10:30:00+00:00' - _media-type: application/vnd.ibexa.api.ExternalParticipant+json createdAt: '2023-11-15T11:00:00+00:00' email: guest@example.com id: 2 name: guest@example.com scope: view updatedAt: '2023-11-15T11:00:00+00:00' _media-type: application/vnd.ibexa.api.ParticipantList+json '401': description: Error - the user is not authorized to access this session. '404': description: Error - the session does not exist. summary: List collaboration session participants description: Retrieves a list of all participants in a collaboration session. parameters: - name: sessionToken in: path description: The session token. required: true deprecated: false schema: type: string style: simple explode: false post: operationId: api_collaborationsessions_sessionTokenparticipants_post tags: - Collaboration Sessions responses: '200': description: Participants list content: application/vnd.ibexa.api.ParticipantList+xml: schema: $ref: '#/components/schemas/ParticipantListWrapper' example: |+ 1 John Doe edit 2023-11-15T10:30:00+00:00 2023-11-15T10:30:00+00:00 2 guest@example.com view guest@example.com 2023-11-15T11:00:00+00:00 2023-11-15T11:00:00+00:00 application/vnd.ibexa.api.ParticipantList+json: schema: $ref: '#/components/schemas/ParticipantListWrapper' example: ParticipantList: Participants: - User: _href: /api/ibexa/v2/user/users/14 _media-type: application/vnd.ibexa.api.User+json _media-type: application/vnd.ibexa.api.InternalParticipant+json createdAt: '2023-11-15T10:30:00+00:00' id: 1 name: John Doe scope: edit updatedAt: '2023-11-15T10:30:00+00:00' - _media-type: application/vnd.ibexa.api.ExternalParticipant+json createdAt: '2023-11-15T11:00:00+00:00' email: guest@example.com id: 2 name: guest@example.com scope: view updatedAt: '2023-11-15T11:00:00+00:00' _media-type: application/vnd.ibexa.api.ParticipantList+json '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to modify this session. '404': description: Error - the session does not exist. summary: Add participants to collaboration session description: Adds new participants to an existing collaboration session. parameters: - name: sessionToken in: path description: The session token. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: Participant list creation payload content: application/vnd.ibexa.api.ParticipantListCreate+xml: schema: $ref: '#/components/schemas/ParticipantListCreate' example: |+ view user@link.invalid view application/vnd.ibexa.api.ParticipantListCreate+json: schema: $ref: '#/components/schemas/ParticipantListCreate' example: ParticipantListCreate: ParticipantCreate: - _media-type: application/vnd.ibexa.api.InternalParticipantCreate+json User: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 scope: view - _media-type: application/vnd.ibexa.api.ExternalParticipantCreate+json email: user@link.invalid scope: view required: false /collaboration/sessions/{sessionToken}/participants/{participantId}: delete: operationId: api_collaborationsessions_sessionTokenparticipants_participantId_delete tags: - Collaboration Sessions responses: '204': description: Participant removed '401': description: Error - the user is not authorized to modify this session. '404': description: Error - the session or participant does not exist. summary: Remove participant from collaboration session description: Removes a participant from a collaboration session. parameters: - name: sessionToken in: path description: The session token. required: true deprecated: false schema: type: string style: simple explode: false - name: participantId in: path description: The participant ID to remove. required: true deprecated: false schema: type: integer style: simple explode: false patch: operationId: api_collaborationsessions_sessionTokenparticipants_participantId_patch tags: - Collaboration Sessions responses: '200': description: Updated participant content: application/vnd.ibexa.api.InternalParticipant+xml: schema: $ref: '#/components/schemas/InternalParticipantWrapper' application/vnd.ibexa.api.InternalParticipant+json: schema: $ref: '#/components/schemas/InternalParticipantWrapper' application/vnd.ibexa.api.ExternalParticipant+xml: schema: $ref: '#/components/schemas/ExternalParticipantWrapper' application/vnd.ibexa.api.ExternalParticipant+json: schema: $ref: '#/components/schemas/ExternalParticipantWrapper' '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to modify this session. '404': description: Error - the session or participant does not exist. summary: Update participant in collaboration session description: Updates properties of a participant in a collaboration session. parameters: - name: sessionToken in: path description: The session token. required: true deprecated: false schema: type: string style: simple explode: false - name: participantId in: path description: The participant ID to update. required: true deprecated: false schema: type: integer style: simple explode: false requestBody: description: Participant update payload content: application/vnd.ibexa.api.InternalParticipantUpdate+xml: schema: $ref: '#/components/schemas/InternalParticipantUpdate' example: |+ view application/vnd.ibexa.api.InternalParticipantUpdate+json: schema: $ref: '#/components/schemas/InternalParticipantUpdate' example: InternalParticipantUpdate: scope: view application/vnd.ibexa.api.ExternalParticipantUpdate+xml: schema: $ref: '#/components/schemas/ExternalParticipantUpdate' example: |+ view application/vnd.ibexa.api.ExternalParticipantUpdate+json: schema: $ref: '#/components/schemas/ExternalParticipantUpdate' example: ExternalParticipantUpdate: scope: view required: false /ai/action-types: get: operationId: ibexa.rest.ai.action_type.list tags: - Connector AI responses: '200': description: Action type list content: application/vnd.ibexa.api.ai.ActionTypeList+json: schema: $ref: '#/components/schemas/ActionTypeList' example: ActionTypeList: _media-type: application/vnd.ibexa.api.ai.ActionTypeList+json _href: /api/ibexa/v2/ai/action-types ActionType: - _media-type: application/vnd.ibexa.api.ai.ActionType+json identifier: generate_alt_text name: Generate alternative text inputIdentifier: image outputIdentifier: text options: width: 512 height: 512 image_quality: 85 - _media-type: application/vnd.ibexa.api.ai.ActionType+json identifier: refine_text name: Refine text inputIdentifier: text outputIdentifier: text options: [] application/vnd.ibexa.api.ai.ActionTypeList+xml: schema: $ref: '#/components/schemas/ActionTypeList' example: | generate_alt_text Generate alternative text image text 512 512 85 refine_text Refine text text text summary: Get action types list. description: Returns action types list. parameters: [] /ai/action-types/{identifier}: get: operationId: ibexa.rest.ai.action_type tags: - Connector AI responses: '200': description: Action type content: application/vnd.ibexa.api.ai.ActionType+json: schema: $ref: '#/components/schemas/ActionType' example: ActionType: _media-type: application/vnd.ibexa.api.ai.ActionType+json identifier: generate_alt_text name: Generate alternative text inputIdentifier: image outputIdentifier: text options: width: 512 height: 512 image_quality: 85 application/vnd.ibexa.api.ai.ActionType+xml: schema: $ref: '#/components/schemas/ActionType' example: | generate_alt_text Generate alternative text image text 512 512 85 '406': description: Error - an action type of the given unique identifier is not found. summary: Get an action type by its unique identifier. description: Returns an action type by its unique string identifier. parameters: - name: identifier in: path description: ActionTypeLoadByIdentifierController identifier required: true deprecated: false schema: type: string style: simple explode: false example: generate_alt_text /ai/actions: get: operationId: ibexa.rest.ai.action.list.get tags: - Connector AI responses: '200': description: Action configuration list is returned in JSON or XML content: application/vnd.ibexa.api.ai.ActionConfigurationList+json: schema: $ref: '#/components/schemas/ActionConfigurationList' example: ActionConfigurationList: _media-type: application/vnd.ibexa.api.ai.ActionConfigurationList+json _href: /api/ibexa/v2/ai/actions ActionConfiguration: - _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json identifier: rewrite_with_friendly_tone name: Rewrite in friendly tone description: '' enabled: true ActionType: _media-type: application/vnd.ibexa.api.ai.ActionType+json identifier: refine_text name: Refine text inputIdentifier: text outputIdentifier: text options: [] actionTypeOptions: [] actionHandlerIdentifier: openai-text-to-text actionHandlerOptions: max_tokens: 4000 temperature: 1 prompt: Rewrite text in friendly tone. Preserve meaning and crucial information. model: gpt-4-turbo createdAt: '2025-08-07T13:16:47+02:00' updatedAt: '2025-08-07T13:16:47+02:00' - _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json identifier: rewrite_with_professional_tone name: Rewrite in professional tone description: '' enabled: true ActionType: _media-type: application/vnd.ibexa.api.ai.ActionType+json identifier: refine_text name: Refine text inputIdentifier: text outputIdentifier: text options: [] actionTypeOptions: [] actionHandlerIdentifier: openai-text-to-text actionHandlerOptions: max_tokens: 4000 temperature: 1 prompt: Rewrite text in professional tone. Preserve meaning and crucial information. model: gpt-4-turbo createdAt: '2025-08-07T13:16:47+02:00' updatedAt: '2025-08-07T13:16:47+02:00' - _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json identifier: summarize_text name: Summarize description: '' enabled: true ActionType: _media-type: application/vnd.ibexa.api.ai.ActionType+json identifier: refine_text name: Refine text inputIdentifier: text outputIdentifier: text options: [] actionTypeOptions: [] actionHandlerIdentifier: openai-text-to-text actionHandlerOptions: max_tokens: 4000 temperature: 1 prompt: Summarize text into one sentence. Preserve meaning and crucial information. model: gpt-4-turbo createdAt: '2025-08-07T13:16:47+02:00' updatedAt: '2025-08-07T13:16:47+02:00' - _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json identifier: expand_text name: Expand text description: '' enabled: true ActionType: _media-type: application/vnd.ibexa.api.ai.ActionType+json identifier: refine_text name: Refine text inputIdentifier: text outputIdentifier: text options: [] actionTypeOptions: [] actionHandlerIdentifier: openai-text-to-text actionHandlerOptions: max_tokens: 4000 temperature: 1 prompt: Expand the given text by 25%. Preserve meaning and crucial information. model: gpt-4-turbo createdAt: '2025-08-07T13:16:47+02:00' updatedAt: '2025-08-07T13:16:47+02:00' - _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json identifier: shorten_text name: Shorten text description: '' enabled: true ActionType: _media-type: application/vnd.ibexa.api.ai.ActionType+json identifier: refine_text name: Refine text inputIdentifier: text outputIdentifier: text options: [] actionTypeOptions: [] actionHandlerIdentifier: openai-text-to-text actionHandlerOptions: max_tokens: 4000 temperature: 1 prompt: Shorten the given text by 25%. Preserve meaning and crucial information. model: gpt-4-turbo createdAt: '2025-08-07T13:16:47+02:00' updatedAt: '2025-08-07T13:16:47+02:00' - _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json identifier: proofread name: Proofread description: '' enabled: true ActionType: _media-type: application/vnd.ibexa.api.ai.ActionType+json identifier: refine_text name: Refine text inputIdentifier: text outputIdentifier: text options: [] actionTypeOptions: [] actionHandlerIdentifier: openai-text-to-text actionHandlerOptions: max_tokens: 4000 temperature: 1 prompt: Rewrite given text to identify and fix grammatical and punctuation errors. Preserve meaning and crucial information. model: gpt-4-turbo createdAt: '2025-08-07T13:16:47+02:00' updatedAt: '2025-08-07T13:16:47+02:00' - _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json identifier: improve_readability name: Improve readability description: '' enabled: true ActionType: _media-type: application/vnd.ibexa.api.ai.ActionType+json identifier: refine_text name: Refine text inputIdentifier: text outputIdentifier: text options: [] actionTypeOptions: [] actionHandlerIdentifier: openai-text-to-text actionHandlerOptions: max_tokens: 4000 temperature: 1 prompt: Rewrite this content to improve readability. Preserve meaning and crucial information. model: gpt-4-turbo createdAt: '2025-08-07T13:16:47+02:00' updatedAt: '2025-08-07T13:16:47+02:00' - _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json identifier: gen_alt_text name: Generate alternative text description: '' enabled: true ActionType: _media-type: application/vnd.ibexa.api.ai.ActionType+json identifier: generate_alt_text name: Generate alternative text inputIdentifier: image outputIdentifier: text options: width: 512 height: 512 image_quality: 85 actionTypeOptions: max_length: 140 actionHandlerIdentifier: openai-image-to-text actionHandlerOptions: max_tokens: 4000 temperature: 1 prompt: '' model: gpt-4-turbo createdAt: '2025-08-07T13:16:47+02:00' updatedAt: '2025-08-07T13:16:47+02:00' application/vnd.ibexa.api.ai.ActionConfigurationList+xml: schema: $ref: '#/components/schemas/ActionConfigurationList' example: | rewrite_with_friendly_tone Rewrite in friendly tone 1 refine_text Refine text text text openai-text-to-text 4000 1 Rewrite text in friendly tone. Preserve meaning and crucial information. gpt-4-turbo 2025-08-07T13:16:47+02:00 2025-08-07T13:16:47+02:00 rewrite_with_professional_tone Rewrite in professional tone 1 refine_text Refine text text text openai-text-to-text 4000 1 Rewrite text in professional tone. Preserve meaning and crucial information. gpt-4-turbo 2025-08-07T13:16:47+02:00 2025-08-07T13:16:47+02:00 summarize_text Summarize 1 refine_text Refine text text text openai-text-to-text 4000 1 Summarize text into one sentence. Preserve meaning and crucial information. gpt-4-turbo 2025-08-07T13:16:47+02:00 2025-08-07T13:16:47+02:00 expand_text Expand text 1 refine_text Refine text text text openai-text-to-text 4000 1 Expand the given text by 25%. Preserve meaning and crucial information. gpt-4-turbo 2025-08-07T13:16:47+02:00 2025-08-07T13:16:47+02:00 shorten_text Shorten text 1 refine_text Refine text text text openai-text-to-text 4000 1 Shorten the given text by 25%. Preserve meaning and crucial information. gpt-4-turbo 2025-08-07T13:16:47+02:00 2025-08-07T13:16:47+02:00 proofread Proofread 1 refine_text Refine text text text openai-text-to-text 4000 1 Rewrite given text to identify and fix grammatical and punctuation errors. Preserve meaning and crucial information. gpt-4-turbo 2025-08-07T13:16:47+02:00 2025-08-07T13:16:47+02:00 improve_readability Improve readability 1 refine_text Refine text text text openai-text-to-text 4000 1 Rewrite this content to improve readability. Preserve meaning and crucial information. gpt-4-turbo 2025-08-07T13:16:47+02:00 2025-08-07T13:16:47+02:00 gen_alt_text Generate alternative text 1 generate_alt_text Generate alternative text image text 512 512 85 140 openai-image-to-text 4000 1 gpt-4-turbo 2025-08-07T13:16:47+02:00 2025-08-07T13:16:47+02:00 summary: Get action configuration list. description: Returns action configuration list. parameters: [] post: operationId: ibexa.rest.ai.action.list.post tags: - Connector AI responses: '200': description: Action configuration list is returned in JSON or XML content: application/vnd.ibexa.api.ai.ActionConfigurationList+json: schema: $ref: '#/components/schemas/ActionConfigurationList' example: ActionConfigurationList: _media-type: application/vnd.ibexa.api.ai.ActionConfigurationList+json _href: /api/ibexa/v2/ai/actions ActionConfiguration: - _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json identifier: rewrite_with_professional_tone name: Rewrite in professional tone description: '' enabled: true ActionType: _media-type: application/vnd.ibexa.api.ai.ActionType+json identifier: refine_text name: Refine text inputIdentifier: text outputIdentifier: text options: [] actionTypeOptions: [] actionHandlerIdentifier: openai-text-to-text actionHandlerOptions: max_tokens: 4000 temperature: 1 prompt: Rewrite text in professional tone. Preserve meaning and crucial information. model: gpt-4-turbo createdAt: '2025-08-07T13:16:47+02:00' updatedAt: '2025-08-07T13:16:47+02:00' - _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json identifier: rewrite_with_friendly_tone name: Rewrite in friendly tone description: '' enabled: true ActionType: _media-type: application/vnd.ibexa.api.ai.ActionType+json identifier: refine_text name: Refine text inputIdentifier: text outputIdentifier: text options: [] actionTypeOptions: [] actionHandlerIdentifier: openai-text-to-text actionHandlerOptions: max_tokens: 4000 temperature: 1 prompt: Rewrite text in friendly tone. Preserve meaning and crucial information. model: gpt-4-turbo createdAt: '2025-08-07T13:16:47+02:00' updatedAt: '2025-08-07T13:16:47+02:00' application/vnd.ibexa.api.ai.ActionConfigurationList+xml: schema: $ref: '#/components/schemas/ActionConfigurationList' example: | rewrite_with_professional_tone Rewrite in professional tone 1 refine_text Refine text text text openai-text-to-text 4000 1 Rewrite text in professional tone. Preserve meaning and crucial information. gpt-4-turbo 2025-08-07T13:16:47+02:00 2025-08-07T13:16:47+02:00 rewrite_with_friendly_tone Rewrite in friendly tone 1 refine_text Refine text text text openai-text-to-text 4000 1 Rewrite text in friendly tone. Preserve meaning and crucial information. gpt-4-turbo 2025-08-07T13:16:47+02:00 2025-08-07T13:16:47+02:00 summary: Query action configuration list. description: Returns action configuration list based on the given query. parameters: - name: X-CSRF-Token in: header description: CSRF token obtained during the authentication. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: Query action configuration search criteria content: application/vnd.ibexa.api.ai.ActionConfigurationListInput+json: schema: $ref: '#/components/schemas/ActionConfigurationListInput' example: ActionConfigurationListInput: query: Rewrite action_type_identifier: refine_text enabled: true limit: 25 page: 1 application/vnd.ibexa.api.ai.ActionConfigurationListInput+xml: schema: $ref: '#/components/schemas/ActionConfigurationListInput' example: | Rewrite refine_text 1 25 1 required: false /ai/actions/{actionConfigurationIdentifier}/execute: post: operationId: ibexa.rest.ai.actions.execute tags: - Connector AI responses: '200': description: Reworked text or generated alternative text content: application/vnd.ibexa.api.ai.Text+json: schema: $ref: '#/components/schemas/Text' example: Text: _media-type: application/vnd.ibexa.api.ai.Text+json text: - Hello, how have you been spending your day? application/vnd.ibexa.api.ai.Text+xml: schema: $ref: '#/components/schemas/Text' example: | Hello, I hope you are well. How have you been spending your day? application/vnd.ibexa.api.ai.AltText+json: schema: $ref: '#/components/schemas/AltText' example: AltText: _media-type: application/vnd.ibexa.api.ai.AltText+json Text: _media-type: application/vnd.ibexa.api.ai.Text+json text: - Blurred image of an open laptop on a desk with paperwork and another laptop in the background. application/vnd.ibexa.api.ai.AltText+xml: schema: $ref: '#/components/schemas/AltText' example: | Sunlit home office with an open laptop, papers, and a blurred background. '400': description: Error - if the provided input or action configuration is invalid or the given action cannot be performed for any reason. content: application/vnd.ibexa.api.ai.ErrorMessage+json: schema: $ref: '#/components/schemas/ErrorMessage' application/vnd.ibexa.api.ai.ErrorMessage+xml: schema: $ref: '#/components/schemas/ErrorMessage' summary: Execute the given AI action description: Executes the given AI Action using configured ActionConfiguration or ActionHandler, if passed. Might consume AI agent resources. parameters: - name: actionConfigurationIdentifier in: path description: Configured action name (obtain by listing the configured actions via GET `/api/ibexa/v2/ai/actions` endpoint). required: true deprecated: false schema: type: string style: simple explode: false examples: rewrite_with_friendly_tone: value: rewrite_with_friendly_tone rewrite_with_professional_tone: value: rewrite_with_professional_tone summarize_text: value: summarize_text expand_text: value: expand_text shorten_text: value: shorten_text proofread: value: proofread improve_readability: value: improve_readability gen_alt_text: value: gen_alt_text - name: X-CSRF-Token in: header description: CSRF token obtained during the authentication. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: Input to execute the action. An Input type must match the action type. content: application/vnd.ibexa.api.ai.RefineText+json: schema: $ref: '#/components/schemas/RefineText' example: RefineText: Text: text: - Hey, wassup. What you've been doing the whole day? RuntimeContext: [] application/vnd.ibexa.api.ai.RefineText+xml: schema: $ref: '#/components/schemas/RefineText' example: | Hey, wassup. What you've been doing the whole day? application/vnd.ibexa.api.ai.GenerateAltText+json: schema: $ref: '#/components/schemas/GenerateAltText' example: GenerateAltText: Image: base64: data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wgARCACMANIDAREAAhEBAxEB/8QAGwAAAQUBAQAAAAAAAAAAAAAAAgABAwQFBgf/xAAaAQADAQEBAQAAAAAAAAAAAAAAAQIDBAUG/9oADAMBAAIQAxAAAAGj879HLORzrbyvP6FbydDfkx/Qx6rzu/uu/wAieoCWCoSmQ4nQ4iSrZ642HVm5vNCNvo7z6nbhq57ZvTpO5NpgjoZFcVZto06SueWpFMU2GgQnB5ThymXXyU628pQIrvr5NfXlr56H0qXSHarTpzptK56aucJoFTJiMQYECBwQ3Q0nnS6siKs5ykree/pXT5tp5Q52ukl0iCNPJ33ZWuL3n7TzxKIRimIC0mkJA4JN1UU15LezY06JZndw6fQ+ry5VATS6CS5FPis+/id5y9cO9xfdZyI2ELlNO5QISGhunnTp49u7GFmi1lfW479xv5pqRll1IqTtZ+PR5Ptvibc7Vn7Tw72nKcpy7lOUDNONISrDNOP2rHRnpaPN1eiYnTVyGpZE/bm7EKOL8/nr817OWrcd9z6+ic7Ny7l6lmmEmkCTZVy9aZF203jNZpXrnDehMEk0mn6XI7TS44rMz6PE+zPG2wmF7bwdGoS7lOU0zlgTEiNVwu2kBWeVQT6TDbouLphw6ZpTydd7Hh0MumMoaiKlwWhwnVyg56zLTvsGDmYnSUlSiFEEmuUGW/nXRpnjea1401sdLXF2LLe3FPJ3XvfOZfD2UTXn90CI5UbzuKbrmxUSubdRZcw1AptFDcZk6cxpdN1IVXL6Dn06TC7riQTiCbQCnFNZ7dDSLCkrytExtE5Koo2o6mGlCyNgjrlWIuSalnTTit6QmWHkTWJw+gLoRiMBDUC5zOrk0FnM5JoiVSz9AWnYgYdendTvZ001bl6SbyDNDLx+bujdQUqNRf0x0KjKx2y9cj1ynEmmadJgBqS1fueictLkY8t03TdU6GhjL5Hk9YiIbintjta87NC1dJnFMmhG07SAE4JdWXUmoQu1Ni5ussMJUIylmjhOP0yahqK9RVuWamFbJkcWUpQuwSgwRsEZCZNIYGQLbUSsVlpFma4/DrdyLkakhC0TmUUoics04p0WZcyaBgYcQxBJsN0IcBUDqNujLmAyRcu0Qk07mRowNJNAwWSpWJc8t0xHGANshxmnG6gKjbwanQgmQ7QOTFKKQTUjE4iAk0IKI2C1Yl2s2hiMBsxhwOq7daj/xAAnEAACAgICAgEFAAMBAAAAAAABAgADBBEFEhATIRQVICIwBiMxMv/aAAgBAQABBQKrJVa0yVi5C7+oSPeheq1N51qkYhHusYSg/wCv+N1nWW5aJHzXaM2/HF1/Diai8dTBx9M+30z7fVPtdM+10x+IoM+zUAni03WOq/x5i3qincBm4vy3HJpGmoPG9SzIrQZHM1JOK5L6s/0P/OZs3fXNzcoG2xhpT4Hi8bTLFi2sJh3nFy6rBZX/ADtOkzbO+Wp+O0BnHr2vq+K/A8GctjxhLZ/juZ3r3/PNfrU3dXD7gMScUu/zyq+9eUvptsMxcg4+TjWi2r+XIN+llQaW4021crcEcQuqvyac9jfq5hn+O5nwD/LOb9oZlddLjsBiAVVewT2ie0fgZlVeyvkKfReZjWmi/BvF9P8ABzpcm7dweZGSFlKNY+Ona659QOZ2M2YwaG1hBf8ANmUihc2p5zqewmtp6mnD5j48XLXr9ckpyxaRufMclRVaXljamS2qmPzZeTKadldLMD/3c27Vg8FhLE7yzHPU8Y2xiJQbKjkFeKUReMrlfH0w4eOIuHjiV0VpPiFfA0I+mmX8y7ASyLx/SeixYQRONX9acSlwMGufRVz6Oue2eyB9x9GWVK0+kqBFdaxbli2GMnY9IewBssEN9qg5NkN9hnuslmUSBepgYwWAz/swUDWeoQFlgsnsXxub8Hwy/ASIdTtN+CnYWYlkGDcZ9vun2y0x+MbqnCiyLwipPtw6/QfriYrUj58ECdRO0P8A1n1GyJi1vaGoRF9naW/Uh1fkJ25HW+VmuXnr5Qz6fkJ9DmtBxWWZTxAErrrpX3177E+d+dTUDzvGbcQ0o45OmNyOJYKszCrn11EXKqae9Z71nuWe5Z7hDfDfZGstMastFpKEXXLFyxFvVp2EBEZwIG3N+NxviH9oy6gG4qfIWBYHKwXRTvwTOzTRM9c6a8b8FRB2EF7LGsWyUsFntH46nWDwJqag+ILiItgPnc7eNzfk/MKCEETbxW3+WoPw1Os1AxEW2dgfGvx3DCZuVmL+Ag/gfG4rGA+NeTDCZuf/xAAnEQACAgICAQMEAwEAAAAAAAAAAQIRAxIQEyEUIDAxQEFhBCIyUf/aAAgBAwEBPwHuWosiFkQppjyI2RnmjA/7E34Mq/t8WPHt5YsZqlzneqIMsf8AJ/R6qR6uR6tnq/0eq/R3p/gWSP8Aw7Uybt/Fi8IsviHk/lSEWPirI4ZSFgivqycItXH4LLL5QuLGzH4RnfkXD4xOpErGXTJRp+6/dEvleWPxEyeZPl8IhLaIyRF7Ir4LL4iKRsNmMyOl78M6ZPwSYpaux/GuKPKMZnfj3xP9RGMxytUP4kLhkfBNOTo6mdTOp+xGORkVMZGVP40JmwhGBfVlI1RqhOIsSY8CFjNaZk8ocTVkX+OWyy+ckqYuLEIRi8RQuVFkJ6nanxp+RxNUUPloocRcThYuFyiWecT1kz1sz1uQ6jrHChWUzRmrGyzc2Gy/fYmJm1CyDUZDxnXLiubHxP6/JZZsbc2zZmvNk8up3N8Sx2dR1miNEao1RSLQ3xXvsvhjJ3+DrZpJDjI1kas62dbOtmjNGdZ1nWikUaGrK5RRXFj91cX8FFFcao0Os0NfsaK4r30X9jfw395//8QAJhEAAgIBAwQCAwEBAAAAAAAAAAECERIDEBMgITAxQVEEFCJAYf/aAAgBAgEBPwGehJyJfjsehI4ZEdKVEtOR+LpuzXX8Gmv6I+KcqGOxLbTWUiW1GBxnEcbOJiTj6G5MXYXiasaKKH2R+OvklshF0ch/TO8H5WJEyiiZpKoj2W00RqhEo5KhPyMS7DRRRL2Lskh7LaRHsxETVjTvyVbHEcKGiQlch70LaSId0JEo5Kiq7eOPvdxTJwaIrv1yNJ06FtrQ+fHBbolI9IyMjLdjH2NN2tmrRKNOvFGPYoxGT9Gp9Ds7nccZGbMmJSl6HCXyaXYssnDIwZgxwa6YKz53YzUJ+xj2lqoas9EdfAlruQp0c7OdnLJmbMn9llljZZDUrbMzMltqexQUj9dH6qP1UZmZkWKRyGRgYlFCRSEkYmKMUYDgUNFDVmJ6MzPwJ9S2sssyY7KKHErZ9FGAtKzhQ0Rml7OWByx+jmRzI5v+HM/oWq38Ccn8CW2aLsrpaMUVsiJZ2OxaM0jmic0Tmic0TmRznOczORnIxahmZFl9S2vazIyKsx6O21l9FmRkLUaJTsy6r6LL2xK8llleOyyyjErw0UP/AAteL//EADAQAAECAwUHAwQDAQAAAAAAAAEAAhEhMQMQEiAwBCIyQVFhcROBkTM0gqEjUHKS/9oACAEBAAY/AqX1VVVVuZPmhpSUzErd3Qp3R6mF9FRUVFwqimFIITMlDSEKnK3xHNvOCgzeKcHCDhrBvTIEfjKYJzXuJubaCnNBw56rz3yN7TQzYxf6LzvNpqO8Il2Rx9s5Cc03NtB7oOHPTIukpqSb3noY23+i40ppwv7oQQHQAaBCcOVzXjkmuGkboBYnpgTR755uC4hFRAuosDgYKJKqt2+KpeXFQaouuc7oEe0s0GlEvtCYqI4lhMAuK6gUCqBboF81S7DyUnEKRBXCphR6lR55aLoqrjKjjf8AK4nfKlFUKiRdIqBU1VVUnKDhFSfD/SjD3CrcRCUFK6ejCOXhiv4wSOhVMKo0e6m5qOJ4MOyiXPHkLctnqDnYvKlhCON4LuoGjiMmd0XOfABbk2qNiLMjo5fR2X9qTdlH4qVpYD8F9zZD8FPbB7MU9tf7Bff26nt1v/0o2207RadsUFBoAUAYnsuUNPFbNc7sqOUHxPkI+m3D4aqH4UlRUvopNUg1fUh4C3rRxUbO0cFPC/8AS3mlqkRnnq0U1XNJxW9dXVkp6siq/wBv/8QAJhAAAgEDBAEEAwEAAAAAAAAAAAERITFREEFhcYEgkbHBMKHw0f/aAAgBAQABPyF1qlkKqY3VIo9EG0SNJSqSRYpYe0jY2P1tpaBh49FJ8C4x5aWNkzYXgSaYFhgTgjftG12exgUsKVKJkjuJI7AbG/wMQaGDGIFq3V/2CaqGiVGJoeSel4Cv5bcDYx6Mb9bwxVayRtNpHt24Ka/i0RpQ1ZobQkhJ7siY2S6Oo4WUkobG9G/wSBWqlBALiRnAAWDxI/QWUU2gkkS6Jn5CWiSfwybAZAzLkWlHpOTd2i+RPFidEhECXyH+EE7HK0T9g1eUkkk/h7JQ2Yeq0jollC1Inbyf6+hMkkjVJRNCqtByd64JEL8DdCdfIkVNEcVEhgO5bHA2H7+henVjCnauh7VVOgw2O6oymZQiSfTJMsieKCIliTdNhGyEcnI+J2/vCHtxZDmIEolE1Ye4Mm1AI4XEJyLhkqikeWVPto3SCnaRasZ9G5ReGQ2JPPgXM1bkcGy5MRFBJIRFW+CnokhbNpwMtBbGMbQ818iRCcmeCarUWdSfQJcSWQbXCOBWox4qGthYBr2zSBb+2DR3LgcVF2UPJ8ITfJJsxB3ksUHELnoG6+A3lBTMkZYlQrjFi3cCfn3E3QP7DK4RyRKw5RUJxlFaWPoXUkWKMfRIwhdHa7UUpJOCVQ6lCJNlLjRi+C9OVyYRzEUHEYb0JZFNlSpFccO41IEwnJbGwNk6Lv2YdMmM/Yn7jKOw7yiVLUmk2LoP0DtOT3A3wDq38QnUGb3P0iQhvYKBJeScjG2jgOqrMZKHLWwpInS22hVjgVU2JZOG05FZaGX6Nmj+cktQeRIvazJ8BDaIG5fGCT8LPleHvlin6IQ3O/uWtxVDsF2MtZk6E1pAiZHKGEcGPeAJYi2EuCkZvDR40x33BOswY4+jCwswWJjVsyjcQf6G2Hkv4nzID8yvybUPcIU/dF6QnaBvDYux6E5oKFA4dJDJVBLWqYRRggFVHJlRClMqMVhiW5IaPcLabKolglO4zsjYwyobS3XkW/6OQkuNEIStVGqsNAnohpZ3tYOmnZjkpGG3MkyrRMRXHV1QUQWsiGUaEhSIYYkjfzKIkJjLJGxN6H1jRnGm3oI0WqIEGhMnR6ZjQxoNCGHHEz//2gAMAwEAAgADAAAAEIYi+VZ+Ndf03ptaHA3sA0vGKiAxcf0JgkWk4FIfyv686UM0LT4YtCOWtZiJ+LmoV1aIdpLEfJAVQ1isgFKPHwK+ZjftYRScC3SR1snp8vNuvxJgzsFsNzKOR6K8LGfMhsOMobK/QI2G8+02rSuJ49xArEzFZz1Is55eJrJyJfsqUM2T5P8Ak1kdG38bXJNr5ejJmIkgw7iIOt83GqzfS0wqf/1xs0+xWQw6Oes6WodtgWzgWehQzf8A/8QAJhEBAQEAAgICAQIHAAAAAAAAAQARECExQVFhILHwMHGBkaHB0f/aAAgBAwEBPxDGZPFmvdT3NtzzI6GCHO5BBBH4PBwAMOo9aXYNv6KWHXFTwJ+IvoL6yV7HE+XDukQ3ZQQR+WQ4DFu62U+/0nyLC8Lwxf6GmIeIIjg438BvA1lhlvIHZaE/ffDZzGS3d56jHbfD544IILZZm22ww3lHa3ZcJdEtZaI4Uzxg+8hG6N8nDJllttt4EGWSHmNPVrDXeNTruzhZtvN+G7ctuNZeyWWWWW222GGcdzd8kxOrw/mSTjbeFjL3+ycrtHqUssssttsMM5QyMy34wIep5CeCFk48crs5d7JZZZbbbbYZcDiKut5xOvzn9oT1PwX0THGxkYhpY+YHQwpJpA1LLASJFsSkSh4GU8ji/ffLJU5xjyId9wdgSEiGSsrAzU9Mc8wFvG6wyhhu5kzgdWXOYPcN9z/eI9S8y8S1wTdZjYWcEMcg13JPd4gl9N9Vpsb7gy6mKXYYiWWWXnvjLYeBDF2hL+UBwdIMMlyb4R3bsCETuJ6Tj3Y9tl7/AFn5D/P/AGz4Uf2WMPo4FwMMRbCtyylDNVjsEnzJW/u+2fn/AAaE+7PzAQXgkvmfiyVogjbHvkWeBdnhkmdlq3eAskODLHNlt6s+uBjgsssszLMySWW2xZyZwDjI6iAscFlm2WZnh4yzjYYm8jDDDDwG2WZ4Zmf4BFtvJFvH/8QAJREBAQEAAgIDAAIBBQAAAAAAAQARECExQSBRYXGxoTDR4fDx/9oACAECAQE/EPOrT5iEG+IXhE9Q9JN0lj6lt5yyyzhOhJf22sYGwRu6tlt8sbu/A9TKebyyExYepHPlklnGyyJ08p2P1P7hZCEgdyPUevqQGujKM/HLLLLJLwvfDm79Xc/b/X/vHIxbGz7AlB969DbbzllllkkkOrCbN1nBDYP4D/nkIhpLounDrvht+OWWWWSRgI06k8uA3SS1WeCCTbPsvK4gVSlqI4CyyyyySG7ttLwvUh3ZN+uHgLJhpduhBZuYiCD5N7JJIML0nVuj9yJNmAuuCu7ThiPJk4hHOWWTYRhHhhLE2zBKLNhTQ4SvEox0nQ2YuxdmcfkIGBsZ6jLtm4gslDYdBd3CFkES26QK7nGBdO3ll+XCe5H2WkG+WKG28Tj1dgyF3Yfuz7tPc4zz+F2m2nu19372/dj6jc/qwtpmXfrLd1jPuLhHmvSgcH5R9ZDySPGynmcXiNk8WsEebN3zkcHVuDJZEQPqT7LX6tfUM9Qx6OFL6lD0y182z1KJgXVt5jcQuz1YGrYORGT8L/sy/F/xfk/4/wBrfpcDwH9r0Qk93RIcT9JWWckGF5gXSQ+bJKvMIvynyiw9X5R9XE/XI9Ev0Ssp5j3EPuC+HjlsSb4lzgLPq7R1Grc4k7SPKzJnwbniMzq22WGQ4beAtWvAiI4PtZw7HBo+Z14lnG/6Itvi44IeRjv4EOJDMVd2/B4DkBJyckfEYbbBgk+ORBZf/8QAJhABAAIBBAEFAQADAQAAAAAAAQARITFBUWFxEIGRobHRweHw8f/aAAgBAQABPxBQcu1XMDcftL7RnciVogijUrXYhByZsaua7HJLPB9ccWEIQYMpSJMrtHvnC2FK/ae8XoTVW2FVXlgrH5jL+/UuKxycQQH4oL+EKMfET+MSxNsJaD2iKqnxEo59BAt2lYaCj1BYw9SXET0NjTVZl5VVdWYCOUSBnWDh6r86Pp+pcMctoMQywOiAkTW4XYLHH5hDm4bvlCSyVgLixehfqQhLF1DJwdHa/wCpjGO252RgdEPdhOFFg8D/AHMyMHEEf6wCbRaSKWbJaVFSDBcphgBEPVF9BYS5cGDBhtvaVdYU+2P7KKFoqC8TOM2L2MfdTmJt98/5mREzDUI1MDVJlo2hiK3kj2ZuHMMizSMsLcIJFJcuXBlQ7j9R2F5J2wNqcTLay2ljgFKx2v8AyEOwaHUyJcoII2JcEUahRIWvYhrFuAAG8DbFFeoety5fpcPtSkvMLl1Yuolb5yVQXxEHZXjGPt6Iw9BAVGXEVt/tEVuW3H3CrupxAJHDFfqsWXLlytPBM1cqFlimyWG0iHEYlRFinTvRf4jlEKNSdxAJR6A5hXmyokAQxmjjhDDc3gBQTrHKSkWLLl+jxlDurHDLlERpbwVCN2VptKoCBXgy/kZXVj5Fo+vkm7Y41TswTFs2jtW6pX6jd2I6C3WxLXMN8zBvG6dYpD+JP9NhTZt46QdmzRdJWm4IgZrvAMkSmEGLKYbEscA1mIVHLUV3GTCZ0sojvXTG0yvXnaCQEwJd9eX/AMZYy0C8go/UapE1LYQ2lTLyO0r1TUIXJVraB6mSkyjKyua7m34j+T7JmGC1p5YQuXuQKnHiJPt5LyhEWyNdQUZBFqIloKKbgEvtRYW2XTLwc5wYoFBvnKM30SJg873f0ZaRuYNu4Js0Vy/2C3fv+z/owXXN3BH+MfsqOZn5niCIceUbm/VkoSkvIjfgSCY3mJd3YrpDaIhgOIxbZGqW6OzMEB1slUiOCyZz1GyAe6K/qZcg2/oZWz1z7gs1bn5R/tCwntDEAOyXKibasBZ/jDLsWiqZj/HK+yBWh2Z9ELFSzOsyB1JY9yxqy+ILxg94TinmOzAVNIY3FcwOG/eLieIYmvVRA67XYNUfUkfI18PzO9BF1FYsuvyWC9C/eq/bikeAiPyMs3BRXrNAasJdNjfZz8wOjC11jxtUogDIlrwv6lAZsMiQUwc2qhgpXt13gmagGgp7mrD2nQ/MA4NPC6xGVDe37idTIt/iPFEv6lSvW7F667gMasAARhtpALjusRs/XUKd8ojA8s3/AFQtOFD/AFLJ8EYmhqf9tZX+KD/MTIzkI1BF2pPyMiA/42gtKapnzq+4WEzKbXlZfeKbWdh5rSIhea6kp/Awe5AbyxhlDF9idDBAC2HcmKxuHWNO8OGDdFfaOsCAKYK4IgIuTR+SvodQU7xBbA1uMUOhBEzK8BEbfxEbcoHHyEUwTqIP0pEXXcqf5MWA4A/bmU8047LLcgfkgNEm9P8ACOCrmqfJDjxl0wHb2iGEwi9zT59FSzUOzY5ltRUlEfDNKL7Q1dTvDq4sMuwbSjrDF44YihX3DMOYYZ0mSzZSTJiGfhhOa/MA0zyykreIaw6JUyGTkifEcLZFdrkg4YNKRuBR2ynR+YnmDSt41U5J1SiGZwy9SRvJGOGXaREatSVgLOZSZL9FB5RXoMYYk2xO2aaNTsuAURO4xwW6meedj5gBmPRi2SswsVMymAtxDqXaQDeK9ZbG2gzFkUwkllGuE6kT4YxpLmpADpEXDCRwywYFaynMwcxQuDEGEzGzKrga0mjiZwg1Moh2gwplxKJmELmevoDioiZjl5hBzG9zP//Z RuntimeContext: [] application/vnd.ibexa.api.ai.GenerateAltText+xml: schema: $ref: '#/components/schemas/GenerateAltText' example: | data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wgARCACMANIDAREAAhEBAxEB/8QAGwAAAQUBAQAAAAAAAAAAAAAAAgABAwQFBgf/xAAaAQADAQEBAQAAAAAAAAAAAAAAAQIDBAUG/9oADAMBAAIQAxAAAAGj879HLORzrbyvP6FbydDfkx/Qx6rzu/uu/wAieoCWCoSmQ4nQ4iSrZ642HVm5vNCNvo7z6nbhq57ZvTpO5NpgjoZFcVZto06SueWpFMU2GgQnB5ThymXXyU628pQIrvr5NfXlr56H0qXSHarTpzptK56aucJoFTJiMQYECBwQ3Q0nnS6siKs5ykree/pXT5tp5Q52ukl0iCNPJ33ZWuL3n7TzxKIRimIC0mkJA4JN1UU15LezY06JZndw6fQ+ry5VATS6CS5FPis+/id5y9cO9xfdZyI2ELlNO5QISGhunnTp49u7GFmi1lfW479xv5pqRll1IqTtZ+PR5Ptvibc7Vn7Tw72nKcpy7lOUDNONISrDNOP2rHRnpaPN1eiYnTVyGpZE/bm7EKOL8/nr817OWrcd9z6+ic7Ny7l6lmmEmkCTZVy9aZF203jNZpXrnDehMEk0mn6XI7TS44rMz6PE+zPG2wmF7bwdGoS7lOU0zlgTEiNVwu2kBWeVQT6TDbouLphw6ZpTydd7Hh0MumMoaiKlwWhwnVyg56zLTvsGDmYnSUlSiFEEmuUGW/nXRpnjea1401sdLXF2LLe3FPJ3XvfOZfD2UTXn90CI5UbzuKbrmxUSubdRZcw1AptFDcZk6cxpdN1IVXL6Dn06TC7riQTiCbQCnFNZ7dDSLCkrytExtE5Koo2o6mGlCyNgjrlWIuSalnTTit6QmWHkTWJw+gLoRiMBDUC5zOrk0FnM5JoiVSz9AWnYgYdendTvZ001bl6SbyDNDLx+bujdQUqNRf0x0KjKx2y9cj1ynEmmadJgBqS1fueictLkY8t03TdU6GhjL5Hk9YiIbintjta87NC1dJnFMmhG07SAE4JdWXUmoQu1Ni5ussMJUIylmjhOP0yahqK9RVuWamFbJkcWUpQuwSgwRsEZCZNIYGQLbUSsVlpFma4/DrdyLkakhC0TmUUoics04p0WZcyaBgYcQxBJsN0IcBUDqNujLmAyRcu0Qk07mRowNJNAwWSpWJc8t0xHGANshxmnG6gKjbwanQgmQ7QOTFKKQTUjE4iAk0IKI2C1Yl2s2hiMBsxhwOq7daj/xAAnEAACAgICAgEFAAMBAAAAAAABAgADBBEFEhATIRQVICIwBiMxMv/aAAgBAQABBQKrJVa0yVi5C7+oSPeheq1N51qkYhHusYSg/wCv+N1nWW5aJHzXaM2/HF1/Diai8dTBx9M+30z7fVPtdM+10x+IoM+zUAni03WOq/x5i3qincBm4vy3HJpGmoPG9SzIrQZHM1JOK5L6s/0P/OZs3fXNzcoG2xhpT4Hi8bTLFi2sJh3nFy6rBZX/ADtOkzbO+Wp+O0BnHr2vq+K/A8GctjxhLZ/juZ3r3/PNfrU3dXD7gMScUu/zyq+9eUvptsMxcg4+TjWi2r+XIN+llQaW4021crcEcQuqvyac9jfq5hn+O5nwD/LOb9oZlddLjsBiAVVewT2ie0fgZlVeyvkKfReZjWmi/BvF9P8ABzpcm7dweZGSFlKNY+Ona659QOZ2M2YwaG1hBf8ANmUihc2p5zqewmtp6mnD5j48XLXr9ckpyxaRufMclRVaXljamS2qmPzZeTKadldLMD/3c27Vg8FhLE7yzHPU8Y2xiJQbKjkFeKUReMrlfH0w4eOIuHjiV0VpPiFfA0I+mmX8y7ASyLx/SeixYQRONX9acSlwMGufRVz6Oue2eyB9x9GWVK0+kqBFdaxbli2GMnY9IewBssEN9qg5NkN9hnuslmUSBepgYwWAz/swUDWeoQFlgsnsXxub8Hwy/ASIdTtN+CnYWYlkGDcZ9vun2y0x+MbqnCiyLwipPtw6/QfriYrUj58ECdRO0P8A1n1GyJi1vaGoRF9naW/Uh1fkJ25HW+VmuXnr5Qz6fkJ9DmtBxWWZTxAErrrpX3177E+d+dTUDzvGbcQ0o45OmNyOJYKszCrn11EXKqae9Z71nuWe5Z7hDfDfZGstMastFpKEXXLFyxFvVp2EBEZwIG3N+NxviH9oy6gG4qfIWBYHKwXRTvwTOzTRM9c6a8b8FRB2EF7LGsWyUsFntH46nWDwJqag+ILiItgPnc7eNzfk/MKCEETbxW3+WoPw1Os1AxEW2dgfGvx3DCZuVmL+Ag/gfG4rGA+NeTDCZuf/xAAnEQACAgICAQMEAwEAAAAAAAAAAQIRAxIQEyEUIDAxQEFhBCIyUf/aAAgBAwEBPwHuWosiFkQppjyI2RnmjA/7E34Mq/t8WPHt5YsZqlzneqIMsf8AJ/R6qR6uR6tnq/0eq/R3p/gWSP8Aw7Uybt/Fi8IsviHk/lSEWPirI4ZSFgivqycItXH4LLL5QuLGzH4RnfkXD4xOpErGXTJRp+6/dEvleWPxEyeZPl8IhLaIyRF7Ir4LL4iKRsNmMyOl78M6ZPwSYpaux/GuKPKMZnfj3xP9RGMxytUP4kLhkfBNOTo6mdTOp+xGORkVMZGVP40JmwhGBfVlI1RqhOIsSY8CFjNaZk8ocTVkX+OWyy+ckqYuLEIRi8RQuVFkJ6nanxp+RxNUUPloocRcThYuFyiWecT1kz1sz1uQ6jrHChWUzRmrGyzc2Gy/fYmJm1CyDUZDxnXLiubHxP6/JZZsbc2zZmvNk8up3N8Sx2dR1miNEao1RSLQ3xXvsvhjJ3+DrZpJDjI1kas62dbOtmjNGdZ1nWikUaGrK5RRXFj91cX8FFFcao0Os0NfsaK4r30X9jfw395//8QAJhEAAgIBAwQCAwEBAAAAAAAAAAECERIDEBMgITAxQVEEFCJAYf/aAAgBAgEBPwGehJyJfjsehI4ZEdKVEtOR+LpuzXX8Gmv6I+KcqGOxLbTWUiW1GBxnEcbOJiTj6G5MXYXiasaKKH2R+OvklshF0ch/TO8H5WJEyiiZpKoj2W00RqhEo5KhPyMS7DRRRL2Lskh7LaRHsxETVjTvyVbHEcKGiQlch70LaSId0JEo5Kiq7eOPvdxTJwaIrv1yNJ06FtrQ+fHBbolI9IyMjLdjH2NN2tmrRKNOvFGPYoxGT9Gp9Ds7nccZGbMmJSl6HCXyaXYssnDIwZgxwa6YKz53YzUJ+xj2lqoas9EdfAlruQp0c7OdnLJmbMn9llljZZDUrbMzMltqexQUj9dH6qP1UZmZkWKRyGRgYlFCRSEkYmKMUYDgUNFDVmJ6MzPwJ9S2sssyY7KKHErZ9FGAtKzhQ0Rml7OWByx+jmRzI5v+HM/oWq38Ccn8CW2aLsrpaMUVsiJZ2OxaM0jmic0Tmic0TmRznOczORnIxahmZFl9S2vazIyKsx6O21l9FmRkLUaJTsy6r6LL2xK8llleOyyyjErw0UP/AAteL//EADAQAAECAwUHAwQDAQAAAAAAAAEAAhEhMQMQEiAwBCIyQVFhcROBkTM0gqEjUHKS/9oACAEBAAY/AqX1VVVVuZPmhpSUzErd3Qp3R6mF9FRUVFwqimFIITMlDSEKnK3xHNvOCgzeKcHCDhrBvTIEfjKYJzXuJubaCnNBw56rz3yN7TQzYxf6LzvNpqO8Il2Rx9s5Cc03NtB7oOHPTIukpqSb3noY23+i40ppwv7oQQHQAaBCcOVzXjkmuGkboBYnpgTR755uC4hFRAuosDgYKJKqt2+KpeXFQaouuc7oEe0s0GlEvtCYqI4lhMAuK6gUCqBboF81S7DyUnEKRBXCphR6lR55aLoqrjKjjf8AK4nfKlFUKiRdIqBU1VVUnKDhFSfD/SjD3CrcRCUFK6ejCOXhiv4wSOhVMKo0e6m5qOJ4MOyiXPHkLctnqDnYvKlhCON4LuoGjiMmd0XOfABbk2qNiLMjo5fR2X9qTdlH4qVpYD8F9zZD8FPbB7MU9tf7Bff26nt1v/0o2207RadsUFBoAUAYnsuUNPFbNc7sqOUHxPkI+m3D4aqH4UlRUvopNUg1fUh4C3rRxUbO0cFPC/8AS3mlqkRnnq0U1XNJxW9dXVkp6siq/wBv/8QAJhAAAgEDBAEEAwEAAAAAAAAAAAERITFREEFhcYEgkbHBMKHw0f/aAAgBAQABPyF1qlkKqY3VIo9EG0SNJSqSRYpYe0jY2P1tpaBh49FJ8C4x5aWNkzYXgSaYFhgTgjftG12exgUsKVKJkjuJI7AbG/wMQaGDGIFq3V/2CaqGiVGJoeSel4Cv5bcDYx6Mb9bwxVayRtNpHt24Ka/i0RpQ1ZobQkhJ7siY2S6Oo4WUkobG9G/wSBWqlBALiRnAAWDxI/QWUU2gkkS6Jn5CWiSfwybAZAzLkWlHpOTd2i+RPFidEhECXyH+EE7HK0T9g1eUkkk/h7JQ2Yeq0jollC1Inbyf6+hMkkjVJRNCqtByd64JEL8DdCdfIkVNEcVEhgO5bHA2H7+henVjCnauh7VVOgw2O6oymZQiSfTJMsieKCIliTdNhGyEcnI+J2/vCHtxZDmIEolE1Ye4Mm1AI4XEJyLhkqikeWVPto3SCnaRasZ9G5ReGQ2JPPgXM1bkcGy5MRFBJIRFW+CnokhbNpwMtBbGMbQ818iRCcmeCarUWdSfQJcSWQbXCOBWox4qGthYBr2zSBb+2DR3LgcVF2UPJ8ITfJJsxB3ksUHELnoG6+A3lBTMkZYlQrjFi3cCfn3E3QP7DK4RyRKw5RUJxlFaWPoXUkWKMfRIwhdHa7UUpJOCVQ6lCJNlLjRi+C9OVyYRzEUHEYb0JZFNlSpFccO41IEwnJbGwNk6Lv2YdMmM/Yn7jKOw7yiVLUmk2LoP0DtOT3A3wDq38QnUGb3P0iQhvYKBJeScjG2jgOqrMZKHLWwpInS22hVjgVU2JZOG05FZaGX6Nmj+cktQeRIvazJ8BDaIG5fGCT8LPleHvlin6IQ3O/uWtxVDsF2MtZk6E1pAiZHKGEcGPeAJYi2EuCkZvDR40x33BOswY4+jCwswWJjVsyjcQf6G2Hkv4nzID8yvybUPcIU/dF6QnaBvDYux6E5oKFA4dJDJVBLWqYRRggFVHJlRClMqMVhiW5IaPcLabKolglO4zsjYwyobS3XkW/6OQkuNEIStVGqsNAnohpZ3tYOmnZjkpGG3MkyrRMRXHV1QUQWsiGUaEhSIYYkjfzKIkJjLJGxN6H1jRnGm3oI0WqIEGhMnR6ZjQxoNCGHHEz//2gAMAwEAAgADAAAAEIYi+VZ+Ndf03ptaHA3sA0vGKiAxcf0JgkWk4FIfyv686UM0LT4YtCOWtZiJ+LmoV1aIdpLEfJAVQ1isgFKPHwK+ZjftYRScC3SR1snp8vNuvxJgzsFsNzKOR6K8LGfMhsOMobK/QI2G8+02rSuJ49xArEzFZz1Is55eJrJyJfsqUM2T5P8Ak1kdG38bXJNr5ejJmIkgw7iIOt83GqzfS0wqf/1xs0+xWQw6Oes6WodtgWzgWehQzf8A/8QAJhEBAQEAAgICAQIHAAAAAAAAAQARECExQVFhILHwMHGBkaHB0f/aAAgBAwEBPxDGZPFmvdT3NtzzI6GCHO5BBBH4PBwAMOo9aXYNv6KWHXFTwJ+IvoL6yV7HE+XDukQ3ZQQR+WQ4DFu62U+/0nyLC8Lwxf6GmIeIIjg438BvA1lhlvIHZaE/ffDZzGS3d56jHbfD544IILZZm22ww3lHa3ZcJdEtZaI4Uzxg+8hG6N8nDJllttt4EGWSHmNPVrDXeNTruzhZtvN+G7ctuNZeyWWWWW222GGcdzd8kxOrw/mSTjbeFjL3+ycrtHqUssssttsMM5QyMy34wIep5CeCFk48crs5d7JZZZbbbbYZcDiKut5xOvzn9oT1PwX0THGxkYhpY+YHQwpJpA1LLASJFsSkSh4GU8ji/ffLJU5xjyId9wdgSEiGSsrAzU9Mc8wFvG6wyhhu5kzgdWXOYPcN9z/eI9S8y8S1wTdZjYWcEMcg13JPd4gl9N9Vpsb7gy6mKXYYiWWWXnvjLYeBDF2hL+UBwdIMMlyb4R3bsCETuJ6Tj3Y9tl7/AFn5D/P/AGz4Uf2WMPo4FwMMRbCtyylDNVjsEnzJW/u+2fn/AAaE+7PzAQXgkvmfiyVogjbHvkWeBdnhkmdlq3eAskODLHNlt6s+uBjgsssszLMySWW2xZyZwDjI6iAscFlm2WZnh4yzjYYm8jDDDDwG2WZ4Zmf4BFtvJFvH/8QAJREBAQEAAgIDAAIBBQAAAAAAAQARECExQSBRYXGxoTDR4fDx/9oACAECAQE/EPOrT5iEG+IXhE9Q9JN0lj6lt5yyyzhOhJf22sYGwRu6tlt8sbu/A9TKebyyExYepHPlklnGyyJ08p2P1P7hZCEgdyPUevqQGujKM/HLLLLJLwvfDm79Xc/b/X/vHIxbGz7AlB969DbbzllllkkkOrCbN1nBDYP4D/nkIhpLounDrvht+OWWWWSRgI06k8uA3SS1WeCCTbPsvK4gVSlqI4CyyyyySG7ttLwvUh3ZN+uHgLJhpduhBZuYiCD5N7JJIML0nVuj9yJNmAuuCu7ThiPJk4hHOWWTYRhHhhLE2zBKLNhTQ4SvEox0nQ2YuxdmcfkIGBsZ6jLtm4gslDYdBd3CFkES26QK7nGBdO3ll+XCe5H2WkG+WKG28Tj1dgyF3Yfuz7tPc4zz+F2m2nu19372/dj6jc/qwtpmXfrLd1jPuLhHmvSgcH5R9ZDySPGynmcXiNk8WsEebN3zkcHVuDJZEQPqT7LX6tfUM9Qx6OFL6lD0y182z1KJgXVt5jcQuz1YGrYORGT8L/sy/F/xfk/4/wBrfpcDwH9r0Qk93RIcT9JWWckGF5gXSQ+bJKvMIvynyiw9X5R9XE/XI9Ev0Ssp5j3EPuC+HjlsSb4lzgLPq7R1Grc4k7SPKzJnwbniMzq22WGQ4beAtWvAiI4PtZw7HBo+Z14lnG/6Itvi44IeRjv4EOJDMVd2/B4DkBJyckfEYbbBgk+ORBZf/8QAJhABAAIBBAEFAQADAQAAAAAAAQARITFBUWFxEIGRobHRweHw8f/aAAgBAQABPxBQcu1XMDcftL7RnciVogijUrXYhByZsaua7HJLPB9ccWEIQYMpSJMrtHvnC2FK/ae8XoTVW2FVXlgrH5jL+/UuKxycQQH4oL+EKMfET+MSxNsJaD2iKqnxEo59BAt2lYaCj1BYw9SXET0NjTVZl5VVdWYCOUSBnWDh6r86Pp+pcMctoMQywOiAkTW4XYLHH5hDm4bvlCSyVgLixehfqQhLF1DJwdHa/wCpjGO252RgdEPdhOFFg8D/AHMyMHEEf6wCbRaSKWbJaVFSDBcphgBEPVF9BYS5cGDBhtvaVdYU+2P7KKFoqC8TOM2L2MfdTmJt98/5mREzDUI1MDVJlo2hiK3kj2ZuHMMizSMsLcIJFJcuXBlQ7j9R2F5J2wNqcTLay2ljgFKx2v8AyEOwaHUyJcoII2JcEUahRIWvYhrFuAAG8DbFFeoety5fpcPtSkvMLl1Yuolb5yVQXxEHZXjGPt6Iw9BAVGXEVt/tEVuW3H3CrupxAJHDFfqsWXLlytPBM1cqFlimyWG0iHEYlRFinTvRf4jlEKNSdxAJR6A5hXmyokAQxmjjhDDc3gBQTrHKSkWLLl+jxlDurHDLlERpbwVCN2VptKoCBXgy/kZXVj5Fo+vkm7Y41TswTFs2jtW6pX6jd2I6C3WxLXMN8zBvG6dYpD+JP9NhTZt46QdmzRdJWm4IgZrvAMkSmEGLKYbEscA1mIVHLUV3GTCZ0sojvXTG0yvXnaCQEwJd9eX/AMZYy0C8go/UapE1LYQ2lTLyO0r1TUIXJVraB6mSkyjKyua7m34j+T7JmGC1p5YQuXuQKnHiJPt5LyhEWyNdQUZBFqIloKKbgEvtRYW2XTLwc5wYoFBvnKM30SJg873f0ZaRuYNu4Js0Vy/2C3fv+z/owXXN3BH+MfsqOZn5niCIceUbm/VkoSkvIjfgSCY3mJd3YrpDaIhgOIxbZGqW6OzMEB1slUiOCyZz1GyAe6K/qZcg2/oZWz1z7gs1bn5R/tCwntDEAOyXKibasBZ/jDLsWiqZj/HK+yBWh2Z9ELFSzOsyB1JY9yxqy+ILxg94TinmOzAVNIY3FcwOG/eLieIYmvVRA67XYNUfUkfI18PzO9BF1FYsuvyWC9C/eq/bikeAiPyMs3BRXrNAasJdNjfZz8wOjC11jxtUogDIlrwv6lAZsMiQUwc2qhgpXt13gmagGgp7mrD2nQ/MA4NPC6xGVDe37idTIt/iPFEv6lSvW7F667gMasAARhtpALjusRs/XUKd8ojA8s3/AFQtOFD/AFLJ8EYmhqf9tZX+KD/MTIzkI1BF2pPyMiA/42gtKapnzq+4WEzKbXlZfeKbWdh5rSIhea6kp/Awe5AbyxhlDF9idDBAC2HcmKxuHWNO8OGDdFfaOsCAKYK4IgIuTR+SvodQU7xBbA1uMUOhBEzK8BEbfxEbcoHHyEUwTqIP0pEXXcqf5MWA4A/bmU8047LLcgfkgNEm9P8ACOCrmqfJDjxl0wHb2iGEwi9zT59FSzUOzY5ltRUlEfDNKL7Q1dTvDq4sMuwbSjrDF44YihX3DMOYYZ0mSzZSTJiGfhhOa/MA0zyykreIaw6JUyGTkifEcLZFdrkg4YNKRuBR2ynR+YnmDSt41U5J1SiGZwy9SRvJGOGXaREatSVgLOZSZL9FB5RXoMYYk2xO2aaNTsuAURO4xwW6meedj5gBmPRi2SswsVMymAtxDqXaQDeK9ZbG2gzFkUwkllGuE6kT4YxpLmpADpEXDCRwywYFaynMwcxQuDEGEzGzKrga0mjiZwg1Moh2gwplxKJmELmevoDioiZjl5hBzG9zP//Z required: false /ai/actions/{identifier}: get: operationId: ibexa.rest.ai.action tags: - Connector AI responses: '200': description: Action configuration in JSON or XML content: application/vnd.ibexa.api.ai.ActionConfiguration+json: schema: $ref: '#/components/schemas/ActionConfiguration' example: ActionConfiguration: _media-type: application/vnd.ibexa.api.ai.ActionConfiguration+json identifier: rewrite_with_friendly_tone name: Rewrite in friendly tone description: '' enabled: true ActionType: _media-type: application/vnd.ibexa.api.ai.ActionType+json identifier: refine_text name: Refine text inputIdentifier: text outputIdentifier: text options: [] actionTypeOptions: [] actionHandlerIdentifier: openai-text-to-text actionHandlerOptions: max_tokens: 4000 temperature: 1 prompt: Rewrite text in friendly tone. Preserve meaning and crucial information. model: gpt-4-turbo createdAt: '2025-08-07T13:16:47+02:00' updatedAt: '2025-08-07T13:18:00+02:00' application/vnd.ibexa.api.ai.ActionConfiguration+xml: schema: $ref: '#/components/schemas/ActionConfiguration' example: | rewrite_with_friendly_tone Rewrite in friendly tone 1 refine_text Refine text text text openai-text-to-text 4000 1 Rewrite text in friendly tone. Preserve meaning and crucial information. gpt-4-turbo 2025-08-07T13:16:47+02:00 2025-08-07T13:16:47+02:00 '401': description: Error – the user doesn't have access to the given action configuration '404': description: Error - an action configuration of the given unique identifier is not found. summary: Get an action configuration by its unique identifier. description: Returns an action configuration by its unique string identifier. parameters: - name: identifier in: path description: ActionConfigurationLoadByIdentifierController identifier required: true deprecated: false schema: type: string style: simple explode: false example: rewrite_with_friendly_tone /languages: get: operationId: ibexa.rest.languages.list tags: - Language responses: '200': description: If set, the list is returned in XML or JSON format. content: application/vnd.ibexa.api.LanguageList+json: schema: $ref: '#/components/schemas/LanguageListWrapper' example: LanguageList: _media-type: application/vnd.ibexa.api.LanguageList+json _href: /api/ibexa/v2/languages Language: - _media-type: application/vnd.ibexa.api.Language+json _href: /api/ibexa/v2/languages/eng-GB languageId: 2 languageCode: eng-GB name: English (United Kingdom) - _href: /api/ibexa/v2/languages/pol-PL _media-type: application/vnd.ibexa.api.Language+json languageCode: pol-PL languageId: 4 name: Polish (polski) application/vnd.ibexa.api.LanguageList+xml: schema: $ref: '#/components/schemas/LanguageList' example: | 2 eng-GB English (United Kingdom) 4 pol-PL Polish (polski) summary: Language list description: Lists languages parameters: [] /languages/{code}: get: operationId: ibexa.rest.languages.view tags: - Language responses: '200': description: If set, the language is returned in XML or JSON format. content: application/vnd.ibexa.api.Language+json: schema: $ref: '#/components/schemas/LanguageWrapper' example: Language: _media-type: application/vnd.ibexa.api.Language+json _href: /api/ibexa/v2/languages/eng-GB languageId: 2 languageCode: eng-GB name: English (United Kingdom) application/vnd.ibexa.api.Language+xml: schema: $ref: '#/components/schemas/Language' example: | 2 eng-GB English (United Kingdom) summary: Get language description: Retrieves a LanguageLoadByIdController resource. parameters: - name: code in: path description: LanguageLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false /content/locations: get: operationId: ibexa.rest.redirect_location tags: - Location responses: '200': description: OK - returns the LocationList in XML or JSON format. content: application/vnd.ibexa.api.LocationList+json: schema: $ref: '#/components/schemas/LocationWrapper' example: Location: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/2/58 id: 58 priority: 0 hidden: false invisible: false explicitlyHidden: false ParentLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/2 pathString: /1/2/58/ depth: 2 childCount: 3 remoteId: 0cfe62f27753448d79aaa8acd8d01699 Children: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/locations/1/2/58/children Content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/57 sortField: PATH sortOrder: ASC UrlAliases: _media-type: application/vnd.ibexa.api.UrlAliasRefList+json _href: /api/ibexa/v2/content/locations/1/2/58/urlaliases ContentInfo: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/57 Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/57 _remoteId: 782f5afa9d6587804daa911e88ff5bb9 _id: 57 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/1 Name: All Tips TranslatedName: All Tips Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/57/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/57/currentversion Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/57/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 lastModificationDate: '2021-06-28T11:22:52+00:00' publishedDate: '2021-06-28T11:22:52+00:00' mainLanguageCode: eng-GB currentVersionNo: 1 alwaysAvailable: true isHidden: false status: PUBLISHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/57/objectstates application/vnd.ibexa.api.LocationList+xml: schema: $ref: '#/components/schemas/Location' example: | 58 0 false false false /1/2/58/ 2 3 0cfe62f27753448d79aaa8acd8d01699 PATH ASC All Tips All Tips
2021-06-28T11:22:52+00:00 2021-06-28T11:22:52+00:00 eng-GB 1 true false PUBLISHED '307': description: Temporary redirect to the main resource URL. '404': description: Error - the Location with the given ID (remote ID or URL Alias) does not exist. summary: Load Locations by id/remoteId/urlAlias description: Loads the Location for a given ID (x), remote ID or URL alias. parameters: [] /content/locations/{path}: get: operationId: ibexa.rest.load_location tags: - Location responses: '200': description: If set, the new Location is returned in XML or JSON format. content: application/vnd.ibexa.api.Location+json: schema: $ref: '#/components/schemas/LocationWrapper' example: Location: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/2/58 id: 58 priority: 0 hidden: false invisible: false explicitlyHidden: false ParentLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/2 pathString: /1/2/58/ depth: 2 childCount: 3 remoteId: 0cfe62f27753448d79aaa8acd8d01699 Children: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/locations/1/2/58/children Content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/57 sortField: PATH sortOrder: ASC UrlAliases: _media-type: application/vnd.ibexa.api.UrlAliasRefList+json _href: /api/ibexa/v2/content/locations/1/2/58/urlaliases ContentInfo: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/57 Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/57 _remoteId: 782f5afa9d6587804daa911e88ff5bb9 _id: 57 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/1 Name: All Tips TranslatedName: All Tips Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/57/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/57/currentversion Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/57/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 lastModificationDate: '2021-06-28T11:22:52+00:00' publishedDate: '2021-06-28T11:22:52+00:00' mainLanguageCode: eng-GB currentVersionNo: 1 alwaysAvailable: true isHidden: false status: PUBLISHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/57/objectstates application/vnd.ibexa.api.Location+xml: schema: $ref: '#/components/schemas/Location' example: | 61 0 false false /1/2/61/ 2 0 2cfa66027e3806b113d994c9c26d3a66 NAME ASC 666
2018-11-09T14:49:52+01:00 2018-11-09T14:49:52+01:00 eng-GB 1 false '401': description: Error - the user is not authorized to read this Location. '404': description: Error - the Location with the given path does not exist. summary: Load Location description: Loads the Location for the given path e.g. '/content/locations/1/2/61'. parameters: - name: If-None-Match in: header description: ETag required: false deprecated: false schema: type: string style: simple explode: false - name: path in: path description: LocationLoadByPathController identifier required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: ibexa.rest.delete_subtree tags: - Location responses: '204': description: No Content - deleted. '401': description: Error - the user is not authorized to delete this subtree. '404': description: Error - the Location with the given ID does not exist. summary: Delete subtree description: Deletes the complete subtree for the given path. Every content item which does not have any other Location is deleted. Otherwise the deleted Location is removed from the content item. The children are recursively deleted. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: path in: path description: LocationSubtreeDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: ibexa.rest.update_location tags: - Location responses: '200': description: If set, the Location is returned in XML or JSON format. content: application/vnd.ibexa.api.Location+json: schema: $ref: '#/components/schemas/LocationWrapper' example: Location: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/2/59 id: 59 priority: 3 hidden: true invisible: true explicitlyHidden: true ParentLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/2 pathString: /1/2/59/ depth: 2 childCount: 5 remoteId: remoteId-qwert999 Children: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/locations/1/2/59/children Content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/58 sortField: NAME sortOrder: DESC UrlAliases: _media-type: application/vnd.ibexa.api.UrlAliasRefList+json _href: /api/ibexa/v2/content/locations/1/2/59/urlaliases ContentInfo: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/58 Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/58 _remoteId: 00b513aae54036a16e00fb3365c4b5f3 _id: 58 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/1 Name: Dog Breed Catalog TranslatedName: Dog Breed Catalog Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/58/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/58/currentversion Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/58/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 lastModificationDate: '2021-06-28T11:23:10+00:00' publishedDate: '2021-06-28T11:23:10+00:00' mainLanguageCode: eng-GB currentVersionNo: 1 alwaysAvailable: true isHidden: false status: PUBLISHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/58/objectstates application/vnd.ibexa.api.Location+xml: schema: $ref: '#/components/schemas/Location' example: | 58 0 false false false /1/2/58/ 2 3 0cfe62f27753448d79aaa8acd8d01699 PATH ASC All Tips All Tips
2021-06-28T11:22:52+00:00 2021-06-28T11:22:52+00:00 eng-GB 1 true false PUBLISHED '401': description: Error - the user is not authorized to update this Location. '404': description: Error - the Location with the given ID does not exist. summary: Update Location description: Updates the Location. This method can also be used to hide/reveal a Location via the hidden field in the LocationUpdate. PATCH or POST with header X-HTTP-Method-Override PATCH. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: If-Match in: header description: ETag required: true deprecated: false schema: type: string style: simple explode: false - name: path in: path description: LocationUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The LocationUpdate schema encoded in XML or JSON format. content: application/vnd.ibexa.api.LocationUpdate+json: schema: $ref: '#/components/schemas/LocationUpdateStructWrapper' example: LocationUpdate: priority: '3' hidden: true remoteId: remoteId-qwert999 sortField: NAME sortOrder: DESC application/vnd.ibexa.api.LocationUpdate+xml: schema: $ref: '#/components/schemas/LocationUpdateStruct' example: | 3 true remoteId-qwert999 CLASS DESC required: false /content/locations/{path}/children: get: operationId: ibexa.rest.load_location_children tags: - Location responses: '200': description: If set, the new Location list is returned in XML or JSON format. content: application/vnd.ibexa.api.LocationList+json: schema: $ref: '#/components/schemas/LocationListWrapper' application/vnd.ibexa.api.LocationList+xml: schema: $ref: '#/components/schemas/LocationList' example: | '401': description: Error - the user is not authorized to read this content item. '404': description: Error - the content item with the given ID does not exist. summary: Get child Locations. description: Loads all child Locations for the given parent Location. parameters: - name: path in: path description: LocationChildrenListController identifier required: true deprecated: false schema: type: string style: simple explode: false /content/locations/{path}/urlaliases: get: operationId: ibexa.rest.list_location_url_aliases tags: - Location responses: '200': description: OK - returns the list of URL aliases. content: application/vnd.ibexa.api.UrlAliasRefList+json: schema: $ref: '#/components/schemas/UrlAliasRefListWrapper' application/vnd.ibexa.api.UrlAliasRefList+xml: schema: $ref: '#/components/schemas/UrlAliasRefList' example: | '400': description: Error - The user has no permission to read URL aliases. '401': description: Error - The Location was not found. summary: List URL aliases for Location description: Returns the list of URL aliases for a Location. parameters: - name: path in: path description: URLAliasListLocationController identifier required: true deprecated: false schema: type: string style: simple explode: false /content/objectstategroups: get: operationId: ibexa.rest.load_object_state_groups tags: - Object State Groups responses: '200': description: OK - returns a list of Object state groups. content: application/vnd.ibexa.api.ObjectStateGroupList+json: schema: $ref: '#/components/schemas/ObjectStateGroupListWrapper' example: ObjectStateGroupList: _media-type: application/vnd.ibexa.api.ObjectStateGroupList+json _href: /api/ibexa/v2/content/objectstategroups ObjectStateGroup: - _media-type: application/vnd.ibexa.api.ObjectStateGroup+json _href: /api/ibexa/v2/content/objectstategroups/2 id: 2 identifier: ibexa_lock defaultLanguageCode: eng-GB languageCodes: eng-GB ObjectStates: _media-type: application/vnd.ibexa.api.ObjectStateList+json _href: /api/ibexa/v2/content/objectstategroups/2/objectstates names: value: - _languageCode: eng-GB '#text': Lock descriptions: value: - _languageCode: eng-GB '#text': '' - _media-type: application/vnd.ibexa.api.ObjectStateGroup+json _href: /api/ibexa/v2/content/objectstategroups/3 id: 3 identifier: accessibility defaultLanguageCode: eng-GB languageCodes: eng-GB ObjectStates: _media-type: application/vnd.ibexa.api.ObjectStateList+json _href: /api/ibexa/v2/content/objectstategroups/3/objectstates names: value: - _languageCode: eng-GB '#text': Accessibility descriptions: value: - _languageCode: eng-GB '#text': '' - _media-type: application/vnd.ibexa.api.ObjectStateGroup+json _href: /api/ibexa/v2/content/objectstategroups/6 id: 6 identifier: custom-states defaultLanguageCode: eng-GB languageCodes: eng-GB ObjectStates: _media-type: application/vnd.ibexa.api.ObjectStateList+json _href: /api/ibexa/v2/content/objectstategroups/6/objectstates names: value: - _languageCode: eng-GB '#text': Custom State descriptions: value: - _languageCode: eng-GB '#text': Custom Object state application/vnd.ibexa.api.ObjectStateGroupList+xml: schema: $ref: '#/components/schemas/ObjectStateGroupList' example: | 2 ibexa_lock eng-GB eng-GB Lock 3 accessibility eng-GB eng-GB Accessibility 6 custom-states eng-GB eng-GB Custom State Custom Object state '401': description: Error - The user has no permission to read Object state groups. summary: List Object state groups description: Returns a list of all Object state groups. parameters: - name: If-None-Match in: header description: ETag required: false deprecated: false schema: type: string style: simple explode: false post: operationId: ibexa.rest.create_object_state_group tags: - Object State Groups responses: '201': description: Object state group created. content: application/vnd.ibexa.api.ObjectStateGroup+json: schema: $ref: '#/components/schemas/ObjectStateGroupWrapper' example: ObjectStateGroup: _media-type: application/vnd.ibexa.api.ObjectStateGroup+json _href: /api/ibexa/v2/content/objectstategroups/7 id: 7 identifier: custom-states defaultLanguageCode: eng-GB languageCodes: eng-GB ObjectStates: _media-type: application/vnd.ibexa.api.ObjectStateList+json _href: /api/ibexa/v2/content/objectstategroups/7/objectstates names: value: - _languageCode: eng-GB '#text': Custom State descriptions: value: - _languageCode: eng-GB '#text': Custom Object state application/vnd.ibexa.api.ObjectStateGroup+xml: schema: $ref: '#/components/schemas/ObjectStateGroup' example: | 5 custom-states eng-GB eng-GB Custom State Custom Object state '400': description: Error - The input does not match the input schema definition. '401': description: Error - The user is not authorized to create an Object state group. '403': description: Error - An Object state group with the same identifier already exists. summary: Create Object state group description: Creates a new Object state group. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The Object state group input schema encoded in XML or JSON format. content: application/vnd.ibexa.api.ObjectStateGroupCreate+json: schema: $ref: '#/components/schemas/ObjectStateGroupCreateWrapper' example: ObjectStateGroupCreate: identifier: custom-states defaultLanguageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Custom State descriptions: value: - _languageCode: eng-GB '#text': Custom Object state application/vnd.ibexa.api.ObjectStateGroupCreate+xml: schema: $ref: '#/components/schemas/ObjectStateGroupCreate' example: |- custom eng-GB Custom State Custom Object state required: false /content/objectstategroups/{objectStateGroupId}: get: operationId: ibexa.rest.load_object_state_group tags: - Object State Groups responses: '200': description: OK - returns the Object state group. content: application/vnd.ibexa.api.ObjectStateGroup+json: schema: $ref: '#/components/schemas/ObjectStateGroupWrapper' example: ObjectStateGroup: _media-type: application/vnd.ibexa.api.ObjectStateGroup+json _href: /api/ibexa/v2/content/objectstategroups/7 id: 7 identifier: custom-states defaultLanguageCode: eng-GB languageCodes: eng-GB ObjectStates: _media-type: application/vnd.ibexa.api.ObjectStateList+json _href: /api/ibexa/v2/content/objectstategroups/7/objectstates names: value: - _languageCode: eng-GB '#text': Custom State descriptions: value: - _languageCode: eng-GB '#text': Custom Object state application/vnd.ibexa.api.ObjectStateGroup+xml: schema: $ref: '#/components/schemas/ObjectStateGroup' example: | 7 custom-states eng-GB eng-GB Custom State Custom Object state '401': description: Error - The user is not authorized to read this Object state group. '404': description: Error - The Object state group does not exist. summary: Get Object state group description: Returns the Object state group with the provided ID. parameters: - name: If-None-Match in: header description: ETag required: false deprecated: false schema: type: string style: simple explode: false - name: objectStateGroupId in: path description: ObjectStateGroupLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: ibexa.rest.delete_object_state_group tags: - Object State Groups responses: '204': description: No Content - Object state group deleted. '401': description: Error - The user is not authorized to delete an Object state group. '404': description: Error - The Object state group does not exist. summary: Delete Object state group description: Deletes the given Object state group including Object states. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: objectStateGroupId in: path description: ObjectStateGroupDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: ibexa.rest.update_object_state_group tags: - Object State Groups responses: '200': description: OK - Object stated group updated. content: application/vnd.ibexa.api.ObjectStateGroup+json: schema: $ref: '#/components/schemas/ObjectStateGroupWrapper' example: ObjectStateGroup: _media-type: application/vnd.ibexa.api.ObjectStateGroup+json _href: /api/ibexa/v2/content/objectstategroups/7 id: 7 identifier: custom-states defaultLanguageCode: eng-GB languageCodes: eng-GB ObjectStates: _media-type: application/vnd.ibexa.api.ObjectStateList+json _href: /api/ibexa/v2/content/objectstategroups/7/objectstates names: value: - _languageCode: eng-GB '#text': New Custom State name descriptions: value: - _languageCode: eng-GB '#text': Custom Object state application/vnd.ibexa.api.ObjectStateGroup+xml: schema: $ref: '#/components/schemas/ObjectStateGroup' example: | 7 custom-states eng-GB eng-GB New Custom State name Custom Object state '400': description: Error - The input does not match the input schema definition. '401': description: Error - The user is not authorized to update an Object state group. '403': description: Error - An Object state group with the provided identifier already exists. '412': description: Error - The current ETag does not match the one provided in the If-Match header. summary: Update Object state group description: Updates an Object state group. PATCH or POST with header X-HTTP-Method-Override PATCH. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: If-Match in: header description: ETag required: true deprecated: false schema: type: string style: simple explode: false - name: objectStateGroupId in: path description: ObjectStateGroupUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The Object state group input schema encoded in XML or JSON format. content: application/vnd.ibexa.api.ObjectStateGroupUpdate+json: schema: $ref: '#/components/schemas/ObjectStateGroupUpdateWrapper' example: ObjectStateGroupUpdate: names: value: - _languageCode: eng-GB '#text': New Custom State name application/vnd.ibexa.api.ObjectStateGroupUpdate+xml: schema: $ref: '#/components/schemas/ObjectStateGroupUpdate' example: | New Custom State name required: false /content/objectstategroups/{objectStateGroupId}/objectstates: get: operationId: ibexa.rest.load_object_states tags: - Object State Groups responses: '200': description: OK - returns a list of Object states. content: application/vnd.ibexa.api.ObjectStateList+json: schema: $ref: '#/components/schemas/ObjectStateListWrapper' example: ObjectStateList: _media-type: application/vnd.ibexa.api.ObjectStateList+json _href: /api/ibexa/v2/content/objectstategroups/2/objectstates ObjectState: - _media-type: application/vnd.ibexa.api.ObjectState+json _href: /api/ibexa/v2/content/objectstategroups/2/objectstates/1 id: 1 identifier: not_locked priority: 0 ObjectStateGroup: _media-type: application/vnd.ibexa.api.ObjectStateGroup+json _href: /api/ibexa/v2/content/objectstategroups/2 defaultLanguageCode: eng-GB languageCodes: eng-GB names: value: - _languageCode: eng-GB '#text': Not locked descriptions: value: - _languageCode: eng-GB '#text': '' - _media-type: application/vnd.ibexa.api.ObjectState+json _href: /api/ibexa/v2/content/objectstategroups/2/objectstates/2 id: 2 identifier: locked priority: 1 ObjectStateGroup: _media-type: application/vnd.ibexa.api.ObjectStateGroup+json _href: /api/ibexa/v2/content/objectstategroups/2 defaultLanguageCode: eng-GB languageCodes: eng-GB names: value: - _languageCode: eng-GB '#text': Locked descriptions: value: - _languageCode: eng-GB '#text': '' application/vnd.ibexa.api.ObjectStateList+xml: schema: $ref: '#/components/schemas/ObjectStateList' example: | 1 not_locked 0 eng-GB eng-GB Not locked 2 locked 1 eng-GB eng-GB Locked '401': description: Error - The user has no permission to read Object states. summary: List Object states description: Returns a list of all Object states of the given group. parameters: - name: If-None-Match in: header description: ETag required: false deprecated: false schema: type: string style: simple explode: false - name: objectStateGroupId in: path description: ObjectStateListController identifier required: true deprecated: false schema: type: string style: simple explode: false post: operationId: ibexa.rest.create_object_state tags: - Object State Groups responses: '201': description: Object state created. content: application/vnd.ibexa.api.ObjectState+json: schema: $ref: '#/components/schemas/ObjectStateWrapper' example: ObjectState: _media-type: application/vnd.ibexa.api.ObjectState+json _href: /api/ibexa/v2/content/objectstategroups/7/objectstates/7 id: 7 identifier: new-state priority: 0 ObjectStateGroup: _media-type: application/vnd.ibexa.api.ObjectStateGroup+json _href: /api/ibexa/v2/content/objectstategroups/7 defaultLanguageCode: eng-GB languageCodes: eng-GB names: value: - _languageCode: eng-GB '#text': New State descriptions: value: - _languageCode: eng-GB '#text': New Object State application/vnd.ibexa.api.ObjectState+xml: schema: $ref: '#/components/schemas/ObjectState' example: | 5 new-state 0 eng-GB eng-GB New State New Object State '400': description: Error - The input does not match the input schema definition. '401': description: Error - The user is not authorized to create an Object state. '403': description: Error - An Object state with the same identifier already exists in the given group. summary: Create Object state description: Creates a new Object state. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: objectStateGroupId in: path description: ObjectStateCreateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The Object state input schema encoded in XML or JSON format. content: application/vnd.ibexa.api.ObjectStateCreate+json: schema: $ref: '#/components/schemas/ObjectStateCreateWrapper' example: ObjectStateCreate: identifier: new-state priority: '1' defaultLanguageCode: eng-GB languageCodes: eng-GB names: value: - _languageCode: eng-GB '#text': New State descriptions: value: - _languageCode: eng-GB '#text': New Object State application/vnd.ibexa.api.ObjectStateCreate+xml: schema: $ref: '#/components/schemas/ObjectStateCreate' example: | new-state 1 eng-GB New State New Object State required: false /content/objectstategroups/{objectStateGroupId}/objectstates/{objectStateId}: get: operationId: ibexa.rest.load_object_state tags: - Object State Groups responses: '200': description: OK - returns the Object state. content: application/vnd.ibexa.api.ObjectState+json: schema: $ref: '#/components/schemas/ObjectStateWrapper' example: ObjectState: _media-type: application/vnd.ibexa.api.ObjectState+json _href: /api/ibexa/v2/content/objectstategroups/2/objectstates/2 id: 2 identifier: locked priority: 1 ObjectStateGroup: _media-type: application/vnd.ibexa.api.ObjectStateGroup+json _href: /api/ibexa/v2/content/objectstategroups/2 defaultLanguageCode: eng-GB languageCodes: eng-GB names: value: - _languageCode: eng-GB '#text': Locked descriptions: value: - _languageCode: eng-GB '#text': '' application/vnd.ibexa.api.ObjectState+xml: schema: $ref: '#/components/schemas/ObjectState' example: | 2 locked 1 eng-GB eng-GB Locked '401': description: Error - The user is not authorized to read this Object state. '404': description: Error - The Object state does not exist. summary: Get Object state description: Returns the Object state. parameters: - name: If-None-Match in: header description: ETag required: false deprecated: false schema: type: string style: simple explode: false - name: objectStateGroupId in: path description: ObjectStateLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: objectStateId in: path description: ObjectStateLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: ibexa.rest.delete_object_state tags: - Object State Groups responses: '204': description: No Content - Object state deleted. '401': description: Error - The user is not authorized to delete an Object state. '404': description: Error - The Object state does not exist. summary: Delete Object state description: Deletes provided Object state. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: objectStateGroupId in: path description: ObjectStateDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: objectStateId in: path description: ObjectStateDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: ibexa.rest.update_object_state tags: - Object State Groups responses: '200': description: OK - Object State updated content: application/vnd.ibexa.api.ObjectState+json: schema: $ref: '#/components/schemas/ObjectStateWrapper' example: ObjectState: _media-type: application/vnd.ibexa.api.ObjectState+json _href: /api/ibexa/v2/content/objectstategroups/6/objectstates/9 id: 9 identifier: closed priority: 1 ObjectStateGroup: _media-type: application/vnd.ibexa.api.ObjectStateGroup+json _href: /api/ibexa/v2/content/objectstategroups/6 defaultLanguageCode: eng-GB languageCodes: eng-GB names: value: - _languageCode: eng-GB '#text': New Object State name descriptions: value: - _languageCode: eng-GB '#text': '' application/vnd.ibexa.api.ObjectState+xml: schema: $ref: '#/components/schemas/ObjectState' example: | 2 locked 1 eng-GB eng-GB New Object State name '400': description: Error - The input does not match the input schema definition. '401': description: Error - The user is not authorized to update the Object state. '403': description: Error - An Object state with the provided identifier already exists in this group. '412': description: Error - The current ETag does not match the one provided in the If-Match header. summary: Update Object state description: Updates an Object state. PATCH or POST with header X-HTTP-Method-Override PATCH. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: If-Match in: header description: ETag required: true deprecated: false schema: type: string style: simple explode: false - name: objectStateGroupId in: path description: ObjectStateUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: objectStateId in: path description: ObjectStateUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The Object state input schema encoded in XML or JSON format. content: application/vnd.ibexa.api.ObjectStateUpdate+json: schema: $ref: '#/components/schemas/ObjectStateUpdateWrapper' example: ObjectStateUpdate: names: value: - _languageCode: eng-GB '#text': New Object State name application/vnd.ibexa.api.ObjectStateUpdate+xml: schema: $ref: '#/components/schemas/ObjectStateUpdate' example: | 3 eng-GB New Object State name required: false /content/objects: get: operationId: ibexa.rest.redirect_content tags: - Objects responses: '307': description: Temporary redirect to `GET /content/objects/{contentId}` equivalent. headers: Location: description: Contains the prefixed `/content/objects/{contentId}` absolute path of the content item. schema: type: string '400': description: Error - the required `remoteId` query parameter is missing. '404': description: Error - the content with the given remote ID does not exist. summary: Load content by remote ID description: Loads content item for a given remote ID. parameters: - name: remoteId in: query description: Remote ID of the content item. required: true deprecated: false schema: type: string style: form explode: false post: operationId: ibexa.rest.create_content tags: - Objects responses: '201': description: Content - If set, all information for the content item including the embedded current version is returned in XML or JSON format. ContentInfo - If set, all information for the content item (excluding the current version) is returned in XML or JSON format. content: application/vnd.ibexa.api.Content+json: schema: $ref: '#/components/schemas/ContentWrapper' example: Content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/109 _remoteId: 8716f007ba15f6f35139acb55e39b811 _id: 109 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2 Name: draft article TranslatedName: draft article Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/109/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/109/currentversion Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/109/versions/1 VersionInfo: id: 587 versionNo: 1 status: DRAFT modificationDate: '2023-05-24T06:27:54+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2023-05-24T06:27:54+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': draft article Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/109 Fields: field: - id: 488 fieldDefinitionIdentifier: title languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: draft article - id: 489 fieldDefinitionIdentifier: short_title languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: null - id: 490 fieldDefinitionIdentifier: author languageCode: eng-GB fieldTypeIdentifier: ibexa_author fieldValue: [] - id: 491 fieldDefinitionIdentifier: intro languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
draft draft
xhtml5edit: |

draft draft

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

draft draft draft

- id: 493 fieldDefinitionIdentifier: enable_comments languageCode: eng-GB fieldTypeIdentifier: ibexa_boolean fieldValue: false - id: 494 fieldDefinitionIdentifier: image languageCode: eng-GB fieldTypeIdentifier: ibexa_object_relation fieldValue: destinationContentId: null Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/109/versions/1/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /placeholder width: null height: null mimeType: image/svg+xml Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/109/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 mainLanguageCode: eng-GB currentVersionNo: 1 alwaysAvailable: true isHidden: false status: DRAFT ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/109/objectstates application/vnd.ibexa.api.Content+xml: schema: $ref: '#/components/schemas/Content' example: | draft article draft article 586 1 DRAFT 2023-05-24T06:24:46+00:00 2023-05-24T06:24:46+00:00 eng-GB eng-GB eng-GB draft article 481 title eng-GB ibexa_string draft article 482 short_title eng-GB ibexa_string 483 author eng-GB ibexa_author 484 intro eng-GB ibexa_richtext <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>draft draft</para></section> <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft</p></section> 485 body eng-GB ibexa_richtext <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ezxhtml="http://ibexa.co/xmlns/dxp/docbook/xhtml" xmlns:ezcustom="http://ibexa.co/xmlns/dxp/docbook/custom" version="5.0-variant ezpublish-1.0"><para>draft draft draft</para></section> <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"><p>draft draft draft</p></section> 486 enable_comments eng-GB ibexa_boolean false 487 image eng-GB ibexa_object_relation /placeholder image/svg+xml
eng-GB 1 true false DRAFT application/vnd.ibexa.api.ContentInfo+json: schema: $ref: '#/components/schemas/ContentInfoWrapper' example: Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/77 _remoteId: 89e9b86c673b1c1de6781bb94488b18c _id: 77 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2 Name: draft article TranslatedName: draft article Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/77/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/77/currentversion Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/77/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 mainLanguageCode: eng-GB currentVersionNo: 1 alwaysAvailable: true isHidden: false status: DRAFT ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/77/objectstates application/vnd.ibexa.api.ContentInfo+xml: schema: $ref: '#/components/schemas/ContentInfo' example: | draft article draft article
eng-GB 1 true false DRAFT '400': description: Error - the input does not match the input schema definition or the validation on a field fails. '401': description: Error - the user is not authorized to create this Object in this Location. '404': description: Error - the parent Location specified in the request body does not exist. summary: Create content item description: Creates a draft assigned to the authenticated user. If a different user ID is given in the input, the draft is assigned to the given user but this action requires special permissions for the authenticated user (this is useful for content staging where the transfer process does not have to authenticate with the user who created the content item in the source server). The user needs to publish the content item if it should be visible. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The ContentCreate schema encoded in XML or JSON format. content: application/vnd.ibexa.api.ContentCreate+json: schema: $ref: '#/components/schemas/ContentCreateWrapper' example: ContentCreate: ContentType: _href: /api/ibexa/v2/content/types/2 mainLanguageCode: eng-GB LocationCreate: _media-type: application/vnd.ibexa.api.LocationCreate ParentLocation: _href: /api/ibexa/v2/content/locations/1/2 priority: '0' hidden: 'false' sortField: PATH sortOrder: ASC Section: _href: /api/ibexa/v2/content/sections/1 alwaysAvailable: 'true' fields: field: - fieldDefinitionIdentifier: title languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: draft article - fieldDefinitionIdentifier: intro languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml:

draft draft

- fieldDefinitionIdentifier: body languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml:

draft draft draft

application/vnd.ibexa.api.ContentCreate+xml: schema: $ref: '#/components/schemas/ContentCreate' example: | eng-GB 0 false PATH ASC
true title eng-GB draft article intro eng-GB

draft draft

]]> body eng-GB

draft draft draft

]]> required: false /content/objects/{contentId}: get: operationId: ibexa.rest.load_content tags: - Objects responses: '200': description: OK - returns the Content or ContentInfo in XML or JSON format. content: application/vnd.ibexa.api.Content+json: schema: $ref: '#/components/schemas/ContentWrapper' example: Content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/54 _remoteId: 9e863fbb0fb835ce050032b4f00de61d _id: 54 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/1 Name: Forms TranslatedName: Forms Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/54/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/54/currentversion Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/54/versions/1 VersionInfo: id: 514 versionNo: 1 status: PUBLISHED modificationDate: '2018-09-17T06:48:13+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2018-09-17T06:48:13+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Forms Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/54 Fields: field: - id: 249 fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Forms - id: 250 fieldDefinitionIdentifier: short_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: null - id: 251 fieldDefinitionIdentifier: short_description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
xhtml5edit: |
- id: 252 fieldDefinitionIdentifier: description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
xhtml5edit: |
Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/54/versions/1/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ezplatformadminui/img/ez-icons.svg#folder width: null height: null mimeType: image/svg+xml Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/6 MainLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/55 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/54/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 lastModificationDate: '2018-09-17T06:48:13+00:00' publishedDate: '2018-09-17T06:48:13+00:00' mainLanguageCode: eng-GB currentVersionNo: 1 alwaysAvailable: false isHidden: false status: PUBLISHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/54/objectstates application/vnd.ibexa.api.Content+xml: schema: $ref: '#/components/schemas/Content' example: | Forms Forms 514 1 PUBLISHED 2018-09-17T06:48:13+00:00 2018-09-17T06:48:13+00:00 eng-GB eng-GB eng-GB Forms 249 name eng-GB ibexa_string Forms 250 short_name eng-GB ibexa_string 251 short_description eng-GB ibexa_richtext <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> 252 description eng-GB ibexa_richtext <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> /bundles/ezplatformadminui/img/ez-icons.svg#folder image/svg+xml
2018-09-17T06:48:13+00:00 2018-09-17T06:48:13+00:00 eng-GB 1 false false PUBLISHED application/vnd.ibexa.api.ContentInfo+json: schema: $ref: '#/components/schemas/ContentInfoWrapper' application/vnd.ibexa.api.ContentInfo+xml: schema: $ref: '#/components/schemas/ContentInfo' '401': description: Error - the user is not authorized to read this object. This could also happen if there is no published version yet and another user owns a draft of this content item. '404': description: Error - the ID is not found. summary: Load content description: "Loads the content item for the given ID. Depending on the Accept header the current version is embedded (i.e. the current published version or if it does not exist, the draft of the authenticated user).\n* Content -\tIf set, all information for the content item including the embedded current version is returned in XML or JSON format.\n* ContentInfo - If set, all information for the content item (excluding the current version) is returned in XML or JSON format." parameters: - name: If-None-Match in: header description: If the provided ETag matches the current ETag then a "304 Not Modified" is returned. The ETag changes if the meta data has changed, this happens also if there is a new published version. required: false deprecated: false schema: type: string style: simple explode: false - name: contentId in: path description: ContentLoadByIdController identifier required: true deprecated: false schema: type: integer style: simple explode: false delete: operationId: ibexa.rest.delete_content tags: - Objects responses: '204': description: The content item is deleted. '401': description: Error - the user is not authorized to delete this content item. '404': description: Error - content item was not found. summary: Delete Content description: Deletes content item. If content item has multiple Locations, all of them will be deleted via delete a subtree. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentId in: path description: ContentDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: ibexa.rest.update_content_metadata tags: - Objects responses: '200': description: If set, all information for the content item (excluding the current version) is returned in XML or JSON format. content: application/vnd.ibexa.api.ContentInfo+json: schema: $ref: '#/components/schemas/ContentInfoWrapper' application/vnd.ibexa.api.ContentInfo+xml: schema: $ref: '#/components/schemas/ContentInfo' example: | article1
2019-02-19T15:00:34+01:00 2019-02-19T15:00:34+01:00 eng-GB 1 false '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to update this object. '404': description: Error - the content ID does not exist. '412': description: Error - the current ETag does not match with the one provided in the If-Match header. '415': description: Error - the media-type is not one of those specified in headers. summary: Update content description: This method updates the content metadata which is independent from a version. PATCH or POST with header X-HTTP-Method-Override PATCH. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: If-match in: header description: Causes to patch only if the specified ETag is the current one. Otherwise a 412 is returned. required: true deprecated: false schema: type: string style: simple explode: false - name: contentId in: path description: ContentMetadataUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The ContentUpdate schema encoded in XML or JSON format. content: application/vnd.ibexa.api.ContentUpdate+json: schema: $ref: '#/components/schemas/ContentInfoWrapper' application/vnd.ibexa.api.ContentUpdate+xml: schema: $ref: '#/components/schemas/ContentInfo' example: | eng-GB
false 69848aeb86164c35e5c98202eebe9e05 required: false /content/objects/{contentId}/currentversion: get: operationId: ibexa.rest.redirect_current_version tags: - Objects responses: '200': description: OK - returns the Version in XML or JSON format. content: application/vnd.ibexa.api.Version+json: schema: $ref: '#/components/schemas/VersionWrapper' example: Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/107/versions/2 VersionInfo: id: 578 versionNo: 2 status: PUBLISHED modificationDate: '2023-05-24T05:59:09+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2023-05-24T05:59:02+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Features Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/107 Fields: field: - id: 477 fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Features - id: 478 fieldDefinitionIdentifier: short_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: null - id: 479 fieldDefinitionIdentifier: short_description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
xhtml5edit: |
- id: 480 fieldDefinitionIdentifier: description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
xhtml5edit: |
Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/107/versions/2/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /placeholder width: null height: null mimeType: image/svg+xml application/vnd.ibexa.api.Version+xml: schema: $ref: '#/components/schemas/Version' example: | 578 2 PUBLISHED 2023-05-24T05:59:09+00:00 2023-05-24T05:59:02+00:00 eng-GB eng-GB eng-GB Features 477 name eng-GB ibexa_string Features 478 short_name eng-GB ibexa_string 479 short_description eng-GB ibexa_richtext <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> 480 description eng-GB ibexa_richtext <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> /placeholder image/svg+xml '307': description: Temporary redirect. '404': description: Error - the resource does not exist. summary: Get current version description: Redirects to the current version of the content item. parameters: - name: contentId in: path description: ContentCurrentVersionRedirectController identifier required: true deprecated: false schema: type: string style: simple explode: false post: operationId: ibexa.rest.content.create_draft_from_current_version tags: - Objects responses: '201': description: Created content: application/vnd.ibexa.api.Version+json: schema: $ref: '#/components/schemas/VersionWrapper' example: Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/107/versions/5 VersionInfo: id: 581 versionNo: 5 status: ARCHIVED modificationDate: '2023-05-24T06:11:50+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2023-05-24T06:09:49+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Features Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/107 Fields: field: - id: 477 fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Features - id: 478 fieldDefinitionIdentifier: short_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: null - id: 479 fieldDefinitionIdentifier: short_description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
xhtml5edit: |
- id: 480 fieldDefinitionIdentifier: description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
xhtml5edit: |
Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/107/versions/5/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /placeholder width: null height: null mimeType: image/svg+xml application/vnd.ibexa.api.Version+xml: schema: $ref: '#/components/schemas/Version' example: | 581 5 ARCHIVED 2023-05-24T06:11:50+00:00 2023-05-24T06:09:49+00:00 eng-GB eng-GB eng-GB Features 477 name eng-GB ibexa_string Features 478 short_name eng-GB ibexa_string 479 short_description eng-GB ibexa_richtext <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> 480 description eng-GB ibexa_richtext <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> /placeholder image/svg+xml '401': description: Error - the user is not authorized to update this content item. '403': description: Error - the current version is already a draft. '404': description: Error - the content item was not found. summary: Create a draft from current version description: The system creates a new draft as a copy of the current version. COPY or POST with header X-HTTP-Method-Override COPY. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentId in: path description: ContentDraftCreateFromCurrentVersionController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: No payload required content: {} required: false /content/objects/{contentId}/hide: post: operationId: ibexa.rest.hide_content tags: - Objects responses: '204': description: OK - Object item is hidden. '401': description: Error - The user has no permission to change Object item visibility. '404': description: Error - The content item was not found. summary: Hide content item description: Makes or keep the content item invisible parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentId in: path description: ContentHideController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: No payload required content: {} required: false /content/objects/{contentId}/locations: get: operationId: ibexa.rest.load_locations_for_content tags: - Objects responses: '200': description: If set, the Location list is returned in XML or JSON format. content: application/vnd.ibexa.api.LocationList+json: schema: $ref: '#/components/schemas/LocationListWrapper' example: LocationList: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/63/locations Location: - _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/2/57/65 application/vnd.ibexa.api.LocationList+xml: schema: $ref: '#/components/schemas/LocationList' example: | '401': description: Error - the user is not authorized to read this content item. '404': description: Error - the content item with the given ID does not exist. summary: Get Locations for content item description: Loads all Locations for the given content item. parameters: - name: If-None-Match in: header description: ETag required: false deprecated: false schema: type: string style: simple explode: false - name: contentId in: path description: LocationForContentListController identifier required: true deprecated: false schema: type: string style: simple explode: false post: operationId: ibexa.rest.create_location tags: - Objects responses: '201': description: If set, the new Location is returned in XML or JSON format. content: application/vnd.ibexa.api.Location+json: schema: $ref: '#/components/schemas/LocationWrapper' example: Location: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/2/59/114 id: 114 priority: 0 hidden: false invisible: false explicitlyHidden: false ParentLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/2/59 pathString: /1/2/59/114/ depth: 3 childCount: 0 remoteId: 47a1e4ee082fb64e93a822dcfe3a5614 Children: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/locations/1/2/59/114/children Content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/59 sortField: PATH sortOrder: ASC UrlAliases: _media-type: application/vnd.ibexa.api.UrlAliasRefList+json _href: /api/ibexa/v2/content/locations/1/2/59/114/urlaliases ContentInfo: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/59 Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/59 _remoteId: 0fe1b1543f886b0becd4d9b2c7c517d0 _id: 59 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2 Name: Art1 TranslatedName: Art1 Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/59/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/59/currentversion Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/59/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 lastModificationDate: '2021-06-28T11:33:01+00:00' publishedDate: '2021-06-28T11:33:01+00:00' mainLanguageCode: eng-GB currentVersionNo: 1 alwaysAvailable: false isHidden: false status: PUBLISHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/59/objectstates application/vnd.ibexa.api.Location+xml: schema: $ref: '#/components/schemas/Location' example: | 96 0 false true false /1/2/42/96/ 3 0 58133c8c75230e5debe362a28b92d27a PATH ASC Art3 Art3
2021-06-28T11:34:17+00:00 2021-06-28T11:34:17+00:00 eng-GB 1 false false PUBLISHED '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to create this Location. '403': description: Error - a Location under the given parent ID already exists. summary: Create new Location for content item description: Creates a new Location for the given content item. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentId in: path description: LocationCreateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The LocationCreate schema encoded in XML or JSON format. content: application/vnd.ibexa.api.LocationCreate+json: schema: $ref: '#/components/schemas/LocationCreateWrapper' example: LocationCreate: _media-type: application/vnd.ibexa.api.LocationCreate ParentLocation: _href: /api/ibexa/v2/content/locations/1/59 priority: '0' hidden: false sortField: PATH sortOrder: ASC application/vnd.ibexa.api.LocationCreate+xml: schema: $ref: '#/components/schemas/LocationCreate' example: | 0 false PATH ASC required: false /content/objects/{contentId}/objectstates: get: operationId: ibexa.rest.get_object_states_for_content tags: - Objects responses: '200': description: OK - returns the Object state. content: application/vnd.ibexa.api.ContentObjectStates+json: schema: $ref: '#/components/schemas/ContentObjectStates' example: ContentObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json ObjectState: - _media-type: application/vnd.ibexa.api.ObjectState+json _href: /api/ibexa/v2/content/objectstategroups/2/objectstates/1 - _media-type: application/vnd.ibexa.api.ObjectState+json _href: /api/ibexa/v2/content/objectstategroups/3/objectstates/3 - _media-type: application/vnd.ibexa.api.ObjectState+json _href: /api/ibexa/v2/content/objectstategroups/7/objectstates/7 - _media-type: application/vnd.ibexa.api.ObjectState+json _href: /api/ibexa/v2/content/objectstategroups/8/objectstates/8 application/vnd.ibexa.api.ContentObjectStates+xml: schema: $ref: '#/components/schemas/ContentObjectStates' example: | '404': description: Error - The content item does not exist. summary: Get Object states of content item description: Returns the Object states of a content item parameters: - name: If-None-Match in: header description: ETag required: false deprecated: false schema: type: string style: simple explode: false - name: contentId in: path description: ObjectStatesForContentListController identifier required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: ibexa.rest.set_object_states_for_content tags: - Objects responses: '204': description: OK - Object state updated. content: application/vnd.ibexa.api.ContentObjectStates+json: schema: $ref: '#/components/schemas/ContentObjectStatesWrapper' example: ContentObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json ObjectState: - _media-type: application/vnd.ibexa.api.ObjectState+json _href: /api/ibexa/v2/content/objectstategroups/2/objectstates/2 application/vnd.ibexa.api.ContentObjectStates+xml: schema: $ref: '#/components/schemas/ContentObjectStates' example: | '400': description: Error - The input does not match the input schema definition. '401': description: Error - The user is not authorized to set an Object state. '403': description: Error - The input contains multiple Object states of the same Object state group. '412': description: Error - The current ETag does not match the one provided in the If-Match header. summary: Set Object states of content item description: Updates Object states of a content item. An Object state in the input overrides the state of the Object state group. PATCH or POST with header X-HTTP-Method-Override PATCH. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: If-Match in: header description: ETag required: true deprecated: false schema: type: string style: simple explode: false - name: contentId in: path description: ObjectStatesForContentUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The content item Object states input schema encoded in XML or JSON format. content: application/vnd.ibexa.api.ContentObjectStates+json: schema: $ref: '#/components/schemas/ContentObjectStatesWrapper' example: ContentObjectStates: ObjectState: - _href: /api/ibexa/v2/content/objectstategroups/2/objectstates/2 application/vnd.ibexa.api.ContentObjectStates+xml: schema: $ref: '#/components/schemas/ContentObjectStates' example: | required: false /content/objects/{contentId}/relations: get: operationId: ibexa.rest.redirect_current_version_relations tags: - Objects responses: '307': description: Temporary redirect. '401': description: Error - the user is not authorized to read this content item. '404': description: Error - the content item was not found. summary: Load Relations of content item description: Redirects to the Relations of the current version. parameters: - name: contentId in: path description: ContentCurrentVersionRelationsRedirectController identifier required: true deprecated: false schema: type: string style: simple explode: false /content/objects/{contentId}/reveal: post: operationId: ibexa.rest.reveal_content tags: - Objects responses: '204': description: OK - Object item is revealed. '401': description: Error - The user has no permission to change Object item visibility. '404': description: Error - The content item was not found. summary: Reveal content item description: Makes or keep the content item visible parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentId in: path description: ContentRevealController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: No payload required content: {} required: false /content/objects/{contentId}/translations/{languageCode}: delete: operationId: ibexa.rest.delete_content_translation tags: - Objects responses: '204': description: No Content '401': description: Error - the user is not authorized to delete content item (content/remove policy). '404': description: Error - the content item was not found. '406': description: Error - the given translation does not exist for the content item. '409': description: Error - the specified translation is the only one any version has or is the main translation. summary: Delete translation (permanently) description: Permanently deletes a translation from all versions of a content item. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentId in: path description: ContentTranslationDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: languageCode in: path description: ContentTranslationDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false /content/objects/{contentId}/versions: get: operationId: ibexa.rest.load_content_versions tags: - Objects responses: '200': description: If set, the version list is returned in XML or JSON format. content: application/vnd.ibexa.api.VersionList+json: schema: $ref: '#/components/schemas/VersionListWrapper' example: VersionList: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/61/versions VersionItem: - Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/61/versions/1 VersionInfo: id: 521 versionNo: 1 status: PUBLISHED modificationDate: '2021-06-28T11:33:49+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2021-06-28T11:33:31+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Art1 Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/61 - Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/61/versions/2 VersionInfo: id: 580 versionNo: 2 status: DRAFT modificationDate: '2021-07-26T08:10:02+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2021-07-26T08:10:02+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Art1 Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/61 - Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/61/versions/3 VersionInfo: id: 581 versionNo: 3 status: DRAFT modificationDate: '2021-07-26T08:16:50+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2021-07-26T08:16:50+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Art1 Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/61 application/vnd.ibexa.api.VersionList+xml: schema: $ref: '#/components/schemas/VersionList' example: | 521 1 PUBLISHED 2021-06-28T11:33:49+00:00 2021-06-28T11:33:31+00:00 eng-GB eng-GB eng-GB Art1 580 2 DRAFT 2021-07-26T08:10:02+00:00 2021-07-26T08:10:02+00:00 eng-GB eng-GB eng-GB Art1 581 3 DRAFT 2021-07-26T08:16:50+00:00 2021-07-26T08:16:50+00:00 eng-GB eng-GB eng-GB Art1 '401': description: Error - the user has no permission to read the versions. summary: List versions description: Returns a list of all versions of the content item. This method does not include fields and relations in the version elements of the response. parameters: - name: contentId in: path description: ContentVersionsListController identifier required: true deprecated: false schema: type: string style: simple explode: false /content/objects/{contentId}/versions/{versionNo}: get: operationId: ibexa.rest.load_content_in_version tags: - Objects responses: '200': description: If set, the version list is returned in XML or JSON format. content: application/vnd.ibexa.api.Version+json: schema: $ref: '#/components/schemas/VersionWrapper' example: Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/107/versions/5 VersionInfo: id: 581 versionNo: 5 status: ARCHIVED modificationDate: '2023-05-24T06:11:50+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2023-05-24T06:09:49+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Features Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/107 Fields: field: - id: 477 fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Features - id: 478 fieldDefinitionIdentifier: short_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: null - id: 479 fieldDefinitionIdentifier: short_description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
xhtml5edit: |
- id: 480 fieldDefinitionIdentifier: description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
xhtml5edit: |
Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/107/versions/5/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /placeholder width: null height: null mimeType: image/svg+xml application/vnd.ibexa.api.Version+xml: schema: $ref: '#/components/schemas/Version' example: | 581 5 ARCHIVED 2023-05-24T06:11:50+00:00 2023-05-24T06:09:49+00:00 eng-GB eng-GB eng-GB Features 477 name eng-GB ibexa_string Features 478 short_name eng-GB ibexa_string 479 short_description eng-GB ibexa_richtext <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> 480 description eng-GB ibexa_richtext <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> /placeholder image/svg+xml '304': description: Not Modified - the ETag matches the current one. '401': description: Error - the user is not authorized to read this content item. '404': description: Error - the ID or version is not found. summary: Load version description: Loads a specific version of a content item. This method returns Fields and relations. parameters: - name: If-None-Match in: header description: Only return the version if the given ETag is the not current one, otherwise a 304 is returned. required: false deprecated: false schema: type: string style: simple explode: false - name: contentId in: path description: ContentInVersionLoadController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: versionNo in: path description: ContentInVersionLoadController identifier required: true deprecated: false schema: type: string style: simple explode: false post: operationId: ibexa.rest.content.create_draft_from_version tags: - Objects responses: '201': description: Created. content: application/vnd.ibexa.api.Version+json: schema: $ref: '#/components/schemas/VersionWrapper' example: Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/107/versions/5 VersionInfo: id: 581 versionNo: 5 status: ARCHIVED modificationDate: '2023-05-24T06:11:50+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2023-05-24T06:09:49+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Features Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/107 Fields: field: - id: 477 fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Features - id: 478 fieldDefinitionIdentifier: short_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: null - id: 479 fieldDefinitionIdentifier: short_description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
xhtml5edit: |
- id: 480 fieldDefinitionIdentifier: description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
xhtml5edit: |
Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/107/versions/5/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /placeholder width: null height: null mimeType: image/svg+xml application/vnd.ibexa.api.Version+xml: schema: $ref: '#/components/schemas/Version' example: | 581 5 ARCHIVED 2023-05-24T06:11:50+00:00 2023-05-24T06:09:49+00:00 eng-GB eng-GB eng-GB Features 477 name eng-GB ibexa_string Features 478 short_name eng-GB ibexa_string 479 short_description eng-GB ibexa_richtext <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> 480 description eng-GB ibexa_richtext <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> /placeholder image/svg+xml '401': description: Error - the user is not authorized to update this content item. '404': description: Error - the content item was not found. summary: Create a draft from a version description: The system creates a new draft as a copy of the given version. COPY or POST with header X-HTTP-Method-Override COPY. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentId in: path description: ContentDraftCreateFromVersionController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: versionNo in: path description: ContentDraftCreateFromVersionController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: No payload required content: {} required: false delete: operationId: ibexa.rest.delete_content_version tags: - Objects responses: '204': description: No Content - the version is deleted. '401': description: Error - the user is not authorized to delete this version. '403': description: Error - the version is in published state. '404': description: Error - the content item or version were not found. summary: Delete content version description: Deletes the content version. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentId in: path description: ContentVersionDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: versionNo in: path description: ContentVersionDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: ibexa.rest.update_version tags: - Objects responses: '200': description: If set, the updated version is returned in XML or JSON format. content: application/vnd.ibexa.api.Version+json: schema: $ref: '#/components/schemas/VersionWrapper' example: Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/107/versions/5 VersionInfo: id: 581 versionNo: 5 status: ARCHIVED modificationDate: '2023-05-24T06:11:50+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2023-05-24T06:09:49+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Features Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/107 Fields: field: - id: 477 fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Features - id: 478 fieldDefinitionIdentifier: short_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: null - id: 479 fieldDefinitionIdentifier: short_description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
xhtml5edit: |
- id: 480 fieldDefinitionIdentifier: description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
xhtml5edit: |
Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/107/versions/5/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /placeholder width: null height: null mimeType: image/svg+xml application/vnd.ibexa.api.Version+xml: schema: $ref: '#/components/schemas/Version' example: | 45 4 DRAFT 2012-02-20T12:00:00 22012-02-20T12:00:00 ger-DE Neuer Titel 1234 title ger-DE Neuer Titel 1235 summary ger-DE Dies ist eine neuse Zusammenfassungy authors ger-DE COMMON '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to update this version. '403': description: Error - the version is not allowed to change - i.e. version is not a DRAFT. '404': description: Error - the content ID or version ID does not exist. '412': description: Error - the current ETag does not match with the one provided in the If-Match header. summary: Update version description: A specific draft is updated. PATCH or POST with header X-HTTP-Method-Override PATCH. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: If-match in: header description: Performs the patch only if the specified ETag is the current one. required: true deprecated: false schema: type: string style: simple explode: false - name: contentId in: path description: ContentVersionUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: versionNo in: path description: ContentVersionUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The VersionUpdate schema encoded in XML or JSON format. content: application/vnd.ibexa.api.VersionUpdate+json: schema: $ref: '#/components/schemas/VersionUpdateWrapper' application/vnd.ibexa.api.VersionUpdate+xml: schema: $ref: '#/components/schemas/VersionUpdate' example: | 2012-02-20T12:00:00 ger-DE 1234 title ger-DE Neuer Titel 1235 summary ger-DE Dies ist eine neuse Zusammenfassungy required: false /content/objects/{contentId}/versions/{versionNo}/relations: get: operationId: ibexa.rest.load_version_relations tags: - Objects responses: '200': description: If set, the Relation is returned in XML or JSON format. content: application/vnd.ibexa.api.RelationList+json: schema: $ref: '#/components/schemas/RelationListWrapper' example: Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/107/versions/9/relations Relation: - _media-type: application/vnd.ibexa.api.Relation+json _href: /api/ibexa/v2/content/objects/107/versions/9/relations/7 SourceContent: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/107 DestinationContent: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/52 RelationType: LINK application/vnd.ibexa.api.RelationList+xml: schema: $ref: '#/components/schemas/RelationList' example: | LINK '401': description: Error - the user is not authorized to read this content item. '404': description: Error - the content item was not found. summary: Load Relations of content item version description: Loads the Relations of the given version. parameters: - name: contentId in: path description: ContentVersionsRelationsListController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: versionNo in: path description: ContentVersionsRelationsListController identifier required: true deprecated: false schema: type: string style: simple explode: false post: operationId: ibexa.rest.create_relation tags: - Objects responses: '201': description: If set, the updated version is returned in XML or JSON format. content: application/vnd.ibexa.api.Relation+json: schema: $ref: '#/components/schemas/RelationWrapper' example: Relation: _media-type: application/vnd.ibexa.api.Relation+json _href: /api/ibexa/v2/content/objects/59/versions/2/relations/38 SourceContent: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/59 DestinationContent: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/59 RelationType: COMMON application/vnd.ibexa.api.Relation+xml: schema: $ref: '#/components/schemas/Relation' example: | COMMON summary: Create new Relation description: Creates a new Relation of type COMMON for the given draft. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentId in: path description: ContentRelationCreateController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: versionNo in: path description: ContentRelationCreateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The RelationCreate schema encoded in XML or JSON format. content: application/vnd.ibexa.api.RelationCreate+json: schema: $ref: '#/components/schemas/RelationCreateWrapper' example: RelationCreate: Destination: _href: /api/ibexa/v2/content/objects/59 application/vnd.ibexa.api.RelationCreate+xml: schema: $ref: '#/components/schemas/RelationCreate' example: | required: false /content/objects/{contentId}/versions/{versionNo}/relations/{relationId}: get: operationId: ibexa.rest.load_version_relation tags: - Objects responses: '200': description: OK - loads a Relation for the given content item. content: application/vnd.ibexa.api.Relation+json: schema: $ref: '#/components/schemas/RelationWrapper' example: Relation: _media-type: application/vnd.ibexa.api.Relation+json _href: /api/ibexa/v2/content/objects/59/versions/2/relations/38 SourceContent: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/59 DestinationContent: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/59 RelationType: COMMON application/vnd.ibexa.api.Relation+xml: schema: $ref: '#/components/schemas/Relation' example: | COMMON '401': description: Error - the user is not authorized to read this content item. '404': description: Error - the content item with the given ID or the Relation does not exist. summary: Load Relation description: Loads a Relation for the given content item. parameters: - name: contentId in: path description: ContentVersionRelationLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: versionNo in: path description: ContentVersionRelationLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: relationId in: path description: ContentVersionRelationLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: ibexa.rest.remove_relation tags: - Objects responses: '204': description: No Content - deleted a Relation of the given draft. '401': description: Error - the user is not authorized to delete this Relation. '403': description: Error - the Relation is not of type COMMON or the given version is not a draft. '404': description: Error - content item or the Relation were not found in the given version. summary: Delete Relation description: Deletes a Relation of the given draft. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentId in: path description: ContentVersionRelationDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: versionNo in: path description: ContentVersionRelationDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: relationId in: path description: ContentVersionRelationDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false /content/objects/{contentId}/versions/{versionNo}/translations/{languageCode}: delete: operationId: ibexa.rest.delete_translation_from_draft tags: - Objects responses: '204': description: No Content - removes a translation from a version draft. '401': description: Error - the user is not authorized to delete this translation. '403': description: Error - the version is not in draft state. '404': description: Error - the content item or version number were not found. '406': description: Error - the given translation does not exist for the version. '409': description: Error - the specified translation is the only one the version has or is the main translation. summary: Delete translation from version draft description: Removes a translation from a version draft. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentId in: path description: ContentDraftTranslationDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: versionNo in: path description: ContentDraftTranslationDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: languageCode in: path description: ContentDraftTranslationDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false /page/structure: get: operationId: ibexa.page_builder.rest.page_structure tags: - Page responses: '200': description: The Page structure is returned in XML or JSON format. content: application/vnd.ibexa.api.PageStructure+json: schema: $ref: '#/components/schemas/PageStructureWrapper' example: PageStructure: _media-type: application/vnd.ibexa.api.PageStructure+json layouts: - _media-type: application/vnd.ibexa.api.PageStructureLayout+json identifier: default name: default description: Default layout for Landing Page zones: - _media-type: application/vnd.ibexa.api.PageStructureZone+json identifier: default_id name: default description: '' blocks: - _media-type: application/vnd.ibexa.api.PageStructureBlock+json identifier: richtext name: Text description: Holds formatted rich text authored in the editor. category: default views: - _media-type: application/vnd.ibexa.api.PageStructureView+json identifier: default name: Default view description: '' attributes: - _media-type: application/vnd.ibexa.api.PageStructureAttribute+json identifier: content name: Content type: richtext category: default options: [] - _media-type: application/vnd.ibexa.api.PageStructureBlock+json identifier: collection name: Collection description: Shows a hand-picked, ordered collection of content items. category: default views: - _media-type: application/vnd.ibexa.api.PageStructureView+json identifier: default name: Default block layout description: '' attributes: - _media-type: application/vnd.ibexa.api.PageStructureAttribute+json identifier: locationlist name: Location list type: locationlist category: default options: match: default: [] application/vnd.ibexa.api.PageStructure+xml: schema: $ref: '#/components/schemas/PageStructure' '400': description: Error - the content type given in `contentTypeIdentifier` exists, but cannot hold a Page, because it has no field of the `ibexa_landing_page` field type. '404': description: Error - the identifier given in `contentTypeIdentifier` names no existing content type. summary: Page structure description: Lists the layouts and blocks available for building Pages, with the zones of every layout and the views and attributes of every block. parameters: - name: contentTypeIdentifier in: query description: Identifier of a content type holding a Page. When given, only the layouts and blocks allowed for that content type are returned. When omitted or empty, the whole catalogue is returned. required: false deprecated: false schema: type: string style: form explode: false example: landing_page /product/catalog/products: get: operationId: ibexa.product_catalog.rest.products tags: - Product responses: '200': description: If set, the products are returned in XML or JSON format. content: application/vnd.ibexa.api.ProductList+json: schema: $ref: '#/components/schemas/ProductListWrapper' example: ProductList: _media-type: application/vnd.ibexa.api.ProductList+json Product: - _media-type: application/vnd.ibexa.api.Product+json code: wsk_98845 name: HUMMINGBIRD PRO DRY 9,2MM ProductType: _media-type: application/vnd.ibexa.api.ProductType+json identifier: d_rope name: Dynamic ropes AttributeAssignmentList: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ibexaadminui/img/ibexa-icons.svg#file width: null height: null mimeType: image/svg+xml created_at: 1645787815 updated_at: 1645787815 AttributesList: [] - _media-type: application/vnd.ibexa.api.Product+json code: wsst_34456 name: Simond XC 60m ProductType: _media-type: application/vnd.ibexa.api.ProductType+json identifier: s_rope name: Static ropes AttributeAssignmentList: [] Content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/141 _remoteId: 86fdab24802923a9c30994858165ba9b _id: 141 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/54 Name: HUMMINGBIRD PRO DRY 9,2MM TranslatedName: HUMMINGBIRD PRO DRY 9,2MM Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/141/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/141/currentversion Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/141/versions/2 VersionInfo: id: 618 versionNo: 2 status: PUBLISHED modificationDate: '2022-05-27T09:29:33+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2022-05-27T09:29:33+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': HUMMINGBIRD PRO DRY 9,2MM Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/141 Fields: field: - id: 612 fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: HUMMINGBIRD PRO DRY 9,2MM - id: 613 fieldDefinitionIdentifier: product_specification languageCode: eng-GB fieldTypeIdentifier: ibexa_product_specification fieldValue: id: 25 code: wsk_98845 attributes: - 10 - id: 614 fieldDefinitionIdentifier: description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
xhtml5edit: |
- id: 615 fieldDefinitionIdentifier: image languageCode: eng-GB fieldTypeIdentifier: ibexa_image_asset fieldValue: destinationContentId: null alternativeText: null source: null Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/141/versions/2/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ibexaadminui/img/ibexa-icons.svg#file width: null height: null mimeType: image/svg+xml Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/141/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 lastModificationDate: '2022-05-27T09:29:33+00:00' publishedDate: '2022-05-27T06:51:36+00:00' mainLanguageCode: eng-GB currentVersionNo: 2 alwaysAvailable: true isHidden: false status: PUBLISHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/141/objectstates Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ibexaadminui/img/ibexa-icons.svg#file width: null height: null mimeType: image/svg+xml created_at: 1645787893 updated_at: 1645787893 AttributesList: [] '401': description: Error - the user has no permission to read product. summary: Load products list (deprecated) description: Returns a list of products. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/products/view instead. parameters: [] requestBody: description: The product list schema encoded in XML or JSON format. content: application/vnd.ibexa.api.ProductListGet+json: schema: $ref: '#/components/schemas/ProductListGetWrapper' example: ProductListGet: offset: 0 limit: 10 languages: - eng-GB required: false /product/catalog/products/view: post: operationId: ibexa.product_catalog.rest.products.view tags: - Product responses: '200': description: The view in XML or JSON format. content: application/vnd.ibexa.api.ProductView+json: schema: $ref: '#/components/schemas/ProductViewWrapper' example: ProductView: _media-type: application/vnd.ibexa.api.ProductView+json identifier: TitleView ProductQuery: _media-type: application/vnd.ibexa.api.ProductQuery+json Result: _media-type: application/vnd.ibexa.api.ViewResult+json count: 2 ProductList: _media-type: application/vnd.ibexa.api.ProductList+json Product: - _media-type: application/vnd.ibexa.api.Product+json code: OTHER isBaseProduct: false isVariant: false name: Other Office Desk ProductType: _media-type: application/vnd.ibexa.api.ProductType+json identifier: desk name: Desk AttributeAssignmentList: - _media-type: application/vnd.ibexa.api.AttributeAssignment+json is_required: false is_discriminator: false Attribute: _media-type: application/vnd.ibexa.api.Attribute+json identifier: color name: Color description: '' type: Selection type_identifier: selection group: Desk position: 0 options: choices: - label: eng-GB: Black value: black - label: eng-GB: White value: white value: null - _media-type: application/vnd.ibexa.api.AttributeAssignment+json is_required: false is_discriminator: false Attribute: _media-type: application/vnd.ibexa.api.Attribute+json identifier: width name: Width description: '' type: Measurement (single) type_identifier: measurement_single group: Desk position: 0 options: sign: none type: length unit: centimeter defaultValue: null value: null Content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/67 _remoteId: c5c22c68912af81992b74851f158db4a _id: 67 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/53 Name: Other Office Desk TranslatedName: Other Office Desk Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/67/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/67/currentversion Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/67/versions/2 VersionInfo: id: 529 versionNo: 2 status: PUBLISHED modificationDate: '2023-04-12T14:06:25+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2023-04-12T14:06:25+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Other Office Desk Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/67 Fields: field: - id: 301 fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Other Office Desk - id: 302 fieldDefinitionIdentifier: product_specification languageCode: eng-GB fieldTypeIdentifier: ibexa_product_specification fieldValue: id: 4 code: OTHER attributes: - white - [] - id: 303 fieldDefinitionIdentifier: description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
xhtml5edit: |
- id: 304 fieldDefinitionIdentifier: image languageCode: eng-GB fieldTypeIdentifier: ibexa_image_asset fieldValue: destinationContentId: null alternativeText: null source: null - id: 305 fieldDefinitionIdentifier: category languageCode: eng-GB fieldTypeIdentifier: ibexa_taxonomy_entry_assignment fieldValue: taxonomy_entries: [] taxonomy: product_categories - id: 306 fieldDefinitionIdentifier: field_64369cb9130a7 languageCode: eng-GB fieldTypeIdentifier: ibexa_seo fieldValue: '' Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/67/versions/2/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /placeholder width: null height: null mimeType: image/svg+xml Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/67/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 lastModificationDate: '2023-04-12T14:06:25+00:00' publishedDate: '2023-04-12T11:59:17+00:00' mainLanguageCode: eng-GB currentVersionNo: 2 alwaysAvailable: true isHidden: false status: PUBLISHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/67/objectstates Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /placeholder width: null height: null mimeType: image/svg+xml created_at: 1681308385 updated_at: 1681308385 AttributesList: - _media-type: application/vnd.ibexa.api.Attribute+json identifier: color name: Color description: '' type: Selection type_identifier: selection group: Desk position: 0 options: choices: - label: eng-GB: Black value: black - label: eng-GB: White value: white value: white - _media-type: application/vnd.ibexa.api.Attribute+json identifier: width name: Width description: '' type: Measurement (single) type_identifier: measurement_single group: Desk position: 0 options: sign: none type: length unit: centimeter defaultValue: null value: null Price: _media-type: application/vnd.ibexa.api.Price+json amount: '160.00' base_amount: '160.00' Currency: _media-type: application/vnd.ibexa.api.Currency+json id: 2 code: EUR subunits: 2 enabled: true money: '16000' base_money: '16000' - _media-type: application/vnd.ibexa.api.Product+json code: ERGO isBaseProduct: false isVariant: false name: Ergo Office Desk ProductType: _media-type: application/vnd.ibexa.api.ProductType+json identifier: desk name: Desk AttributeAssignmentList: - _media-type: application/vnd.ibexa.api.AttributeAssignment+json is_required: false is_discriminator: false Attribute: _media-type: application/vnd.ibexa.api.Attribute+json identifier: color name: Color description: '' type: Selection type_identifier: selection group: Desk position: 0 options: choices: - label: eng-GB: Black value: black - label: eng-GB: White value: white value: null - _media-type: application/vnd.ibexa.api.AttributeAssignment+json is_required: false is_discriminator: false Attribute: _media-type: application/vnd.ibexa.api.Attribute+json identifier: width name: Width description: '' type: Measurement (single) type_identifier: measurement_single group: Desk position: 0 options: sign: none type: length unit: centimeter defaultValue: null value: null Content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/66 _remoteId: 1e7449c13671b56ed3907929a2af3ad9 _id: 66 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/53 Name: Ergo Office Desk TranslatedName: Ergo Office Desk Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/66/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/66/currentversion Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/66/versions/2 VersionInfo: id: 528 versionNo: 2 status: PUBLISHED modificationDate: '2023-04-12T14:06:14+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2023-04-12T14:06:14+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Ergo Office Desk Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/66 Fields: field: - id: 295 fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Ergo Office Desk - id: 296 fieldDefinitionIdentifier: product_specification languageCode: eng-GB fieldTypeIdentifier: ibexa_product_specification fieldValue: id: 3 code: ERGO attributes: - black - [] - id: 297 fieldDefinitionIdentifier: description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
xhtml5edit: |
- id: 298 fieldDefinitionIdentifier: image languageCode: eng-GB fieldTypeIdentifier: ibexa_image_asset fieldValue: destinationContentId: null alternativeText: null source: null - id: 299 fieldDefinitionIdentifier: category languageCode: eng-GB fieldTypeIdentifier: ibexa_taxonomy_entry_assignment fieldValue: taxonomy_entries: [] taxonomy: product_categories - id: 300 fieldDefinitionIdentifier: field_64369cb9130a7 languageCode: eng-GB fieldTypeIdentifier: ibexa_seo fieldValue: '' Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/66/versions/2/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /placeholder width: null height: null mimeType: image/svg+xml Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/66/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 lastModificationDate: '2023-04-12T14:06:14+00:00' publishedDate: '2023-04-12T11:58:00+00:00' mainLanguageCode: eng-GB currentVersionNo: 2 alwaysAvailable: true isHidden: false status: PUBLISHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/66/objectstates Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /placeholder width: null height: null mimeType: image/svg+xml created_at: 1681308374 updated_at: 1681308374 AttributesList: - _media-type: application/vnd.ibexa.api.Attribute+json identifier: color name: Color description: '' type: Selection type_identifier: selection group: Desk position: 0 options: choices: - label: eng-GB: Black value: black - label: eng-GB: White value: white value: black - _media-type: application/vnd.ibexa.api.Attribute+json identifier: width name: Width description: '' type: Measurement (single) type_identifier: measurement_single group: Desk position: 0 options: sign: none type: length unit: centimeter defaultValue: null value: null Price: _media-type: application/vnd.ibexa.api.Price+json amount: '99.00' base_amount: '99.00' Currency: _media-type: application/vnd.ibexa.api.Currency+json id: 2 code: EUR subunits: 2 enabled: true money: '9900' base_money: '9900' aggregations: - _media-type: application/vnd.ibexa.api.RangeAggregationResult+json name: price entries: - _media-type: application/vnd.ibexa.api.RangeAggregationResultEntry+json key: Range: _media-type: application/vnd.ibexa.api.Range+json from: 0 to: 10000 count: 1 application/vnd.ibexa.api.ProductView+xml: schema: $ref: '#/components/schemas/ProductView' '400': description: Error - the input does not match the input schema definition. summary: Filter products description: Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API. parameters: - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The view input in XML or JSON format. content: application/vnd.ibexa.api.ProductViewInput+json: schema: $ref: '#/components/schemas/ProductViewInputWrapper' example: ViewInput: identifier: TitleView ProductQuery: limit: '10' offset: '0' Filter: ProductTypeCriterion: desk ProductAvailabilityCriterion: false SortClauses: ProductName: descending Aggregations: - ProductPriceRange: name: price currencyCode: EUR ranges: - from: 0 to: 10000 - from: 10000 to: null application/vnd.ibexa.api.ProductViewInput+xml: schema: $ref: '#/components/schemas/ProductViewInput' required: false /product/catalog/products/{code}: get: operationId: ibexa.product_catalog.rest.product tags: - Product responses: '200': description: If set, the products are returned in XML or JSON format. content: application/vnd.ibexa.api.Product+json: schema: $ref: '#/components/schemas/ProductWrapper' example: Product: _media-type: application/vnd.ibexa.api.Product+json code: DRESUN name: Yellow sundress ProductType: _media-type: application/vnd.ibexa.api.ProductType+json identifier: dress name: Dress AttributeAssignmentList: - _media-type: application/vnd.ibexa.api.AttributeAssignment+json is_required: false is_discriminator: false Attribute: _media-type: application/vnd.ibexa.api.Attribute+json identifier: size name: Size description: '' type: Integer type_identifier: integer value: 5 group: Hat position: 0 options: [] Content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/141 _remoteId: 86fdab24802923a9c30994858165ba9b _id: 141 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/54 Name: Yellow sundress TranslatedName: Yellow sundress Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/141/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/141/currentversion Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/141/versions/2 VersionInfo: id: 618 versionNo: 2 status: PUBLISHED modificationDate: '2022-05-27T09:29:33+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2022-05-27T09:29:33+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Yellow sundress Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/141 Fields: field: - id: 612 fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Yellow sundress - id: 613 fieldDefinitionIdentifier: product_specification languageCode: eng-GB fieldTypeIdentifier: ibexa_product_specification fieldValue: id: 25 code: DRESUN attributes: - 10 - id: 614 fieldDefinitionIdentifier: description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
xhtml5edit: |
- id: 615 fieldDefinitionIdentifier: image languageCode: eng-GB fieldTypeIdentifier: ibexa_image_asset fieldValue: destinationContentId: null alternativeText: null source: null Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/141/versions/2/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ibexaadminui/img/ibexa-icons.svg#file width: null height: null mimeType: image/svg+xml Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/141/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 lastModificationDate: '2022-05-27T09:29:33+00:00' publishedDate: '2022-05-27T06:51:36+00:00' mainLanguageCode: eng-GB currentVersionNo: 2 alwaysAvailable: true isHidden: false status: PUBLISHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/141/objectstates Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ibexaadminui/img/ibexa-icons.svg#file width: null height: null mimeType: image/svg+xml created_at: 1647006758 updated_at: 1647006758 AttributesList: - _media-type: application/vnd.ibexa.api.Attribute+json identifier: size name: Size description: '' type: Integer type_identifier: integer value: 5 group: Clothes position: 0 options: [] '401': description: Error - the user is not authorized to view this product. '404': description: Error - no product with the given code exists. summary: Load the given product description: Loads the given product. parameters: - name: code in: path description: ProductLoadByCodeController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: An optional product schema encoded in XML or JSON format. content: application/vnd.ibexa.api.ProductGet+json: schema: $ref: '#/components/schemas/ProductGetWrapper' example: ProductGet: languages: - eng-GB required: false patch: operationId: ibexa.product_catalog.rest.products.update tags: - Product responses: '201': description: If set, the updated product is returned in XML or JSON format. content: application/vnd.ibexa.api.Product+json: schema: $ref: '#/components/schemas/ProductWrapper' example: Product: _media-type: application/vnd.ibexa.api.Product+json code: bbbb name: fgh ProductType: _media-type: application/vnd.ibexa.api.ProductType+json identifier: test_pt321 name: New Product Type AttributeAssignmentList: - _media-type: application/vnd.ibexa.api.AttributeAssignment+json is_required: false is_discriminator: true Attribute: _media-type: application/vnd.ibexa.api.Attribute+json identifier: testAttr name: testAttr description: '' type: Checkbox type_identifier: checkbox value: true group: Test Attribute group position: 0 options: [] Content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/141 _remoteId: 86fdab24802923a9c30994858165ba9b _id: 141 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/54 Name: fgh TranslatedName: fgh Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/141/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/141/currentversion Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/141/versions/2 VersionInfo: id: 618 versionNo: 2 status: PUBLISHED modificationDate: '2022-05-27T09:29:33+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2022-05-27T09:29:33+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': fgh Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/141 Fields: field: - id: 612 fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: fgh - id: 613 fieldDefinitionIdentifier: product_specification languageCode: eng-GB fieldTypeIdentifier: ibexa_product_specification fieldValue: id: 25 code: bbbb attributes: - 10 - id: 614 fieldDefinitionIdentifier: description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
xhtml5edit: |
- id: 615 fieldDefinitionIdentifier: image languageCode: eng-GB fieldTypeIdentifier: ibexa_image_asset fieldValue: destinationContentId: null alternativeText: null source: null Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/141/versions/2/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ibexaadminui/img/ibexa-icons.svg#file width: null height: null mimeType: image/svg+xml Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/141/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 lastModificationDate: '2022-05-27T09:29:33+00:00' publishedDate: '2022-05-27T06:51:36+00:00' mainLanguageCode: eng-GB currentVersionNo: 2 alwaysAvailable: true isHidden: false status: PUBLISHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/141/objectstates Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ibexaadminui/img/ibexa-icons.svg#file width: null height: null mimeType: image/svg+xml created_at: 1646398748 updated_at: 1646398748 AttributesList: - _media-type: application/vnd.ibexa.api.Attribute+json identifier: testAttr name: testAttr description: '' type: Checkbox type_identifier: checkbox value: true group: Test Attribute group position: 0 options: [] - _media-type: application/vnd.ibexa.api.Attribute+json identifier: nnnn name: nnnn description: '' type: Checkbox type_identifier: checkbox value: true group: Test Attribute group position: 0 options: [] '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to update this product. '403': description: Error - a product with the same code already exists. '404': description: Error - no product with the given code exists. summary: Update product description: Updates product. parameters: - name: code in: path description: ProductUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: If set, the updated product is returned in XML or JSON format. content: application/vnd.ibexa.api.ProductUpdate+json: schema: $ref: '#/components/schemas/ProductUpdateWrapper' example: ProductUpdate: ContentUpdate: __url: /api/ibexa/v2/content/objects/67 fields: field: - fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: IN6.1200tze205 code: NEWCODE required: false /product/catalog/products/{code}/prices: get: operationId: ibexa.product_catalog.rest.prices.list tags: - Product responses: '200': description: OK - loads the list of product prices. content: application/vnd.ibexa.api.PriceList+json: schema: $ref: '#/components/schemas/PriceListWrapper' example: PriceList: _media-type: application/vnd.ibexa.api.PriceList+json prices: - _media-type: application/vnd.ibexa.api.Price+json id: 1 amount: '12.00' base_amount: '12.00' Currency: _media-type: application/vnd.ibexa.api.Currency+json id: 2 code: EUR subunits: 2 enabled: true money: '1200' base_money: '1200' - _media-type: application/vnd.ibexa.api.Price+json id: 2 amount: '12.00' base_amount: '12.00' Currency: _media-type: application/vnd.ibexa.api.Currency+json id: 5 code: USD subunits: 2 enabled: true money: '1200' base_money: '1200' totalCount: 2 '401': description: Error - the user has no permission to read prices. summary: Load the list of product prices description: Loads the list of product prices. parameters: - name: code in: path description: PriceLoadAllController identifier required: true deprecated: false schema: type: string style: simple explode: false post: operationId: ibexa.product_catalog.rest.prices.create tags: - Product responses: '200': description: OK - creates product price. content: application/vnd.ibexa.api.CustomPrice+json: schema: $ref: '#/components/schemas/CustomPriceWrapper' example: CustomPrice: _media-type: application/vnd.ibexa.api.CustomPrice+json id: 5 amount: '15.00' base_amount: '25.00' Currency: _media-type: application/vnd.ibexa.api.Currency+json id: 2 code: EUR subunits: 2 enabled: true money: '1500' base_money: '2500' custom_money: '1500' custom_amount: '15.00' application/vnd.ibexa.api.Price+json: schema: $ref: '#/components/schemas/PriceWrapper' example: Price: _media-type: application/vnd.ibexa.api.Price+json id: 4 amount: '0.09' base_amount: '0.09' Currency: _media-type: application/vnd.ibexa.api.Currency+json id: 94 code: CHF subunits: 2 enabled: true money: '9' base_money: '9' '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to create this price. summary: Create product price or custom price description: Create product price or custom price. parameters: - name: code in: path description: PriceCreateController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The product price schema encoded in JSON format. content: application/vnd.ibexa.api.CustomPriceCreateStruct+json: schema: $ref: '#/components/schemas/CustomPriceCreateStructWrapper' example: CustomPriceCreateStruct: customerGroup: test amount: 2500 customAmount: 1500 currency: EUR application/vnd.ibexa.api.PriceCreateStruct+json: schema: $ref: '#/components/schemas/PriceCreateStructWrapper' example: PriceCreateStruct: amount: 9 currency: CHF required: false /product/catalog/products/{code}/prices/{currencyCode}: get: operationId: ibexa.product_catalog.rest.prices.get.base_price tags: - Product responses: '200': description: OK - gets price in given currency. content: application/vnd.ibexa.api.Price+json: schema: $ref: '#/components/schemas/PriceWrapper' example: Price: _media-type: application/vnd.ibexa.api.Price+json id: 1 amount: '12.00' base_amount: '12.00' Currency: _media-type: application/vnd.ibexa.api.Currency+json id: 2 code: EUR subunits: 2 enabled: true money: '1200' base_money: '1200' '401': description: Error - the user has no permission to read prices. '404': description: Error - the price does not exist. summary: Get price in given currency description: Get price in given currency. parameters: - name: code in: path description: PriceLoadByProductCodeController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: currencyCode in: path description: PriceLoadByProductCodeController identifier required: true deprecated: false schema: type: string style: simple explode: false /product/catalog/products/{code}/prices/{currencyCode}/customer-group/{customerGroupIdentifier}: get: operationId: ibexa.product_catalog.rest.prices.get.custom_price tags: - Product responses: '200': description: OK - gets price in given currency and customer group. content: application/vnd.ibexa.api.CustomPrice+json: schema: $ref: '#/components/schemas/CustomPriceWrapper' example: CustomPrice: _media-type: application/vnd.ibexa.api.CustomPrice+json id: 3 amount: '11.50' base_amount: '10.00' Currency: _media-type: application/vnd.ibexa.api.Currency+json id: 5 code: USD subunits: 2 enabled: true money: '1150' base_money: '1000' custom_money: '1150' custom_amount: '11.50' custom_rule: '15.00' '401': description: Error - the user has no permission to read prices. '404': description: Error - the price does not exist. summary: Get price in given currency and customer group description: Get price in given currency and customer group. parameters: - name: code in: path description: PriceLoadByProductCodeController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: currencyCode in: path description: PriceLoadByProductCodeController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: customerGroupIdentifier in: path description: PriceLoadByProductCodeController identifier required: true deprecated: false schema: type: string style: simple explode: false /product/catalog/products/{code}/prices/{id}: delete: operationId: ibexa.product_catalog.rest.prices.delete tags: - Product responses: '200': description: No content - the given price is deleted. '401': description: Error - the user is not authorized to delete this price. summary: Delete product price description: Deletes product price. parameters: - name: code in: path description: PriceDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: id in: path description: PriceDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: ibexa.product_catalog.rest.prices.update tags: - Product responses: '200': description: OK - updates product price. content: application/vnd.ibexa.api.CustomPrice+json: schema: $ref: '#/components/schemas/CustomPriceWrapper' example: CustomPrice: _media-type: application/vnd.ibexa.api.CustomPrice+json id: 3 amount: '17.00' base_amount: '35.00' Currency: _media-type: application/vnd.ibexa.api.Currency+json id: 5 code: USD subunits: 2 enabled: true money: '1700' base_money: '3500' custom_money: '1700' custom_amount: '17.00' custom_rule: null application/vnd.ibexa.api.Price+json: schema: $ref: '#/components/schemas/PriceWrapper' example: Price: _media-type: application/vnd.ibexa.api.Price+json id: 2 amount: '35.00' base_amount: '35.00' Currency: _media-type: application/vnd.ibexa.api.Currency+json id: 5 code: USD subunits: 2 enabled: true money: '3500' base_money: '3500' '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to update this price. summary: Update product price description: Updates product price. parameters: - name: code in: path description: PriceUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: id in: path description: PriceUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: Update price or custom price for given currency. content: application/vnd.ibexa.api.CustomPriceUpdateStruct+json: schema: $ref: '#/components/schemas/CustomPriceUpdateStructWrapper' example: CustomPriceUpdateStruct: amount: 2500 customAmount: 1700 currency: USD application/vnd.ibexa.api.PriceUpdateStruct+json: schema: $ref: '#/components/schemas/PriceUpdateStructWrapper' example: PriceUpdateStruct: amount: 3500 currency: USD required: false /product/catalog/products/{identifier}: delete: operationId: ibexa.product_catalog.rest.products.delete tags: - Product responses: '204': description: No content - the given product is deleted. '401': description: Error - the user is not authorized to delete this product. summary: Delete product description: Deletes the given product. parameters: - name: identifier in: path description: ProductDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false /product/catalog/products/{productTypeIdentifier}: post: operationId: ibexa.product_catalog.rest.products.create tags: - Product responses: '201': description: If set, the new product is returned in XML or JSON format. content: application/vnd.ibexa.api.ProductCreate+json: schema: $ref: '#/components/schemas/ProductWrapper' example: Product: _media-type: application/vnd.ibexa.api.Product+json code: wsk_98845 name: HUMMINGBIRD PRO DRY 9,2MM ProductType: _media-type: application/vnd.ibexa.api.ProductType+json identifier: d_rope name: Dynamic ropes AttributeAssignmentList: [] Content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/141 _remoteId: 86fdab24802923a9c30994858165ba9b _id: 141 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/54 Name: HUMMINGBIRD PRO DRY 9,2MM TranslatedName: HUMMINGBIRD PRO DRY 9,2MM Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/141/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/141/currentversion Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/141/versions/2 VersionInfo: id: 618 versionNo: 2 status: PUBLISHED modificationDate: '2022-05-27T09:29:33+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2022-05-27T09:29:33+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': HUMMINGBIRD PRO DRY 9,2MM Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/141 Fields: field: - id: 612 fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: HUMMINGBIRD PRO DRY 9,2MM - id: 613 fieldDefinitionIdentifier: product_specification languageCode: eng-GB fieldTypeIdentifier: ibexa_product_specification fieldValue: id: 25 code: wsk_98845 attributes: - 10 - id: 614 fieldDefinitionIdentifier: description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
xhtml5edit: |
- id: 615 fieldDefinitionIdentifier: image languageCode: eng-GB fieldTypeIdentifier: ibexa_image_asset fieldValue: destinationContentId: null alternativeText: null source: null Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/141/versions/2/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ibexaadminui/img/ibexa-icons.svg#file width: null height: null mimeType: image/svg+xml Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/141/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 lastModificationDate: '2022-05-27T09:29:33+00:00' publishedDate: '2022-05-27T06:51:36+00:00' mainLanguageCode: eng-GB currentVersionNo: 2 alwaysAvailable: true isHidden: false status: PUBLISHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/141/objectstates Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ibexaadminui/img/ibexa-icons.svg#file width: null height: null mimeType: image/svg+xml created_at: 1645787815 updated_at: 1645787815 AttributesList: [] '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to update this product. '403': description: Error - a product with the same name already exists. '404': description: Error - no product with the given code exists. summary: Create product description: Creates a new product. parameters: - name: productTypeIdentifier in: path description: ProductCreateController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The product schema encoded in XML or JSON format. content: application/vnd.ibexa.api.ProductCreate+json: schema: $ref: '#/components/schemas/ProductCreateWrapper' example: ProductCreate: ContentCreate: ContentType: _href: /api/ibexa/v2/content/types/46 FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/260/fieldDefinitions FieldDefinition: [] LocationCreate: _media-type: application/vnd.ibexa.api.LocationCreate ParentLocation: _href: /api/ibexa/v2/content/locations/1/2 priority: '0' hidden: 'false' sortField: PATH sortOrder: ASC alwaysAvailable: 'true' fields: field: - fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: new PT mainLanguageCode: eng-GB code: ggg attributes: attr1: fffffff required: false /product/catalog/attributes: get: operationId: ibexa.product_catalog.rest.attributes tags: - Product Attribute responses: '200': description: AttributeList - If set, the attributes list is returned in XML or JSON format. content: application/vnd.ibexa.api.AttributeList+json: schema: $ref: '#/components/schemas/AttributeListWrapper' example: AttributeList: _media-type: application/vnd.ibexa.api.AttributeList+json Attribute: - _media-type: application/vnd.ibexa.api.Attribute+json identifier: attrib1 name: Attrib1 description: '' type: Checkbox type_identifier: checkbox value: true group: Attribute Group Test position: 0 options: [] - _media-type: application/vnd.ibexa.api.Attribute+json identifier: attrib2 name: Attrib2 description: '' type: Checkbox type_identifier: checkbox value: true group: Attribute Group Test position: 0 options: [] - _media-type: application/vnd.ibexa.api.Attribute+json identifier: attrib3 name: Attrib3 description: '' type: Checkbox type_identifier: checkbox value: true group: Attribute Group Test position: 0 options: [] application/vnd.ibexa.api.AttributeList+xml: schema: $ref: '#/components/schemas/AttributeList' '401': description: Error - the user has no permission to read user groups. summary: Load attributes (deprecated) description: Loads list of all attributes. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/attributes/view instead. parameters: [] requestBody: description: Attribute filter content: application/vnd.ibexa.api.AttributeListGet+json: schema: $ref: '#/components/schemas/AttributeListGetWrapper' example: AttributeListGet: group_name_prefix: a name_prefix: a offset: 0 limit: 10 application/vnd.ibexa.api.AttributeListGet+xml: schema: $ref: '#/components/schemas/AttributeListGet' required: false post: operationId: ibexa.product_catalog.rest.attributes.create tags: - Product Attribute responses: '201': description: If set, the new attribute is returned in XML or JSON format. content: application/vnd.ibexa.api.Attribute+json: schema: $ref: '#/components/schemas/AttributeWrapper' example: Attribute: _media-type: application/vnd.ibexa.api.Attribute+json identifier: foo name: Attribute description: description type: Checkbox type_identifier: checkbox value: true group: Attribute Test position: 0 options: [] '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to create this attribute. '403': description: Error - an attribute with the same name already exists. summary: Create attribute description: Creates a new attribute. parameters: - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The attribute schema encoded in XML or JSON format. content: application/vnd.ibexa.api.AttributeCreate+json: schema: $ref: '#/components/schemas/AttributeCreateWrapper' example: AttributeCreate: identifier: foo type: checkbox group: attr_group_test names: eng-GB: Attribute descriptions: eng-GB: description position: 0 options: foo: bar required: false /product/catalog/attributes/translation/{id}/{languageCode}: delete: operationId: ibexa.product_catalog.rest.attributes.translation.delete tags: - Product Attribute responses: '200': description: No Content. '401': description: Error - the user is not authorized to delete this translation. summary: Delete attribute translation description: The given translation is removed from the attribute. parameters: - name: id in: path description: AttributeTranslationDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: languageCode in: path description: AttributeTranslationDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false /product/catalog/attributes/view: post: operationId: ibexa.product_catalog.rest.attributes.view tags: - Product Attribute responses: '200': description: The view in XML or JSON format. content: application/vnd.ibexa.api.AttributeView+json: schema: $ref: '#/components/schemas/AttributeViewWrapper' example: AttributeView: _media-type: application/vnd.ibexa.api.AttributeView+json identifier: TitleView AttributeQuery: _media-type: application/vnd.ibexa.api.AttributeQuery+json Result: _media-type: application/vnd.ibexa.api.ViewResult+json count: 1 AttributeList: _media-type: application/vnd.ibexa.api.AttributeList+json Attribute: - _media-type: application/vnd.ibexa.api.Attribute+json identifier: measure name: measure description: '' type: Measurement type_identifier: measurement group: Test Attribute group position: 0 options: type: length unit: centimeter measurementRange: minimum: 12 maximum: 15 measurementDefaultRange: defaultRangeMinimumValue: null defaultRangeMaximumValue: null application/vnd.ibexa.api.AttributeView+xml: schema: $ref: '#/components/schemas/AttributeView' '400': description: Error - the input does not match the input schema definition. summary: Filter attributes description: Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API. parameters: - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The view input in XML or JSON format. content: application/vnd.ibexa.api.AttributeViewInput+json: schema: $ref: '#/components/schemas/AttributeViewInputWrapper' example: ViewInput: identifier: TitleView AttributeQuery: limit: '10' offset: '0' Query: AttributeNameCriterion: measure AttributeGroupIdentifierCriterion: test_attribute_group application/vnd.ibexa.api.AttributeViewInput+xml: schema: $ref: '#/components/schemas/AttributeViewInput' required: false /product/catalog/attributes/{id}: get: operationId: ibexa.product_catalog.rest.attributes.get tags: - Product Attribute responses: '200': description: Attribute - If set, the given attribute is returned in XML or JSON format. content: application/vnd.ibexa.api.Attribute+json: schema: $ref: '#/components/schemas/AttributeWrapper' example: Attribute: _media-type: application/vnd.ibexa.api.Attribute+json identifier: attrib2 name: Attrib2 description: '' type: Checkbox type_identifier: checkbox value: true group: Attribute Group Test position: 0 options: [] application/vnd.ibexa.api.Attribute+xml: schema: $ref: '#/components/schemas/Attribute' '401': description: Error - the user has no permission to read the attribute. summary: Load attribute description: Loads given attribute. parameters: - name: id in: path description: AttributeLoadByIdentifierController identifier required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: ibexa.product_catalog.rest.attributes.delete tags: - Product Attribute responses: '200': description: No Content. '401': description: Error - the user is not authorized to delete this attribute. summary: Delete attribute description: The given attribute is removed from the attribute group. parameters: - name: id in: path description: AttributeDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false /product/catalog/attributes/{id}/{group_id}: patch: operationId: ibexa.product_catalog.rest.attributes.update tags: - Product Attribute responses: '201': description: If set, the updated attribute is returned in XML or JSON format. content: application/vnd.ibexa.api.Attribute+json: schema: $ref: '#/components/schemas/AttributeWrapper' example: Attribute: _media-type: application/vnd.ibexa.api.Attribute+json identifier: attr_group name: Attribute Group description: description type: Checkbox type_identifier: checkbox value: true group: Attribute Group position: 0 options: [] '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to create this attribute. '403': description: Error - an attribute with the same name already exists. '404': description: Error - the attribute with the given ID does not exist. summary: Update attribute description: Updates an attribute. parameters: - name: id in: path description: AttributeUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: group_id in: path description: AttributeUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: If set, the updated attribute group is returned in XML or JSON format. content: application/vnd.ibexa.api.AttributeUpdate+json: schema: $ref: '#/components/schemas/AttributeUpdateWrapper' example: AttributeUpdate: identifier: attr_group names: eng-GB: Attribute Group descriptions: eng-GB: description position: 0 options: foo: bar required: false /product/catalog/attribute_groups: get: operationId: ibexa.product_catalog.rest.attribute_groups tags: - Product Attribute Group responses: '200': description: AttributeGroupList - If set, the attribute group list is returned in XML or JSON format. content: application/vnd.ibexa.api.AttributeGroupList+json: schema: $ref: '#/components/schemas/AttributeGroupListWrapper' example: AttributeGroupList: _media-type: application/vnd.ibexa.api.AttributeGroupList+json AttributeGroup: - _media-type: application/vnd.ibexa.api.AttributeGroup+json name: Attribute Group Test identifier: attr_group_test position: 0 - _media-type: application/vnd.ibexa.api.AttributeGroup+json name: Dimensions identifier: ag_dimensions position: 0 application/vnd.ibexa.api.AttributeGroupList+xml: schema: $ref: '#/components/schemas/AttributeGroupList' '401': description: Error - the user has no permission to read attribute groups. summary: Load attribute groups (deprecated) description: Returns a list of attribute groups. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/attribute_groups/view instead. parameters: [] requestBody: description: The AttributeGroupListGet schema encoded in XML or JSON format. content: application/vnd.ibexa.api.AttributeGroupListGet+json: schema: $ref: '#/components/schemas/AttributeGroupListGetWrapper' example: AttributeGroupListGet: prefix: s offset: 0 limit: 10 required: false post: operationId: ibexa.product_catalog.rest.attribute_groups.create tags: - Product Attribute Group responses: '201': description: If set, the new attribute group is returned in XML or JSON format. content: application/vnd.ibexa.api.AttributeGroup+json: schema: $ref: '#/components/schemas/AttributeGroupWrapper' example: AttributeGroup: _media-type: application/vnd.ibexa.api.AttributeGroup+json name: Attribute Group Test identifier: attr_group_test position: 0 '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to create this attribute group. '403': description: Error - an attribute group with the same identifier already exists. summary: Create attribute group description: Creates a new attribute group. parameters: - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The AttributeGroup schema encoded in XML or JSON format. content: application/vnd.ibexa.api.AttributeGroupCreate+json: schema: $ref: '#/components/schemas/AttributeGroupCreateWrapper' example: AttributeGroupCreate: identifier: attr_group_test names: eng-GB: Attribute Group Test position: 0 required: false /product/catalog/attribute_groups/translation/{id}/{languageCode}: delete: operationId: ibexa.product_catalog.rest.attribute_groups.translation.delete tags: - Product Attribute Group responses: '200': description: No content - the given attribute group translation is deleted. '401': description: Error - the user is not authorized to delete this attribute group translation assignment. summary: Delete attribute group translation description: Deletes given translation from attribute group. parameters: - name: id in: path description: AttributeGroupTranslationDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: languageCode in: path description: AttributeGroupTranslationDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false /product/catalog/attribute_groups/view: post: operationId: ibexa.product_catalog.rest.attribute_groups.view tags: - Product Attribute Group responses: '200': description: The view in XML or JSON format. content: application/vnd.ibexa.api.AttributeGroupView+json: schema: $ref: '#/components/schemas/AttributeGroupViewWrapper' example: AttributeGroupView: _media-type: application/vnd.ibexa.api.AttributeGroupView+json identifier: TitleView AttributeGroupQuery: _media-type: application/vnd.ibexa.api.AttributeGroupQuery+json Result: _media-type: application/vnd.ibexa.api.ViewResult+json count: 1 AttributeGroupList: _media-type: application/vnd.ibexa.api.AttributeGroupList+json AttributeGroup: - _media-type: application/vnd.ibexa.api.AttributeGroup+json name: Test Attribute group identifier: test_attribute_group position: 0 application/vnd.ibexa.api.AttributeGroupView+xml: schema: $ref: '#/components/schemas/AttributeGroupView' '400': description: Error - the input does not match the input schema definition. summary: Filter attribute groups description: Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API. parameters: - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The view input in XML or JSON format. content: application/vnd.ibexa.api.AttributeGroupViewInput+json: schema: $ref: '#/components/schemas/AttributeGroupViewInputWrapper' example: ViewInput: identifier: TitleView AttributeGroupQuery: limit: '10' offset: '0' name_prefix: test application/vnd.ibexa.api.AttributeGroupViewInput+xml: schema: $ref: '#/components/schemas/AttributeGroupViewInput' required: false /product/catalog/attribute_groups/{id}: get: operationId: ibexa.product_catalog.rest.attribute_groups.get tags: - Product Attribute Group responses: '200': description: AttributeGroupGet - If set, the attribute group List is returned in XML or JSON format. content: application/vnd.ibexa.api.AttributeGroup+json: schema: $ref: '#/components/schemas/AttributeGroupWrapper' example: AttributeGroup: _media-type: application/vnd.ibexa.api.AttributeGroup+json name: Attribute Group Test identifier: attr_group_test position: 0 application/vnd.ibexa.api.AttributeGroup+xml: schema: $ref: '#/components/schemas/AttributeGroup' '401': description: Error - the user has no permission to read attribute groups. summary: Load attribute group description: Returns the given attribute group. parameters: - name: id in: path description: AttributeGroupLoadByIdentifierController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: An optional AttributeGroupGet schema encoded in XML or JSON format. content: application/vnd.ibexa.api.AttributeGroupGet+json: schema: $ref: '#/components/schemas/AttributeGroupGetWrapper' example: AttributeGroupGet: languages: - eng-GB application/vnd.ibexa.api.AttributeGroupGet+xml: schema: $ref: '#/components/schemas/AttributeGroupGet' required: false delete: operationId: ibexa.product_catalog.rest.attribute_groups.delete tags: - Product Attribute Group responses: '204': description: No content - the given attribute group is deleted. '401': description: Error - the user is not authorized to delete this attribute group. summary: Delete attribute group description: Deletes an attribute group. parameters: - name: id in: path description: AttributeGroupDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: ibexa.product_catalog.rest.attribute_groups.update tags: - Product Attribute Group responses: '201': description: If set, the updated attribute group is returned in XML or JSON format. content: application/vnd.ibexa.api.AttributeGroup+json: schema: $ref: '#/components/schemas/AttributeGroupWrapper' example: AttributeGroup: _media-type: application/vnd.ibexa.api.AttributeGroup+json name: Colors Group identifier: ag_colors position: 0 application/vnd.ibexa.api.AttributeGroup+xml: schema: $ref: '#/components/schemas/AttributeGroup' '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to create this attribute group. '403': description: Error - an attribute group with the same identifier already exists. '404': description: Error - the group with the given ID does not exist. summary: Update attribute group description: Updates an attribute group. parameters: - name: id in: path description: AttributeGroupUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The attribute group update schema is sent in XML or JSON format. content: application/vnd.ibexa.api.AttributeGroupUpdate+json: schema: $ref: '#/components/schemas/AttributeGroupUpdateWrapper' example: AttributeGroupUpdate: identifier: ag_colors names: eng-GB: Colors Group position: 0 application/vnd.ibexa.api.AttributeGroupUpdate+xml: schema: $ref: '#/components/schemas/AttributeGroupUpdate' required: false /product/catalog/attribute_types: get: operationId: ibexa.product_catalog.rest.attribute_types tags: - Product Attribute Type responses: '200': description: OK - returns a list of Attribute Types content: application/vnd.ibexa.api.AttributeTypeList+json: schema: $ref: '#/components/schemas/AttributeTypeListWrapper' application/vnd.ibexa.api.AttributeTypeList+xml: schema: $ref: '#/components/schemas/AttributeTypeList' summary: List Attribute Types description: Lists all Attribute Types. parameters: [] /product/catalog/attribute_types/{identifier}: get: operationId: ibexa.product_catalog.rest.attribute_type tags: - Product Attribute Type responses: '200': description: OK - returns the Attribute Type content: application/vnd.ibexa.api.AttributeType+json: schema: $ref: '#/components/schemas/AttributeTypeWrapper' application/vnd.ibexa.api.AttributeType+xml: schema: $ref: '#/components/schemas/AttributeType' '404': description: Error - The Attribute Type does not exist. summary: Get Attribute Type description: Gets an Attribute Type by its identifier. parameters: - name: identifier in: path description: AttributeTypeLoadByIdentifierController identifier required: true deprecated: false schema: type: string style: simple explode: false /product/catalog/catalogs: post: operationId: ibexa.product_catalog.rest.catalogs.create tags: - Product Catalog responses: '201': description: If set, the new catalog is returned in XML or JSON format. content: application/vnd.ibexa.api.CatalogCreate+json: schema: $ref: '#/components/schemas/CatalogWrapper' example: Catalog: _media-type: application/vnd.ibexa.api.Catalog+json identifier: test_catalog_copied name: Snow Equipment updated description: Snow Equipment catalog for 2022 User: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 created: 1666091820 modified: 1666091820 status: draft Criteria: - _media-type: application/vnd.ibexa.api.ProductCode+json ProductCodeCriterion: _media-type: application/vnd.ibexa.api.ProductCodeCriterion+json codes: - ski - _media-type: application/vnd.ibexa.api.ProductAvailability+json ProductAvailabilityCriterion: _media-type: application/vnd.ibexa.api.ProductAvailabilityCriterion+json is_available: false - _media-type: application/vnd.ibexa.api.CreatedAt+json CreatedAtCriterion: _media-type: application/vnd.ibexa.api.CreatedAtCriterion+json created_at: date: '2022-12-12 00:00:00.000000' timezone_type: 3 timezone: Europe/Warsaw operator: '>=' '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to update this catalog. '403': description: Error - a catalog with the same name already exists. '404': description: Error - no catalog with the given code exists. summary: Create catalog description: Creates a new catalog. parameters: - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The catalog schema encoded in XML or JSON format. content: application/vnd.ibexa.api.CatalogCreate+json: schema: $ref: '#/components/schemas/CatalogCreateWrapper' example: CatalogCreate: identifier: test_catalog criteria: ProductCodeCriterion: - ski - snowboard ProductAvailabilityCriterion: true ColorAttributeCriterion: identifier: color value: - '#000000' - '#FFFFFF' CreatedAtCriterion: operator: '>=' created_at: 12-09-2022 FloatAttributeCriterion: identifier: width value: 16.6 IntegerAttributeRangeCriterion: identifier: length min: 180 max: 230 names: eng-GB: Snow Equipment status: draft required: false /product/catalog/catalogs/copy/{identifier}: post: operationId: ibexa.product_catalog.rest.catalogs.copy tags: - Product Catalog responses: '201': description: If set, the copied catalog is returned in XML or JSON format. content: application/vnd.ibexa.api.Catalog+json: schema: $ref: '#/components/schemas/CatalogWrapper' example: Catalog: _media-type: application/vnd.ibexa.api.Catalog+json identifier: test_catalog_copied name: Snow Equipment updated description: Snow Equipment catalog for 2022 User: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 created: 1666091820 modified: 1666091820 status: draft Criteria: - _media-type: application/vnd.ibexa.api.ProductCode+json ProductCodeCriterion: _media-type: application/vnd.ibexa.api.ProductCodeCriterion+json codes: - ski - _media-type: application/vnd.ibexa.api.ProductAvailability+json ProductAvailabilityCriterion: _media-type: application/vnd.ibexa.api.ProductAvailabilityCriterion+json is_available: false - _media-type: application/vnd.ibexa.api.CreatedAt+json CreatedAtCriterion: _media-type: application/vnd.ibexa.api.CreatedAtCriterion+json created_at: date: '2022-12-12 00:00:00.000000' timezone_type: 3 timezone: Europe/Warsaw operator: '>=' '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to copy this catalog. '403': description: Error - a catalog with the same identifier already exists. '404': description: Error - no catalog with the given identifier exists. summary: Copy catalog description: Copies a catalog. parameters: - name: identifier in: path description: CatalogCopyController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: If set, the copied catalog is returned in XML or JSON format. content: application/vnd.ibexa.api.CatalogCopy+json: schema: $ref: '#/components/schemas/CatalogCopyWrapper' example: CatalogCopy: identifier: test_catalog_copied creator_id: 14 required: false /product/catalog/catalogs/filters: get: operationId: ibexa.product_catalog.rest.catalog.filters tags: - Product Catalog responses: '200': description: If set, the filters are returned in XML or JSON format. content: application/vnd.ibexa.api.ProductFilterList+json: schema: $ref: '#/components/schemas/ProductFilterListWrapper' example: ProductFilterList: _media-type: application/vnd.ibexa.api.ProductFilterList+json ProductFilter: - _media-type: application/vnd.ibexa.api.ProductFilter+json name: CreatedAtCriterion - _media-type: application/vnd.ibexa.api.ProductFilter+json name: CreatedAtRangeCriterion - _media-type: application/vnd.ibexa.api.ProductFilter+json name: ProductCategoryCriterion - _media-type: application/vnd.ibexa.api.ProductFilter+json name: ColorAttributeCriterion - _media-type: application/vnd.ibexa.api.ProductFilter+json name: FloatAttributeCriterion - _media-type: application/vnd.ibexa.api.ProductFilter+json name: FloatAttributeRangeCriterion - _media-type: application/vnd.ibexa.api.ProductFilter+json name: IntegerAttributeCriterion - _media-type: application/vnd.ibexa.api.ProductFilter+json name: IntegerAttributeRangeCriterion - _media-type: application/vnd.ibexa.api.ProductFilter+json name: SelectionAttributeCriterion - _media-type: application/vnd.ibexa.api.ProductFilter+json name: ProductCodeCriterion - _media-type: application/vnd.ibexa.api.ProductFilter+json name: ProductNameCriterion - _media-type: application/vnd.ibexa.api.ProductFilter+json name: ProductAvailabilityCriterion application/vnd.ibexa.api.ProductFilterList+xml: schema: $ref: '#/components/schemas/ProductFilterList' summary: Load catalog filters description: Loads product filters available for catalogs. parameters: [] /product/catalog/catalogs/sort_clauses: get: operationId: ibexa.product_catalog.rest.catalog.sort_clauses tags: - Product Catalog responses: '200': description: If set, the clauses are returned in XML or JSON format. content: application/vnd.ibexa.api.ProductSortClauseList+json: schema: $ref: '#/components/schemas/ProductSortClauseListWrapper' example: ProductSortClauseList: _media-type: application/vnd.ibexa.api.ProductSortClauseList+json ProductSortClause: - _media-type: application/vnd.ibexa.api.ProductSortClause+json name: ProductName - _media-type: application/vnd.ibexa.api.ProductSortClause+json name: ProductCode - _media-type: application/vnd.ibexa.api.ProductSortClause+json name: ProductAvailability - _media-type: application/vnd.ibexa.api.ProductSortClause+json name: CreatedAt application/vnd.ibexa.api.ProductSortClauseList+xml: schema: $ref: '#/components/schemas/ProductSortClauseList' summary: Load catalog sort clauses description: Loads product sort clauses available for catalogs. parameters: [] /product/catalog/catalogs/view: post: operationId: ibexa.product_catalog.rest.catalogs.view tags: - Product Catalog responses: '200': description: The view in XML or JSON format. content: application/vnd.ibexa.api.CatalogView+json: schema: $ref: '#/components/schemas/CatalogViewWrapper' example: CatalogView: _media-type: application/vnd.ibexa.api.CatalogView+json identifier: TitleView CatalogQuery: _media-type: application/vnd.ibexa.api.CatalogQuery+json Result: _media-type: application/vnd.ibexa.api.ViewResult+json count: 1 CatalogList: _media-type: application/vnd.ibexa.api.CatalogList+json Catalog: - _media-type: application/vnd.ibexa.api.Catalog+json identifier: test name: test description: '' User: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 created: 1665479475 modified: 1665479475 status: draft Criteria: - _media-type: application/vnd.ibexa.api.ProductCode+json ProductCodeCriterion: _media-type: application/vnd.ibexa.api.ProductCodeCriterion+json codes: - test application/vnd.ibexa.api.CatalogView+xml: schema: $ref: '#/components/schemas/CatalogView' '400': description: Error - the input does not match the input schema definition. summary: Filter catalogs description: Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API. parameters: - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The view input in XML or JSON format. content: application/vnd.ibexa.api.CatalogViewInput+json: schema: $ref: '#/components/schemas/CatalogViewInputWrapper' example: ViewInput: identifier: TitleView CatalogQuery: Query: CatalogIdentifierCriterion: test CatalogNameCriterion: test application/vnd.ibexa.api.CatalogViewInput+xml: schema: $ref: '#/components/schemas/CatalogViewInput' required: false /product/catalog/catalogs/{identifier}: get: operationId: ibexa.product_catalog.rest.catalogs.get tags: - Product Catalog responses: '200': description: If set, the catalog is returned in XML or JSON format. content: application/vnd.ibexa.api.Catalog+json: schema: $ref: '#/components/schemas/CatalogWrapper' example: Catalog: _media-type: application/vnd.ibexa.api.Catalog+json identifier: test_catalog name: Snow Equipment description: '' User: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 created: 1666090438 modified: 1666090438 status: draft Criteria: - _media-type: application/vnd.ibexa.api.ProductCode+json ProductCodeCriterion: _media-type: application/vnd.ibexa.api.ProductCodeCriterion+json codes: - ski - snowboard - _media-type: application/vnd.ibexa.api.ProductAvailability+json ProductAvailabilityCriterion: _media-type: application/vnd.ibexa.api.ProductAvailabilityCriterion+json is_available: true - _media-type: application/vnd.ibexa.api.ColorAttribute+json ColorAttributeCriterion: _media-type: application/vnd.ibexa.api.ColorAttributeCriterion+json identifier: color value: - '#000000' - '#FFFFFF' - _media-type: application/vnd.ibexa.api.CreatedAt+json CreatedAtCriterion: _media-type: application/vnd.ibexa.api.CreatedAtCriterion+json created_at: date: '2022-09-12 00:00:00.000000' timezone_type: 3 timezone: Europe/Warsaw operator: '>=' - _media-type: application/vnd.ibexa.api.FloatAttribute+json FloatAttributeCriterion: _media-type: application/vnd.ibexa.api.FloatAttributeCriterion+json identifier: width value: 16.6 - _media-type: application/vnd.ibexa.api.IntegerAttributeRange+json IntegerAttributeRangeCriterion: _media-type: application/vnd.ibexa.api.IntegerAttributeRangeCriterion+json identifier: length min: 180 max: 230 application/vnd.ibexa.api.Catalog+xml: schema: $ref: '#/components/schemas/Catalog' '401': description: Error - the user is not authorized to view this catalog. '404': description: Error - no catalog with the given identifier exists. summary: Load catalog description: Loads the given catalog. parameters: - name: identifier in: path description: CatalogLoadByIdentifierController identifier required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: ibexa.product_catalog.rest.catalogs.delete tags: - Product Catalog responses: '204': description: No content - the given catalog is deleted. '401': description: Error - the user is not authorized to delete this catalog. summary: Delete catalog description: Deletes the given catalog. parameters: - name: identifier in: path description: CatalogDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: ibexa.product_catalog.rest.catalogs.update tags: - Product Catalog responses: '201': description: If set, the updated catalog is returned in XML or JSON format. content: application/vnd.ibexa.api.Catalog+json: schema: $ref: '#/components/schemas/CatalogWrapper' example: Catalog: _media-type: application/vnd.ibexa.api.Catalog+json identifier: test_catalog_updated name: Snow Equipment updated description: Snow Equipment catalog for 2022 User: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 created: 1666090438 modified: 1666091260 status: published Criteria: - _media-type: application/vnd.ibexa.api.ProductCode+json ProductCodeCriterion: _media-type: application/vnd.ibexa.api.ProductCodeCriterion+json codes: - ski - _media-type: application/vnd.ibexa.api.ProductAvailability+json ProductAvailabilityCriterion: _media-type: application/vnd.ibexa.api.ProductAvailabilityCriterion+json is_available: false - _media-type: application/vnd.ibexa.api.CreatedAt+json CreatedAtCriterion: _media-type: application/vnd.ibexa.api.CreatedAtCriterion+json created_at: date: '2022-12-12 00:00:00.000000' timezone_type: 3 timezone: Europe/Warsaw operator: '>=' '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to update this catalog. '403': description: Error - a catalog with the same identifier already exists. '404': description: Error - no catalog with the given identifier exists. summary: Update catalog description: Updates a catalog. parameters: - name: identifier in: path description: CatalogUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: If set, the updated catalog is returned in XML or JSON format. content: application/vnd.ibexa.api.CatalogUpdate+json: schema: $ref: '#/components/schemas/CatalogUpdateWrapper' example: CatalogUpdate: identifier: test_catalog_updated criteria: ProductCodeCriterion: - ski ProductAvailabilityCriterion: false CreatedAtCriterion: operator: '>=' created_at: 12-12-2022 names: eng-GB: Snow Equipment updated descriptions: eng-GB: Snow Equipment catalog for 2022 transition: publish required: false /product/catalog/catalogs/{identifier}/products/view: post: operationId: ibexa.product_catalog.rest.catalogs.products.view tags: - Product Catalog responses: '200': description: The view in XML or JSON format. content: application/vnd.ibexa.api.ProductView+json: schema: $ref: '#/components/schemas/ProductViewWrapper' example: ProductView: _media-type: application/vnd.ibexa.api.ProductView+json identifier: TitleView ProductQuery: _media-type: application/vnd.ibexa.api.ProductQuery+json Result: _media-type: application/vnd.ibexa.api.ViewResult+json count: 1 ProductList: _media-type: application/vnd.ibexa.api.ProductList+json Product: - _media-type: application/vnd.ibexa.api.Product+json code: test name: test ProductType: _media-type: application/vnd.ibexa.api.ProductType+json identifier: quickdraw name: Quickdraw AttributeAssignmentList: [] Content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/187 _remoteId: b0608be4ef4dc978ad603d02ac3c9ad1 _id: 187 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/55 Name: test TranslatedName: test Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/187/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/187/currentversion Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/187/versions/1 VersionInfo: id: 665 versionNo: 1 status: PUBLISHED modificationDate: '2022-08-26T11:16:49+02:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2022-08-26T11:16:49+02:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': test Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/187 Fields: field: - id: 915 fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: test - id: 916 fieldDefinitionIdentifier: product_specification languageCode: eng-GB fieldTypeIdentifier: ibexa_product_specification fieldValue: id: 60 code: test attributes: [] - id: 917 fieldDefinitionIdentifier: description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
xhtml5edit: |
- id: 918 fieldDefinitionIdentifier: image languageCode: eng-GB fieldTypeIdentifier: ibexa_image_asset fieldValue: destinationContentId: null alternativeText: null source: null - id: 919 fieldDefinitionIdentifier: category languageCode: eng-GB fieldTypeIdentifier: ibexa_taxonomy_entry_assignment fieldValue: taxonomy_entries: [] taxonomy: null Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/187/versions/1/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ibexaadminui/img/ibexa-icons.svg#file width: null height: null mimeType: image/svg+xml Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/187/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 lastModificationDate: '2022-08-26T11:16:49+02:00' publishedDate: '2022-08-26T11:16:49+02:00' mainLanguageCode: eng-GB currentVersionNo: 1 alwaysAvailable: true isHidden: false status: PUBLISHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/187/objectstates Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ibexaadminui/img/ibexa-icons.svg#file width: null height: null mimeType: image/svg+xml created_at: 1661505409 updated_at: 1661505409 AttributesList: [] application/vnd.ibexa.api.ProductView+xml: schema: $ref: '#/components/schemas/ProductView' '400': description: Error - the input does not match the input schema definition. summary: Filter catalog products description: Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API. parameters: - name: identifier in: path description: CatalogProductsViewController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The view input in XML or JSON format. content: application/vnd.ibexa.api.ProductViewInput+json: schema: $ref: '#/components/schemas/ProductViewInputWrapper' example: ViewInput: identifier: TitleView ProductQuery: Query: ProductCodeCriterion: test ProductAvailabilityCriterion: true application/vnd.ibexa.api.ProductViewInput+xml: schema: $ref: '#/components/schemas/ProductViewInput' required: false /product/catalog/currencies: get: operationId: ibexa.product_catalog.rest.currencies tags: - Product Currency responses: '200': description: OK - loads currencies. content: application/vnd.ibexa.api.CurrencyList+json: schema: $ref: '#/components/schemas/CurrencyListWrapper' example: CurrencyList: _media-type: application/vnd.ibexa.api.CurrencyList+json Currency: - _media-type: application/vnd.ibexa.api.Currency+json id: 1 code: AFN subunits: 1 enabled: false - _media-type: application/vnd.ibexa.api.Currency+json id: 2 code: EUR subunits: 2 enabled: false - _media-type: application/vnd.ibexa.api.Currency+json id: 3 code: ALL subunits: 2 enabled: false - _media-type: application/vnd.ibexa.api.Currency+json id: 4 code: DZD subunits: 2 enabled: false - _media-type: application/vnd.ibexa.api.Currency+json id: 5 code: USD subunits: 2 enabled: false - _media-type: application/vnd.ibexa.api.Currency+json id: 6 code: AOA subunits: 2 enabled: false '401': description: Error - the user has no permission to read currencies. summary: Load currencies description: Loads the list of currencies. parameters: [] post: operationId: ibexa.product_catalog.rest.currencies.create tags: - Product Currency responses: '200': description: If set, the new currency is returned in JSON format. content: application/vnd.ibexa.api.Currency+json: schema: $ref: '#/components/schemas/CurrencyWrapper' example: Currency: _media-type: application/vnd.ibexa.api.Currency+json id: 181 code: cur subunits: 1 enabled: true '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to create this currency. '406': description: Error - a currency with this code already exists. summary: Create currency description: Creates a new currency. parameters: - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The Currency schema encoded in XML or JSON format. content: application/vnd.ibexa.api.CurrencyCreate+json: schema: $ref: '#/components/schemas/CurrencyCreateWrapper' example: CurrencyCreate: code: cur subunits: 1 enabled: true required: false /product/catalog/currencies/view: post: operationId: ibexa.product_catalog.rest.currencies.view tags: - Product Currency responses: '200': description: The view in XML or JSON format. content: application/vnd.ibexa.api.CurrencyView+json: schema: $ref: '#/components/schemas/CurrencyViewWrapper' example: CurrencyView: _media-type: application/vnd.ibexa.api.CurrencyView+json identifier: TitleView CurrencyQuery: _media-type: application/vnd.ibexa.api.CurrencyQuery+json Result: _media-type: application/vnd.ibexa.api.ViewResult+json count: 179 CurrencyList: _media-type: application/vnd.ibexa.api.CurrencyList+json Currency: - _media-type: application/vnd.ibexa.api.Currency+json id: 1 code: AFN subunits: 2 enabled: false - _media-type: application/vnd.ibexa.api.Currency+json id: 2 code: EUR subunits: 2 enabled: false - _media-type: application/vnd.ibexa.api.Currency+json id: 3 code: ALL subunits: 2 enabled: false - _media-type: application/vnd.ibexa.api.Currency+json id: 4 code: DZD subunits: 2 enabled: false - _media-type: application/vnd.ibexa.api.Currency+json id: 5 code: USD subunits: 2 enabled: false - _media-type: application/vnd.ibexa.api.Currency+json id: 6 code: AOA subunits: 2 enabled: false - _media-type: application/vnd.ibexa.api.Currency+json id: 7 code: XCD subunits: 2 enabled: false - _media-type: application/vnd.ibexa.api.Currency+json id: 8 code: ARS subunits: 2 enabled: false - _media-type: application/vnd.ibexa.api.Currency+json id: 9 code: AMD subunits: 2 enabled: false - _media-type: application/vnd.ibexa.api.Currency+json id: 10 code: AWG subunits: 2 enabled: false application/vnd.ibexa.api.CurrencyView+xml: schema: $ref: '#/components/schemas/CurrencyView' '400': description: Error - the input does not match the input schema definition. summary: Filter currencies description: Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API. parameters: - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The view input in XML or JSON format. content: application/vnd.ibexa.api.CurrencyViewInput+json: schema: $ref: '#/components/schemas/CurrencyViewInputWrapper' example: ViewInput: identifier: TitleView CurrencyQuery: limit: '10' offset: '0' application/vnd.ibexa.api.CurrencyViewInput+xml: schema: $ref: '#/components/schemas/CurrencyViewInput' required: false /product/catalog/currencies/{id}: get: operationId: ibexa.product_catalog.rest.currencies.get tags: - Product Currency responses: '200': description: OK - loads the currency. content: application/vnd.ibexa.api.Currency+json: schema: $ref: '#/components/schemas/CurrencyWrapper' example: Currency: _media-type: application/vnd.ibexa.api.Currency+json id: 3 code: ALL subunits: 2 enabled: false '401': description: Error - the user has no permission to read currencies. '404': description: Error - the currency does not exist. summary: Load currency description: Loads a currency. parameters: - name: id in: path description: CurrencyLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: ibexa.product_catalog.rest.currencies.delete tags: - Product Currency responses: '200': description: No content - the given currency is deleted. '401': description: Error - the user is not authorized to delete this currency. summary: Delete currency description: Deletes the given currency. parameters: - name: id in: path description: CurrencyDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: ibexa.product_catalog.rest.currencies.update tags: - Product Currency responses: '200': description: If set, the updated currency is returned in XML or JSON format. content: application/vnd.ibexa.api.Currency+json: schema: $ref: '#/components/schemas/CurrencyWrapper' example: Currency: _media-type: application/vnd.ibexa.api.Currency+json id: 1 code: AFN subunits: 1 enabled: false '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to create this User. '403': description: Error - a currency with the same ID already exists. '404': description: Error - the currency with the given ID does not exist. summary: Update currency description: Updates a currency. parameters: - name: id in: path description: CurrencyUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The CurrencyUpdate schema encoded in XML or JSON format. content: application/vnd.ibexa.api.CurrencyUpdate+json: schema: $ref: '#/components/schemas/CurrencyUpdateWrapper' example: CurrencyUpdate: subunits: 1 enabled: false required: false /product/catalog/customer_groups: get: operationId: ibexa.product_catalog.rest.customer_groups.list tags: - Product Customer Group responses: '200': description: If set, the customer groups list is returned in XML or JSON format. content: application/vnd.ibexa.api.CustomerGroupList+json: schema: $ref: '#/components/schemas/CustomerGroupListWrapper' example: CustomerGroupList: _media-type: application/vnd.ibexa.api.CustomerGroupList+json CustomerGroup: - _media-type: application/vnd.ibexa.api.CustomerGroup+json id: 1 name: Resellers identifier: resellers description: '' users: [] global_price_rate: '0.00' - _media-type: application/vnd.ibexa.api.CustomerGroup+json id: 2 name: Contractors identifier: contractors description: '' users: [] global_price_rate: '-20.00' '401': description: Error - the user has no permission to read customer groups. summary: Load customer groups description: Returns a list of customer groups parameters: [] post: operationId: ibexa.product_catalog.rest.customer_group.create tags: - Product Customer Group responses: '201': description: If set, the new customer group is returned in XML or JSON format. content: application/vnd.ibexa.api.CustomerGroup+json: schema: $ref: '#/components/schemas/CustomerGroupWrapper' example: CustomerGroup: _media-type: application/vnd.ibexa.api.CustomerGroup+json id: 5 name: test-en identifier: test description: test-desc-en users: [] global_price_rate: '1.00' '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to create this Customer Group. '403': description: Error - a customer group with the same name already exists. summary: Create customer group description: Creates a new customer group. parameters: - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The CustomerGroupCreate schema encoded in XML or JSON format. content: application/vnd.ibexa.api.CustomerGroupCreate+json: schema: $ref: '#/components/schemas/CustomerGroupCreateWrapper' example: CustomerGroupCreate: identifier: customer_group names: eng-GB: Customer Group descriptions: eng-GB: Customer Group description global_price_rate: '1' required: false /product/catalog/customer_groups/view: post: operationId: ibexa.product_catalog.rest.customer_groups.view tags: - Product Customer Group responses: '200': description: The view in XML or JSON format. content: application/vnd.ibexa.api.CustomerGroupView+json: schema: $ref: '#/components/schemas/CustomerGroupViewWrapper' example: CustomerGroupView: _media-type: application/vnd.ibexa.api.CustomerGroupView+json identifier: TitleView CustomerGroupQuery: _media-type: application/vnd.ibexa.api.CustomerGroupQuery+json Result: _media-type: application/vnd.ibexa.api.ViewResult+json count: 1 CustomerGroupList: _media-type: application/vnd.ibexa.api.CustomerGroupList+json CustomerGroup: - _media-type: application/vnd.ibexa.api.CustomerGroup+json id: 1 name: Business identifier: business description: Most trusted business customers, being our partners for at least 5 years. users: [] global_price_rate: '15.00' application/vnd.ibexa.api.CustomerGroupView+xml: schema: $ref: '#/components/schemas/CustomerGroupView' '400': description: Error - the input does not match the input schema definition. summary: Filter customer groups description: Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API. parameters: - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The view input in XML or JSON format. content: application/vnd.ibexa.api.CustomerGroupViewInput+json: schema: $ref: '#/components/schemas/CustomerGroupViewInputWrapper' example: ViewInput: identifier: TitleView CustomerGroupQuery: limit: '10' offset: '0' application/vnd.ibexa.api.CustomerGroupViewInput+xml: schema: $ref: '#/components/schemas/CustomerGroupViewInput' required: false /product/catalog/customer_groups/{identifier}: get: operationId: ibexa.product_catalog.rest.customer_groups.identifier tags: - Product Customer Group responses: '200': description: If set, the customer group is returned in XML or JSON format. content: application/vnd.ibexa.api.CustomerGroup+json: schema: $ref: '#/components/schemas/CustomerGroupWrapper' example: CustomerGroup: _media-type: application/vnd.ibexa.api.CustomerGroup+json id: 1 name: Resellers identifier: resellers description: '' users: [] global_price_rate: '0.00' '401': description: Error - the user has no permission to read customer groups. summary: Load customer group description: Returns a customer group parameters: - name: identifier in: path description: CustomerGroupLoadByIdentifierController identifier required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: ibexa.product_catalog.rest.customer_groups.delete tags: - Product Customer Group responses: '204': description: No content - the given customer group is deleted. '401': description: Error - the user is not authorized to delete this customer group. summary: Delete customer group description: Deletes the given customer group. parameters: - name: identifier in: path description: CustomerGroupDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: ibexa.product_catalog.rest.customer_group.update tags: - Product Customer Group responses: '201': description: If set, the updated customer group is returned in XML or JSON format. content: application/vnd.ibexa.api.CustomerGroup+json: schema: $ref: '#/components/schemas/CustomerGroupWrapper' example: CustomerGroup: _media-type: application/vnd.ibexa.api.CustomerGroup+json id: 1 name: Customer Group identifier: customer_group description: '' users: [] global_price_rate: '1.00' '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to update a customer group. summary: Update customer group description: Updates the given customer group. parameters: - name: identifier in: path description: CustomerGroupUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The CustomerGroupUpdate schema encoded in XML or JSON format. content: application/vnd.ibexa.api.CustomerGroupUpdate+json: schema: $ref: '#/components/schemas/CustomerGroupUpdateWrapper' example: CustomerGroupUpdate: identifier: customer_group names: eng-GB: Customer Group global_price_rate: '1' required: false /product/catalog/customer_groups/{id}: get: operationId: ibexa.product_catalog.rest.customer_group tags: - Product Customer Group responses: '200': description: If set, the customer group is returned in XML or JSON format. content: application/vnd.ibexa.api.CustomerGroup+json: schema: $ref: '#/components/schemas/CustomerGroupWrapper' example: CustomerGroup: _media-type: application/vnd.ibexa.api.CustomerGroup+json id: 1 name: Customer Group identifier: customer_group description: '' users: [] global_price_rate: '1.00' '401': description: Error - the user has no permission to read customer groups. summary: Load customer group description: Returns a customer group parameters: - name: id in: path description: CustomerGroupLoadByIdController identifier required: true deprecated: false schema: type: integer style: simple explode: false /product/catalog/regions: get: operationId: ibexa.product_catalog.rest.regions tags: - Product Region responses: '200': description: OK - loads regions. content: application/vnd.ibexa.api.RegionList+json: schema: $ref: '#/components/schemas/RegionListWrapper' example: RegionList: _media-type: application/vnd.ibexa.api.RegionList+json Region: - _media-type: application/vnd.ibexa.api.Region+json identifier: france - _media-type: application/vnd.ibexa.api.Region+json identifier: __REGION_2__ - _media-type: application/vnd.ibexa.api.Region+json identifier: __REGION_1__ - _media-type: application/vnd.ibexa.api.Region+json identifier: foo - _media-type: application/vnd.ibexa.api.Region+json identifier: bar application/vnd.ibexa.api.RegionList+xml: schema: $ref: '#/components/schemas/RegionList' '401': description: Error - the user has no permission to read regions. summary: Load regions description: Loads the list of regions. parameters: [] /product/catalog/regions/view: post: operationId: ibexa.product_catalog.rest.regions.view tags: - Product Region responses: '200': description: The view in XML or JSON format. content: application/vnd.ibexa.api.RegionView+json: schema: $ref: '#/components/schemas/RegionViewWrapper' example: RegionView: _media-type: application/vnd.ibexa.api.RegionView+json identifier: TitleView RegionQuery: _media-type: application/vnd.ibexa.api.RegionQuery+json Result: _media-type: application/vnd.ibexa.api.ViewResult+json count: 2 RegionList: _media-type: application/vnd.ibexa.api.RegionList+json Region: - _media-type: application/vnd.ibexa.api.Region+json identifier: region_1 - _media-type: application/vnd.ibexa.api.Region+json identifier: region_2 application/vnd.ibexa.api.RegionView+xml: schema: $ref: '#/components/schemas/RegionView' '400': description: Error - the input does not match the input schema definition. summary: Filter regions description: Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API. parameters: - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The view input in XML or JSON format. content: application/vnd.ibexa.api.RegionViewInput+json: schema: $ref: '#/components/schemas/RegionViewInputWrapper' example: ViewInput: identifier: TitleView RegionQuery: limit: '10' offset: '0' application/vnd.ibexa.api.RegionViewInput+xml: schema: $ref: '#/components/schemas/RegionViewInput' required: false /product/catalog/regions/{identifier}: get: operationId: ibexa.product_catalog.rest.region tags: - Product Region responses: '200': description: OK - loads region. content: application/vnd.ibexa.api.Region+json: schema: $ref: '#/components/schemas/RegionWrapper' application/vnd.ibexa.api.Region+xml: schema: $ref: '#/components/schemas/Region' '404': description: Error - the region does not exist. summary: Load region description: Loads a region by its identifier parameters: - name: identifier in: path description: RegionLoadByIdentifierController identifier required: true deprecated: false schema: type: string style: simple explode: false /product/catalog/product_types: get: operationId: ibexa.product_catalog.rest.product_types tags: - Product Type responses: '200': description: ProductTypeList - If set, the product type list is returned in XML or JSON format. content: application/vnd.ibexa.api.ProductTypeList+json: schema: $ref: '#/components/schemas/ProductTypeListWrapper' example: ProductTypeList: _media-type: application/vnd.ibexa.api.ProductTypeList+json ProductType: - _media-type: application/vnd.ibexa.api.ProductType+json identifier: s_rope name: Static ropes AttributeAssignmentList: [] application/vnd.ibexa.api.ProductTypeList+xml: schema: $ref: '#/components/schemas/ProductTypeList' '401': description: Error - the user has no permission to read product type. summary: Load product types (deprecated) description: Returns a list of product types. Deprecated as of Ibexa DXP 4.3, use POST /product/catalog/product_types/view instead. parameters: [] requestBody: description: The ProductTypeList schema encoded in XML or JSON format. content: application/vnd.ibexa.api.ProductTypeListGet+json: schema: $ref: '#/components/schemas/ProductTypeListGetWrapper' example: ProductTypeListGet: name_prefix: s offset: 0 limit: 10 application/vnd.ibexa.api.ProductTypeListGet+xml: schema: $ref: '#/components/schemas/ProductTypeListGet' required: false post: operationId: ibexa.product_catalog.rest.product_types.create tags: - Product Type responses: '201': description: If set, the new product type is returned in XML or JSON format. content: application/vnd.ibexa.api.ProductType+json: schema: $ref: '#/components/schemas/ProductTypeWrapper' example: ProductType: _media-type: application/vnd.ibexa.api.ProductType+json identifier: test_pt321 name: New Product Type AttributeAssignmentList: - _media-type: application/vnd.ibexa.api.AttributeAssignment+json is_required: false is_discriminator: true Attribute: _media-type: application/vnd.ibexa.api.Attribute+json identifier: testAttr name: testAttr description: '' type: Checkbox type_identifier: checkbox value: true group: Test Attribute group position: 0 options: [] '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to create this product type. '403': description: Error - a product type with the same name already exists. '404': description: Error - the product type with the given ID does not exist. summary: Create product type description: Creates a new product type. parameters: - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The ProductType schema encoded in XML or JSON format. content: application/vnd.ibexa.api.ProductTypeCreate+json: schema: $ref: '#/components/schemas/ProductTypeCreateWrapper' example: ProductTypeCreate: ContentTypeCreateStruct: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2 id: 2 status: DEFINED identifier: test_pt321 names: value: - _languageCode: eng-GB '#text': Article descriptions: value: - _languageCode: eng-GB '#text': null creationDate: '2002-06-18T09:21:38+00:00' modificationDate: '2021-06-28T11:31:22+00:00' remoteId: c15b600eb9198b1924063b5a68758232 urlAliasSchema: '' nameSchema: isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: false defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/1 id: 1 identifier: title fieldType: ibexa_string fieldGroup: '' position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: New article isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null main_language_code: eng-GB assigned_attributes: - identifier: testAttr is_required: false is_discriminator: true required: false /product/catalog/product_types/is_used/{identifier}: get: operationId: ibexa.product_catalog.rest.product_types.is_used tags: - Product Type responses: '200': description: OK - product type usage is returned. content: application/vnd.ibexa.api.ProductTypeUsage+json: schema: $ref: '#/components/schemas/ProductTypeUsageWrapper' application/vnd.ibexa.api.ProductTypeUsage+xml: schema: $ref: '#/components/schemas/ProductTypeUsage' example: | 1 '404': description: Error - product type not found. summary: Check product type usage description: Checks whether the product type is in use. parameters: - name: identifier in: path description: ProductTypeIsUsedController identifier required: true deprecated: false schema: type: string style: simple explode: false /product/catalog/product_types/view: post: operationId: ibexa.product_catalog.rest.product_types.view tags: - Product Type responses: '200': description: The view in XML or JSON format. content: application/vnd.ibexa.api.ProductTypeView+json: schema: $ref: '#/components/schemas/ProductTypeViewWrapper' example: ProductTypeView: _media-type: application/vnd.ibexa.api.ProductTypeView+json identifier: TitleView ProductTypeQuery: _media-type: application/vnd.ibexa.api.ProductTypeQuery+json Result: _media-type: application/vnd.ibexa.api.ViewResult+json count: 1 ProductTypeList: _media-type: application/vnd.ibexa.api.ProductTypeList+json ProductType: - _media-type: application/vnd.ibexa.api.ProductType+json identifier: climbing_shoe name: New Product Type AttributeAssignmentList: - _media-type: application/vnd.ibexa.api.AttributeAssignment+json is_required: false is_discriminator: false Attribute: _media-type: application/vnd.ibexa.api.Attribute+json identifier: measure name: measure description: '' type: Measurement type_identifier: measurement group: Test Attribute group position: 0 options: type: length unit: centimeter measurementRange: minimum: 12 maximum: 15 measurementDefaultRange: defaultRangeMinimumValue: null defaultRangeMaximumValue: null - _media-type: application/vnd.ibexa.api.AttributeAssignment+json is_required: false is_discriminator: false Attribute: _media-type: application/vnd.ibexa.api.Attribute+json identifier: leather_color name: leather color description: '' type: Color type_identifier: color value: '#000000' group: Test Attribute group position: 0 options: [] application/vnd.ibexa.api.ProductTypeView+xml: schema: $ref: '#/components/schemas/ProductTypeView' '400': description: Error - the input does not match the input schema definition. summary: Filter product types description: Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API. parameters: - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The view input in XML or JSON format. content: application/vnd.ibexa.api.ProductTypeViewInput+json: schema: $ref: '#/components/schemas/ProductTypeViewInputWrapper' example: ViewInput: identifier: TitleView ProductTypeQuery: limit: '10' offset: '0' name_prefix: new application/vnd.ibexa.api.ProductTypeViewInput+xml: schema: $ref: '#/components/schemas/ProductTypeViewInput' required: false /product/catalog/product_types/{identifier}: get: operationId: ibexa.product_catalog.rest.product_type tags: - Product Type responses: '200': description: OK - load the product type content: application/vnd.ibexa.api.ProductType+json: schema: $ref: '#/components/schemas/ProductTypeWrapper' example: ProductType: _media-type: application/vnd.ibexa.api.ProductType+json identifier: d_rope name: Dynamic ropes AttributeAssignmentList: [] application/vnd.ibexa.api.ProductType+xml: schema: $ref: '#/components/schemas/ProductType' '401': description: Error - the user has no permission to read product type. '404': description: Error - product type not found. summary: Load product type description: Returns the given product type. parameters: - name: identifier in: path description: ProductTypeLoadByIdentifierController identifier required: true deprecated: false schema: type: string style: simple explode: false /product/catalog/product_types/{id}: delete: operationId: ibexa.product_catalog.rest.product_types.delete tags: - Product Type responses: '204': description: No content - the given product type is deleted. '401': description: Error - the user is not authorized to delete this product type. summary: Delete product type description: Deletes the given product type. parameters: - name: id in: path description: ProductTypeDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: ibexa.product_catalog.rest.product_types.update tags: - Product Type responses: '201': description: If set, the updated product type is returned in XML or JSON format. content: application/vnd.ibexa.api.ProductType+json: schema: $ref: '#/components/schemas/ProductTypeWrapper' example: ProductType: _media-type: application/vnd.ibexa.api.ProductType+json identifier: NEW name: pt_1_updated AttributeAssignmentList: - _media-type: application/vnd.ibexa.api.AttributeAssignment+json is_required: false is_discriminator: true Attribute: _media-type: application/vnd.ibexa.api.Attribute+json identifier: size name: Size description: '' type: Integer type_identifier: integer value: 5 group: Hat position: 0 options: [] '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to create this product type. '404': description: Error - the product type with the given ID does not exist. summary: Update product type description: Updates product type. parameters: - name: id in: path description: ProductTypeUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: If set, the updated product type is returned in XML or JSON format. content: application/vnd.ibexa.api.ProductTypeUpdate+json: schema: $ref: '#/components/schemas/ProductTypeUpdateWrapper' example: ProductTypeUpdate: ContentTypeUpdateStruct: names: value: - _languageCode: eng-GB '#text': pt_1_updated descriptions: value: - _languageCode: eng-GB '#text': updated assigned_attributes: - identifier: size is_required: false is_discriminator: true required: false /product/catalog/product_variant/{code}: get: operationId: ibexa.product_catalog.rest.product_variant tags: - Product Variant responses: '200': description: OK - loads the product variant. content: application/vnd.ibexa.api.ProductVariant+json: schema: $ref: '#/components/schemas/ProductVariantWrapper' example: ProductVariant: _media-type: application/vnd.ibexa.api.ProductVariant+json code: macbook name: Macbook Air 32/232 Product: _media-type: application/vnd.ibexa.api.Product+json code: mac_air name: Macbook Air ProductType: _media-type: application/vnd.ibexa.api.ProductType+json identifier: laptop name: Laptop AttributeAssignmentList: - _media-type: application/vnd.ibexa.api.AttributeAssignment+json is_required: false is_discriminator: true Attribute: _media-type: application/vnd.ibexa.api.Attribute+json identifier: number name: number description: '' type: Float type_identifier: float value: 1.5 group: test position: 0 options: min: 4 max: 5 - _media-type: application/vnd.ibexa.api.AttributeAssignment+json is_required: false is_discriminator: true Attribute: _media-type: application/vnd.ibexa.api.Attribute+json identifier: testattr name: testAttr description: '' type: Integer type_identifier: integer value: 5 group: test position: 0 options: min: 4 max: 5 Content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/152 _remoteId: 2d61ff8d0043eb299ca8c29c74f25441 _id: 152 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/56 Name: Macbook Air TranslatedName: Macbook Air Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/152/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/152/currentversion Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/152/versions/1 VersionInfo: id: 635 versionNo: 1 status: PUBLISHED modificationDate: '2022-07-21T15:17:18+02:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2022-07-21T15:17:18+02:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Macbook Air Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/152 Fields: field: - id: 716 fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Macbook Air - id: 717 fieldDefinitionIdentifier: product_specification languageCode: eng-GB fieldTypeIdentifier: ibexa_product_specification fieldValue: id: 89 code: mac_air attributes: [] - id: 718 fieldDefinitionIdentifier: description languageCode: eng-GB fieldTypeIdentifier: ibexa_richtext fieldValue: xml: |
test
xhtml5edit: |

test

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

test

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

test

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

test

- id: 719 fieldDefinitionIdentifier: image languageCode: eng-GB fieldTypeIdentifier: ibexa_image_asset fieldValue: destinationContentId: null alternativeText: null source: null - id: 720 fieldDefinitionIdentifier: category languageCode: eng-GB fieldTypeIdentifier: ibexa_taxonomy_entry_assignment fieldValue: taxonomy_entries: [] taxonomy: null Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/152/versions/1/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ibexaadminui/img/ibexa-icons.svg#file width: null height: null mimeType: image/svg+xml Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/152/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 lastModificationDate: '2022-07-21T15:17:18+02:00' publishedDate: '2022-07-21T15:17:18+02:00' mainLanguageCode: eng-GB currentVersionNo: 1 alwaysAvailable: true isHidden: false status: PUBLISHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/152/objectstates Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ibexaadminui/img/ibexa-icons.svg#file width: null height: null mimeType: image/svg+xml created_at: 1658409438 updated_at: 1658409438 AttributesList: [] DiscriminatorAttributesList: [] '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to update this product variant. '403': description: Error - a product variant with the same code already exists. '404': description: Error - no product variant with the given code exists. summary: Update product variant description: Updates product variant. parameters: - name: code in: path description: ProductVariantUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The CSRF token is required when passing user session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The product variant update schema encoded in XML or JSON format. content: application/vnd.ibexa.api.ProductVariantUpdate+json: schema: $ref: '#/components/schemas/ProductVariantUpdateWrapper' example: ProductVariantUpdate: code: test attributes: number: 2 testattr: 10 required: false /product/catalog/vat/{region}: get: operationId: ibexa.product_catalog.rest.vat.list tags: - Product Vat responses: '200': description: OK - loads the VAT category list. content: application/vnd.ibexa.api.VatCategoryList+json: schema: $ref: '#/components/schemas/VatCategoryListWrapper' example: VatCategoryList: _media-type: application/vnd.ibexa.api.VatCategoryList+json VatCategory: - _media-type: application/vnd.ibexa.api.VatCategory+json identifier: standard region: region_1 vatValue: 18 - _media-type: application/vnd.ibexa.api.VatCategory+json identifier: reduced region: region_1 vatValue: 6 - _media-type: application/vnd.ibexa.api.VatCategory+json identifier: none region: region_1 vatValue: null '401': description: Error - the user is not authorized to read this object. '404': description: Error - the VAT category region does not exist. summary: Load VAT region description: Loads a VAT category for the given region. parameters: - name: region in: path description: VatCategoriesListController identifier required: true deprecated: false schema: type: string style: simple explode: false /product/catalog/vat/{region}/{identifier}: get: operationId: ibexa.product_catalog.rest.vat tags: - Product Vat responses: '200': description: OK - loads the VAT category. content: application/vnd.ibexa.api.VatCategory+json: schema: $ref: '#/components/schemas/VatCategoryWrapper' example: VatCategory: _media-type: application/vnd.ibexa.api.VatCategory+json identifier: standard region: region_1 vatValue: 18 '401': description: Error - the user is not authorized to read this object. '404': description: Error - the VAT category for the given identifier not exists. summary: Load VAT specific region description: Loads a VAT category for the given identifier. parameters: - name: region in: path description: VatCategoryLoadByIdentifierController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: identifier in: path description: VatCategoryLoadByIdentifierController identifier required: true deprecated: false schema: type: string style: simple explode: false /content/sections: get: operationId: ibexa.rest.list_sections tags: - Section responses: '200': description: If set, the Section list is returned in XML or JSON format. content: application/vnd.ibexa.api.SectionList+json: schema: $ref: '#/components/schemas/SectionListWrapper' example: SectionList: _media-type: application/vnd.ibexa.api.SectionList+json _href: /api/ibexa/v2/content/sections Section: - _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 sectionId: 1 identifier: standard name: Standard - _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/2 sectionId: 2 identifier: users name: Users - _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/3 sectionId: 3 identifier: media name: Media - _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/6 sectionId: 6 identifier: form name: Form - _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/7 sectionId: 7 identifier: template name: Template - _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/8 sectionId: 8 identifier: restricted name: Restricted application/vnd.ibexa.api.SectionList+xml: schema: $ref: '#/components/schemas/SectionList' example: |
1 standard Standard
2 users Users
3 media Media
6 form Form
7 template Template
8 restricted Restricted
'401': description: Error - The user has no permission to read the Section. summary: Get Sections description: Returns a list of all Sections. parameters: - name: If-None-Match in: header description: ETag required: false deprecated: false schema: type: string style: simple explode: false post: operationId: ibexa.rest.create_section tags: - Section responses: '201': description: If set, the new Section is returned in XML or JSON format. content: application/vnd.ibexa.api.Section+json: schema: $ref: '#/components/schemas/SectionWrapper' example: Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/13 sectionId: 13 identifier: restricted name: Restricted application/vnd.ibexa.api.Section+xml: schema: $ref: '#/components/schemas/Section' example: |
7 restricted Restricted
summary: Create new Section description: Creates a new Section. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The Section input schema encoded in XML or JSON format. content: application/vnd.ibexa.api.SectionInput+json: schema: $ref: '#/components/schemas/SectionInputWrapper' example: SectionInput: identifier: restricted name: Restricted application/vnd.ibexa.api.SectionInput+xml: schema: $ref: '#/components/schemas/SectionInput' example: |- restricted Restricted required: false /content/sections/{sectionId}: get: operationId: ibexa.rest.load_section tags: - Section responses: '200': description: If set, the Section is returned in XML or JSON format. content: application/vnd.ibexa.api.Section+json: schema: $ref: '#/components/schemas/SectionWrapper' example: Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/10 sectionId: 10 identifier: design name: Design application/vnd.ibexa.api.Section+xml: schema: $ref: '#/components/schemas/Section' example: |
10 design Design
'401': description: Error - The user is not authorized to read this Section. '404': description: Error - The Section does not exist. summary: Get Section description: Returns the Section by given Section ID. parameters: - name: If-None-match in: header description: ETag required: false deprecated: false schema: type: string style: simple explode: false - name: sectionId in: path description: SectionLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: ibexa.rest.delete_section tags: - Section responses: '204': description: No Content - given Section is deleted. '401': description: Error - the user is not authorized to delete this Section. '404': description: Error - the Section does not exist. summary: Delete Section description: The given Section is deleted. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: sectionId in: path description: SectionDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: ibexa.rest.update_section tags: - Section responses: '200': description: OK - Section updated. content: application/vnd.ibexa.api.Section+json: schema: $ref: '#/components/schemas/SectionWrapper' example: Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/7 sectionId: 7 identifier: template name: Template application/vnd.ibexa.api.Section+xml: schema: $ref: '#/components/schemas/Section' example: |
7 template Template
'400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to create this Section. '403': description: Error - a Section with the given identifier already exists. '412': description: Error - the current ETag does not match with the one provided in the If-Match header. summary: Update a Section description: Updates a Section. PATCH or POST with header X-HTTP-Method-Override PATCH. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: If-Match in: header description: ETag required: true deprecated: false schema: type: string style: simple explode: false - name: sectionId in: path description: SectionUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The Section input schema encoded in XML or JSON. content: application/vnd.ibexa.api.SectionInput+json: schema: $ref: '#/components/schemas/SectionInputWrapper' example: SectionInput: identifier: template name: Template application/vnd.ibexa.api.SectionInput+xml: schema: $ref: '#/components/schemas/SectionInput' example: | template Template required: false /segment_groups: get: operationId: ibexa.segmentation.rest.segment_groups.list tags: - Segmentation responses: '200': description: OK - list the segment groups. content: application/vnd.ibexa.api.SegmentGroupList+json: schema: $ref: '#/components/schemas/SegmentGroupListWrapper' example: SegmentGroupList: _media-type: application/vnd.ibexa.api.SegmentGroupList+json _href: /api/ibexa/v2/segment_groups SegmentGroup: - _media-type: application/vnd.ibexa.api.SegmentGroup+json _href: /api/ibexa/v2/segment_groups/corporate_accounts id: 1 identifier: corporate_accounts name: Corporate Accounts application/vnd.ibexa.api.SegmentGroupList+xml: schema: $ref: '#/components/schemas/SegmentGroupList' example: | 1 corporate_accounts Corporate Accounts '401': description: Error - the user is not authorized to list segment groups. content: application/vnd.ibexa.api.ErrorMessage+json: schema: $ref: '#/components/schemas/ErrorMessage' application/vnd.ibexa.api.ErrorMessage+xml: schema: $ref: '#/components/schemas/ErrorMessage' summary: List segment groups description: Lists segment groups. parameters: [] /segment_groups/{identifier}: get: operationId: ibexa.segmentation.rest.segment_groups.view tags: - Segmentation responses: '200': description: OK - return the segment group. content: application/vnd.ibexa.api.SegmentGroup+json: schema: $ref: '#/components/schemas/SegmentGroupWrapper' example: SegmentGroup: _media-type: application/vnd.ibexa.api.SegmentGroup+json _href: /api/ibexa/v2/segment_groups/corporate_accounts id: 1 identifier: corporate_accounts name: Corporate Accounts application/vnd.ibexa.api.SegmentGroup+xml: schema: $ref: '#/components/schemas/SegmentGroup' example: | 1 corporate_accounts Corporate Accounts '401': description: Error - the user is not authorized to load this segment group. '404': description: Error - the identifier doesn't match any segment group. summary: Load segment group description: Loads segment group. parameters: - name: identifier in: path description: SegmentGroupViewController identifier required: true deprecated: false schema: type: string style: simple explode: false /segment_groups/{identifier}/segments: get: operationId: ibexa.segmentation.rest.segment_groups.list.segments tags: - Segmentation responses: '200': description: OK - list the group's segments. content: application/vnd.ibexa.api.SegmentList+json: schema: $ref: '#/components/schemas/SegmentListWrapper' example: SegmentList: _media-type: application/vnd.ibexa.api.SegmentList+json _href: /api/ibexa/v2/segment_groups/corporate_accounts/segments Segment: [] application/vnd.ibexa.api.SegmentList+xml: schema: $ref: '#/components/schemas/SegmentList' example: | '401': description: Error - the user is not authorized to load this group's segments. '404': description: Error - the identifier doesn't match any segment group. summary: List segment group's segments description: Lists segment group's segments. parameters: - name: identifier in: path description: SegmentListController identifier required: true deprecated: false schema: type: string style: simple explode: false /segments/{identifier}: get: operationId: ibexa.segmentation.rest.segments.view tags: - Segmentation responses: '200': description: OK - Return the segment. content: application/vnd.ibexa.api.Segment+json: schema: $ref: '#/components/schemas/SegmentWrapper' example: Segment: _media-type: application/vnd.ibexa.api.Segment+json _href: /api/ibexa/v2/segments/corporate_account id: 1 identifier: corporate_account name: Corporate Account source: cohesivo lastUpdatedBy: '14' updatedAt: '2026-06-30T12:00:00+00:00' SegmentGroup: _media-type: application/vnd.ibexa.api.SegmentGroup+json _href: /api/ibexa/v2/segment_groups/corporate_accounts application/vnd.ibexa.api.Segment+xml: schema: $ref: '#/components/schemas/Segment' example: | 1 corporate_account Corporate Account cohesivo 14 2026-06-30T12:00:00+00:00 '401': description: Error - the user is not authorized to load this group's segments. '404': description: Error - the identifier doesn't match any segment group. summary: Load segment description: Loads the identified segment. parameters: - name: identifier in: path description: SegmentViewController identifier required: true deprecated: false schema: type: string style: simple explode: false /taxonomy/{taxonomyName}/entries: delete: operationId: ibexa.taxonomy.rest.entries.remove tags: - Taxonomy responses: '204': description: No Content - The entries have been deleted. '400': description: Error - The input does not match the input schema definition. '401': description: Error - The user is not authorized to delete some of the entries. summary: Delete Entries description: Bulk removes several taxonomy entries. parameters: - name: X-CSRF-Token in: header description: The CSRF token. required: true deprecated: false schema: type: string style: simple explode: false - name: taxonomyName in: path description: TaxonomyEntryBulkRemoveController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: TaxonomyEntryBulkRemove schema encoded in XML or JSON format. content: application/vnd.ibexa.api.TaxonomyEntryBulkRemove+json: schema: $ref: '#/components/schemas/TaxonomyEntryBulkRemoveWrapper' example: TaxonomyEntryBulkRemove: entries: - 2 - 3 application/vnd.ibexa.api.TaxonomyEntryBulkRemove+xml: schema: $ref: '#/components/schemas/TaxonomyEntryBulkRemove' required: false /taxonomy/{taxonomyName}/entries/move: post: operationId: ibexa.taxonomy.rest.entries.move tags: - Taxonomy responses: '204': description: No Content - The entries have been moved. '400': description: Error - The input does not match the input schema definition. '401': description: Error - The user is not authorized to move some of the entries. '404': description: Error - Some to-be-moved or sibling entries do not exist. summary: Move Entries description: Bulk move several taxonomy entries relative to sibling. parameters: - name: X-CSRF-Token in: header description: The CSRF token. required: true deprecated: false schema: type: string style: simple explode: false - name: taxonomyName in: path description: TaxonomyEntryBulkMoveController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The TaxonomyEntryBulkMove schema encoded in XML or JSON format. content: application/vnd.ibexa.api.TaxonomyEntryBulkMove+json: schema: $ref: '#/components/schemas/TaxonomyEntryBulkMoveWrapper' example: TaxonomyEntryBulkMove: entries: - entry: 2 sibling: 1 position: next - entry: 3 sibling: 1 position: prev application/vnd.ibexa.api.TaxonomyEntryBulkMove+xml: schema: $ref: '#/components/schemas/TaxonomyEntryBulkMove' required: false /taxonomy/{taxonomyName}/entry-assignment/{id}: get: operationId: ibexa.taxonomy.rest.entry_assignment.load_by_id tags: - Taxonomy responses: '200': description: OK - returns the taxonomy entry Assignment. content: application/vnd.ibexa.api.TaxonomyEntryAssignment+json: schema: $ref: '#/components/schemas/TaxonomyEntryAssignmentWrapper' application/vnd.ibexa.api.TaxonomyEntryAssignment+xml: schema: $ref: '#/components/schemas/TaxonomyEntryAssignment' '404': description: Error - the assignment does not exist. summary: Get Assignment by ID description: Gets taxonomy entry Assignment by its ID. parameters: - name: taxonomyName in: path description: TaxonomyEntryAssignmentLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: id in: path description: TaxonomyEntryAssignmentLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false /taxonomy/{taxonomyName}/entry-assignments/assign-to-content: post: operationId: ibexa.taxonomy.rest.entry_assignments.assign_to_content tags: - Taxonomy responses: '201': description: No Content. '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to assign this Entry. summary: Assign entry description: Assigns taxonomy entry to a content item. parameters: - name: X-CSRF-Token in: header description: The CSRF token. required: true deprecated: false schema: type: string style: simple explode: false - name: taxonomyName in: path description: TaxonomyEntryAssignmentAssignController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: TaxonomyEntryAssignToContent schema encoded in JSON format. content: application/vnd.ibexa.api.TaxonomyEntryAssignToContent+json: schema: $ref: '#/components/schemas/TaxonomyEntryAssignToContentWrapper' example: TaxonomyEntryAssignToContent: content: 130 entries: - 2 - 3 required: false /taxonomy/{taxonomyName}/entry-assignments/content-id/{contentId}: get: operationId: ibexa.taxonomy.rest.entry_assignments.load tags: - Taxonomy responses: '200': description: OK - returns the assigment collection. content: application/vnd.ibexa.api.EntryAssignmentCollection+json: schema: $ref: '#/components/schemas/EntryAssignmentCollectionWrapper' example: EntryAssignmentCollection: _media-type: application/vnd.ibexa.api.EntryAssignmentCollection+json content: _media-type: application/vnd.ibexa.api.Content+json Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/1 _remoteId: 9459d3c29e15006e45197295722c7ade _id: 1 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/1 Name: Ibexa Platform TranslatedName: Ibexa Platform Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/1/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/1/currentversion Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/1/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 lastModificationDate: '2023-01-01T00:00:00+00:00' publishedDate: '2015-11-30T13:10:46+00:00' mainLanguageCode: eng-GB currentVersionNo: 10 alwaysAvailable: true isHidden: false status: PUBLISHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/1/objectstates assignments: - _media-type: application/vnd.ibexa.api.TaxonomyEntryAssignment+json id: 1 content: _media-type: application/vnd.ibexa.api.Content+json Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/1 _remoteId: 9459d3c29e15006e45197295722c7ade _id: 1 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/1 Name: Ibexa Platform TranslatedName: Ibexa Platform Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/1/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/1/currentversion Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/1/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 lastModificationDate: '2023-01-01T00:00:00+00:00' publishedDate: '2015-11-30T13:10:46+00:00' mainLanguageCode: eng-GB currentVersionNo: 10 alwaysAvailable: true isHidden: false status: PUBLISHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/1/objectstates entry: _media-type: application/vnd.ibexa.api.TaxonomyEntry+json TaxonomyEntry: _media-type: application/vnd.ibexa.api.TaxonomyEntry+json id: 3 identifier: example name: Example contentId: 65 content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/65 taxonomy: tags application/vnd.ibexa.api.EntryAssignmentCollection+xml: schema: $ref: '#/components/schemas/EntryAssignmentCollection' example: |- 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 '404': description: Error - the Content does not exists. summary: Get Assignments to a Content description: Gets taxonomy entries assigned to a content item by its ID. parameters: - name: taxonomyName in: path description: TaxonomyEntryAssignmentLoadController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: contentId in: path description: TaxonomyEntryAssignmentLoadController identifier required: true deprecated: false schema: type: string style: simple explode: false /taxonomy/{taxonomyName}/entry-assignments/unassign-from-content: post: operationId: ibexa.taxonomy.rest.entry_assignments.unassign_from_content tags: - Taxonomy responses: '201': description: No Content. '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to unassign this entry. summary: Unassign entry description: Unassigns taxonomy entry from a content item. parameters: - name: X-CSRF-Token in: header description: The CSRF token. required: true deprecated: false schema: type: string style: simple explode: false - name: taxonomyName in: path description: TaxonomyEntryAssignmentUnassignController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: TaxonomyEntryUnassignFromContent schema encoded in JSON format. content: application/vnd.ibexa.api.TaxonomyEntryUnassignFromContent+json: schema: $ref: '#/components/schemas/TaxonomyEntryUnassignFromContentWrapper' example: TaxonomyEntryUnassignFromContent: content: 130 entries: - 2 - 3 required: false /taxonomy/{taxonomyName}/entry/content-id/{contentId}: get: operationId: ibexa.taxonomy.rest.entry.load_by_content_id tags: - Taxonomy responses: '200': description: OK - returns the taxonomy Entry. content: application/vnd.ibexa.api.TaxonomyEntry+json: schema: $ref: '#/components/schemas/TaxonomyEntryWrapper' application/vnd.ibexa.api.TaxonomyEntry+xml: schema: $ref: '#/components/schemas/TaxonomyEntry' '401': description: Error - the user is not authorized to read this Entry. '404': description: Error - the Entry does not exists. summary: Get Entry by Content ID description: Loads taxonomy Entry by its Content ID. parameters: - name: taxonomyName in: path description: TaxonomyEntryLoadByContentIdController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: contentId in: path description: TaxonomyEntryLoadByContentIdController identifier required: true deprecated: false schema: type: string style: simple explode: false /taxonomy/{taxonomyName}/entry/identifier/{identifier}: get: operationId: ibexa.taxonomy.rest.entry.load_by_identifier tags: - Taxonomy responses: '200': description: OK - returns the taxonomy Entry. content: application/vnd.ibexa.api.TaxonomyEntry+json: schema: $ref: '#/components/schemas/TaxonomyEntryWrapper' application/vnd.ibexa.api.TaxonomyEntry+xml: schema: $ref: '#/components/schemas/TaxonomyEntry' '401': description: Error - the user is not authorized to read this Entry. '404': description: Error - the Entry does not exists. summary: Get Entry by identifier description: Loads taxonomy Entry by its Entry identifier. parameters: - name: taxonomyName in: path description: TaxonomyEntryLoadByIdentifierController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: identifier in: path description: TaxonomyEntryLoadByIdentifierController identifier required: true deprecated: false schema: type: string style: simple explode: false /taxonomy/{taxonomyName}/entry/{id}: get: operationId: ibexa.taxonomy.rest.entry.load_by_id tags: - Taxonomy responses: '200': description: OK - returns the taxonomy Entry. content: application/vnd.ibexa.api.TaxonomyEntry+json: schema: $ref: '#/components/schemas/TaxonomyEntryWrapper' application/vnd.ibexa.api.TaxonomyEntry+xml: schema: $ref: '#/components/schemas/TaxonomyEntry' '401': description: Error - the user is not authorized to read this Entry. '404': description: Error - the Entry does not exists. summary: Get Entry by ID description: Loads taxonomy Entry by its Entry ID. parameters: - name: taxonomyName in: path description: TaxonomyEntryLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: id in: path description: TaxonomyEntryLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false /content/trash: get: operationId: ibexa.rest.load_trash_items tags: - Trash responses: '200': description: OK - returns the list of items in the Trash. content: application/vnd.ibexa.api.Trash+json: schema: $ref: '#/components/schemas/TrashWrapper' example: Trash: _media-type: application/vnd.ibexa.api.Trash+json _href: /api/ibexa/v2/content/trash TrashItem: - _media-type: application/vnd.ibexa.api.TrashItem+json _href: /api/ibexa/v2/content/trash/87 id: 87 priority: 0 hidden: false invisible: false ParentLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/2/57 pathString: /1/2/57/87/ depth: 3 childCount: 0 remoteId: 7cc6565354858f39a794bf64aa2c2761 Content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/91 sortField: PATH sortOrder: ASC ContentInfo: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/91 Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/91 _remoteId: de906bef76f08700662bfaf1579871f0 _id: 91 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2 Name: test_article TranslatedName: test_article Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/91/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/91/currentversion Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/91/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/11 lastModificationDate: '2021-07-19T08:31:01+00:00' publishedDate: '2021-07-19T08:31:01+00:00' mainLanguageCode: eng-GB currentVersionNo: 1 alwaysAvailable: false isHidden: false status: TRASHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/91/objectstates - _media-type: application/vnd.ibexa.api.TrashItem+json _href: /api/ibexa/v2/content/trash/89 id: 89 priority: 0 hidden: false invisible: false ParentLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/2 pathString: /1/2/89/ depth: 2 childCount: 0 remoteId: 256c2e7d71e927bab32a901878827312 Content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/96 sortField: PATH sortOrder: ASC ContentInfo: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/96 Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/96 _remoteId: d5bad9eb55cfe8572adf04452a2b206e _id: 96 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/1 Name: All Articles test TranslatedName: All Articles test Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/96/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/96/currentversion Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/96/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 lastModificationDate: '2021-07-19T12:43:02+00:00' publishedDate: '2021-07-19T12:42:47+00:00' mainLanguageCode: eng-GB currentVersionNo: 2 alwaysAvailable: true isHidden: false status: TRASHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/96/objectstates application/vnd.ibexa.api.Trash+xml: schema: $ref: '#/components/schemas/Trash' example: | 58 0 false false /1/2/56/58/ 3 0 59800915ad2eb8514de0bebe84f6ccba PATH ASC Folder 1
2019-02-06T09:03:09+01:00 2019-02-06T09:03:09+01:00 eng-GB 1 true '401': description: Error - The user has no permission to read the Trash. summary: List Trash items description: Returns a list of all items in the Trash. parameters: [] delete: operationId: ibexa.rest.empty_trash tags: - Trash responses: '204': description: No Content - Trash emptied. '401': description: Error - The user is not authorized to empty all items from Trash. summary: Empty Trash description: Empties the Trash. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false /content/trash/{trashItemid}: get: operationId: ibexa.rest.load_trash_item tags: - Trash responses: '200': description: If set, the item in Trash is returned in XML or JSON format. content: application/vnd.ibexa.api.TrashItem+json: schema: $ref: '#/components/schemas/TrashItemWrapper' example: TrashItem: _media-type: application/vnd.ibexa.api.TrashItem+json _href: /api/ibexa/v2/content/trash/87 id: 87 priority: 0 hidden: false invisible: false ParentLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/2/57 pathString: /1/2/57/87/ depth: 3 childCount: 0 remoteId: 7cc6565354858f39a794bf64aa2c2761 Content: _media-type: application/vnd.ibexa.api.Content+json _href: /api/ibexa/v2/content/objects/91 sortField: PATH sortOrder: ASC ContentInfo: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/91 Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/91 _remoteId: de906bef76f08700662bfaf1579871f0 _id: 91 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2 Name: test_article TranslatedName: test_article Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/91/versions CurrentVersion: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/91/currentversion Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/1 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/91/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/11 lastModificationDate: '2021-07-19T08:31:01+00:00' publishedDate: '2021-07-19T08:31:01+00:00' mainLanguageCode: eng-GB currentVersionNo: 1 alwaysAvailable: false isHidden: false status: TRASHED ObjectStates: _media-type: application/vnd.ibexa.api.ContentObjectStates+json _href: /api/ibexa/v2/content/objects/91/objectstates application/vnd.ibexa.api.TrashItem+xml: schema: $ref: '#/components/schemas/TrashItem' example: | 81 0 false false /1/2/42/81/ 3 0 135e8a84b61848a67be36e9552d2724d PATH ASC Folder 1
2019-04-25T12:45:58+02:00 2019-04-25T12:45:58+02:00 eng-GB 1 true TRASHED '401': description: Error - The user has no permission to read the item in Trash. '404': description: Error - An item in Trash with the provided ID does not exist. summary: Get Trash item description: Returns the item in Trash with the provided ID. parameters: - name: trashItemid in: path description: TrashItemLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: ibexa.rest.delete_trash_item tags: - Trash responses: '204': description: No Content - item deleted. '401': description: Error - The user is not authorized to delete the provided item. '404': description: Error - The provided item does not exist in Trash. summary: Delete Trash item description: Deletes the provided item from Trash. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: trashItemid in: path description: TrashItemDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false /content/types: get: operationId: ibexa.rest.list_content_types tags: - Type responses: '200': description: OK - returns a list of content types. content: application/vnd.ibexa.api.ContentTypeInfoList+json: schema: $ref: '#/components/schemas/ContentTypeInfoListWrapper' example: ContentTypeList: _media-type: application/vnd.ibexa.api.ContentTypeList+json _href: /api/ibexa/v2/content/typegroups/1/types ContentType: - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2 id: 2 status: DEFINED identifier: article names: value: - _languageCode: eng-GB '#text': Article descriptions: value: [] creationDate: '2002-06-18T09:21:38+00:00' modificationDate: '2004-04-20T09:56:29+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/2/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2/draft remoteId: c15b600eb9198b1924063b5a68758232 urlAliasSchema: null nameSchema: isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: false defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/1 id: 1 identifier: title fieldType: ibexa_string fieldGroup: '' position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: New article isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/152 id: 152 identifier: short_title fieldType: ibexa_string fieldGroup: '' position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Short title descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/153 id: 153 identifier: author fieldType: ibexa_author fieldGroup: '' position: 3 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: [] isSearchable: false names: value: - _languageCode: eng-GB '#text': Author descriptions: value: [] fieldSettings: defaultAuthor: 1 validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/120 id: 120 identifier: intro fieldType: ibexa_richtext fieldGroup: '' position: 4 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: xml: |
xhtml5edit: |
isSearchable: true names: value: - _languageCode: eng-GB '#text': Intro descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/121 id: 121 identifier: body fieldType: ibexa_richtext fieldGroup: '' position: 5 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: |
xhtml5edit: |
isSearchable: true names: value: - _languageCode: eng-GB '#text': Body descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/123 id: 123 identifier: enable_comments fieldType: ibexa_boolean fieldGroup: '' position: 6 isTranslatable: false isRequired: false isInfoCollector: false defaultValue: false isSearchable: false names: value: - _languageCode: eng-GB '#text': Enable comments descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/154 id: 154 identifier: image fieldType: ibexa_object_relation fieldGroup: '' position: 7 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: destinationContentId: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Image descriptions: value: [] fieldSettings: selectionMethod: SELECTION_BROWSE selectionRoot: '' selectionContentTypes: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/1 id: 1 status: DEFINED identifier: folder names: value: - _languageCode: eng-GB '#text': Folder descriptions: value: [] creationDate: '2002-06-18T09:21:38+00:00' modificationDate: '2015-11-29T21:14:32+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/1/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/1/draft remoteId: a3d405b81be900468eb153d774f4f0d2 urlAliasSchema: null nameSchema: isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions/4 id: 4 identifier: name fieldType: ibexa_string fieldGroup: '' position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: Folder isSearchable: true names: value: - _languageCode: eng-GB '#text': Name descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions/155 id: 155 identifier: short_name fieldType: ibexa_string fieldGroup: '' position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Short name descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 100 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions/119 id: 119 identifier: short_description fieldType: ibexa_richtext fieldGroup: '' position: 3 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: |
xhtml5edit: |
isSearchable: true names: value: - _languageCode: eng-GB '#text': Short description descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions/156 id: 156 identifier: description fieldType: ibexa_richtext fieldGroup: '' position: 4 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: |
xhtml5edit: |
isSearchable: true names: value: - _languageCode: eng-GB '#text': Description descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/43 id: 43 status: DEFINED identifier: form names: value: - _languageCode: eng-GB '#text': Form descriptions: value: [] creationDate: '2018-09-17T06:46:13+00:00' modificationDate: '2018-09-17T06:47:14+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/43/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/43/draft remoteId: 6f7f21df775a33c1e4bbc76b48c38476 urlAliasSchema: '' nameSchema: isContainer: false mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PUBLISHED defaultSortOrder: DESC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/43/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/43/fieldDefinitions/188 id: 188 identifier: title fieldType: ibexa_string fieldGroup: content position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: null minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/43/fieldDefinitions/189 id: 189 identifier: form fieldType: ibexa_form fieldGroup: content position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: fields: [] content_id: null content_field_id: null language_code: null isSearchable: false names: value: - _languageCode: eng-GB '#text': Form descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/42 id: 42 status: DEFINED identifier: landing_page names: value: - _languageCode: eng-GB '#text': Landing page descriptions: value: - _languageCode: eng-GB '#text': '' creationDate: '2015-07-03T12:00:26+00:00' modificationDate: '2015-07-03T12:00:26+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/42/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/42/draft remoteId: 60c03e9758465eb69d56b3afb6adf18e urlAliasSchema: '' nameSchema: <name> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PUBLISHED defaultSortOrder: DESC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/42/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/42/fieldDefinitions/185 id: 185 identifier: name fieldType: ibexa_string fieldGroup: content position: 10 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: - _languageCode: eng-GB '#text': Title fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: null minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/42/fieldDefinitions/186 id: 186 identifier: description fieldType: ibexa_string fieldGroup: content position: 20 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Description descriptions: value: - _languageCode: eng-GB '#text': Landing page description fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: null minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/42/fieldDefinitions/187 id: 187 identifier: page fieldType: ibexa_landing_page fieldGroup: content position: 30 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: layout: default zones: - id: default_id name: default blocks: [] isSearchable: false names: value: - _languageCode: eng-GB '#text': Landing page descriptions: value: - _languageCode: eng-GB '#text': Landing page fieldSettings: availableBlocks: null availableLayouts: null editorMode: page_view_mode validatorConfiguration: [] application/vnd.ibexa.api.ContentTypeInfoList+xml: schema: $ref: '#/components/schemas/ContentTypeInfoList' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentTypeList media-type="application/vnd.ibexa.api.ContentTypeList+xml" href="/api/ibexa/v2/content/typegroups/1/types"> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"> <id>2</id> <status>DEFINED</status> <identifier>article</identifier> <names> <value languageCode="eng-GB">Article</value> </names> <descriptions/> <creationDate>2002-06-18T09:21:38+00:00</creationDate> <modificationDate>2004-04-20T09:56:29+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2/draft"/> <remoteId>c15b600eb9198b1924063b5a68758232</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><short_title|title></nameSchema> <isContainer>true</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>false</defaultAlwaysAvailable> <defaultSortField>PATH</defaultSortField> <defaultSortOrder>ASC</defaultSortOrder> <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions"> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/1"> <id>1</id> <identifier>title</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>1</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue>New article</defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Title</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">255</value> <value key="minStringLength"/></value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/152"> <id>152</id> <identifier>short_title</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>2</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Short title</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">255</value> <value key="minStringLength"/></value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/153"> <id>153</id> <identifier>author</identifier> <fieldType>ibexa_author</fieldType> <fieldGroup></fieldGroup> <position>3</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Author</value> </names> <descriptions/> <fieldSettings> <value key="defaultAuthor">1</value> </fieldSettings> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/120"> <id>120</id> <identifier>intro</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup></fieldGroup> <position>4</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Intro</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/121"> <id>121</id> <identifier>body</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup></fieldGroup> <position>5</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Body</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/123"> <id>123</id> <identifier>enable_comments</identifier> <fieldType>ibexa_boolean</fieldType> <fieldGroup></fieldGroup> <position>6</position> <isTranslatable>false</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue>false</defaultValue> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Enable comments</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/154"> <id>154</id> <identifier>image</identifier> <fieldType>ibexa_object_relation</fieldType> <fieldGroup></fieldGroup> <position>7</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="destinationContentId"/> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Image</value> </names> <descriptions/> <fieldSettings> <value key="selectionMethod">SELECTION_BROWSE</value> <value key="selectionRoot"></value> <value key="selectionContentTypes"/> </fieldSettings> <validatorConfiguration/> </FieldDefinition> </FieldDefinitions> </ContentType> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"> <id>1</id> <status>DEFINED</status> <identifier>folder</identifier> <names> <value languageCode="eng-GB">Folder</value> </names> <descriptions/> <creationDate>2002-06-18T09:21:38+00:00</creationDate> <modificationDate>2015-11-29T21:14:32+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/1/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1/draft"/> <remoteId>a3d405b81be900468eb153d774f4f0d2</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><short_name|name></nameSchema> <isContainer>true</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>true</defaultAlwaysAvailable> <defaultSortField>PATH</defaultSortField> <defaultSortOrder>ASC</defaultSortOrder> <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions"> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/4"> <id>4</id> <identifier>name</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>1</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue>Folder</defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Name</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">255</value> <value key="minStringLength"/></value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/155"> <id>155</id> <identifier>short_name</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>2</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Short name</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">100</value> <value key="minStringLength"/></value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/119"> <id>119</id> <identifier>short_description</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup></fieldGroup> <position>3</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Short description</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/156"> <id>156</id> <identifier>description</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup></fieldGroup> <position>4</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Description</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> </FieldDefinitions> </ContentType> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/43"> <id>43</id> <status>DEFINED</status> <identifier>form</identifier> <names> <value languageCode="eng-GB">Form</value> </names> <descriptions/> <creationDate>2018-09-17T06:46:13+00:00</creationDate> <modificationDate>2018-09-17T06:47:14+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/43/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/43/draft"/> <remoteId>6f7f21df775a33c1e4bbc76b48c38476</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><title></nameSchema> <isContainer>false</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>true</defaultAlwaysAvailable> <defaultSortField>PUBLISHED</defaultSortField> <defaultSortOrder>DESC</defaultSortOrder> <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions"> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions/188"> <id>188</id> <identifier>title</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup>content</fieldGroup> <position>1</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Title</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength"/> <value key="minStringLength"/></value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions/189"> <id>189</id> <identifier>form</identifier> <fieldType>ibexa_form</fieldType> <fieldGroup>content</fieldGroup> <position>2</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="fields"/> <value key="content_id"/> <value key="content_field_id"/> <value key="language_code"/> </defaultValue> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Form</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> </FieldDefinitions> </ContentType> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/42"> <id>42</id> <status>DEFINED</status> <identifier>landing_page</identifier> <names> <value languageCode="eng-GB">Landing page</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <creationDate>2015-07-03T12:00:26+00:00</creationDate> <modificationDate>2015-07-03T12:00:26+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/42/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/42/draft"/> <remoteId>60c03e9758465eb69d56b3afb6adf18e</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><name></nameSchema> <isContainer>true</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>true</defaultAlwaysAvailable> <defaultSortField>PUBLISHED</defaultSortField> <defaultSortOrder>DESC</defaultSortOrder> <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions"> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/185"> <id>185</id> <identifier>name</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup>content</fieldGroup> <position>10</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Title</value> </names> <descriptions> <value languageCode="eng-GB">Title</value> </descriptions> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength"/> <value key="minStringLength"/></value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/186"> <id>186</id> <identifier>description</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup>content</fieldGroup> <position>20</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Description</value> </names> <descriptions> <value languageCode="eng-GB">Landing page description</value> </descriptions> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength"/> <value key="minStringLength"/></value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/187"> <id>187</id> <identifier>page</identifier> <fieldType>ibexa_landing_page</fieldType> <fieldGroup>content</fieldGroup> <position>30</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="layout">default</value> <value key="zones"> <value> <value key="id">default_id</value> <value key="name">default</value> <value key="blocks"/></value> </value> </defaultValue> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Landing page</value> </names> <descriptions> <value languageCode="eng-GB">Landing page</value> </descriptions> <fieldSettings> <value key="availableBlocks"/> <value key="availableLayouts"/> <value key="editorMode">page_view_mode</value> </fieldSettings> <validatorConfiguration/> </FieldDefinition> </FieldDefinitions> </ContentType> </ContentTypeList> application/vnd.ibexa.api.ContentTypeList+json: schema: $ref: '#/components/schemas/ContentTypeListWrapper' application/vnd.ibexa.api.ContentTypeList+xml: schema: $ref: '#/components/schemas/ContentTypeList' '401': description: Error - The user has no permission to read the content types. summary: List content types description: Returns a list of content types. parameters: [] /content/types/view: post: operationId: ibexa.rest.content_types.view tags: - Type responses: '200': description: The view in XML or JSON format. content: application/vnd.ibexa.api.ContentTypeList+json: schema: $ref: '#/components/schemas/ContentTypeInfoListWrapper' example: ContentTypeList: _media-type: application/vnd.ibexa.api.ContentTypeList+json _href: /api/ibexa/v2/content/typegroups/1/types ContentType: - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2 id: 2 status: DEFINED identifier: article names: value: - _languageCode: eng-GB '#text': Article descriptions: value: [] creationDate: '2002-06-18T09:21:38+00:00' modificationDate: '2004-04-20T09:56:29+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/2/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2/draft remoteId: c15b600eb9198b1924063b5a68758232 urlAliasSchema: null nameSchema: <short_title|title> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: false defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/1 id: 1 identifier: title fieldType: ibexa_string fieldGroup: '' position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: New article isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/152 id: 152 identifier: short_title fieldType: ibexa_string fieldGroup: '' position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Short title descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/153 id: 153 identifier: author fieldType: ibexa_author fieldGroup: '' position: 3 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: [] isSearchable: false names: value: - _languageCode: eng-GB '#text': Author descriptions: value: [] fieldSettings: defaultAuthor: 1 validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/120 id: 120 identifier: intro fieldType: ibexa_richtext fieldGroup: '' position: 4 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Intro descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/121 id: 121 identifier: body fieldType: ibexa_richtext fieldGroup: '' position: 5 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Body descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/123 id: 123 identifier: enable_comments fieldType: ibexa_boolean fieldGroup: '' position: 6 isTranslatable: false isRequired: false isInfoCollector: false defaultValue: false isSearchable: false names: value: - _languageCode: eng-GB '#text': Enable comments descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/154 id: 154 identifier: image fieldType: ibexa_object_relation fieldGroup: '' position: 7 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: destinationContentId: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Image descriptions: value: [] fieldSettings: selectionMethod: SELECTION_BROWSE selectionRoot: '' selectionContentTypes: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/1 id: 1 status: DEFINED identifier: folder names: value: - _languageCode: eng-GB '#text': Folder descriptions: value: [] creationDate: '2002-06-18T09:21:38+00:00' modificationDate: '2015-11-29T21:14:32+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/1/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/1/draft remoteId: a3d405b81be900468eb153d774f4f0d2 urlAliasSchema: null nameSchema: <short_name|name> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions/4 id: 4 identifier: name fieldType: ibexa_string fieldGroup: '' position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: Folder isSearchable: true names: value: - _languageCode: eng-GB '#text': Name descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions/155 id: 155 identifier: short_name fieldType: ibexa_string fieldGroup: '' position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Short name descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 100 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions/119 id: 119 identifier: short_description fieldType: ibexa_richtext fieldGroup: '' position: 3 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Short description descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions/156 id: 156 identifier: description fieldType: ibexa_richtext fieldGroup: '' position: 4 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Description descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/43 id: 43 status: DEFINED identifier: form names: value: - _languageCode: eng-GB '#text': Form descriptions: value: [] creationDate: '2018-09-17T06:46:13+00:00' modificationDate: '2018-09-17T06:47:14+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/43/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/43/draft remoteId: 6f7f21df775a33c1e4bbc76b48c38476 urlAliasSchema: '' nameSchema: <title> isContainer: false mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PUBLISHED defaultSortOrder: DESC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/43/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/43/fieldDefinitions/188 id: 188 identifier: title fieldType: ibexa_string fieldGroup: content position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: null minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/43/fieldDefinitions/189 id: 189 identifier: form fieldType: ibexa_form fieldGroup: content position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: fields: [] content_id: null content_field_id: null language_code: null isSearchable: false names: value: - _languageCode: eng-GB '#text': Form descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/42 id: 42 status: DEFINED identifier: landing_page names: value: - _languageCode: eng-GB '#text': Landing page descriptions: value: - _languageCode: eng-GB '#text': '' creationDate: '2015-07-03T12:00:26+00:00' modificationDate: '2015-07-03T12:00:26+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/42/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/42/draft remoteId: 60c03e9758465eb69d56b3afb6adf18e urlAliasSchema: '' nameSchema: <name> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PUBLISHED defaultSortOrder: DESC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/42/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/42/fieldDefinitions/185 id: 185 identifier: name fieldType: ibexa_string fieldGroup: content position: 10 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: - _languageCode: eng-GB '#text': Title fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: null minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/42/fieldDefinitions/186 id: 186 identifier: description fieldType: ibexa_string fieldGroup: content position: 20 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Description descriptions: value: - _languageCode: eng-GB '#text': Landing page description fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: null minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/42/fieldDefinitions/187 id: 187 identifier: page fieldType: ibexa_landing_page fieldGroup: content position: 30 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: layout: default zones: - id: default_id name: default blocks: [] isSearchable: false names: value: - _languageCode: eng-GB '#text': Landing page descriptions: value: - _languageCode: eng-GB '#text': Landing page fieldSettings: availableBlocks: null availableLayouts: null editorMode: page_view_mode validatorConfiguration: [] application/vnd.ibexa.api.ContentTypeList+xml: schema: $ref: '#/components/schemas/ContentTypeInfoList' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentTypeList media-type="application/vnd.ibexa.api.ContentTypeList+xml" href="/api/ibexa/v2/content/typegroups/1/types"> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"> <id>2</id> <status>DEFINED</status> <identifier>article</identifier> <names> <value languageCode="eng-GB">Article</value> </names> <descriptions/> <creationDate>2002-06-18T09:21:38+00:00</creationDate> <modificationDate>2004-04-20T09:56:29+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2/draft"/> <remoteId>c15b600eb9198b1924063b5a68758232</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><short_title|title></nameSchema> <isContainer>true</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>false</defaultAlwaysAvailable> <defaultSortField>PATH</defaultSortField> <defaultSortOrder>ASC</defaultSortOrder> <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions"> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/1"> <id>1</id> <identifier>title</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>1</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue>New article</defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Title</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">255</value> <value key="minStringLength"/></value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/152"> <id>152</id> <identifier>short_title</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>2</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Short title</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">255</value> <value key="minStringLength"/></value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/153"> <id>153</id> <identifier>author</identifier> <fieldType>ibexa_author</fieldType> <fieldGroup></fieldGroup> <position>3</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Author</value> </names> <descriptions/> <fieldSettings> <value key="defaultAuthor">1</value> </fieldSettings> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/120"> <id>120</id> <identifier>intro</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup></fieldGroup> <position>4</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Intro</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/121"> <id>121</id> <identifier>body</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup></fieldGroup> <position>5</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Body</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/123"> <id>123</id> <identifier>enable_comments</identifier> <fieldType>ibexa_boolean</fieldType> <fieldGroup></fieldGroup> <position>6</position> <isTranslatable>false</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue>false</defaultValue> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Enable comments</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/154"> <id>154</id> <identifier>image</identifier> <fieldType>ibexa_object_relation</fieldType> <fieldGroup></fieldGroup> <position>7</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="destinationContentId"/> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Image</value> </names> <descriptions/> <fieldSettings> <value key="selectionMethod">SELECTION_BROWSE</value> <value key="selectionRoot"></value> <value key="selectionContentTypes"/> </fieldSettings> <validatorConfiguration/> </FieldDefinition> </FieldDefinitions> </ContentType> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"> <id>1</id> <status>DEFINED</status> <identifier>folder</identifier> <names> <value languageCode="eng-GB">Folder</value> </names> <descriptions/> <creationDate>2002-06-18T09:21:38+00:00</creationDate> <modificationDate>2015-11-29T21:14:32+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/1/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1/draft"/> <remoteId>a3d405b81be900468eb153d774f4f0d2</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><short_name|name></nameSchema> <isContainer>true</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>true</defaultAlwaysAvailable> <defaultSortField>PATH</defaultSortField> <defaultSortOrder>ASC</defaultSortOrder> <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions"> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/4"> <id>4</id> <identifier>name</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>1</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue>Folder</defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Name</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">255</value> <value key="minStringLength"/></value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/155"> <id>155</id> <identifier>short_name</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>2</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Short name</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">100</value> <value key="minStringLength"/></value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/119"> <id>119</id> <identifier>short_description</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup></fieldGroup> <position>3</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Short description</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/156"> <id>156</id> <identifier>description</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup></fieldGroup> <position>4</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Description</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> </FieldDefinitions> </ContentType> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/43"> <id>43</id> <status>DEFINED</status> <identifier>form</identifier> <names> <value languageCode="eng-GB">Form</value> </names> <descriptions/> <creationDate>2018-09-17T06:46:13+00:00</creationDate> <modificationDate>2018-09-17T06:47:14+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/43/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/43/draft"/> <remoteId>6f7f21df775a33c1e4bbc76b48c38476</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><title></nameSchema> <isContainer>false</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>true</defaultAlwaysAvailable> <defaultSortField>PUBLISHED</defaultSortField> <defaultSortOrder>DESC</defaultSortOrder> <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions"> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions/188"> <id>188</id> <identifier>title</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup>content</fieldGroup> <position>1</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Title</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength"/> <value key="minStringLength"/></value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions/189"> <id>189</id> <identifier>form</identifier> <fieldType>ibexa_form</fieldType> <fieldGroup>content</fieldGroup> <position>2</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="fields"/> <value key="content_id"/> <value key="content_field_id"/> <value key="language_code"/> </defaultValue> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Form</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> </FieldDefinitions> </ContentType> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/42"> <id>42</id> <status>DEFINED</status> <identifier>landing_page</identifier> <names> <value languageCode="eng-GB">Landing page</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <creationDate>2015-07-03T12:00:26+00:00</creationDate> <modificationDate>2015-07-03T12:00:26+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/42/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/42/draft"/> <remoteId>60c03e9758465eb69d56b3afb6adf18e</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><name></nameSchema> <isContainer>true</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>true</defaultAlwaysAvailable> <defaultSortField>PUBLISHED</defaultSortField> <defaultSortOrder>DESC</defaultSortOrder> <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions"> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/185"> <id>185</id> <identifier>name</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup>content</fieldGroup> <position>10</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Title</value> </names> <descriptions> <value languageCode="eng-GB">Title</value> </descriptions> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength"/> <value key="minStringLength"/></value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/186"> <id>186</id> <identifier>description</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup>content</fieldGroup> <position>20</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Description</value> </names> <descriptions> <value languageCode="eng-GB">Landing page description</value> </descriptions> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength"/> <value key="minStringLength"/></value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/187"> <id>187</id> <identifier>page</identifier> <fieldType>ibexa_landing_page</fieldType> <fieldGroup>content</fieldGroup> <position>30</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="layout">default</value> <value key="zones"> <value> <value key="id">default_id</value> <value key="name">default</value> <value key="blocks"/></value> </value> </defaultValue> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Landing page</value> </names> <descriptions> <value languageCode="eng-GB">Landing page</value> </descriptions> <fieldSettings> <value key="availableBlocks"/> <value key="availableLayouts"/> <value key="editorMode">page_view_mode</value> </fieldSettings> <validatorConfiguration/> </FieldDefinition> </FieldDefinitions> </ContentType> </ContentTypeList> '400': description: Error - the input does not match the input schema definition. summary: Filter content types description: Executes a query and returns a View including the results. The View input reflects the criteria model of the public PHP API. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The view input in XML or JSON format. content: application/vnd.ibexa.api.ContentTypeViewInput+json: schema: $ref: '#/components/schemas/ContentTypeViewInputWrapper' example: ViewInput: identifier: ContentTypeView ContentTypeQuery: limit: '10' offset: '1' Query: ContentTypeIdCriterion: - 1 - 2 ContentTypeIdentifierCriterion: folder IsSystemCriterion: true ContentTypeGroupIdCriterion: 1 ContainsFieldDefinitionIdCriterion: 2 SortClauses: Identifier: descending Id: ascending application/vnd.ibexa.api.ContentTypeViewInput+xml: schema: $ref: '#/components/schemas/ContentTypeViewInput' example: | <?xml version="1.0" encoding="UTF-8"?> <ViewInput> <identifier>ContentTypeView</identifier> <ContentTypeQuery> <limit>10</limit> <offset>1</offset> <Query> <ContentTypeIdCriterion>1</ContentTypeIdCriterion> <ContentTypeIdCriterion>2</ContentTypeIdCriterion> <ContentTypeIdentifierCriterion>folder</ContentTypeIdentifierCriterion> <IsSystemCriterion>true</IsSystemCriterion> <ContentTypeGroupIdCriterion>1</ContentTypeGroupIdCriterion> <ContainsFieldDefinitionIdCriterion>2</ContainsFieldDefinitionIdCriterion> </Query> <SortClauses> <Identifier>descending</Identifier> <Id>ascending</Id> </SortClauses> </ContentTypeQuery> </ViewInput> required: false /content/types/{contentTypeId}: get: operationId: ibexa.rest.load_content_type tags: - Type responses: '200': description: OK - returns the content type. content: application/vnd.ibexa.api.ContentType+json: schema: $ref: '#/components/schemas/ContentTypeWrapper' example: ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2 id: 2 status: DEFINED identifier: article names: value: - _languageCode: eng-GB '#text': Article descriptions: value: - _languageCode: eng-GB '#text': null creationDate: '2002-06-18T09:21:38+00:00' modificationDate: '2021-06-28T11:31:22+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/2/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2/draft remoteId: c15b600eb9198b1924063b5a68758232 urlAliasSchema: '' nameSchema: <short_title|title> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: false defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/1 id: 1 identifier: title fieldType: ibexa_string fieldGroup: '' position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: New article isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/152 id: 152 identifier: short_title fieldType: ibexa_string fieldGroup: '' position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Short title descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/153 id: 153 identifier: author fieldType: ibexa_author fieldGroup: '' position: 3 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: [] isSearchable: false names: value: - _languageCode: eng-GB '#text': Author descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: defaultAuthor: 1 validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/120 id: 120 identifier: intro fieldType: ibexa_richtext fieldGroup: '' position: 4 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Intro descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/121 id: 121 identifier: body fieldType: ibexa_richtext fieldGroup: '' position: 5 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Body descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/123 id: 123 identifier: enable_comments fieldType: ibexa_boolean fieldGroup: '' position: 6 isTranslatable: false isRequired: false isInfoCollector: false defaultValue: false isSearchable: false names: value: - _languageCode: eng-GB '#text': Enable comments descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/195 id: 195 identifier: image fieldType: ibexa_image_asset fieldGroup: content position: 7 isTranslatable: false isRequired: false isInfoCollector: false defaultValue: destinationContentId: null alternativeText: null source: null isSearchable: false names: value: - _languageCode: eng-GB '#text': Image descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] application/vnd.ibexa.api.ContentType+xml: schema: $ref: '#/components/schemas/ContentType' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"> <id>2</id> <status>DEFINED</status> <identifier>article</identifier> <names> <value languageCode="eng-GB">Article</value> </names> <descriptions/> <creationDate>2002-06-18T11:21:38+02:00</creationDate> <modificationDate>2004-04-20T11:56:29+02:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2/draft"/> <remoteId>c15b600eb9198b1924063b5a68758232</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><short_title|title></nameSchema> <isContainer>true</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>false</defaultAlwaysAvailable> <defaultSortField>PATH</defaultSortField> <defaultSortOrder>ASC</defaultSortOrder> <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions"> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/1"> <id>1</id> <identifier>title</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>1</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue>New article</defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Title</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">255</value> <value key="minStringLength"/></value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/152"> <id>152</id> <identifier>short_title</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>2</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Short title</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">255</value> <value key="minStringLength"/></value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/153"> <id>153</id> <identifier>author</identifier> <fieldType>ibexa_author</fieldType> <fieldGroup></fieldGroup> <position>3</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Author</value> </names> <descriptions/> <fieldSettings> <value key="defaultAuthor">1</value> </fieldSettings> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/120"> <id>120</id> <identifier>intro</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup></fieldGroup> <position>4</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Intro</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/121"> <id>121</id> <identifier>body</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup></fieldGroup> <position>5</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Body</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/123"> <id>123</id> <identifier>enable_comments</identifier> <fieldType>ibexa_boolean</fieldType> <fieldGroup></fieldGroup> <position>6</position> <isTranslatable>false</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue>false</defaultValue> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Enable comments</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/154"> <id>154</id> <identifier>image</identifier> <fieldType>ibexa_object_relation</fieldType> <fieldGroup></fieldGroup> <position>7</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="destinationContentId"/> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Image</value> </names> <descriptions/> <fieldSettings> <value key="selectionMethod">SELECTION_BROWSE</value> <value key="selectionRoot"></value> <value key="selectionContentTypes"/> </fieldSettings> <validatorConfiguration/> </FieldDefinition> </FieldDefinitions> </ContentType> '401': description: Error - The user is not authorized to read this content type. '404': description: Error - The content type does not exist. summary: Get content type description: Returns the content type with the provided ID. parameters: - name: If-None-Match in: header description: ETag required: false deprecated: false schema: type: string style: simple explode: false - name: contentTypeId in: path description: ContentTypeLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false post: operationId: ibexa.rest.create_content_type_draft tags: - Type responses: '201': description: Draft created. content: application/vnd.ibexa.api.ContentTypeInfo+json: schema: $ref: '#/components/schemas/ContentTypeInfoWrapper' example: ContentTypeInfo: _media-type: application/vnd.ibexa.api.ContentTypeInfo+json _href: /api/ibexa/v2/content/types/1/draft id: 1 status: DRAFT identifier: folder names: value: - _languageCode: eng-GB '#text': Folder descriptions: value: [] creationDate: '2002-06-18T09:21:38+00:00' modificationDate: '2021-08-11T11:17:58+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/1/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/1/draft remoteId: a3d405b81be900468eb153d774f4f0d2 urlAliasSchema: null nameSchema: <short_name|name> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PATH defaultSortOrder: ASC application/vnd.ibexa.api.ContentTypeInfo+xml: schema: $ref: '#/components/schemas/ContentTypeInfo' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentTypeInfo media-type="application/vnd.ibexa.api.ContentTypeInfo+xml" href="/api/ibexa/v2/content/types/3/draft"> <id>3</id> <status>DRAFT</status> <identifier>user_group</identifier> <names> <value languageCode="eng-GB">User group</value> </names> <descriptions/> <creationDate>2002-06-18T11:21:38+02:00</creationDate> <modificationDate>2019-02-25T14:41:53+01:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/3/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/3/draft"/> <remoteId>25b4268cdcd01921b808a0d854b877ef</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><name></nameSchema> <isContainer>true</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>true</defaultAlwaysAvailable> <defaultSortField>PATH</defaultSortField> <defaultSortOrder>ASC</defaultSortOrder> </ContentTypeInfo> '400': description: Error - The input does not match the input schema definition. '401': description: Error - The user is not authorized to create the draft. '403': description: Error - A content type with the given new identifier already exists. A draft already exists. summary: Create Draft description: Creates a draft and updates it with the given data. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentTypeId in: path description: ContentTypeDraftCreateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The content type Update schema encoded in XML or JSON format. content: application/vnd.ibexa.api.ContentTypeUpdate+json: schema: $ref: '#/components/schemas/ContentTypeUpdateWrapper' example: ContentTypeUpdate: _media-type: application/vnd.ibexa.api.ContentTypeUpdate defaultAlwaysAvailable: 'true' application/vnd.ibexa.api.ContentTypeUpdate+xml: schema: $ref: '#/components/schemas/ContentTypeUpdate' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentTypeUpdate> <defaultAlwaysAvailable>true</defaultAlwaysAvailable> </ContentTypeUpdate> required: false delete: operationId: ibexa.rest.delete_content_type tags: - Type responses: '204': description: No Content - content type deleted. '401': description: Error - The user is not authorized to delete this content type. '403': description: Error - There are object instances of this content type. '404': description: Error - The content type does not exist. summary: Delete content type description: Deletes the provided content type. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentTypeId in: path description: ContentTypeDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false /content/types/{contentTypeId}/draft: get: operationId: ibexa.rest.load_content_type_draft tags: - Type responses: '200': description: OK - returns the content type. content: application/vnd.ibexa.api.ContentType+json: schema: $ref: '#/components/schemas/ContentTypeWrapper' example: ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2 id: 2 status: DEFINED identifier: article names: value: - _languageCode: eng-GB '#text': Article descriptions: value: - _languageCode: eng-GB '#text': null creationDate: '2002-06-18T09:21:38+00:00' modificationDate: '2021-06-28T11:31:22+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/2/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2/draft remoteId: c15b600eb9198b1924063b5a68758232 urlAliasSchema: '' nameSchema: <short_title|title> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: false defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/1 id: 1 identifier: title fieldType: ibexa_string fieldGroup: '' position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: New article isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/152 id: 152 identifier: short_title fieldType: ibexa_string fieldGroup: '' position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Short title descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/153 id: 153 identifier: author fieldType: ibexa_author fieldGroup: '' position: 3 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: [] isSearchable: false names: value: - _languageCode: eng-GB '#text': Author descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: defaultAuthor: 1 validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/120 id: 120 identifier: intro fieldType: ibexa_richtext fieldGroup: '' position: 4 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Intro descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/121 id: 121 identifier: body fieldType: ibexa_richtext fieldGroup: '' position: 5 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Body descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/123 id: 123 identifier: enable_comments fieldType: ibexa_boolean fieldGroup: '' position: 6 isTranslatable: false isRequired: false isInfoCollector: false defaultValue: false isSearchable: false names: value: - _languageCode: eng-GB '#text': Enable comments descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/195 id: 195 identifier: image fieldType: ibexa_image_asset fieldGroup: content position: 7 isTranslatable: false isRequired: false isInfoCollector: false defaultValue: destinationContentId: null alternativeText: null source: null isSearchable: false names: value: - _languageCode: eng-GB '#text': Image descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] application/vnd.ibexa.api.ContentType+xml: schema: $ref: '#/components/schemas/ContentType' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/14"> <id>14</id> <status>DEFINED</status> <identifier>copy_of_article_14</identifier> <names> <value languageCode="eng-GB">Updated content type name</value> </names> <descriptions> <value languageCode="eng-GB">This is an updated content type description</value> </descriptions> <creationDate>2019-02-06T10:56:36+01:00</creationDate> <modificationDate>2019-02-25T12:15:51+01:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/14/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/14/draft"/> <remoteId>d7ae816f22fe929e67a359a2ef6e7cde</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><short_title|title></nameSchema> <isContainer>true</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>false</defaultAlwaysAvailable> <defaultSortField>PATH</defaultSortField> <defaultSortOrder>ASC</defaultSortOrder> <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/14/fieldDefinitions"> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/14/fieldDefinitions/188"> <id>188</id> <identifier>title</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>1</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue>New article</defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Title</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">255</value> <value key="minStringLength"/></value> </validatorConfiguration> </FieldDefinition> </FieldDefinitions> </ContentType> '401': description: Error - The user is not authorized to read this content type. '404': description: Error - The content type does not exist or does not have a draft. summary: Get content type draft description: Returns the draft of the content type with the provided ID. parameters: - name: contentTypeId in: path description: ContentTypeDraftLoadController identifier required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: ibexa.rest.delete_content_type_draft tags: - Type responses: '204': description: No Content - content type draft deleted. '401': description: Error - The user is not authorized to delete this content type draft. '404': description: Error - The content type draft does not exist. summary: Delete content type draft description: Deletes the provided content type draft. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentTypeId in: path description: ContentTypeDraftDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: ibexa.rest.update_content_type_draft tags: - Type responses: '200': description: Draft metadata updated. content: application/vnd.ibexa.api.ContentTypeInfo+json: schema: $ref: '#/components/schemas/ContentTypeInfoWrapper' example: ContentTypeInfo: _media-type: application/vnd.ibexa.api.ContentTypeInfo+json _href: /api/ibexa/v2/content/types/2/draft id: 2 status: DRAFT identifier: article names: value: - _languageCode: eng-GB '#text': Updated content type name descriptions: value: - _languageCode: eng-GB '#text': This is an updated content type description creationDate: '2002-06-18T09:21:38+00:00' modificationDate: '2021-08-11T11:58:24+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/2/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2/draft remoteId: c15b600eb9198b1924063b5a68758232 urlAliasSchema: null nameSchema: <short_title|title> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PATH defaultSortOrder: ASC application/vnd.ibexa.api.ContentTypeInfo+xml: schema: $ref: '#/components/schemas/ContentTypeInfo' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentTypeInfo media-type="application/vnd.ibexa.api.ContentTypeInfo+xml" href="/api/ibexa/v2/content/types/14/draft"> <id>14</id> <status>DRAFT</status> <identifier>new_content_type</identifier> <names> <value languageCode="eng-GB">Updated content type name</value> </names> <descriptions> <value languageCode="eng-GB">This is an updated content type description</value> </descriptions> <creationDate>2019-02-06T10:56:36+01:00</creationDate> <modificationDate>2019-02-25T12:15:51+01:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/14/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/14/draft"/> <remoteId>d7ae816f22fe929e67a359a2ef6e7cde</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><short_title|title></nameSchema> <isContainer>true</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>false</defaultAlwaysAvailable> <defaultSortField>PATH</defaultSortField> <defaultSortOrder>ASC</defaultSortOrder> </ContentTypeInfo> '400': description: Error - The input does not match the input schema definition. '401': description: Error - The user is not authorized to update the draft. '403': description: Error - A content type with the given new identifier already exists. '404': description: Error - There is no draft for this content type. summary: Update content type draft description: Updates metadata of a draft. This method does not handle Field definitions. PATCH or POST with header X-HTTP-Method-Override PATCH. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentTypeId in: path description: ContentTypeDraftUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The content type update schema encoded in XML or JSON format. content: application/vnd.ibexa.api.ContentTypeUpdate+json: schema: $ref: '#/components/schemas/ContentTypeUpdateWrapper' example: ContentTypeUpdate: _media-type: application/vnd.ibexa.api.ContentTypeUpdate names: value: - _languageCode: eng-GB '#text': Updated content type name descriptions: value: - _languageCode: eng-GB '#text': This is an updated content type description application/vnd.ibexa.api.ContentTypeUpdate+xml: schema: $ref: '#/components/schemas/ContentTypeUpdate' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentTypeUpdate> <names> <value languageCode="eng-GB">Updated content type name</value> </names> <descriptions> <value languageCode="eng-GB">This is an updated content type description</value> </descriptions> </ContentTypeUpdate> required: false /content/types/{contentTypeId}/draft/fieldDefinitions: get: operationId: ibexa.rest.load_content_type_draft_field_definition_list tags: - Type responses: '200': description: OK - return a list of Field definitions. content: application/vnd.ibexa.api.FieldDefinitionList+json: schema: $ref: '#/components/schemas/FieldDefinitionsWrapper' application/vnd.ibexa.api.FieldDefinitionList+xml: schema: $ref: '#/components/schemas/FieldDefinitions' '404': description: Error - The content type draft does not exist. summary: Get Draft Field definition list description: Returns all Field definitions of the provided content type Draft. parameters: - name: contentTypeId in: path description: ContentTypeDraftFieldDefinitionListController identifier required: true deprecated: false schema: type: string style: simple explode: false post: operationId: ibexa.rest.add_content_type_draft_field_definition tags: - Type responses: '201': description: Field definition created. content: application/vnd.ibexa.api.FieldDefinition+json: schema: $ref: '#/components/schemas/FieldDefinitionWrapper' example: FieldDefinition: _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/195 id: 195 identifier: image fieldType: ibexa_image_asset fieldGroup: content position: 7 isTranslatable: false isRequired: false isInfoCollector: false defaultValue: destinationContentId: null alternativeText: null source: null isSearchable: false names: value: - _languageCode: eng-GB '#text': Image descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] application/vnd.ibexa.api.FieldDefinition+xml: schema: $ref: '#/components/schemas/FieldDefinition' example: | <?xml version="1.0" encoding="UTF-8"?> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/14/draft/fieldDefinitions/221"> <id>221</id> <identifier>name2</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>0</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names/> <descriptions/> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">32</value> <value key="minStringLength">8</value> </value> </validatorConfiguration> </FieldDefinition> '400': description: Error - The input does not match the input schema definition or validation on the Field definition fails. '401': description: Error - The user is not authorized to add a Field definition. '403': description: Error - A Field definition with the same identifier already exists in the given content type. The Field definition is of singular type, already existing in the given content type. The Field definition you want to add is of a type that can't be added to a content type that already has content instances. summary: Add content type Draft Field definition description: Creates a new Field definition for the given content type. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentTypeId in: path description: ContentTypeDraftFieldDefinitionAddController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The Field Definition Create schema encoded in XML or JSON format. content: application/vnd.ibexa.api.FieldDefinitionCreate+json: schema: $ref: '#/components/schemas/FieldDefinitionCreateWrapper' application/vnd.ibexa.api.FieldDefinitionCreate+xml: schema: $ref: '#/components/schemas/FieldDefinitionCreate' example: | <?xml version="1.0" encoding="UTF-8"?> <FieldDefinitionCreate> <identifier>name</identifier> <fieldType>ibexa_string</fieldType> <isRequired>true</isRequired> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">32</value> <value key="minStringLength">8</value> </value> </validatorConfiguration> </FieldDefinitionCreate> required: false /content/types/{contentTypeId}/draft/fieldDefinitions/{fieldDefinitionId}: get: operationId: ibexa.rest.load_content_type_draft_field_definition tags: - Type responses: '200': description: OK - returns the Field definition. content: application/vnd.ibexa.api.FieldDefinition+json: schema: $ref: '#/components/schemas/FieldDefinitionWrapper' example: FieldDefinition: _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/195 id: 195 identifier: image fieldType: ibexa_image_asset fieldGroup: content position: 7 isTranslatable: false isRequired: false isInfoCollector: false defaultValue: destinationContentId: null alternativeText: null source: null isSearchable: false names: value: - _languageCode: eng-GB '#text': Image descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] application/vnd.ibexa.api.FieldDefinition+xml: schema: $ref: '#/components/schemas/FieldDefinition' example: | <?xml version="1.0" encoding="UTF-8"?> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/195"> <id>195</id> <identifier>image</identifier> <fieldType>ibexa_image_asset</fieldType> <fieldGroup>content</fieldGroup> <position>7</position> <isTranslatable>false</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="destinationContentId"/> <value key="alternativeText"/> <value key="source"/> </defaultValue> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Image</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> '401': description: Error - The user is not authorized to read the content type draft. '404': description: Error - The content type or draft does not exist. summary: Get content type Draft Field definition description: Returns the Field definition by the given ID. parameters: - name: contentTypeId in: path description: ContentTypeDraftFieldDefinitionLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: fieldDefinitionId in: path description: ContentTypeDraftFieldDefinitionLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: ibexa.rest.remove_content_type_draft_field_definition tags: - Type responses: '204': description: No Content - Field definition deleted. '401': description: Error - The user is not authorized to delete this content type. '403': description: Error - There is no draft of the content type assigned to the authenticated user. summary: Delete content type Draft Field definition description: Deletes the provided Field definition. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentTypeId in: path description: ContentTypeDraftFieldDefinitionDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: fieldDefinitionId in: path description: ContentTypeDraftFieldDefinitionDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: ibexa.rest.update_content_type_draft_field_definition tags: - Type responses: '200': description: OK - attributes updated. content: application/vnd.ibexa.api.FieldDefinition+json: schema: $ref: '#/components/schemas/FieldDefinitionWrapper' example: FieldDefinition: _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/195 id: 195 identifier: image fieldType: ibexa_image_asset fieldGroup: content position: 7 isTranslatable: false isRequired: false isInfoCollector: false defaultValue: destinationContentId: null alternativeText: null source: null isSearchable: false names: value: - _languageCode: eng-GB '#text': Image descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] application/vnd.ibexa.api.FieldDefinition+xml: schema: $ref: '#/components/schemas/FieldDefinition' example: | <?xml version="1.0" encoding="UTF-8"?> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/15/draft/fieldDefinitions/197"> <id>197</id> <identifier>author</identifier> <fieldType>ibexa_author</fieldType> <fieldGroup>new_field_group</fieldGroup> <position>10</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Author</value> </names> <descriptions/> <fieldSettings> <value key="defaultAuthor">1</value> </fieldSettings> <validatorConfiguration/> </FieldDefinition> '400': description: Error - The input does not match the input schema definition. '401': description: Error - The user is not authorized to update the Field definition. '403': description: Error - A Field definition with the given identifier already exists in the given content type. summary: Update content type Draft Field definition description: Updates the attributes of a Field definition. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentTypeId in: path description: ContentTypeDraftFieldDefinitionUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: fieldDefinitionId in: path description: ContentTypeDraftFieldDefinitionUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The Field definition update schema encoded in XML or JSON format. content: application/vnd.ibexa.api.FieldDefinitionUpdate+json: schema: $ref: '#/components/schemas/FieldDefinitionUpdateWrapper' application/vnd.ibexa.api.FieldDefinitionUpdate+xml: schema: $ref: '#/components/schemas/FieldDefinitionUpdate' example: | <?xml version="1.0" encoding="UTF-8"?> <FieldDefinitionUpdate> <fieldGroup>new_field_group</fieldGroup> <position>10</position> </FieldDefinitionUpdate> required: false /content/types/{contentTypeId}/fieldDefinitions: get: operationId: ibexa.rest.load_content_type_field_definition_list tags: - Type responses: '200': description: OK - return a list of Field definitions. content: application/vnd.ibexa.api.FieldDefinitionList+json: schema: $ref: '#/components/schemas/FieldDefinitionsWrapper' application/vnd.ibexa.api.FieldDefinitionList+xml: schema: $ref: '#/components/schemas/FieldDefinitions' '404': description: Error - The content type does not exist. summary: Get Field definition list description: Returns all Field definitions of the provided content type. parameters: - name: contentTypeId in: path description: ContentTypeFieldDefinitionListController identifier required: true deprecated: false schema: type: string style: simple explode: false /content/types/{contentTypeId}/fieldDefinitions/{fieldDefinitionId}: get: operationId: ibexa.rest.load_content_type_field_definition tags: - Type responses: '200': description: OK - returns the Field definition. content: application/vnd.ibexa.api.FieldDefinition+json: schema: $ref: '#/components/schemas/FieldDefinitionWrapper' example: FieldDefinition: _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/195 id: 195 identifier: image fieldType: ibexa_image_asset fieldGroup: content position: 7 isTranslatable: false isRequired: false isInfoCollector: false defaultValue: destinationContentId: null alternativeText: null source: null isSearchable: false names: value: - _languageCode: eng-GB '#text': Image descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] application/vnd.ibexa.api.FieldDefinition+xml: schema: $ref: '#/components/schemas/FieldDefinition' example: | <?xml version="1.0" encoding="UTF-8"?> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/195"> <id>195</id> <identifier>image</identifier> <fieldType>ibexa_image_asset</fieldType> <fieldGroup>content</fieldGroup> <position>7</position> <isTranslatable>false</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="destinationContentId"/> <value key="alternativeText"/> <value key="source"/> </defaultValue> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Image</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> '401': description: Error - The user is not authorized to read the content type. '404': description: Error - The content type does not exist. summary: Get Field definition description: Returns the Field definition by the given ID. parameters: - name: contentTypeId in: path description: ContentTypeFieldDefinitionLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: fieldDefinitionId in: path description: ContentTypeFieldDefinitionLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false /content/types/{contentTypeId}/groups: get: operationId: ibexa.rest.load_groups_of_content_type tags: - Type responses: '200': description: If set, the content type group list is returned in XML or JSON format. content: application/vnd.ibexa.api.ContentTypeGroupRefList+json: schema: $ref: '#/components/schemas/ContentTypeGroupRefListWrapper' example: ContentTypeGroupRefList: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/typegroups/2/types ContentTypeGroupRef: - _media-type: application/vnd.ibexa.api.ContentTypeGroup+json _href: /api/ibexa/v2/content/typegroups/1 application/vnd.ibexa.api.ContentTypeGroupRefList+xml: schema: $ref: '#/components/schemas/ContentTypeGroupRefList' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentTypeGroupRefList media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/typegroups/2/types"> <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/1"/> </ContentTypeGroupRefList> '401': description: Error - The user is not authorized to read this content type. '404': description: Error - The content type does not exist. summary: Get groups of content type description: Returns the content type group to which content type belongs to. parameters: - name: contentTypeId in: path description: ContentTypeGroupListController identifier required: true deprecated: false schema: type: string style: simple explode: false post: operationId: ibexa.rest.link_content_type_to_group tags: - Type responses: '200': description: If set, the updated content type group list is returned in XML or JSON format. content: application/vnd.ibexa.api.ContentTypeGroupRefList+json: schema: $ref: '#/components/schemas/ContentTypeGroupRefListWrapper' example: ContentTypeGroupRefList: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/typegroups/2/types ContentTypeGroupRef: - _media-type: application/vnd.ibexa.api.ContentTypeGroup+json _href: /api/ibexa/v2/content/typegroups/1 unlink: _href: /api/ibexa/v2/content/types/2/groups/1 _method: DELETE - _media-type: application/vnd.ibexa.api.ContentTypeGroup+json _href: /api/ibexa/v2/content/typegroups/2 unlink: _href: /api/ibexa/v2/content/types/2/groups/2 _method: DELETE application/vnd.ibexa.api.ContentTypeGroupRefList+xml: schema: $ref: '#/components/schemas/ContentTypeGroupRefList' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentTypeGroupRefList media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/typegroups/15/types"> <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/1"> <unlink href="/api/ibexa/v2/content/types/15/groups/1" method="DELETE"/> </ContentTypeGroupRef> <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/3"> <unlink href="/api/ibexa/v2/content/types/15/groups/3" method="DELETE"/> </ContentTypeGroupRef> <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/2"> <unlink href="/api/ibexa/v2/content/types/15/groups/2" method="DELETE"/> </ContentTypeGroupRef> </ContentTypeGroupRefList> '400': description: Error - The input does not match the input schema definition. '401': description: Error - The user is not authorized to add a group. '403': description: Error - The content type is already assigned to the group. summary: Link group to content type description: Links a content type group to the content type and returns the updated group list. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentTypeId in: path description: ContentTypeLinkToGroupController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: group in: query description: 'Destination content type group URI; for example with content type group 4: `?group=/api/ibexa/v2/content/typegroups/4`' required: true deprecated: false schema: type: string style: form explode: false requestBody: description: No payload required content: {} required: false /content/types/{contentTypeId}/groups/{id}: delete: operationId: ibexa.rest.unlink_content_type_from_group tags: - Type responses: '200': description: If set, the updated content type group list is returned in XML or JSON format. content: application/vnd.ibexa.api.ContentTypeGroupRefList+json: schema: $ref: '#/components/schemas/ContentTypeGroupRefListWrapper' example: ContentTypeGroupRefList: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/typegroups/2/types ContentTypeGroupRef: - _media-type: application/vnd.ibexa.api.ContentTypeGroup+json _href: /api/ibexa/v2/content/typegroups/1 unlink: _href: /api/ibexa/v2/content/types/2/groups/1 _method: DELETE - _media-type: application/vnd.ibexa.api.ContentTypeGroup+json _href: /api/ibexa/v2/content/typegroups/2 unlink: _href: /api/ibexa/v2/content/types/2/groups/2 _method: DELETE application/vnd.ibexa.api.ContentTypeGroupRefList+xml: schema: $ref: '#/components/schemas/ContentTypeGroupRefList' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentTypeGroupRefList media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/typegroups/15/types"> <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/1"> <unlink href="/api/ibexa/v2/content/types/15/groups/1" method="DELETE"/> </ContentTypeGroupRef> <ContentTypeGroupRef media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/2"> <unlink href="/api/ibexa/v2/content/types/15/groups/2" method="DELETE"/> </ContentTypeGroupRef> </ContentTypeGroupRefList> '204': description: ContentTypeUnlinkFromGroupController resource deleted '401': description: Error - The user is not authorized to delete this content type. '403': description: Error - content type cannot be unlinked from the only remaining group. '404': description: Error - The resource does not exist. summary: Unlink group from content type description: Removes the given group from the content type and returns the updated group list. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentTypeId in: path description: ContentTypeUnlinkFromGroupController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: id in: path description: ContentTypeUnlinkFromGroupController identifier required: true deprecated: false schema: type: string style: simple explode: false /content/typegroups: get: operationId: ibexa.rest.load_content_type_group_list tags: - Type Groups responses: '200': description: OK - returns a list of content type groups. content: application/vnd.ibexa.api.ContentTypeGroupList+json: schema: $ref: '#/components/schemas/ContentTypeGroupListWrapper' example: ContentTypeGroupList: _media-type: application/vnd.ibexa.api.ContentTypeGroupList+json _href: /api/ibexa/v2/content/typegroups ContentTypeGroup: - _media-type: application/vnd.ibexa.api.ContentTypeGroup+json _href: /api/ibexa/v2/content/typegroups/1 id: 1 identifier: Content created: '2002-09-05T09:08:48+00:00' modified: '2002-10-06T16:35:06+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 ContentTypes: _media-type: application/vnd.ibexa.api.ContentTypeInfoList+json _href: /api/ibexa/v2/content/typegroups/1/types - _media-type: application/vnd.ibexa.api.ContentTypeGroup+json _href: /api/ibexa/v2/content/typegroups/2 id: 2 identifier: Users created: '2002-09-05T09:09:01+00:00' modified: '2002-10-06T16:35:13+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 ContentTypes: _media-type: application/vnd.ibexa.api.ContentTypeInfoList+json _href: /api/ibexa/v2/content/typegroups/2/types - _media-type: application/vnd.ibexa.api.ContentTypeGroup+json _href: /api/ibexa/v2/content/typegroups/3 id: 3 identifier: Media created: '2002-09-14T13:22:23+00:00' modified: '2002-10-06T16:35:20+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 ContentTypes: _media-type: application/vnd.ibexa.api.ContentTypeInfoList+json _href: /api/ibexa/v2/content/typegroups/3/types application/vnd.ibexa.api.ContentTypeGroupList+xml: schema: $ref: '#/components/schemas/ContentTypeGroupList' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentTypeGroupList media-type="application/vnd.ibexa.api.ContentTypeGroupList+xml" href="/api/ibexa/v2/content/typegroups"> <ContentTypeGroup media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/1"> <id>1</id> <identifier>Content</identifier> <created>2002-09-05T11:08:48+02:00</created> <modified>2002-10-06T18:35:06+02:00</modified> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <ContentTypes media-type="application/vnd.ibexa.api.ContentTypeInfoList+xml" href="/api/ibexa/v2/content/typegroups/1/types"/> </ContentTypeGroup> <ContentTypeGroup media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/2"> <id>2</id> <identifier>Users</identifier> <created>2002-09-05T11:09:01+02:00</created> <modified>2002-10-06T18:35:13+02:00</modified> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <ContentTypes media-type="application/vnd.ibexa.api.ContentTypeInfoList+xml" href="/api/ibexa/v2/content/typegroups/2/types"/> </ContentTypeGroup> <ContentTypeGroup media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/3"> <id>3</id> <identifier>Media</identifier> <created>2002-09-14T15:22:23+02:00</created> <modified>2002-10-06T18:35:20+02:00</modified> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <ContentTypes media-type="application/vnd.ibexa.api.ContentTypeInfoList+xml" href="/api/ibexa/v2/content/typegroups/3/types"/> </ContentTypeGroup> </ContentTypeGroupList> '307': description: Temporary redirect. '401': description: Error - The user has no permission to read content types. '404': description: Error - The content type group with the given identifier does not exist. summary: Get content type groups description: Returns a list of all content type groups. If an identifier is provided, loads the content type group for this identifier. parameters: [] post: operationId: ibexa.rest.create_content_type_group tags: - Type Groups responses: '201': description: Content type group created. content: application/vnd.ibexa.api.ContentTypeGroup+json: schema: $ref: '#/components/schemas/ContentTypeGroupWrapper' example: ContentTypeGroup: _media-type: application/vnd.ibexa.api.ContentTypeGroup+json _href: /api/ibexa/v2/content/typegroups/6 id: 6 identifier: newContentTypeGroup created: '2021-08-11T09:44:18+00:00' modified: '2021-08-11T09:44:18+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 ContentTypes: _media-type: application/vnd.ibexa.api.ContentTypeInfoList+json _href: /api/ibexa/v2/content/typegroups/6/types application/vnd.ibexa.api.ContentTypeGroup+xml: schema: $ref: '#/components/schemas/ContentTypeGroup' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentTypeGroup href="/content/typesgroups/7" media-type="application/vnd.ibexa.api.ContentTypeGroup+xml"> <id>7</id> <identifier>newContentTypeGroup</identifier> <created>2012-02-31T12:45:00</created> <modified>2012-02-31T12:45:00</modified> <Creator href="/user/users/13" media-type="application/vnd.ibexa.api.User+xml"/> <Modifier href="/user/users/13" media-type="application/vnd.ibexa.api.User+xml"/> <ContentTypes href="/content/typegroups/7/types" media-type="application/vnd.ibexa.api.ContentTypeList+xml"/> </ContentTypeGroup> '400': description: Error - The input does not match the input schema definition. '401': description: Error - The user is not authorized to create this content type group. '403': description: Error - A content type group with the same identifier already exists. summary: Create content type group description: Creates a new content type group. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The content type group input schema encoded in XML or JSON. content: application/vnd.ibexa.api.ContentTypeGroupInput+json: schema: $ref: '#/components/schemas/ContentTypeGroupInputWrapper' example: ContentTypeGroupInput: identifier: newContentTypeGroup application/vnd.ibexa.api.ContentTypeGroupInput+xml: schema: $ref: '#/components/schemas/ContentTypeGroupInput' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentTypeGroupInput> <identifier>newContentTypeGroup</identifier> </ContentTypeGroupInput> required: false /content/typegroups/{contentTypeGroupId}: get: operationId: ibexa.rest.load_content_type_group tags: - Type Groups responses: '200': description: OK - returns the content type group. content: application/vnd.ibexa.api.ContentTypeGroup+json: schema: $ref: '#/components/schemas/ContentTypeListWrapper' example: ContentTypeList: _media-type: application/vnd.ibexa.api.ContentTypeList+json _href: /api/ibexa/v2/content/typegroups/1/types ContentType: - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2 id: 2 status: DEFINED identifier: article names: value: - _languageCode: eng-GB '#text': Article descriptions: value: - _languageCode: eng-GB '#text': null creationDate: '2002-06-18T09:21:38+00:00' modificationDate: '2021-06-28T11:31:22+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/2/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2/draft remoteId: c15b600eb9198b1924063b5a68758232 urlAliasSchema: '' nameSchema: <short_title|title> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: false defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/1 id: 1 identifier: title fieldType: ibexa_string fieldGroup: '' position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: New article isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/152 id: 152 identifier: short_title fieldType: ibexa_string fieldGroup: '' position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Short title descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/153 id: 153 identifier: author fieldType: ibexa_author fieldGroup: '' position: 3 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: [] isSearchable: false names: value: - _languageCode: eng-GB '#text': Author descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: defaultAuthor: 1 validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/120 id: 120 identifier: intro fieldType: ibexa_richtext fieldGroup: '' position: 4 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Intro descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/121 id: 121 identifier: body fieldType: ibexa_richtext fieldGroup: '' position: 5 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Body descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/123 id: 123 identifier: enable_comments fieldType: ibexa_boolean fieldGroup: '' position: 6 isTranslatable: false isRequired: false isInfoCollector: false defaultValue: false isSearchable: false names: value: - _languageCode: eng-GB '#text': Enable comments descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/195 id: 195 identifier: image fieldType: ibexa_image_asset fieldGroup: content position: 7 isTranslatable: false isRequired: false isInfoCollector: false defaultValue: destinationContentId: null alternativeText: null source: null isSearchable: false names: value: - _languageCode: eng-GB '#text': Image descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/50 id: 50 status: DEFINED identifier: copy_of_article_50 names: value: - _languageCode: eng-GB '#text': Article descriptions: value: - _languageCode: eng-GB '#text': null creationDate: '2021-07-14T10:30:00+00:00' modificationDate: '2021-07-14T10:30:00+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/50/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/50/draft remoteId: fc9434492469d136ffe13377bfdcbb28 urlAliasSchema: '' nameSchema: <short_title|title> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: false defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/50/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/50/fieldDefinitions/197 id: 197 identifier: title fieldType: ibexa_string fieldGroup: '' position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: New article isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/50/fieldDefinitions/198 id: 198 identifier: short_title fieldType: ibexa_string fieldGroup: '' position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Short title descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/50/fieldDefinitions/199 id: 199 identifier: author fieldType: ibexa_author fieldGroup: '' position: 3 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: [] isSearchable: false names: value: - _languageCode: eng-GB '#text': Author descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: defaultAuthor: 1 validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/50/fieldDefinitions/200 id: 200 identifier: intro fieldType: ibexa_richtext fieldGroup: '' position: 4 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Intro descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/50/fieldDefinitions/201 id: 201 identifier: body fieldType: ibexa_richtext fieldGroup: '' position: 5 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Body descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/50/fieldDefinitions/202 id: 202 identifier: enable_comments fieldType: ibexa_boolean fieldGroup: '' position: 6 isTranslatable: false isRequired: false isInfoCollector: false defaultValue: false isSearchable: false names: value: - _languageCode: eng-GB '#text': Enable comments descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/50/fieldDefinitions/203 id: 203 identifier: image fieldType: ibexa_image_asset fieldGroup: content position: 7 isTranslatable: false isRequired: false isInfoCollector: false defaultValue: destinationContentId: null alternativeText: null source: null isSearchable: false names: value: - _languageCode: eng-GB '#text': Image descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/44 id: 44 status: DEFINED identifier: dog_breed names: value: - _languageCode: eng-GB '#text': Dog Breed descriptions: value: - _languageCode: eng-GB '#text': null creationDate: '2021-06-28T11:28:00+00:00' modificationDate: '2021-06-28T11:29:02+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/44/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/44/draft remoteId: b348c95f7c573d4d502d6b59f80e618a urlAliasSchema: '' nameSchema: <name> isContainer: false mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PUBLISHED defaultSortOrder: DESC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/44/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/44/fieldDefinitions/190 id: 190 identifier: name fieldType: ibexa_string fieldGroup: content position: 1 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Name descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: null minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/44/fieldDefinitions/191 id: 191 identifier: photo fieldType: ibexa_image_asset fieldGroup: content position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: destinationContentId: null alternativeText: null source: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Photo descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/44/fieldDefinitions/192 id: 192 identifier: description fieldType: ibexa_richtext fieldGroup: content position: 3 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Full Description descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/1 id: 1 status: DEFINED identifier: folder names: value: - _languageCode: eng-GB '#text': Folder descriptions: value: [] creationDate: '2002-06-18T09:21:38+00:00' modificationDate: '2015-11-29T21:14:32+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/1/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/1/draft remoteId: a3d405b81be900468eb153d774f4f0d2 urlAliasSchema: null nameSchema: <short_name|name> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions/4 id: 4 identifier: name fieldType: ibexa_string fieldGroup: '' position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: Folder isSearchable: true names: value: - _languageCode: eng-GB '#text': Name descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions/155 id: 155 identifier: short_name fieldType: ibexa_string fieldGroup: '' position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Short name descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 100 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions/119 id: 119 identifier: short_description fieldType: ibexa_richtext fieldGroup: '' position: 3 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Short description descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions/156 id: 156 identifier: description fieldType: ibexa_richtext fieldGroup: '' position: 4 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Description descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/55 id: 55 status: DEFINED identifier: folder_55 names: value: - _languageCode: eng-GB '#text': Folder descriptions: value: - _languageCode: eng-GB '#text': null creationDate: '2021-07-28T07:57:22+00:00' modificationDate: '2021-07-28T07:57:34+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/55/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/55/draft remoteId: 4eb7bc76f6d0bd1d5ded2d8936cc6afb urlAliasSchema: '' nameSchema: <short_name|name> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/55/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/55/fieldDefinitions/210 id: 210 identifier: name fieldType: ibexa_string fieldGroup: '' position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: Folder isSearchable: true names: value: - _languageCode: eng-GB '#text': Name descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/55/fieldDefinitions/211 id: 211 identifier: short_name fieldType: ibexa_string fieldGroup: '' position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Short name descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 100 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/55/fieldDefinitions/212 id: 212 identifier: short_description fieldType: ibexa_richtext fieldGroup: '' position: 3 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Short description descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/55/fieldDefinitions/213 id: 213 identifier: description fieldType: ibexa_richtext fieldGroup: '' position: 4 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Description descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/43 id: 43 status: DEFINED identifier: form names: value: - _languageCode: eng-GB '#text': Form descriptions: value: [] creationDate: '2018-09-17T06:46:13+00:00' modificationDate: '2018-09-17T06:47:14+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/43/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/43/draft remoteId: 6f7f21df775a33c1e4bbc76b48c38476 urlAliasSchema: '' nameSchema: <title> isContainer: false mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PUBLISHED defaultSortOrder: DESC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/43/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/43/fieldDefinitions/188 id: 188 identifier: title fieldType: ibexa_string fieldGroup: content position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: null minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/43/fieldDefinitions/189 id: 189 identifier: form fieldType: ibexa_form fieldGroup: content position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: fields: [] content_id: null content_field_id: null language_code: null isSearchable: false names: value: - _languageCode: eng-GB '#text': Form descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/45 id: 45 status: DEFINED identifier: tip names: value: - _languageCode: eng-GB '#text': Tip descriptions: value: - _languageCode: eng-GB '#text': null creationDate: '2021-06-28T11:29:19+00:00' modificationDate: '2021-07-26T09:33:06+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/45/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/45/draft remoteId: e6490e8a785edacd48629f2022be3125 urlAliasSchema: '' nameSchema: <title> isContainer: false mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PUBLISHED defaultSortOrder: DESC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/45/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/45/fieldDefinitions/193 id: 193 identifier: title fieldType: ibexa_string fieldGroup: content position: 1 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: null minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/45/fieldDefinitions/194 id: 194 identifier: body fieldType: ibexa_text fieldGroup: content position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Body descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: textRows: 10 validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/45/fieldDefinitions/204 id: 204 identifier: richtext fieldType: ibexa_richtext fieldGroup: content position: 3 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': richtext descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/42 id: 42 status: DEFINED identifier: landing_page names: value: - _languageCode: eng-GB '#text': Landing page descriptions: value: - _languageCode: eng-GB '#text': '' creationDate: '2015-07-03T12:00:26+00:00' modificationDate: '2015-07-03T12:00:26+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/42/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/42/draft remoteId: 60c03e9758465eb69d56b3afb6adf18e urlAliasSchema: '' nameSchema: <name> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PUBLISHED defaultSortOrder: DESC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/42/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/42/fieldDefinitions/185 id: 185 identifier: name fieldType: ibexa_string fieldGroup: content position: 10 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: - _languageCode: eng-GB '#text': Title fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: null minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/42/fieldDefinitions/186 id: 186 identifier: description fieldType: ibexa_string fieldGroup: content position: 20 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Description descriptions: value: - _languageCode: eng-GB '#text': Landing page description fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: null minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/42/fieldDefinitions/187 id: 187 identifier: page fieldType: ibexa_landing_page fieldGroup: content position: 30 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: layout: default zones: - id: default_id name: default blocks: [] isSearchable: false names: value: - _languageCode: eng-GB '#text': Landing page descriptions: value: - _languageCode: eng-GB '#text': Landing page fieldSettings: availableBlocks: null availableLayouts: null editorMode: page_view_mode validatorConfiguration: [] application/vnd.ibexa.api.ContentTypeGroup+xml: schema: $ref: '#/components/schemas/ContentTypeList' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentTypeList media-type="application/vnd.ibexa.api.ContentTypeList+xml" href="/api/ibexa/v2/content/typegroups/1/types"> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"> <id>2</id> <status>DEFINED</status> <identifier>article</identifier> <names> <value languageCode="eng-GB">Article</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <creationDate>2002-06-18T09:21:38+00:00</creationDate> <modificationDate>2021-06-28T11:31:22+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2/draft"/> <remoteId>c15b600eb9198b1924063b5a68758232</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><short_title|title></nameSchema> <isContainer>true</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>false</defaultAlwaysAvailable> <defaultSortField>PATH</defaultSortField> <defaultSortOrder>ASC</defaultSortOrder> <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions"> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/1"> <id>1</id> <identifier>title</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>1</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue>New article</defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Title</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">255</value> <value key="minStringLength"/> </value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/152"> <id>152</id> <identifier>short_title</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>2</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Short title</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">255</value> <value key="minStringLength"/> </value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/153"> <id>153</id> <identifier>author</identifier> <fieldType>ibexa_author</fieldType> <fieldGroup></fieldGroup> <position>3</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Author</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings> <value key="defaultAuthor">1</value> </fieldSettings> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/120"> <id>120</id> <identifier>intro</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup></fieldGroup> <position>4</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Intro</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/121"> <id>121</id> <identifier>body</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup></fieldGroup> <position>5</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Body</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/123"> <id>123</id> <identifier>enable_comments</identifier> <fieldType>ibexa_boolean</fieldType> <fieldGroup></fieldGroup> <position>6</position> <isTranslatable>false</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue>false</defaultValue> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Enable comments</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/195"> <id>195</id> <identifier>image</identifier> <fieldType>ibexa_image_asset</fieldType> <fieldGroup>content</fieldGroup> <position>7</position> <isTranslatable>false</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="destinationContentId"/> <value key="alternativeText"/> <value key="source"/> </defaultValue> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Image</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> </FieldDefinitions> </ContentType> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/50"> <id>50</id> <status>DEFINED</status> <identifier>copy_of_article_50</identifier> <names> <value languageCode="eng-GB">Article</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <creationDate>2021-07-14T10:30:00+00:00</creationDate> <modificationDate>2021-07-14T10:30:00+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/50/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/50/draft"/> <remoteId>fc9434492469d136ffe13377bfdcbb28</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><short_title|title></nameSchema> <isContainer>true</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>false</defaultAlwaysAvailable> <defaultSortField>PATH</defaultSortField> <defaultSortOrder>ASC</defaultSortOrder> <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions"> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/197"> <id>197</id> <identifier>title</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>1</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue>New article</defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Title</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">255</value> <value key="minStringLength"/> </value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/198"> <id>198</id> <identifier>short_title</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>2</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Short title</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">255</value> <value key="minStringLength"/> </value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/199"> <id>199</id> <identifier>author</identifier> <fieldType>ibexa_author</fieldType> <fieldGroup></fieldGroup> <position>3</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Author</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings> <value key="defaultAuthor">1</value> </fieldSettings> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/200"> <id>200</id> <identifier>intro</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup></fieldGroup> <position>4</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Intro</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/201"> <id>201</id> <identifier>body</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup></fieldGroup> <position>5</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Body</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/202"> <id>202</id> <identifier>enable_comments</identifier> <fieldType>ibexa_boolean</fieldType> <fieldGroup></fieldGroup> <position>6</position> <isTranslatable>false</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue>false</defaultValue> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Enable comments</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/50/fieldDefinitions/203"> <id>203</id> <identifier>image</identifier> <fieldType>ibexa_image_asset</fieldType> <fieldGroup>content</fieldGroup> <position>7</position> <isTranslatable>false</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="destinationContentId"/> <value key="alternativeText"/> <value key="source"/> </defaultValue> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Image</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> </FieldDefinitions> </ContentType> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/44"> <id>44</id> <status>DEFINED</status> <identifier>dog_breed</identifier> <names> <value languageCode="eng-GB">Dog Breed</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <creationDate>2021-06-28T11:28:00+00:00</creationDate> <modificationDate>2021-06-28T11:29:02+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/44/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/44/draft"/> <remoteId>b348c95f7c573d4d502d6b59f80e618a</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><name></nameSchema> <isContainer>false</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>true</defaultAlwaysAvailable> <defaultSortField>PUBLISHED</defaultSortField> <defaultSortOrder>DESC</defaultSortOrder> <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/44/fieldDefinitions"> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/44/fieldDefinitions/190"> <id>190</id> <identifier>name</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup>content</fieldGroup> <position>1</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Name</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength"/> <value key="minStringLength"/> </value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/44/fieldDefinitions/191"> <id>191</id> <identifier>photo</identifier> <fieldType>ibexa_image_asset</fieldType> <fieldGroup>content</fieldGroup> <position>2</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="destinationContentId"/> <value key="alternativeText"/> <value key="source"/> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Photo</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/44/fieldDefinitions/192"> <id>192</id> <identifier>description</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup>content</fieldGroup> <position>3</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Full Description</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> </FieldDefinitions> </ContentType> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"> <id>1</id> <status>DEFINED</status> <identifier>folder</identifier> <names> <value languageCode="eng-GB">Folder</value> </names> <descriptions/> <creationDate>2002-06-18T09:21:38+00:00</creationDate> <modificationDate>2015-11-29T21:14:32+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/1/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1/draft"/> <remoteId>a3d405b81be900468eb153d774f4f0d2</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><short_name|name></nameSchema> <isContainer>true</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>true</defaultAlwaysAvailable> <defaultSortField>PATH</defaultSortField> <defaultSortOrder>ASC</defaultSortOrder> <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions"> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/4"> <id>4</id> <identifier>name</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>1</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue>Folder</defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Name</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">255</value> <value key="minStringLength"/> </value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/155"> <id>155</id> <identifier>short_name</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>2</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Short name</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">100</value> <value key="minStringLength"/> </value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/119"> <id>119</id> <identifier>short_description</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup></fieldGroup> <position>3</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Short description</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/156"> <id>156</id> <identifier>description</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup></fieldGroup> <position>4</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Description</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> </FieldDefinitions> </ContentType> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/55"> <id>55</id> <status>DEFINED</status> <identifier>folder_55</identifier> <names> <value languageCode="eng-GB">Folder</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <creationDate>2021-07-28T07:57:22+00:00</creationDate> <modificationDate>2021-07-28T07:57:34+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/55/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/55/draft"/> <remoteId>4eb7bc76f6d0bd1d5ded2d8936cc6afb</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><short_name|name></nameSchema> <isContainer>true</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>true</defaultAlwaysAvailable> <defaultSortField>PATH</defaultSortField> <defaultSortOrder>ASC</defaultSortOrder> <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/55/fieldDefinitions"> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/55/fieldDefinitions/210"> <id>210</id> <identifier>name</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>1</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue>Folder</defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Name</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">255</value> <value key="minStringLength"/> </value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/55/fieldDefinitions/211"> <id>211</id> <identifier>short_name</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>2</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Short name</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">100</value> <value key="minStringLength"/> </value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/55/fieldDefinitions/212"> <id>212</id> <identifier>short_description</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup></fieldGroup> <position>3</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Short description</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/55/fieldDefinitions/213"> <id>213</id> <identifier>description</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup></fieldGroup> <position>4</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Description</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> </FieldDefinitions> </ContentType> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/43"> <id>43</id> <status>DEFINED</status> <identifier>form</identifier> <names> <value languageCode="eng-GB">Form</value> </names> <descriptions/> <creationDate>2018-09-17T06:46:13+00:00</creationDate> <modificationDate>2018-09-17T06:47:14+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/43/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/43/draft"/> <remoteId>6f7f21df775a33c1e4bbc76b48c38476</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><title></nameSchema> <isContainer>false</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>true</defaultAlwaysAvailable> <defaultSortField>PUBLISHED</defaultSortField> <defaultSortOrder>DESC</defaultSortOrder> <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions"> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions/188"> <id>188</id> <identifier>title</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup>content</fieldGroup> <position>1</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Title</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength"/> <value key="minStringLength"/> </value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/43/fieldDefinitions/189"> <id>189</id> <identifier>form</identifier> <fieldType>ibexa_form</fieldType> <fieldGroup>content</fieldGroup> <position>2</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="fields"/> <value key="content_id"/> <value key="content_field_id"/> <value key="language_code"/> </defaultValue> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Form</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> </FieldDefinitions> </ContentType> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/45"> <id>45</id> <status>DEFINED</status> <identifier>tip</identifier> <names> <value languageCode="eng-GB">Tip</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <creationDate>2021-06-28T11:29:19+00:00</creationDate> <modificationDate>2021-07-26T09:33:06+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/45/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/45/draft"/> <remoteId>e6490e8a785edacd48629f2022be3125</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><title></nameSchema> <isContainer>false</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>true</defaultAlwaysAvailable> <defaultSortField>PUBLISHED</defaultSortField> <defaultSortOrder>DESC</defaultSortOrder> <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/45/fieldDefinitions"> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/45/fieldDefinitions/193"> <id>193</id> <identifier>title</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup>content</fieldGroup> <position>1</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Title</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength"/> <value key="minStringLength"/> </value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/45/fieldDefinitions/194"> <id>194</id> <identifier>body</identifier> <fieldType>ibexa_text</fieldType> <fieldGroup>content</fieldGroup> <position>2</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Body</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings> <value key="textRows">10</value> </fieldSettings> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/45/fieldDefinitions/204"> <id>204</id> <identifier>richtext</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup>content</fieldGroup> <position>3</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">richtext</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> </FieldDefinitions> </ContentType> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/42"> <id>42</id> <status>DEFINED</status> <identifier>landing_page</identifier> <names> <value languageCode="eng-GB">Landing page</value> </names> <descriptions> <value languageCode="eng-GB"></value> </descriptions> <creationDate>2015-07-03T12:00:26+00:00</creationDate> <modificationDate>2015-07-03T12:00:26+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/42/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/42/draft"/> <remoteId>60c03e9758465eb69d56b3afb6adf18e</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><name></nameSchema> <isContainer>true</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>true</defaultAlwaysAvailable> <defaultSortField>PUBLISHED</defaultSortField> <defaultSortOrder>DESC</defaultSortOrder> <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions"> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/185"> <id>185</id> <identifier>name</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup>content</fieldGroup> <position>10</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Title</value> </names> <descriptions> <value languageCode="eng-GB">Title</value> </descriptions> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength"/> <value key="minStringLength"/> </value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/186"> <id>186</id> <identifier>description</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup>content</fieldGroup> <position>20</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Description</value> </names> <descriptions> <value languageCode="eng-GB">Landing page description</value> </descriptions> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength"/> <value key="minStringLength"/> </value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/42/fieldDefinitions/187"> <id>187</id> <identifier>page</identifier> <fieldType>ibexa_landing_page</fieldType> <fieldGroup>content</fieldGroup> <position>30</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="layout">default</value> <value key="zones"> <value> <value key="id">default_id</value> <value key="name">default</value> <value key="blocks"/> </value> </value> </defaultValue> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Landing page</value> </names> <descriptions> <value languageCode="eng-GB">Landing page</value> </descriptions> <fieldSettings> <value key="availableBlocks"/> <value key="availableLayouts"/> <value key="editorMode">page_view_mode</value> </fieldSettings> <validatorConfiguration/> </FieldDefinition> </FieldDefinitions> </ContentType> </ContentTypeList> '401': description: Error - The user is not authorized to read this content type group. '404': description: Error - The content type group does not exist. summary: Get content type group description: Returns the content type group with provided ID. parameters: - name: If-None-Match in: header description: ETag required: false deprecated: false schema: type: string style: simple explode: false - name: contentTypeGroupId in: path description: ContentTypeGroupLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: ibexa.rest.delete_content_type_group tags: - Type Groups responses: '204': description: No Content - content type group deleted. '401': description: Error - The user is not authorized to delete this content type group. '403': description: Error - The content type group is not empty. '404': description: Error - The content type group does not exist. summary: Delete content type group description: Deletes the provided content type group. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentTypeGroupId in: path description: ContentTypeGroupDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: ibexa.rest.update_content_type_group tags: - Type Groups responses: '200': description: Content type group updated. content: application/vnd.ibexa.api.ContentTypeGroup+json: schema: $ref: '#/components/schemas/ContentTypeGroupWrapper' example: ContentTypeGroup: _media-type: application/vnd.ibexa.api.ContentTypeGroup+json _href: /api/ibexa/v2/content/typegroups/4 id: 4 identifier: updatedIdentifer created: '2021-08-11T09:44:18+00:00' modified: '2021-08-11T10:10:04+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 ContentTypes: _media-type: application/vnd.ibexa.api.ContentTypeInfoList+json _href: /api/ibexa/v2/content/typegroups/6/types application/vnd.ibexa.api.ContentTypeGroup+xml: schema: $ref: '#/components/schemas/ContentTypeGroup' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentTypeGroup media-type="application/vnd.ibexa.api.ContentTypeGroup+xml" href="/api/ibexa/v2/content/typegroups/1"> <id>4</id> <identifier>updatedIdentifer</identifier> <created>2002-09-05T11:08:48+02:00</created> <modified>2019-02-22T14:42:55+01:00</modified> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <ContentTypes media-type="application/vnd.ibexa.api.ContentTypeInfoList+xml" href="/api/ibexa/v2/content/typegroups/1/types"/> </ContentTypeGroup> '400': description: Error - The input does not match the input schema definition. '401': description: Error - The user is not authorized to create this content type group. '403': description: Error - A content type group with the given identifier already exists. '412': description: Error - The current ETag does not match the one provided in the If-Match header. summary: Update content type group description: Updates a content type group. PATCH or POST with header X-HTTP-Method-Override PATCH. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: If-Match in: header description: ETag causes patching only if the specified ETag is the current one. Otherwise a 412 is returned. required: true deprecated: false schema: type: string style: simple explode: false - name: contentTypeGroupId in: path description: ContentTypeGroupUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The content type group input schema encoded in XML or JSON format. content: application/vnd.ibexa.api.ContentTypeGroupInput+json: schema: $ref: '#/components/schemas/ContentTypeGroupInputWrapper' example: ContentTypeGroupInput: identifier: updatedIdentifer application/vnd.ibexa.api.ContentTypeGroupInput+xml: schema: $ref: '#/components/schemas/ContentTypeGroupInput' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentTypeGroupInput> <identifier>updatedIdentifer</identifier> </ContentTypeGroupInput> required: false /content/typegroups/{contentTypeGroupId}/types: get: operationId: ibexa.rest.list_content_types_for_group tags: - Type Groups responses: '200': description: OK - returns a list on content types. content: application/vnd.ibexa.api.ContentTypeInfoList+json: schema: $ref: '#/components/schemas/ContentTypeInfoListWrapper' example: ContentTypeList: _media-type: application/vnd.ibexa.api.ContentTypeList+json _href: /api/ibexa/v2/content/types ContentType: - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2 id: 2 status: DEFINED identifier: article names: value: - _languageCode: eng-GB '#text': Article descriptions: value: - _languageCode: eng-GB '#text': null creationDate: '2002-06-18T09:21:38+00:00' modificationDate: '2021-06-28T11:31:22+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/2/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2/draft remoteId: c15b600eb9198b1924063b5a68758232 urlAliasSchema: '' nameSchema: <short_title|title> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: false defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/1 id: 1 identifier: title fieldType: ibexa_string fieldGroup: '' position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: New article isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/152 id: 152 identifier: short_title fieldType: ibexa_string fieldGroup: '' position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Short title descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/153 id: 153 identifier: author fieldType: ibexa_author fieldGroup: '' position: 3 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: [] isSearchable: false names: value: - _languageCode: eng-GB '#text': Author descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: defaultAuthor: 1 validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/120 id: 120 identifier: intro fieldType: ibexa_richtext fieldGroup: '' position: 4 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Intro descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/121 id: 121 identifier: body fieldType: ibexa_richtext fieldGroup: '' position: 5 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Body descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/123 id: 123 identifier: enable_comments fieldType: ibexa_boolean fieldGroup: '' position: 6 isTranslatable: false isRequired: false isInfoCollector: false defaultValue: false isSearchable: false names: value: - _languageCode: eng-GB '#text': Enable comments descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/195 id: 195 identifier: image fieldType: ibexa_image_asset fieldGroup: content position: 7 isTranslatable: false isRequired: false isInfoCollector: false defaultValue: destinationContentId: null alternativeText: null source: null isSearchable: false names: value: - _languageCode: eng-GB '#text': Image descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/50 id: 50 status: DEFINED identifier: copy_of_article_50 names: value: - _languageCode: eng-GB '#text': Article descriptions: value: - _languageCode: eng-GB '#text': null creationDate: '2021-07-14T10:30:00+00:00' modificationDate: '2021-07-14T10:30:00+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/50/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/50/draft remoteId: fc9434492469d136ffe13377bfdcbb28 urlAliasSchema: '' nameSchema: <short_title|title> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: false defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/50/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/50/fieldDefinitions/197 id: 197 identifier: title fieldType: ibexa_string fieldGroup: '' position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: New article isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/50/fieldDefinitions/198 id: 198 identifier: short_title fieldType: ibexa_string fieldGroup: '' position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Short title descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/50/fieldDefinitions/199 id: 199 identifier: author fieldType: ibexa_author fieldGroup: '' position: 3 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: [] isSearchable: false names: value: - _languageCode: eng-GB '#text': Author descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: defaultAuthor: 1 validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/50/fieldDefinitions/200 id: 200 identifier: intro fieldType: ibexa_richtext fieldGroup: '' position: 4 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Intro descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/50/fieldDefinitions/201 id: 201 identifier: body fieldType: ibexa_richtext fieldGroup: '' position: 5 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Body descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/50/fieldDefinitions/202 id: 202 identifier: enable_comments fieldType: ibexa_boolean fieldGroup: '' position: 6 isTranslatable: false isRequired: false isInfoCollector: false defaultValue: false isSearchable: false names: value: - _languageCode: eng-GB '#text': Enable comments descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/50/fieldDefinitions/203 id: 203 identifier: image fieldType: ibexa_image_asset fieldGroup: content position: 7 isTranslatable: false isRequired: false isInfoCollector: false defaultValue: destinationContentId: null alternativeText: null source: null isSearchable: false names: value: - _languageCode: eng-GB '#text': Image descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/44 id: 44 status: DEFINED identifier: dog_breed names: value: - _languageCode: eng-GB '#text': Dog Breed descriptions: value: - _languageCode: eng-GB '#text': null creationDate: '2021-06-28T11:28:00+00:00' modificationDate: '2021-06-28T11:29:02+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/44/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/44/draft remoteId: b348c95f7c573d4d502d6b59f80e618a urlAliasSchema: '' nameSchema: <name> isContainer: false mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PUBLISHED defaultSortOrder: DESC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/44/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/44/fieldDefinitions/190 id: 190 identifier: name fieldType: ibexa_string fieldGroup: content position: 1 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Name descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: null minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/44/fieldDefinitions/191 id: 191 identifier: photo fieldType: ibexa_image_asset fieldGroup: content position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: destinationContentId: null alternativeText: null source: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Photo descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/44/fieldDefinitions/192 id: 192 identifier: description fieldType: ibexa_richtext fieldGroup: content position: 3 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Full Description descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/1 id: 1 status: DEFINED identifier: folder names: value: - _languageCode: eng-GB '#text': Folder descriptions: value: [] creationDate: '2002-06-18T09:21:38+00:00' modificationDate: '2015-11-29T21:14:32+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/1/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/1/draft remoteId: a3d405b81be900468eb153d774f4f0d2 urlAliasSchema: null nameSchema: <short_name|name> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions/4 id: 4 identifier: name fieldType: ibexa_string fieldGroup: '' position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: Folder isSearchable: true names: value: - _languageCode: eng-GB '#text': Name descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions/155 id: 155 identifier: short_name fieldType: ibexa_string fieldGroup: '' position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Short name descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 100 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions/119 id: 119 identifier: short_description fieldType: ibexa_richtext fieldGroup: '' position: 3 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Short description descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions/156 id: 156 identifier: description fieldType: ibexa_richtext fieldGroup: '' position: 4 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Description descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/43 id: 43 status: DEFINED identifier: form names: value: - _languageCode: eng-GB '#text': Form descriptions: value: [] creationDate: '2018-09-17T06:46:13+00:00' modificationDate: '2018-09-17T06:47:14+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/43/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/43/draft remoteId: 6f7f21df775a33c1e4bbc76b48c38476 urlAliasSchema: '' nameSchema: <title> isContainer: false mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PUBLISHED defaultSortOrder: DESC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/43/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/43/fieldDefinitions/188 id: 188 identifier: title fieldType: ibexa_string fieldGroup: content position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: null minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/43/fieldDefinitions/189 id: 189 identifier: form fieldType: ibexa_form fieldGroup: content position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: fields: [] content_id: null content_field_id: null language_code: null isSearchable: false names: value: - _languageCode: eng-GB '#text': Form descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/45 id: 45 status: DEFINED identifier: tip names: value: - _languageCode: eng-GB '#text': Tip descriptions: value: - _languageCode: eng-GB '#text': null creationDate: '2021-06-28T11:29:19+00:00' modificationDate: '2021-07-26T09:33:06+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/45/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/45/draft remoteId: e6490e8a785edacd48629f2022be3125 urlAliasSchema: '' nameSchema: <title> isContainer: false mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PUBLISHED defaultSortOrder: DESC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/45/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/45/fieldDefinitions/193 id: 193 identifier: title fieldType: ibexa_string fieldGroup: content position: 1 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: null minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/45/fieldDefinitions/194 id: 194 identifier: body fieldType: ibexa_text fieldGroup: content position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Body descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: textRows: 10 validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/45/fieldDefinitions/204 id: 204 identifier: richtext fieldType: ibexa_richtext fieldGroup: content position: 3 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': richtext descriptions: value: - _languageCode: eng-GB '#text': null fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/42 id: 42 status: DEFINED identifier: landing_page names: value: - _languageCode: eng-GB '#text': Landing page descriptions: value: - _languageCode: eng-GB '#text': '' creationDate: '2015-07-03T12:00:26+00:00' modificationDate: '2015-07-03T12:00:26+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/42/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/42/draft remoteId: 60c03e9758465eb69d56b3afb6adf18e urlAliasSchema: '' nameSchema: <name> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PUBLISHED defaultSortOrder: DESC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/42/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/42/fieldDefinitions/185 id: 185 identifier: name fieldType: ibexa_string fieldGroup: content position: 10 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: - _languageCode: eng-GB '#text': Title fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: null minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/42/fieldDefinitions/186 id: 186 identifier: description fieldType: ibexa_string fieldGroup: content position: 20 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Description descriptions: value: - _languageCode: eng-GB '#text': Landing page description fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: null minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/42/fieldDefinitions/187 id: 187 identifier: page fieldType: ibexa_landing_page fieldGroup: content position: 30 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: layout: default zones: - id: default_id name: default blocks: [] isSearchable: false names: value: - _languageCode: eng-GB '#text': Landing page descriptions: value: - _languageCode: eng-GB '#text': Landing page fieldSettings: availableBlocks: null availableLayouts: null editorMode: page_view_mode validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/4 id: 4 status: DEFINED identifier: user names: value: - _languageCode: eng-GB '#text': User descriptions: value: [] creationDate: '2002-06-18T09:21:38+00:00' modificationDate: '2004-04-15T08:39:24+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/4/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/4/draft remoteId: 40faa822edc579b02c25f6bb7beec3ad urlAliasSchema: null nameSchema: <first_name> <last_name> isContainer: false mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/4/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/4/fieldDefinitions/8 id: 8 identifier: first_name fieldType: ibexa_string fieldGroup: '' position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': First name descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/4/fieldDefinitions/9 id: 9 identifier: last_name fieldType: ibexa_string fieldGroup: '' position: 2 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Last name descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/4/fieldDefinitions/12 id: 12 identifier: user_account fieldType: ibexa_user fieldGroup: '' position: 3 isTranslatable: false isRequired: true isInfoCollector: false defaultValue: null isSearchable: false names: value: - _languageCode: eng-GB '#text': User account descriptions: value: [] fieldSettings: PasswordTTL: 0 PasswordTTLWarning: 0 RequireUniqueEmail: false UsernamePattern: ^[^@]+$ validatorConfiguration: PasswordValueValidator: requireAtLeastOneUpperCaseCharacter: true requireAtLeastOneLowerCaseCharacter: true requireAtLeastOneNumericCharacter: true requireAtLeastOneNonAlphanumericCharacter: false requireNewPassword: false minLength: 10 - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/4/fieldDefinitions/179 id: 179 identifier: signature fieldType: ibexa_text fieldGroup: '' position: 4 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Signature descriptions: value: [] fieldSettings: textRows: 10 validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/4/fieldDefinitions/180 id: 180 identifier: image fieldType: ibexa_image fieldGroup: '' position: 5 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: false names: value: - _languageCode: eng-GB '#text': Image descriptions: value: [] fieldSettings: [] validatorConfiguration: FileSizeValidator: maxFileSize: 10 - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/3 id: 3 status: DEFINED identifier: user_group names: value: - _languageCode: eng-GB '#text': User group descriptions: value: [] creationDate: '2002-06-18T09:21:38+00:00' modificationDate: '2003-03-24T08:32:23+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/3/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/3/draft remoteId: 25b4268cdcd01921b808a0d854b877ef urlAliasSchema: null nameSchema: <name> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/3/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/3/fieldDefinitions/6 id: 6 identifier: name fieldType: ibexa_string fieldGroup: '' position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Name descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/3/fieldDefinitions/7 id: 7 identifier: description fieldType: ibexa_string fieldGroup: '' position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Description descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/12 id: 12 status: DEFINED identifier: file names: value: - _languageCode: eng-GB '#text': File descriptions: value: [] creationDate: '2003-05-08T09:17:52+00:00' modificationDate: '2003-05-08T09:21:09+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/12/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/12/draft remoteId: 637d58bfddf164627bdfd265733280a0 urlAliasSchema: null nameSchema: <name> isContainer: false mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/12/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/12/fieldDefinitions/146 id: 146 identifier: name fieldType: ibexa_string fieldGroup: '' position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: New file isSearchable: true names: value: - _languageCode: eng-GB '#text': Name descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: null minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/12/fieldDefinitions/147 id: 147 identifier: description fieldType: ibexa_richtext fieldGroup: '' position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Description descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/12/fieldDefinitions/148 id: 148 identifier: file fieldType: ibexa_author fieldGroup: '' position: 3 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: null isSearchable: false names: value: - _languageCode: eng-GB '#text': File descriptions: value: [] fieldSettings: [] validatorConfiguration: FileSizeValidator: maxFileSize: null - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/5 id: 5 status: DEFINED identifier: image names: value: - _languageCode: eng-GB '#text': Image descriptions: value: [] creationDate: '2002-09-08T11:36:32+00:00' modificationDate: '2003-03-24T08:33:04+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/5/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/5/draft remoteId: f6df12aa74e36230eb675f364fccd25a urlAliasSchema: null nameSchema: <name> isContainer: false mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/5/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/5/fieldDefinitions/116 id: 116 identifier: name fieldType: ibexa_string fieldGroup: '' position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Name descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 150 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/5/fieldDefinitions/117 id: 117 identifier: caption fieldType: ibexa_richtext fieldGroup: '' position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Caption descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/5/fieldDefinitions/118 id: 118 identifier: image fieldType: ibexa_image fieldGroup: '' position: 3 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: false names: value: - _languageCode: eng-GB '#text': Image descriptions: value: [] fieldSettings: [] validatorConfiguration: FileSizeValidator: maxFileSize: 10 application/vnd.ibexa.api.ContentTypeInfoList+xml: schema: $ref: '#/components/schemas/ContentTypeInfoList' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentTypeInfoList media-type="application/vnd.ibexa.api.ContentTypeInfoList+xml" href="/api/ibexa/v2/content/typegroups/1/types"> <ContentTypeInfo media-type="application/vnd.ibexa.api.ContentTypeInfo+xml" href="/api/ibexa/v2/content/types/2"> <id>2</id> <status>DEFINED</status> <identifier>article</identifier> <names> <value languageCode="eng-GB">Article</value> </names> <descriptions/> <creationDate>2002-06-18T11:21:38+02:00</creationDate> <modificationDate>2004-04-20T11:56:29+02:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2/draft"/> <remoteId>c15b600eb9198b1924063b5a68758232</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><short_title|title></nameSchema> <isContainer>true</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>false</defaultAlwaysAvailable> <defaultSortField>PATH</defaultSortField> <defaultSortOrder>ASC</defaultSortOrder> </ContentTypeInfo> <ContentTypeInfo media-type="application/vnd.ibexa.api.ContentTypeInfo+xml" href="/api/ibexa/v2/content/types/1"> <id>1</id> <status>DEFINED</status> <identifier>folder</identifier> <names> <value languageCode="eng-GB">Folder</value> </names> <descriptions/> <creationDate>2002-06-18T11:21:38+02:00</creationDate> <modificationDate>2015-11-29T22:14:32+01:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/1/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1/draft"/> <remoteId>a3d405b81be900468eb153d774f4f0d2</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><short_name|name></nameSchema> <isContainer>true</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>true</defaultAlwaysAvailable> <defaultSortField>PATH</defaultSortField> <defaultSortOrder>ASC</defaultSortOrder> </ContentTypeInfo> </ContentTypeInfoList> application/vnd.ibexa.api.ContentTypeList+json: schema: $ref: '#/components/schemas/ContentTypeListWrapper' example: ContentTypeList: _media-type: application/vnd.ibexa.api.ContentTypeList+json _href: /api/ibexa/v2/content/typegroups/1/types ContentType: - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2 id: 2 status: DEFINED identifier: article names: value: - _languageCode: eng-GB '#text': Article descriptions: value: [] creationDate: '2002-06-18T09:21:38+00:00' modificationDate: '2004-04-20T09:56:29+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/2/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/2/draft remoteId: c15b600eb9198b1924063b5a68758232 urlAliasSchema: null nameSchema: <short_title|title> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: false defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/1 id: 1 identifier: title fieldType: ibexa_string fieldGroup: '' position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: New article isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/152 id: 152 identifier: short_title fieldType: ibexa_string fieldGroup: '' position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Short title descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/153 id: 153 identifier: author fieldType: ibexa_author fieldGroup: '' position: 3 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: [] isSearchable: false names: value: - _languageCode: eng-GB '#text': Author descriptions: value: [] fieldSettings: defaultAuthor: 1 validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/120 id: 120 identifier: intro fieldType: ibexa_richtext fieldGroup: '' position: 4 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Intro descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/121 id: 121 identifier: body fieldType: ibexa_richtext fieldGroup: '' position: 5 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Body descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/123 id: 123 identifier: enable_comments fieldType: ibexa_boolean fieldGroup: '' position: 6 isTranslatable: false isRequired: false isInfoCollector: false defaultValue: false isSearchable: false names: value: - _languageCode: eng-GB '#text': Enable comments descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/2/fieldDefinitions/154 id: 154 identifier: image fieldType: ibexa_object_relation fieldGroup: '' position: 7 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: destinationContentId: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Image descriptions: value: [] fieldSettings: selectionMethod: SELECTION_BROWSE selectionRoot: '' selectionContentTypes: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/1 id: 1 status: DEFINED identifier: folder names: value: - _languageCode: eng-GB '#text': Folder descriptions: value: [] creationDate: '2002-06-18T09:21:38+00:00' modificationDate: '2015-11-29T21:14:32+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/1/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/1/draft remoteId: a3d405b81be900468eb153d774f4f0d2 urlAliasSchema: null nameSchema: <short_name|name> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions/4 id: 4 identifier: name fieldType: ibexa_string fieldGroup: '' position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: Folder isSearchable: true names: value: - _languageCode: eng-GB '#text': Name descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 255 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions/155 id: 155 identifier: short_name fieldType: ibexa_string fieldGroup: '' position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Short name descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: 100 minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions/119 id: 119 identifier: short_description fieldType: ibexa_richtext fieldGroup: '' position: 3 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Short description descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/1/fieldDefinitions/156 id: 156 identifier: description fieldType: ibexa_richtext fieldGroup: '' position: 4 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: xml: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> xhtml5edit: | <?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> isSearchable: true names: value: - _languageCode: eng-GB '#text': Description descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/43 id: 43 status: DEFINED identifier: form names: value: - _languageCode: eng-GB '#text': Form descriptions: value: [] creationDate: '2018-09-17T06:46:13+00:00' modificationDate: '2018-09-17T06:47:14+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/43/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/43/draft remoteId: 6f7f21df775a33c1e4bbc76b48c38476 urlAliasSchema: '' nameSchema: <title> isContainer: false mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PUBLISHED defaultSortOrder: DESC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/43/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/43/fieldDefinitions/188 id: 188 identifier: title fieldType: ibexa_string fieldGroup: content position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: [] fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: null minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/43/fieldDefinitions/189 id: 189 identifier: form fieldType: ibexa_form fieldGroup: content position: 2 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: fields: [] content_id: null content_field_id: null language_code: null isSearchable: false names: value: - _languageCode: eng-GB '#text': Form descriptions: value: [] fieldSettings: [] validatorConfiguration: [] - _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/42 id: 42 status: DEFINED identifier: landing_page names: value: - _languageCode: eng-GB '#text': Landing page descriptions: value: - _languageCode: eng-GB '#text': '' creationDate: '2015-07-03T12:00:26+00:00' modificationDate: '2015-07-03T12:00:26+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Modifier: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 Groups: _media-type: application/vnd.ibexa.api.ContentTypeGroupRefList+json _href: /api/ibexa/v2/content/types/42/groups Draft: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/42/draft remoteId: 60c03e9758465eb69d56b3afb6adf18e urlAliasSchema: '' nameSchema: <name> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PUBLISHED defaultSortOrder: DESC FieldDefinitions: _media-type: application/vnd.ibexa.api.FieldDefinitionList+json _href: /api/ibexa/v2/content/types/42/fieldDefinitions FieldDefinition: - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/42/fieldDefinitions/185 id: 185 identifier: name fieldType: ibexa_string fieldGroup: content position: 10 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: - _languageCode: eng-GB '#text': Title fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: null minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/42/fieldDefinitions/186 id: 186 identifier: description fieldType: ibexa_string fieldGroup: content position: 20 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: null isSearchable: true names: value: - _languageCode: eng-GB '#text': Description descriptions: value: - _languageCode: eng-GB '#text': Landing page description fieldSettings: [] validatorConfiguration: StringLengthValidator: maxStringLength: null minStringLength: null - _media-type: application/vnd.ibexa.api.FieldDefinition+json _href: /api/ibexa/v2/content/types/42/fieldDefinitions/187 id: 187 identifier: page fieldType: ibexa_landing_page fieldGroup: content position: 30 isTranslatable: true isRequired: false isInfoCollector: false defaultValue: layout: default zones: - id: default_id name: default blocks: [] isSearchable: false names: value: - _languageCode: eng-GB '#text': Landing page descriptions: value: - _languageCode: eng-GB '#text': Landing page fieldSettings: availableBlocks: null availableLayouts: null editorMode: page_view_mode validatorConfiguration: [] application/vnd.ibexa.api.ContentTypeList+xml: schema: $ref: '#/components/schemas/ContentTypeList' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentTypeList media-type="application/vnd.ibexa.api.ContentTypeList+xml" href="/api/ibexa/v2/content/typegroups/1/types"> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2"> <id>2</id> <status>DEFINED</status> <identifier>article</identifier> <names> <value languageCode="eng-GB">Article</value> </names> <descriptions/> <creationDate>2002-06-18T11:21:38+02:00</creationDate> <modificationDate>2004-04-20T11:56:29+02:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/2/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/2/draft"/> <remoteId>c15b600eb9198b1924063b5a68758232</remoteId> <urlAliasSchema></urlAliasSchema> <nameSchema><short_title|title></nameSchema> <isContainer>true</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>false</defaultAlwaysAvailable> <defaultSortField>PATH</defaultSortField> <defaultSortOrder>ASC</defaultSortOrder> <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions"> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/1"> <id>1</id> <identifier>title</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>1</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue>New article</defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Title</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">255</value> <value key="minStringLength"/></value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/152"> <id>152</id> <identifier>short_title</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup></fieldGroup> <position>2</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Short title</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="maxStringLength">255</value> <value key="minStringLength"/></value> </validatorConfiguration> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/153"> <id>153</id> <identifier>author</identifier> <fieldType>ibexa_author</fieldType> <fieldGroup></fieldGroup> <position>3</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue/> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Author</value> </names> <descriptions/> <fieldSettings> <value key="defaultAuthor">1</value> </fieldSettings> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/120"> <id>120</id> <identifier>intro</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup></fieldGroup> <position>4</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Intro</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/121"> <id>121</id> <identifier>body</identifier> <fieldType>ibexa_richtext</fieldType> <fieldGroup></fieldGroup> <position>5</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> </value> <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> </value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Body</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/123"> <id>123</id> <identifier>enable_comments</identifier> <fieldType>ibexa_boolean</fieldType> <fieldGroup></fieldGroup> <position>6</position> <isTranslatable>false</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue>false</defaultValue> <isSearchable>false</isSearchable> <names> <value languageCode="eng-GB">Enable comments</value> </names> <descriptions/> <fieldSettings/> <validatorConfiguration/> </FieldDefinition> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/2/fieldDefinitions/154"> <id>154</id> <identifier>image</identifier> <fieldType>ibexa_object_relation</fieldType> <fieldGroup></fieldGroup> <position>7</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="destinationContentId"/> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Image</value> </names> <descriptions/> <fieldSettings> <value key="selectionMethod">SELECTION_BROWSE</value> <value key="selectionRoot"></value> <value key="selectionContentTypes"/> </fieldSettings> <validatorConfiguration/> </FieldDefinition> </FieldDefinitions> </ContentType> </ContentTypeList> '401': description: Error - The user has no permission to read the content types. summary: List content types for group description: Returns a list of content types in the provided group. parameters: - name: contentTypeGroupId in: path description: ContentTypeListForGroupController identifier required: true deprecated: false schema: type: string style: simple explode: false post: operationId: ibexa.rest.create_content_type tags: - Type Groups responses: '201': description: Content type created. content: application/vnd.ibexa.api.ContentType+json: schema: $ref: '#/components/schemas/ContentTypeWrapper' application/vnd.ibexa.api.ContentType+xml: schema: $ref: '#/components/schemas/ContentType' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/20/draft"> <id>20</id> <status>DRAFT</status> <identifier>newContentType</identifier> <names> <value languageCode="eng-GB">New content type</value> </names> <descriptions> <value languageCode="eng-GB">This is a description</value> </descriptions> <creationDate>2019-02-26T09:39:58+01:00</creationDate> <modificationDate>2019-02-26T09:39:58+01:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/20/groups"/> <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/20/draft"/> <remoteId>remoteId-qwert548</remoteId> <urlAliasSchema><title></urlAliasSchema> <nameSchema><title></nameSchema> <isContainer>true</isContainer> <mainLanguageCode>eng-GB</mainLanguageCode> <defaultAlwaysAvailable>true</defaultAlwaysAvailable> <defaultSortField>PATH</defaultSortField> <defaultSortOrder>ASC</defaultSortOrder> <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/20/draft/fieldDefinitions"> <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/20/draft/fieldDefinitions/223"> <id>223</id> <identifier>title</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup>content</fieldGroup> <position>1</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue>New Title</defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-GB">Title</value> </names> <descriptions> <value languageCode="eng-GB">This is the title</value> </descriptions> <fieldSettings/> <validatorConfiguration> <value key="StringLengthValidator"> <value key="minStringLength">0</value> <value key="maxStringLength"/></value> </validatorConfiguration> </FieldDefinition> </FieldDefinitions> </ContentType> '400': description: Error - The input does not match the input schema definition. Validation on a Field definition fails. Validation of the content type fails, e.g. multiple Fields of a same singular Field Type are provided. Publish is set to true and the input is not complete e.g. no Field definitions are provided. '401': description: Error - The user is not authorized to create this content type. '403': description: Error - A content type with same identifier already exists. summary: Create content type description: Creates a new content type draft in the given content type group. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: contentTypeGroupId in: path description: ContentTypeCreateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The content type Create schema encoded in XML or JSON format. content: application/vnd.ibexa.api.ContentTypeCreate+json: schema: $ref: '#/components/schemas/ContentTypeCreateWrapper' example: ContentTypeCreate: identifier: new_content_type names: value: - _languageCode: eng-GB '#text': New content type descriptions: value: - _languageCode: eng-GB '#text': This is a description remoteId: remoteId-qwerty548 urlAliasSchema: <title> nameSchema: <title> isContainer: true mainLanguageCode: eng-GB defaultAlwaysAvailable: true defaultSortField: PATH defaultSortOrder: ASC FieldDefinitions: FieldDefinition: - identifier: title fieldType: ibexa_string fieldGroup: content position: 1 isTranslatable: true isRequired: true isInfoCollector: false defaultValue: New Title isSearchable: true names: value: - _languageCode: eng-GB '#text': Title descriptions: value: - _languageCode: eng-GB '#text': This is the title - identifier: summary fieldType: ibexa_richtext fieldGroup: content position: 2 isTranslatable: true isRequired: false isInfoCollector: false isSearchable: true names: value: - _languageCode: eng-GB '#text': Summary descriptions: value: - _languageCode: eng-GB '#text': This is the summary application/vnd.ibexa.api.ContentTypeCreate+xml: schema: $ref: '#/components/schemas/ContentTypeCreate' example: | <?xml version="1.0" encoding="UTF-8"?> <ContentTypeCreate> <identifier>newContentType</identifier> <names> <value languageCode="eng-US">New content type</value> </names> <descriptions> <value languageCode="eng-US">This is a description</value> </descriptions> <remoteId>remoteId-qwert548</remoteId> <urlAliasSchema><title></urlAliasSchema> <nameSchema><title></nameSchema> <isContainer>true</isContainer> <mainLanguageCode>eng-US</mainLanguageCode> <defaultAlwaysAvailable>true</defaultAlwaysAvailable> <defaultSortField>PATH</defaultSortField> <defaultSortOrder>ASC</defaultSortOrder> <FieldDefinitions> <FieldDefinition> <identifier>title</identifier> <fieldType>ibexa_string</fieldType> <fieldGroup>content</fieldGroup> <position>1</position> <isTranslatable>true</isTranslatable> <isRequired>true</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue>New Title</defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-US">Title</value> </names> <descriptions> <value languageCode="eng-US">This is the title</value> </descriptions> </FieldDefinition> <FieldDefinition> <identifier>summary</identifier> <fieldType>ezxmltext</fieldType> <fieldGroup>content</fieldGroup> <position>2</position> <isTranslatable>true</isTranslatable> <isRequired>false</isRequired> <isInfoCollector>false</isInfoCollector> <defaultValue> <value key="xml"><?xml version="1.0" encoding="utf-8"?><section/></value> </defaultValue> <isSearchable>true</isSearchable> <names> <value languageCode="eng-US">Summary</value> </names> <descriptions> <value languageCode="eng-US">This is the summary</value> </descriptions> </FieldDefinition> </FieldDefinitions> </ContentTypeCreate> required: false /content/urlaliases: get: operationId: ibexa.rest.list_global_url_aliases tags: - Url Alias responses: '200': description: OK - returns the list of URL aliases. content: application/vnd.ibexa.api.UrlAliasRefList+json: schema: $ref: '#/components/schemas/UrlAliasRefListWrapper' example: UrlAliasRefList: _media-type: application/vnd.ibexa.api.UrlAliasRefList+json _href: /api/ibexa/v2/content/urlaliases UrlAlias: - _media-type: application/vnd.ibexa.api.UrlAlias+json _href: /api/ibexa/v2/content/urlaliases/0-2cecdff5f90b8595d76b68c417b09f36 application/vnd.ibexa.api.UrlAliasRefList+xml: schema: $ref: '#/components/schemas/UrlAliasRefList' example: | <?xml version="1.0" encoding="UTF-8"?> <UrlAliasRefList media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/urlaliases"> <UrlAlias media-type="application/vnd.ibexa.api.UrlAlias+xml" href="/api/ibexa/v2/content/urlaliases/0-2cecdff5f90b8595d76b68c417b09f36" /> </UrlAliasRefList> '401': description: Error - The user has no permission to read URL aliases. summary: List global URL aliases description: Returns the list of global URL aliases. parameters: [] post: operationId: ibexa.rest.create_url_alias tags: - Url Alias responses: '201': description: URL alias created. content: application/vnd.ibexa.api.UrlAlias+json: schema: $ref: '#/components/schemas/UrlAliasWrapper' example: UrlAlias: _media-type: application/vnd.ibexa.api.UrlAlias+json _href: /api/ibexa/v2/content/urlaliases/0-f530173ad554787c1fe30dc929d98360 _id: 0-f530173ad554787c1fe30dc929d98360 _type: RESOURCE resource: content/view/full path: /example-global languageCodes: eng-GB alwaysAvailable: true isHistory: false forward: true custom: true application/vnd.ibexa.api.UrlAlias+xml: schema: $ref: '#/components/schemas/UrlAlias' example: | <?xml version="1.0" encoding="UTF-8"?> <UrlAlias media-type="application/vnd.ibexa.api.UrlAlias+xml" href="/api/ibexa/v2/content/urlaliases/0-deca3dadca45c3dff7861274b8e67ed7" id="0-deca3dadca45c3dff7861274b8e67ed7" type="LOCATION"> <location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/59"/> <path>/example-urlalias</path> <languageCodes>eng-GB</languageCodes> <alwaysAvailable>true</alwaysAvailable> <isHistory>false</isHistory> <forward>true</forward> <custom>true</custom> </UrlAlias> '400': description: Error - The input does not match the input schema definition. '401': description: Error - The user is not authorized to create a URL alias. '403': description: Error - A URL alias with the same identifier already exists. summary: Create URL alias description: Creates a URL alias. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The URL alias input schema encoded in XML or JSON format. content: application/vnd.ibexa.api.UrlAliasCreate+json: schema: $ref: '#/components/schemas/UrlAliasCreateWrapper' example: UrlAliasCreate: _type: GLOBAL resource: module:content/view/full path: example-global languageCode: eng-GB alwaysAvailable: 'true' forward: 'true' application/vnd.ibexa.api.UrlAliasCreate+xml: schema: $ref: '#/components/schemas/UrlAliasCreate' example: | <?xml version="1.0" encoding="UTF-8"?> <UrlAliasCreate type="LOCATION"> <location href='/api/ibexa/v2/content/locations/1/2/59' /> <path>example-global</path> <languageCode>eng-GB</languageCode> <alwaysAvailable>true</alwaysAvailable> <forward>true</forward> </UrlAliasCreate> required: false /content/urlaliases/{urlAliasId}: get: operationId: ibexa.rest.load_url_alias tags: - Url Alias responses: '200': description: OK - returns the URL alias. content: application/vnd.ibexa.api.UrlAlias+json: schema: $ref: '#/components/schemas/UrlAliasWrapper' example: UrlAlias: _media-type: application/vnd.ibexa.api.UrlAlias+json _href: /api/ibexa/v2/content/urlaliases/0-2cecdff5f90b8595d76b68c417b09f36 _id: 0-2cecdff5f90b8595d76b68c417b09f36 _type: RESOURCE resource: content/view/full path: /example-global languageCodes: eng-GB alwaysAvailable: true isHistory: false forward: true custom: true application/vnd.ibexa.api.UrlAlias+xml: schema: $ref: '#/components/schemas/UrlAlias' example: | <?xml version="1.0" encoding="UTF-8"?> <UrlAlias media-type="application/vnd.ibexa.api.UrlAlias+xml" href="/api/ibexa/v2/content/urlaliases/0-2cecdff5f90b8595d76b68c417b09f36" id="0-2cecdff5f90b8595d76b68c417b09f36" type="RESOURCE"> <resource>content/view/full</resource> <path>/example-global</path> <languageCodes>eng-GB</languageCodes> <alwaysAvailable>true</alwaysAvailable> <isHistory>false</isHistory> <forward>true</forward> <custom>true</custom> </UrlAlias> '401': description: Error - The user is not authorized to read URL aliases. '404': description: Error - The URL alias does not exist. summary: Get URL alias description: Returns the URL alias with the given ID. parameters: - name: urlAliasId in: path description: URLAliasLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: ibexa.rest.delete_url_alias tags: - Url Alias responses: '204': description: No Content - URL alias deleted. '401': description: Error - The user is not authorized to delete a URL alias. '404': description: Error - The URL alias does not exist. summary: Delete URL alias description: Deletes the provided URL alias. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: urlAliasId in: path description: URLAliasDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false /user/current: get: operationId: api_usercurrent_get tags: - User responses: '200': description: OK - the User with the given ID. content: application/vnd.ibexa.api.User+xml: schema: $ref: '#/components/schemas/UserList' example: | <?xml version="1.0" encoding="UTF-8"?> <UserList media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/users"> <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/79" id="79" remoteId="bcf0764b417f05af21852a1f03fb1f13"> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/> <name>Jose Vargas</name> <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/79/versions"/> <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/12/79"/> <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/79/locations"/> <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/79/groups"/> <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> <publishDate>2021-06-29T08:23:42+00:00</publishDate> <lastModificationDate>2021-06-29T08:23:42+00:00</lastModificationDate> <mainLanguageCode>eng-GB</mainLanguageCode> <alwaysAvailable>true</alwaysAvailable> <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/79/versions/1"> <VersionInfo> <id>547</id> <versionNo>1</versionNo> <status>PUBLISHED</status> <modificationDate>2021-06-29T08:23:42+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> <creationDate>2021-06-29T08:23:42+00:00</creationDate> <initialLanguageCode>eng-GB</initialLanguageCode> <languageCodes>eng-GB</languageCodes> <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> <Language> <languageCode>eng-GB</languageCode> </Language> </VersionTranslationInfo> <names> <value languageCode="eng-GB">Jose Vargas</value> </names> <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/79"/> </VersionInfo> <Fields> <field> <id>342</id> <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>Jose</fieldValue> </field> <field> <id>343</id> <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>Vargas</fieldValue> </field> <field> <id>344</id> <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> <fieldValue> <value key="hasStoredLogin">true</value> <value key="contentId">79</value> <value key="login">josevargas</value> <value key="email">aa@bb.cc</value> <value key="passwordUpdatedAt">1624955022</value> <value key="enabled">true</value> <value key="maxLogin">0</value> <value key="plainPassword"/> </fieldValue> </field> <field> <id>345</id> <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier> <fieldValue/> </field> <field> <id>346</id> <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier> <fieldValue/> </field> </Fields> <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/79/versions/1/relations"/> <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource> <width></width> <height></height> <mimeType>image/svg+xml</mimeType> </Thumbnail> </Version> <login>josevargas</login> <email>aa@bb.cc</email> <enabled>true</enabled> <UserGroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/users/79/groups"/> <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/79/roles"/> </User> </UserList> application/vnd.ibexa.api.User+json: schema: $ref: '#/components/schemas/UserListWrapper' example: UserList: _media-type: application/vnd.ibexa.api.UserList+json _href: /api/ibexa/v2/user/users User: - _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/79 _id: 79 _remoteId: bcf0764b417f05af21852a1f03fb1f13 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/4 name: Jose Vargas Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/79/versions Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/2 MainLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/5/12/79 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/79/locations Groups: _media-type: application/vnd.ibexa.api.UserGroupRefList+json _href: /api/ibexa/v2/user/users/79/groups Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/10 publishDate: '2021-06-29T08:23:42+00:00' lastModificationDate: '2021-06-29T08:23:42+00:00' mainLanguageCode: eng-GB alwaysAvailable: true Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/79/versions/1 VersionInfo: id: 547 versionNo: 1 status: PUBLISHED modificationDate: '2021-06-29T08:23:42+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/10 creationDate: '2021-06-29T08:23:42+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Jose Vargas Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/79 Fields: field: - id: 342 fieldDefinitionIdentifier: first_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Jose - id: 343 fieldDefinitionIdentifier: last_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Vargas - id: 344 fieldDefinitionIdentifier: user_account languageCode: eng-GB fieldTypeIdentifier: ibexa_user fieldValue: hasStoredLogin: true contentId: 79 login: josevargas email: aa@bb.cc passwordUpdatedAt: 1624955022 enabled: true maxLogin: 0 plainPassword: null - id: 345 fieldDefinitionIdentifier: signature languageCode: eng-GB fieldTypeIdentifier: ibexa_text fieldValue: null - id: 346 fieldDefinitionIdentifier: image languageCode: eng-GB fieldTypeIdentifier: ibexa_image fieldValue: null Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/79/versions/1/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ezplatformadminui/img/ez-icons.svg#user width: null height: null mimeType: image/svg+xml login: josevargas email: aa@bb.cc enabled: true UserGroups: _media-type: application/vnd.ibexa.api.UserGroupList+json _href: /api/ibexa/v2/user/users/79/groups Roles: _media-type: application/vnd.ibexa.api.RoleAssignmentList+json _href: /api/ibexa/v2/user/users/79/roles '401': description: Error - the user has no permission to read Users. For example, Anonymous user can't load oneself. summary: Load current User description: Loads the current user. parameters: - name: Accept in: header description: If set, the User is returned in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false /user/users: get: operationId: api_userusers_get tags: - User responses: '200': description: OK - Loads Users either for a given remote ID or Role. content: application/vnd.ibexa.api.UserList+xml: schema: $ref: '#/components/schemas/UserList' example: | <?xml version="1.0" encoding="UTF-8"?> <UserList media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/users"> <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/79" id="79" remoteId="bcf0764b417f05af21852a1f03fb1f13"> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/> <name>Jose Vargas</name> <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/79/versions"/> <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/12/79"/> <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/79/locations"/> <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/79/groups"/> <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> <publishDate>2021-06-29T08:23:42+00:00</publishDate> <lastModificationDate>2021-06-29T08:23:42+00:00</lastModificationDate> <mainLanguageCode>eng-GB</mainLanguageCode> <alwaysAvailable>true</alwaysAvailable> <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/79/versions/1"> <VersionInfo> <id>547</id> <versionNo>1</versionNo> <status>PUBLISHED</status> <modificationDate>2021-06-29T08:23:42+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> <creationDate>2021-06-29T08:23:42+00:00</creationDate> <initialLanguageCode>eng-GB</initialLanguageCode> <languageCodes>eng-GB</languageCodes> <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> <Language> <languageCode>eng-GB</languageCode> </Language> </VersionTranslationInfo> <names> <value languageCode="eng-GB">Jose Vargas</value> </names> <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/79"/> </VersionInfo> <Fields> <field> <id>342</id> <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>Jose</fieldValue> </field> <field> <id>343</id> <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>Vargas</fieldValue> </field> <field> <id>344</id> <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> <fieldValue> <value key="hasStoredLogin">true</value> <value key="contentId">79</value> <value key="login">josevargas</value> <value key="email">aa@bb.cc</value> <value key="passwordUpdatedAt">1624955022</value> <value key="enabled">true</value> <value key="maxLogin">0</value> <value key="plainPassword"/> </fieldValue> </field> <field> <id>345</id> <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier> <fieldValue/> </field> <field> <id>346</id> <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier> <fieldValue/> </field> </Fields> <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/79/versions/1/relations"/> <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource> <width></width> <height></height> <mimeType>image/svg+xml</mimeType> </Thumbnail> </Version> <login>josevargas</login> <email>aa@bb.cc</email> <enabled>true</enabled> <UserGroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/users/79/groups"/> <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/79/roles"/> </User> </UserList> application/vnd.ibexa.api.UserList+json: schema: $ref: '#/components/schemas/UserListWrapper' example: UserList: _media-type: application/vnd.ibexa.api.UserList+json _href: /api/ibexa/v2/user/users User: - _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/79 _id: 79 _remoteId: bcf0764b417f05af21852a1f03fb1f13 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/4 name: Jose Vargas Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/79/versions Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/2 MainLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/5/12/79 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/79/locations Groups: _media-type: application/vnd.ibexa.api.UserGroupRefList+json _href: /api/ibexa/v2/user/users/79/groups Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/10 publishDate: '2021-06-29T08:23:42+00:00' lastModificationDate: '2021-06-29T08:23:42+00:00' mainLanguageCode: eng-GB alwaysAvailable: true Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/79/versions/1 VersionInfo: id: 547 versionNo: 1 status: PUBLISHED modificationDate: '2021-06-29T08:23:42+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/10 creationDate: '2021-06-29T08:23:42+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Jose Vargas Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/79 Fields: field: - id: 342 fieldDefinitionIdentifier: first_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Jose - id: 343 fieldDefinitionIdentifier: last_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Vargas - id: 344 fieldDefinitionIdentifier: user_account languageCode: eng-GB fieldTypeIdentifier: ibexa_user fieldValue: hasStoredLogin: true contentId: 79 login: josevargas email: aa@bb.cc passwordUpdatedAt: 1624955022 enabled: true maxLogin: 0 plainPassword: null - id: 345 fieldDefinitionIdentifier: signature languageCode: eng-GB fieldTypeIdentifier: ibexa_text fieldValue: null - id: 346 fieldDefinitionIdentifier: image languageCode: eng-GB fieldTypeIdentifier: ibexa_image fieldValue: null Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/79/versions/1/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ezplatformadminui/img/ez-icons.svg#user width: null height: null mimeType: image/svg+xml login: josevargas email: aa@bb.cc enabled: true UserGroups: _media-type: application/vnd.ibexa.api.UserGroupList+json _href: /api/ibexa/v2/user/users/79/groups Roles: _media-type: application/vnd.ibexa.api.RoleAssignmentList+json _href: /api/ibexa/v2/user/users/79/roles application/vnd.ibexa.api.UserRefList+xml: schema: $ref: '#/components/schemas/UserRefList' example: | <?xml version="1.0" encoding="UTF-8"?> <UserRefList media-type="application/vnd.ibexa.api.UserRefList+xml" href="/api/ibexa/v2/user/users"> <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> </UserRefList> application/vnd.ibexa.api.UserRefList+json: schema: $ref: '#/components/schemas/UserRefListWrapper' '404': description: If there are no visible Users matching the filter. summary: List Users description: Load Users either for a given remote ID or Role. parameters: - name: Accept in: header description: UserList - If set, the User list is returned in XML or JSON format. UserRefList - If set, the link list of Users is returned in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false head: operationId: api_userusers_head tags: - User responses: '200': description: OK - verifies if there are Users matching the given filter. '404': description: Error - there are no visible Users matching the filter. summary: Verify Users description: Verifies if there are Users matching given filter. parameters: [] /user/users/{userId}: get: operationId: api_userusers_userId_get tags: - User responses: '200': description: OK - the User with the given ID. content: application/vnd.ibexa.api.User+xml: schema: $ref: '#/components/schemas/UserList' example: | <?xml version="1.0" encoding="UTF-8"?> <UserList media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/users"> <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/79" id="79" remoteId="bcf0764b417f05af21852a1f03fb1f13"> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/> <name>Jose Vargas</name> <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/79/versions"/> <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/12/79"/> <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/79/locations"/> <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/79/groups"/> <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> <publishDate>2021-06-29T08:23:42+00:00</publishDate> <lastModificationDate>2021-06-29T08:23:42+00:00</lastModificationDate> <mainLanguageCode>eng-GB</mainLanguageCode> <alwaysAvailable>true</alwaysAvailable> <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/79/versions/1"> <VersionInfo> <id>547</id> <versionNo>1</versionNo> <status>PUBLISHED</status> <modificationDate>2021-06-29T08:23:42+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> <creationDate>2021-06-29T08:23:42+00:00</creationDate> <initialLanguageCode>eng-GB</initialLanguageCode> <languageCodes>eng-GB</languageCodes> <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> <Language> <languageCode>eng-GB</languageCode> </Language> </VersionTranslationInfo> <names> <value languageCode="eng-GB">Jose Vargas</value> </names> <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/79"/> </VersionInfo> <Fields> <field> <id>342</id> <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>Jose</fieldValue> </field> <field> <id>343</id> <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>Vargas</fieldValue> </field> <field> <id>344</id> <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> <fieldValue> <value key="hasStoredLogin">true</value> <value key="contentId">79</value> <value key="login">josevargas</value> <value key="email">aa@bb.cc</value> <value key="passwordUpdatedAt">1624955022</value> <value key="enabled">true</value> <value key="maxLogin">0</value> <value key="plainPassword"/> </fieldValue> </field> <field> <id>345</id> <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier> <fieldValue/> </field> <field> <id>346</id> <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier> <fieldValue/> </field> </Fields> <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/79/versions/1/relations"/> <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource> <width></width> <height></height> <mimeType>image/svg+xml</mimeType> </Thumbnail> </Version> <login>josevargas</login> <email>aa@bb.cc</email> <enabled>true</enabled> <UserGroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/users/79/groups"/> <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/79/roles"/> </User> </UserList> application/vnd.ibexa.api.User+json: schema: $ref: '#/components/schemas/UserListWrapper' example: UserList: _media-type: application/vnd.ibexa.api.UserList+json _href: /api/ibexa/v2/user/users User: - _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/79 _id: 79 _remoteId: bcf0764b417f05af21852a1f03fb1f13 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/4 name: Jose Vargas Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/79/versions Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/2 MainLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/5/12/79 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/79/locations Groups: _media-type: application/vnd.ibexa.api.UserGroupRefList+json _href: /api/ibexa/v2/user/users/79/groups Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/10 publishDate: '2021-06-29T08:23:42+00:00' lastModificationDate: '2021-06-29T08:23:42+00:00' mainLanguageCode: eng-GB alwaysAvailable: true Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/79/versions/1 VersionInfo: id: 547 versionNo: 1 status: PUBLISHED modificationDate: '2021-06-29T08:23:42+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/10 creationDate: '2021-06-29T08:23:42+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Jose Vargas Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/79 Fields: field: - id: 342 fieldDefinitionIdentifier: first_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Jose - id: 343 fieldDefinitionIdentifier: last_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Vargas - id: 344 fieldDefinitionIdentifier: user_account languageCode: eng-GB fieldTypeIdentifier: ibexa_user fieldValue: hasStoredLogin: true contentId: 79 login: josevargas email: aa@bb.cc passwordUpdatedAt: 1624955022 enabled: true maxLogin: 0 plainPassword: null - id: 345 fieldDefinitionIdentifier: signature languageCode: eng-GB fieldTypeIdentifier: ibexa_text fieldValue: null - id: 346 fieldDefinitionIdentifier: image languageCode: eng-GB fieldTypeIdentifier: ibexa_image fieldValue: null Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/79/versions/1/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ezplatformadminui/img/ez-icons.svg#user width: null height: null mimeType: image/svg+xml login: josevargas email: aa@bb.cc enabled: true UserGroups: _media-type: application/vnd.ibexa.api.UserGroupList+json _href: /api/ibexa/v2/user/users/79/groups Roles: _media-type: application/vnd.ibexa.api.RoleAssignmentList+json _href: /api/ibexa/v2/user/users/79/roles '401': description: Error - the user has no permission to read Users. '404': description: Error - the User does not exist. summary: Load User description: Loads User with the given ID. parameters: - name: Accept in: header description: If set, the User is returned in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false - name: If-None-Match in: header description: ETag required: true deprecated: false schema: type: string style: simple explode: false - name: userId in: path description: UserLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: api_userusers_userId_delete tags: - User responses: '204': description: No Content. '401': description: Error - the user is not authorized to delete this User. '403': description: Error - the user is the same as the authenticated User. '404': description: Error - the User does not exist. summary: Delete User description: Deletes the given User. parameters: - name: userId in: path description: UserDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: api_userusers_userId_patch tags: - User responses: '200': description: OK - User updated. content: application/vnd.ibexa.api.User+xml: schema: $ref: '#/components/schemas/User' example: | <?xml version="1.0" encoding="UTF-8"?> <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/79" id="79" remoteId="bcf0764b417f05af21852a1f03fb1f13"> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/> <name>Jose Vargas</name> <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/79/versions"/> <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/12/79"/> <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/79/locations"/> <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/79/groups"/> <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> <publishDate>2021-06-29T08:23:42+00:00</publishDate> <lastModificationDate>2021-07-29T11:45:07+00:00</lastModificationDate> <mainLanguageCode>eng-GB</mainLanguageCode> <alwaysAvailable>true</alwaysAvailable> <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/79/versions/6"> <VersionInfo> <id>609</id> <versionNo>6</versionNo> <status>PUBLISHED</status> <modificationDate>2021-07-29T11:45:07+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <creationDate>2021-07-29T11:45:07+00:00</creationDate> <initialLanguageCode>eng-GB</initialLanguageCode> <languageCodes>eng-GB</languageCodes> <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> <Language> <languageCode>eng-GB</languageCode> </Language> </VersionTranslationInfo> <names> <value languageCode="eng-GB">Jose Vargas</value> </names> <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/79"/> </VersionInfo> <Fields> <field> <id>342</id> <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>Jose</fieldValue> </field> <field> <id>343</id> <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>Vargas</fieldValue> </field> <field> <id>344</id> <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> <fieldValue> <value key="hasStoredLogin">true</value> <value key="contentId">79</value> <value key="login">josevargas</value> <value key="email">aa@bb.cc</value> <value key="passwordUpdatedAt"/> <value key="enabled">false</value> <value key="maxLogin">0</value> <value key="plainPassword"/> </fieldValue> </field> <field> <id>345</id> <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier> <fieldValue/> </field> <field> <id>346</id> <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier> <fieldValue/> </field> </Fields> <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/79/versions/6/relations"/> <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource> <width></width> <height></height> <mimeType>image/svg+xml</mimeType> </Thumbnail> </Version> <login>josevargas</login> <email>aa@bb.cc</email> <enabled>false</enabled> <UserGroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/users/79/groups"/> <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/79/roles"/> </User> application/vnd.ibexa.api.User+json: schema: $ref: '#/components/schemas/UserWrapper' example: User: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/79 _id: 79 _remoteId: bcf0764b417f05af21852a1f03fb1f13 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/4 name: Jose Vargas Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/79/versions Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/2 MainLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/5/12/79 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/79/locations Groups: _media-type: application/vnd.ibexa.api.UserGroupRefList+json _href: /api/ibexa/v2/user/users/79/groups Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/10 publishDate: '2021-06-29T08:23:42+00:00' lastModificationDate: '2021-07-29T12:00:24+00:00' mainLanguageCode: eng-GB alwaysAvailable: true Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/79/versions/11 VersionInfo: id: 614 versionNo: 11 status: PUBLISHED modificationDate: '2021-07-29T12:00:24+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2021-07-29T12:00:24+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Jose Vargas Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/79 Fields: field: - id: 342 fieldDefinitionIdentifier: first_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Jose - id: 343 fieldDefinitionIdentifier: last_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Vargas - id: 344 fieldDefinitionIdentifier: user_account languageCode: eng-GB fieldTypeIdentifier: ibexa_user fieldValue: hasStoredLogin: true contentId: 79 login: josevargas email: aa@bb.cc passwordUpdatedAt: null enabled: false maxLogin: 0 plainPassword: null - id: 345 fieldDefinitionIdentifier: signature languageCode: eng-GB fieldTypeIdentifier: ibexa_text fieldValue: null - id: 346 fieldDefinitionIdentifier: image languageCode: eng-GB fieldTypeIdentifier: ibexa_image fieldValue: null Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/79/versions/11/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ezplatformadminui/img/ez-icons.svg#user width: null height: null mimeType: image/svg+xml login: josevargas email: aa@bb.cc enabled: false UserGroups: _media-type: application/vnd.ibexa.api.UserGroupList+json _href: /api/ibexa/v2/user/users/79/groups Roles: _media-type: application/vnd.ibexa.api.RoleAssignmentList+json _href: /api/ibexa/v2/user/users/79/roles '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to update the User. '404': description: Error - the User does not exist. '412': description: Error - the current ETag does not match with the provided one in the If-Match header. summary: Update User description: Updates a User. parameters: - name: Accept in: header description: If set, the updated User is returned in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false - name: Content-Type in: header description: The UserUpdate schema encoded in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false - name: If-Match in: header description: Performs a PATCH only if the specified ETag is the current one. required: true deprecated: false schema: type: string style: simple explode: false - name: userId in: path description: UserUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The updated UserUpdateController resource content: application/vnd.ibexa.api.UserUpdate+xml: schema: $ref: '#/components/schemas/UserUpdate' example: | <?xml version="1.0" encoding="UTF-8"?> <UserUpdate> <login>josevargas</login> <enabled>false</enabled> </UserUpdate> application/vnd.ibexa.api.UserUpdate+json: schema: $ref: '#/components/schemas/UserUpdateWrapper' example: UserUpdate: login: josevargas enabled: false required: false /user/users/{userId}/drafts: get: operationId: api_userusers_userIddrafts_get tags: - User responses: '200': description: OK - List the draft versions content: application/vnd.ibexa.api.VersionList+xml: schema: $ref: '#/components/schemas/VersionList' application/vnd.ibexa.api.VersionList+json: schema: $ref: '#/components/schemas/VersionListWrapper' '401': description: Error - the current user is not authorized to list the drafts of the given user. summary: Load user drafts description: Loads user's drafts parameters: - name: Accept in: header description: If set, the version list is returned in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false - name: userId in: path description: UserDraftListController identifier required: true deprecated: false schema: type: string style: simple explode: false /user/users/{userId}/groups: get: operationId: api_userusers_userIdgroups_get tags: - User responses: '200': description: OK - list of the User Groups the User belongs to. content: application/vnd.ibexa.api.UserGroupRefList+xml: schema: $ref: '#/components/schemas/UserGroupRefList' example: | <?xml version="1.0" encoding="UTF-8"?> <UserGroupRefList media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/115/groups"> <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/12"> <unassign href="/api/ibexa/v2/user/users/79/groups/12" method="DELETE"/> </UserGroup> <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13"> <unassign href="/api/ibexa/v2/user/users/115/groups/13" method="DELETE"/> </UserGroup> </UserGroupRefList> application/vnd.ibexa.api.UserGroupRefList+json: schema: $ref: '#/components/schemas/UserGroupRefListWrapper' example: UserGroupRefList: _media-type: application/vnd.ibexa.api.UserGroupRefList+json _href: /api/ibexa/v2/user/users/57/groups UserGroup: - _media-type: application/vnd.ibexa.api.UserGroup+json _href: /api/ibexa/v2/user/groups/1/5/13 '401': description: Error - the user has no permission to read User Groups. '404': description: Error - the user does not exist. summary: Load Groups of User description: Returns a list of User Groups the User belongs to. The returned list includes the resources for unassigning a User Group if the User is in multiple groups. parameters: - name: Accept in: header description: If set, the link list of User Groups is returned in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false - name: userId in: path description: UserGroupsOfUserListController identifier required: true deprecated: false schema: type: string style: simple explode: false post: operationId: api_userusers_userIdgroups_post tags: - User responses: '200': description: OK - the User has been assigned to the User Group. content: application/vnd.ibexa.api.UserGroupRefList+xml: schema: $ref: '#/components/schemas/UserGroupRefList' example: | <?xml version="1.0" encoding="UTF-8"?> <UserGroupRefList media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/115/groups"> <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/12"> <unassign href="/api/ibexa/v2/user/users/79/groups/12" method="DELETE"/> </UserGroup> <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13"> <unassign href="/api/ibexa/v2/user/users/115/groups/13" method="DELETE"/> </UserGroup> </UserGroupRefList> application/vnd.ibexa.api.UserGroupRefList+json: schema: $ref: '#/components/schemas/UserGroupRefListWrapper' example: UserGroupRefList: _media-type: application/vnd.ibexa.api.UserGroupRefList+json _href: /api/ibexa/v2/user/users/57/groups UserGroup: - _media-type: application/vnd.ibexa.api.UserGroup+json _href: /api/ibexa/v2/user/groups/1/5/13 '401': description: Error - the user is not authorized to assign User Groups. '403': description: Error - the new User Group does not exist or the User is already in this group. '404': description: Error - the User does not exist. summary: Assign User Group description: Assigns the User to a User Group. parameters: - name: Accept in: header description: If set, the link list of User Groups is returned in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false - name: userId in: path description: UserAssignToUserGroupController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The new UserAssignToUserGroupController resource content: {} required: false /user/users/{userId}/groups/{groupId}: delete: operationId: api_userusers_userIdgroups_groupId_delete tags: - User responses: '200': description: OK - the User has been unassigned from the User Group. content: application/vnd.ibexa.api.UserGroupRefList+xml: schema: $ref: '#/components/schemas/UserGroupRefList' example: | <?xml version="1.0" encoding="UTF-8"?> <UserGroupRefList media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/115/groups"> <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/12"> <unassign href="/api/ibexa/v2/user/users/79/groups/12" method="DELETE"/> </UserGroup> <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13"> <unassign href="/api/ibexa/v2/user/users/115/groups/13" method="DELETE"/> </UserGroup> </UserGroupRefList> application/vnd.ibexa.api.UserGroupRefList+json: schema: $ref: '#/components/schemas/UserGroupRefListWrapper' example: UserGroupRefList: _media-type: application/vnd.ibexa.api.UserGroupRefList+json _href: /api/ibexa/v2/user/users/57/groups UserGroup: - _media-type: application/vnd.ibexa.api.UserGroup+json _href: /api/ibexa/v2/user/groups/1/5/13 '204': description: UserUnassignFromUserGroupController resource deleted '401': description: Error - the user is not authorized to unassign User Groups. '403': description: Error - the User is not in the given group. '404': description: Error - the User does not exist. summary: Unassign User Group description: Unassigns the User from a User Group. parameters: - name: Accept in: header description: If set, the link list of User Groups is returned in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false - name: userId in: path description: UserUnassignFromUserGroupController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: groupId in: path description: UserUnassignFromUserGroupController identifier required: true deprecated: false schema: type: string style: simple explode: false /user/users/{userId}/roles: get: operationId: ibexa.rest.load_role_assignments_for_user tags: - User responses: '200': description: If set, the Role assignment list is returned in XML or JSON format. content: application/vnd.ibexa.api.RoleAssignmentList+json: schema: $ref: '#/components/schemas/RoleAssignmentListWrapper' example: RoleAssignmentList: _media-type: application/vnd.ibexa.api.RoleAssignmentList+json _href: /api/ibexa/v2/user/users/115/roles RoleAssignment: - _media-type: application/vnd.ibexa.api.RoleAssignment+json _href: /api/ibexa/v2/user/users/115/roles/2 limitation: _identifier: Section values: ref: - _media-type: application/vnd.ibexa.api.ref+json _href: '1' Role: _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/2 application/vnd.ibexa.api.RoleAssignmentList+xml: schema: $ref: '#/components/schemas/RoleAssignmentList' example: | <?xml version="1.0" encoding="UTF-8"?> <RoleAssignmentList media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/115/roles"> <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/users/115/roles/2"> <limitation identifier="Section"> <values> <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/> </values> </limitation> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/2"/> </RoleAssignment> </RoleAssignmentList> '400': description: Error - the user has no permission to read Roles. summary: Load Roles for User description: Returns a list of all Roles assigned to the given User. parameters: - name: userId in: path description: RoleAssignmentForUserListController identifier required: true deprecated: false schema: type: string style: simple explode: false post: operationId: ibexa.rest.assign_role_to_user tags: - User responses: '200': description: If set, the updated Role assignment list is returned in XML or JSON format. content: application/vnd.ibexa.api.RoleAssignmentList+json: schema: $ref: '#/components/schemas/RoleAssignmentListWrapper' example: RoleAssignmentList: _media-type: application/vnd.ibexa.api.RoleAssignmentList+json _href: /api/ibexa/v2/user/users/115/roles RoleAssignment: - _media-type: application/vnd.ibexa.api.RoleAssignment+json _href: /api/ibexa/v2/user/users/115/roles/2 limitation: _identifier: Section values: ref: - _media-type: application/vnd.ibexa.api.ref+json _href: '2' Role: _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/2 - _media-type: application/vnd.ibexa.api.RoleAssignment+json _href: /api/ibexa/v2/user/users/115/roles/2 limitation: _identifier: Section values: ref: - _media-type: application/vnd.ibexa.api.ref+json _href: '1' Role: _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/2 application/vnd.ibexa.api.RoleAssignmentList+xml: schema: $ref: '#/components/schemas/RoleAssignmentList' example: | <?xml version="1.0" encoding="UTF-8"?> <RoleAssignmentList media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/115/roles"> <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/users/115/roles/2"> <limitation identifier="Section"> <values> <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/> </values> </limitation> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/2"/> </RoleAssignment> <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/users/115/roles/2"> <limitation identifier="Section"> <values> <ref media-type="application/vnd.ibexa.api.ref+xml" href="2"/> </values> </limitation> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/2"/> </RoleAssignment> </RoleAssignmentList> '400': description: Error - validation of limitation in RoleAssignInput fails. '401': description: Error - the user is not authorized to assign this Role. summary: Assign Role to User description: Assigns a Role to a user. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: userId in: path description: RoleAssignToUserController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The RoleAssignInput schema encoded in XML or JSON format. content: application/vnd.ibexa.api.RoleAssignInput+json: schema: $ref: '#/components/schemas/RoleAssignInputWrapper' example: RoleAssignInput: Role: _href: /api/ibexa/v2/user/roles/2 _media-type: application/vnd.ibexa.api.RoleAssignInput+xml limitation: _identifier: Section values: ref: - _href: /api/ibexa/v2/content/sections/1 _media-type: application/vnd.ibexa.api.Section+xml - _href: /api/ibexa/v2/content/sections/2 _media-type: application/vnd.ibexa.api.Section+xml application/vnd.ibexa.api.RoleAssignInput+xml: schema: $ref: '#/components/schemas/RoleAssignInput' example: | <?xml version="1.0" encoding="UTF-8"?> <RoleAssignInput> <Role href="/api/ibexa/v2/user/roles/2" media-type="application/vnd.ibexa.api.RoleAssignInput+xml"/> <limitation identifier="Section"> <values> <ref href="/api/ibexa/v2/content/sections/1" media-type="application/vnd.ibexa.api.Section+xml" /> <ref href="/api/ibexa/v2/content/sections/2" media-type="application/vnd.ibexa.api.Section+xml" /> </values> </limitation> </RoleAssignInput> required: false /user/users/{userId}/roles/{roleId}: get: operationId: ibexa.rest.load_role_assignment_for_user tags: - User responses: '200': description: OK - Role assignment to the given User Group. content: application/vnd.ibexa.api.RoleAssignment+json: schema: $ref: '#/components/schemas/RoleAssignmentWrapper' example: RoleAssignment: _media-type: application/vnd.ibexa.api.RoleAssignment+json _href: /api/ibexa/v2/user/users/113/roles/3 limitation: _identifier: Section values: ref: - _media-type: application/vnd.ibexa.api.ref+json _href: '6' Role: _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/3 application/vnd.ibexa.api.RoleAssignment+xml: schema: $ref: '#/components/schemas/RoleAssignment' example: | <?xml version="1.0" encoding="UTF-8"?> <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/users/113/roles/3"> <limitation identifier="Section"> <values> <ref media-type="application/vnd.ibexa.api.ref+xml" href="6"/> </values> </limitation> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/3"/> </RoleAssignment> '401': description: Error - the user has no permission to read Roles. summary: Load User Role Assignment description: Returns a Role assignment to the given User. parameters: - name: userId in: path description: RoleAssignmentForUserLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: roleId in: path description: RoleAssignmentForUserLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: ibexa.rest.unassign_role_from_user tags: - User responses: '200': description: If set, the updated Role assignment list is returned in XML or JSON format. content: application/vnd.ibexa.api.RoleAssignmentList+json: schema: $ref: '#/components/schemas/RoleAssignmentListWrapper' example: RoleAssignmentList: _media-type: application/vnd.ibexa.api.RoleAssignmentList+json _href: /api/ibexa/v2/user/users/57/roles RoleAssignment: - _media-type: application/vnd.ibexa.api.RoleAssignment+json _href: /api/ibexa/v2/user/users/57/roles/1 Role: _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/1 - _media-type: application/vnd.ibexa.api.RoleAssignment+json _href: /api/ibexa/v2/user/users/57/roles/2 Role: _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/2 application/vnd.ibexa.api.RoleAssignmentList+xml: schema: $ref: '#/components/schemas/RoleAssignmentList' example: | <?xml version="1.0" encoding="UTF-8"?> <RoleAssignmentList href="/user/groups/1/5/65/roles" media-type="application/vnd.ibexa.api.RoleAssignmentList+xml"> <RoleAssignment href="/user/groups/1/5/65/roles/5" media-type="application/vnd.ibexa.api.RoleAssignment+xml"> <Role href="/user/roles/5" media-type="application/vnd.ibexa.api.Role+xml"/> </RoleAssignment> <RoleAssignment href="/user/groups/1/5/65/roles/11" media-type="application/vnd.ibexa.api.RoleAssignment+xml"> <limitation identifier="Section"> <values> <ref href="/content/sections/1" media-type="application/vnd.ibexa.api.Section+xml" /> <ref href="/content/sections/4" media-type="application/vnd.ibexa.api.Section+xml" /> </values> </limitation> <Role href="/user/roles/11" media-type="application/vnd.ibexa.api.Role+xml"/> </RoleAssignment> </RoleAssignmentList> '401': description: Error - the user is not authorized to delete this content type. summary: Unassign Role from User description: The given Role is removed from the user. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: userId in: path description: RoleUnassignFromUserController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: roleId in: path description: RoleUnassignFromUserController identifier required: true deprecated: false schema: type: string style: simple explode: false /user/users/{userId}/segments: get: operationId: ibexa.segmentation.rest.user.segments.view tags: - User responses: '200': description: If set, the user's segment list is returned in XML or JSON format. content: application/vnd.ibexa.api.UserSegmentList+json: schema: $ref: '#/components/schemas/UserSegmentListWrapper' example: UserSegmentList: _media-type: application/vnd.ibexa.api.UserSegmentList+json _href: /api/ibexa/v2/user/users/14/segments UserSegment: - _media-type: application/vnd.ibexa.api.UserSegment+json id: 1 identifier: corporate_account name: Corporate Account source: cohesivo lastUpdatedBy: '14' updatedAt: '2026-06-30T12:00:00+00:00' SegmentGroup: _media-type: application/vnd.ibexa.api.SegmentGroup+json _href: /api/ibexa/v2/segment_groups/corporate_accounts User: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 application/vnd.ibexa.api.UserSegmentList+xml: schema: $ref: '#/components/schemas/UserSegmentList' example: | <?xml version="1.0" encoding="UTF-8"?> <UserSegmentList media-type="application/vnd.ibexa.api.UserSegmentList+xml" href="/api/ibexa/v2/user/users/14/segments"> <UserSegment media-type="application/vnd.ibexa.api.UserSegment+xml"> <id>1</id> <identifier>corporate_account</identifier> <name>Corporate Account</name> <source>cohesivo</source> <lastUpdatedBy>14</lastUpdatedBy> <updatedAt>2026-06-30T12:00:00+00:00</updatedAt> <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts"/> <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/1234"/> </UserSegment> </UserSegmentList> '404': description: Error - the user doesn't exist. summary: View user segments description: Return user's segment list. parameters: - name: userId in: path description: UserSegmentListController identifier required: true deprecated: false schema: type: string style: simple explode: false post: operationId: ibexa.segmentation.rest.user.segments.assign tags: - User responses: '204': description: No Content - segments assigned to user '401': description: Error - the requesting user is not authorized to assign this segment to the given user. '404': description: Error - the user doesn't exist. summary: Assign Segments to User description: Assigns Segments from payload to User given by ID. parameters: - name: X-CSRF-Token in: header description: The CSRF token. Used for POST, PATCH and DELETE requests. required: true deprecated: false schema: type: string style: simple explode: false - name: userId in: path description: UserSegmentAssignController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The UserSegmentAssignInput schema encoded in XML or JSON format. content: application/vnd.ibexa.api.UserSegmentAssignInput+json: schema: $ref: '#/components/schemas/UserSegmentAssignInputWrapper' example: UserSegmentAssignInput: segments: - corporate_account application/vnd.ibexa.api.UserSegmentAssignInput+xml: schema: $ref: '#/components/schemas/UserSegmentAssignInput' example: | <UserSegmentAssignInput> <segments>corporate_account</segments> </UserSegmentAssignInput> required: false /user/users/{userId}/segments/{segmentIdentifier}: delete: operationId: ibexa.segmentation.rest.user.segments.unnassign tags: - User responses: '204': description: No Content - segments unassigned from user '401': description: Error - the requesting user is not authorized to unassign this segment from the given user. '404': description: Error - the segment or the user doesn't exist. summary: Unassign Segment from User description: The Segment designated by its identifier is unassigned from the User given by ID. parameters: - name: X-CSRF-Token in: header description: The CSRF token. Used for POST, PATCH and DELETE requests. required: true deprecated: false schema: type: string style: simple explode: false - name: userId in: path description: UserSegmentUnassignController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: segmentIdentifier in: path description: UserSegmentUnassignController identifier required: true deprecated: false schema: type: string style: simple explode: false /user/groups: get: operationId: api_usergroups_get tags: - User Group responses: '200': description: OK - list of User Groups. content: application/vnd.ibexa.api.UserGroupList+xml: schema: $ref: '#/components/schemas/UserGroupList' example: | <?xml version="1.0" encoding="UTF-8"?> <UserGroupList media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/groups"> <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13/15" id="14" remoteId="1bb4fe25487f05527efa8bfd394cecc7"> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/> <name>Administrator User</name> <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/14/versions"/> <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/13/15"/> <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/14/locations"/> <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <publishDate>2002-10-06T16:13:50+00:00</publishDate> <lastModificationDate>2011-03-25T14:07:04+00:00</lastModificationDate> <mainLanguageCode>eng-GB</mainLanguageCode> <alwaysAvailable>true</alwaysAvailable> <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/14/versions/3"> <VersionInfo> <id>499</id> <versionNo>3</versionNo> <status>PUBLISHED</status> <modificationDate>2011-03-25T14:07:04+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <creationDate>2011-03-25T14:03:03+00:00</creationDate> <initialLanguageCode>eng-GB</initialLanguageCode> <languageCodes>eng-GB</languageCodes> <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> <Language> <languageCode>eng-GB</languageCode> </Language> </VersionTranslationInfo> <names> <value languageCode="eng-GB">Administrator User</value> </names> <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/14"/> </VersionInfo> <Fields> <field> <id>28</id> <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>Administrator</fieldValue> </field> <field> <id>29</id> <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>User</fieldValue> </field> <field> <id>30</id> <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> <fieldValue> <value key="hasStoredLogin">true</value> <value key="contentId">14</value> <value key="login">admin</value> <value key="email">admin@link.invalid</value> <value key="passwordUpdatedAt"/> <value key="enabled">true</value> <value key="maxLogin">10</value> <value key="plainPassword"/> </fieldValue> </field> <field> <id>178</id> <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier> <fieldValue/> </field> <field> <id>180</id> <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier> <fieldValue/> </field> </Fields> <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/14/versions/3/relations"/> <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource> <width></width> <height></height> <mimeType>image/svg+xml</mimeType> </Thumbnail> </Version> <ParentUserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13"/> <Subgroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/groups/1/5/13/15/subgroups"/> <Users media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/groups/1/5/13/15/users"/> <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/13/15/roles"/> </UserGroup> </UserGroupList> application/vnd.ibexa.api.UserGroupList+json: schema: $ref: '#/components/schemas/UserGroupListWrapper' example: UserGroupList: _media-type: application/vnd.ibexa.api.UserGroupList+json _href: /api/ibexa/v2/user/groups UserGroup: - _media-type: application/vnd.ibexa.api.UserGroup+json _href: /api/ibexa/v2/user/groups/1/5/13/15 _id: 14 _remoteId: 1bb4fe25487f05527efa8bfd394cecc7 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/4 name: Administrator User Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/14/versions Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/2 MainLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/5/13/15 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/14/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 publishDate: '2002-10-06T16:13:50+00:00' lastModificationDate: '2011-03-25T14:07:04+00:00' mainLanguageCode: eng-GB alwaysAvailable: true Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/14/versions/3 VersionInfo: id: 499 versionNo: 3 status: PUBLISHED modificationDate: '2011-03-25T14:07:04+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2011-03-25T14:03:03+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Administrator User Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/14 Fields: field: - id: 28 fieldDefinitionIdentifier: first_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Administrator - id: 29 fieldDefinitionIdentifier: last_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: User - id: 30 fieldDefinitionIdentifier: user_account languageCode: eng-GB fieldTypeIdentifier: ibexa_user fieldValue: hasStoredLogin: true contentId: 14 login: admin email: admin@link.invalid passwordUpdatedAt: null enabled: true maxLogin: 10 plainPassword: null - id: 178 fieldDefinitionIdentifier: signature languageCode: eng-GB fieldTypeIdentifier: ibexa_text fieldValue: null - id: 180 fieldDefinitionIdentifier: image languageCode: eng-GB fieldTypeIdentifier: ibexa_image fieldValue: null Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/14/versions/3/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ezplatformadminui/img/ez-icons.svg#user width: null height: null mimeType: image/svg+xml ParentUserGroup: _media-type: application/vnd.ibexa.api.UserGroup+json _href: /api/ibexa/v2/user/groups/1/5/13 Subgroups: _media-type: application/vnd.ibexa.api.UserGroupList+json _href: /api/ibexa/v2/user/groups/1/5/13/15/subgroups Users: _media-type: application/vnd.ibexa.api.UserList+json _href: /api/ibexa/v2/user/groups/1/5/13/15/users Roles: _media-type: application/vnd.ibexa.api.RoleAssignmentList+json _href: /api/ibexa/v2/user/groups/1/5/13/15/roles application/vnd.ibexa.api.UserGroupRefList+xml: schema: $ref: '#/components/schemas/UserGroupRefList' example: | <?xml version="1.0" encoding="UTF-8"?> <UserGroupRefList media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/115/groups"> <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/12"> <unassign href="/api/ibexa/v2/user/users/79/groups/12" method="DELETE"/> </UserGroup> <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13"> <unassign href="/api/ibexa/v2/user/users/115/groups/13" method="DELETE"/> </UserGroup> </UserGroupRefList> application/vnd.ibexa.api.UserGroupRefList+json: schema: $ref: '#/components/schemas/UserGroupRefListWrapper' example: UserGroupRefList: _media-type: application/vnd.ibexa.api.UserGroupRefList+json _href: /api/ibexa/v2/user/users/57/groups UserGroup: - _media-type: application/vnd.ibexa.api.UserGroup+json _href: /api/ibexa/v2/user/groups/1/5/13 '401': description: Error - the user has no permission to read User Groups. summary: Load User Groups description: Loads User Groups for either an an ID or a remote ID or a Role. parameters: - name: Accept in: header description: UserGroupList - If set, the User Group List is returned in XML or JSON format. UserGroupRefList - If set, the link list of User Group is returned in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false /user/groups/root: get: operationId: api_usergroupsroot_get tags: - User Group responses: '301': description: Moved permanently. summary: Get root User Group description: Redirects to the root User Group. parameters: [] /user/groups/subgroups: post: operationId: api_usergroupssubgroups_post tags: - User Group responses: '201': description: Created - the User Group has been created content: application/vnd.ibexa.api.UserGroup+xml: schema: $ref: '#/components/schemas/UserGroup' example: | <?xml version="1.0" encoding="UTF-8"?> <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/79" id="85" remoteId="remoteId-qwert098"> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/3"/> <name>UserGroup2</name> <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/85/versions"/> <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/79"/> <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/85/locations"/> <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <publishDate>2021-08-09T09:03:35+00:00</publishDate> <lastModificationDate>2021-08-09T09:03:35+00:00</lastModificationDate> <mainLanguageCode>eng-GB</mainLanguageCode> <alwaysAvailable>true</alwaysAvailable> <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/85/versions/1"> <VersionInfo> <id>576</id> <versionNo>1</versionNo> <status>PUBLISHED</status> <modificationDate>2021-08-09T09:03:35+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <creationDate>2021-08-09T09:03:35+00:00</creationDate> <initialLanguageCode>eng-GB</initialLanguageCode> <languageCodes>eng-GB</languageCodes> <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> <Language> <languageCode>eng-GB</languageCode> </Language> </VersionTranslationInfo> <names> <value languageCode="eng-GB">UserGroup2</value> </names> <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/85"/> </VersionInfo> <Fields> <field> <id>380</id> <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>UserGroup2</fieldValue> </field> <field> <id>381</id> <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>This is the description of the user group</fieldValue> </field> </Fields> <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/85/versions/1/relations"/> <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user_group</resource> <width></width> <height></height> <mimeType>image/svg+xml</mimeType> </Thumbnail> </Version> <ParentUserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5"/> <Subgroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/groups/1/5/79/subgroups"/> <Users media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/groups/1/5/79/users"/> <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/79/roles"/> </UserGroup> application/vnd.ibexa.api.UserGroup+json: schema: $ref: '#/components/schemas/UserGroupWrapper' example: UserGroup: _media-type: application/vnd.ibexa.api.UserGroup+json _href: /api/ibexa/v2/user/groups/1/5/81 _id: 87 _remoteId: remoteId-qwert098 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/3 name: UserGroup2 Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/87/versions Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/2 MainLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/5/81 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/87/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 publishDate: '2021-08-09T09:06:49+00:00' lastModificationDate: '2021-08-09T09:06:49+00:00' mainLanguageCode: eng-GB alwaysAvailable: true Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/87/versions/1 VersionInfo: id: 578 versionNo: 1 status: PUBLISHED modificationDate: '2021-08-09T09:06:49+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2021-08-09T09:06:49+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': UserGroup2 Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/87 Fields: field: - id: 384 fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: UserGroup2 - id: 385 fieldDefinitionIdentifier: description languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: This is the description of the user group Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/87/versions/1/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ezplatformadminui/img/ez-icons.svg#user_group width: null height: null mimeType: image/svg+xml ParentUserGroup: _media-type: application/vnd.ibexa.api.UserGroup+json _href: /api/ibexa/v2/user/groups/1/5 Subgroups: _media-type: application/vnd.ibexa.api.UserGroupList+json _href: /api/ibexa/v2/user/groups/1/5/81/subgroups Users: _media-type: application/vnd.ibexa.api.UserList+json _href: /api/ibexa/v2/user/groups/1/5/81/users Roles: _media-type: application/vnd.ibexa.api.RoleAssignmentList+json _href: /api/ibexa/v2/user/groups/1/5/81/roles '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to create this User Group. summary: Create a top level User Group description: Creates a top level User Group under the root. To create a child group under a parent group use '/user/groups/{path}/subgroups'. parameters: - name: Accept in: header description: If set, the new User Group is returned in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false - name: Content-Type in: header description: The UserGroupCreate schema encoded in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The new UserGroupCreateController resource content: application/vnd.ibexa.api.UserGroupCreate+xml: schema: $ref: '#/components/schemas/UserGroupCreate' example: |- <?xml version="1.0" encoding="UTF-8"?> <UserGroupCreate> <mainLanguageCode>eng-GB</mainLanguageCode> <remoteId>remoteId-qwert098</remoteId> <fields> <field> <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldValue>UserGroup</fieldValue> </field> <field> <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldValue>This is the description of the user group</fieldValue> </field> </fields> </UserGroupCreate> application/vnd.ibexa.api.UserGroupCreate+json: schema: $ref: '#/components/schemas/UserGroupCreateWrapper' example: UserGroupCreate: mainLanguageCode: eng-GB remoteId: remoteId-qwert098 fields: field: - fieldDefinitionIdentifier: name languageCode: eng-GB fieldValue: UserGroup2 - fieldDefinitionIdentifier: description languageCode: eng-GB fieldValue: This is the description of the user group required: false /user/groups/{path}: get: operationId: api_usergroups_path_get tags: - User Group responses: '200': description: OK - loads User Groups. content: application/vnd.ibexa.api.UserGroup+xml: schema: $ref: '#/components/schemas/UserGroup' example: | <?xml version="1.0" encoding="UTF-8"?> <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/79" id="85" remoteId="remoteId-qwert098"> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/3"/> <name>UserGroup2</name> <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/85/versions"/> <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/79"/> <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/85/locations"/> <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <publishDate>2021-08-09T09:03:35+00:00</publishDate> <lastModificationDate>2021-08-09T09:03:35+00:00</lastModificationDate> <mainLanguageCode>eng-GB</mainLanguageCode> <alwaysAvailable>true</alwaysAvailable> <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/85/versions/1"> <VersionInfo> <id>576</id> <versionNo>1</versionNo> <status>PUBLISHED</status> <modificationDate>2021-08-09T09:03:35+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <creationDate>2021-08-09T09:03:35+00:00</creationDate> <initialLanguageCode>eng-GB</initialLanguageCode> <languageCodes>eng-GB</languageCodes> <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> <Language> <languageCode>eng-GB</languageCode> </Language> </VersionTranslationInfo> <names> <value languageCode="eng-GB">UserGroup2</value> </names> <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/85"/> </VersionInfo> <Fields> <field> <id>380</id> <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>UserGroup2</fieldValue> </field> <field> <id>381</id> <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>This is the description of the user group</fieldValue> </field> </Fields> <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/85/versions/1/relations"/> <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user_group</resource> <width></width> <height></height> <mimeType>image/svg+xml</mimeType> </Thumbnail> </Version> <ParentUserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5"/> <Subgroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/groups/1/5/79/subgroups"/> <Users media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/groups/1/5/79/users"/> <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/79/roles"/> </UserGroup> application/vnd.ibexa.api.UserGroup+json: schema: $ref: '#/components/schemas/UserGroupWrapper' example: UserGroup: _media-type: application/vnd.ibexa.api.UserGroup+json _href: /api/ibexa/v2/user/groups/1/5/81 _id: 87 _remoteId: remoteId-qwert098 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/3 name: UserGroup2 Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/87/versions Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/2 MainLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/5/81 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/87/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 publishDate: '2021-08-09T09:06:49+00:00' lastModificationDate: '2021-08-09T09:06:49+00:00' mainLanguageCode: eng-GB alwaysAvailable: true Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/87/versions/1 VersionInfo: id: 578 versionNo: 1 status: PUBLISHED modificationDate: '2021-08-09T09:06:49+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2021-08-09T09:06:49+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': UserGroup2 Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/87 Fields: field: - id: 384 fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: UserGroup2 - id: 385 fieldDefinitionIdentifier: description languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: This is the description of the user group Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/87/versions/1/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ezplatformadminui/img/ez-icons.svg#user_group width: null height: null mimeType: image/svg+xml ParentUserGroup: _media-type: application/vnd.ibexa.api.UserGroup+json _href: /api/ibexa/v2/user/groups/1/5 Subgroups: _media-type: application/vnd.ibexa.api.UserGroupList+json _href: /api/ibexa/v2/user/groups/1/5/81/subgroups Users: _media-type: application/vnd.ibexa.api.UserList+json _href: /api/ibexa/v2/user/groups/1/5/81/users Roles: _media-type: application/vnd.ibexa.api.RoleAssignmentList+json _href: /api/ibexa/v2/user/groups/1/5/81/roles '401': description: Error - the user has no permission to read User Groups. '404': description: Error - the User Group does not exist. summary: Load User Group description: Loads User Groups for the given {path}. parameters: - name: Accept in: header description: If set, the new User Group is returned in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false - name: If-None-Match in: header description: ETag required: true deprecated: false schema: type: string style: simple explode: false - name: path in: path description: UserGroupLoadByPathController identifier required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: api_usergroups_path_delete tags: - User Group responses: '204': description: No content - the given User Group is deleted. '401': description: Error - the user is not authorized to delete this content type. '403': description: Error - the User Group is not empty. summary: Delete User Group description: The given User Group is deleted. parameters: - name: path in: path description: UserGroupDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: api_usergroups_path_patch tags: - User Group responses: '200': description: OK - updated User Group. content: application/vnd.ibexa.api.UserGroup+xml: schema: $ref: '#/components/schemas/UserGroup' example: | <?xml version="1.0" encoding="UTF-8"?> <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/79" id="85" remoteId="remoteId-qwert098"> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/3"/> <name>UserGroup2</name> <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/85/versions"/> <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/79"/> <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/85/locations"/> <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <publishDate>2021-08-09T09:03:35+00:00</publishDate> <lastModificationDate>2021-08-09T09:03:35+00:00</lastModificationDate> <mainLanguageCode>eng-GB</mainLanguageCode> <alwaysAvailable>true</alwaysAvailable> <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/85/versions/1"> <VersionInfo> <id>576</id> <versionNo>1</versionNo> <status>PUBLISHED</status> <modificationDate>2021-08-09T09:03:35+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <creationDate>2021-08-09T09:03:35+00:00</creationDate> <initialLanguageCode>eng-GB</initialLanguageCode> <languageCodes>eng-GB</languageCodes> <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> <Language> <languageCode>eng-GB</languageCode> </Language> </VersionTranslationInfo> <names> <value languageCode="eng-GB">UserGroup2</value> </names> <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/85"/> </VersionInfo> <Fields> <field> <id>380</id> <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>UserGroup2</fieldValue> </field> <field> <id>381</id> <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>This is the description of the user group</fieldValue> </field> </Fields> <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/85/versions/1/relations"/> <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user_group</resource> <width></width> <height></height> <mimeType>image/svg+xml</mimeType> </Thumbnail> </Version> <ParentUserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5"/> <Subgroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/groups/1/5/79/subgroups"/> <Users media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/groups/1/5/79/users"/> <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/79/roles"/> </UserGroup> application/vnd.ibexa.api.UserGroup+json: schema: $ref: '#/components/schemas/UserGroupWrapper' example: UserGroup: _media-type: application/vnd.ibexa.api.UserGroup+json _href: /api/ibexa/v2/user/groups/1/5/81 _id: 87 _remoteId: remoteId-qwert098 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/3 name: UserGroup2 Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/87/versions Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/2 MainLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/5/81 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/87/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 publishDate: '2021-08-09T09:06:49+00:00' lastModificationDate: '2021-08-09T09:06:49+00:00' mainLanguageCode: eng-GB alwaysAvailable: true Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/87/versions/1 VersionInfo: id: 578 versionNo: 1 status: PUBLISHED modificationDate: '2021-08-09T09:06:49+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2021-08-09T09:06:49+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': UserGroup2 Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/87 Fields: field: - id: 384 fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: UserGroup2 - id: 385 fieldDefinitionIdentifier: description languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: This is the description of the user group Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/87/versions/1/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ezplatformadminui/img/ez-icons.svg#user_group width: null height: null mimeType: image/svg+xml ParentUserGroup: _media-type: application/vnd.ibexa.api.UserGroup+json _href: /api/ibexa/v2/user/groups/1/5 Subgroups: _media-type: application/vnd.ibexa.api.UserGroupList+json _href: /api/ibexa/v2/user/groups/1/5/81/subgroups Users: _media-type: application/vnd.ibexa.api.UserList+json _href: /api/ibexa/v2/user/groups/1/5/81/users Roles: _media-type: application/vnd.ibexa.api.RoleAssignmentList+json _href: /api/ibexa/v2/user/groups/1/5/81/roles '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to update the User Group. '412': description: "Error -\tif the current ETag does not match with the one provided in the If-Match header." summary: Update User Group description: Updates a User Group. PATCH or POST with header X-HTTP-Method-Override PATCH. parameters: - name: Accept in: header description: If set, the new User Group is returned in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false - name: Content-Type in: header description: The UserGroupUpdate schema encoded in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false - name: If-Match in: header description: Performs the PATCH only if the specified ETag is the current one. Otherwise a 412 is returned. required: true deprecated: false schema: type: string style: simple explode: false - name: path in: path description: UserGroupUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The updated UserGroupUpdateController resource content: application/vnd.ibexa.api.UserGroupUpdate+xml: schema: $ref: '#/components/schemas/UserGroupUpdate' example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<UserGroupUpdate>\n\t<Section href=\"/api/ibexa/v2/content/sections/2\" />\n</UserGroupUpdate>\n" application/vnd.ibexa.api.UserGroupUpdate+json: schema: $ref: '#/components/schemas/UserGroupUpdateWrapper' example: UserGroupUpdate: Section: _href: /api/ibexa/v2/content/sections/2 required: false /user/groups/{path}/roles: get: operationId: ibexa.rest.load_role_assignments_for_user_group tags: - User Group responses: '200': description: If set, the Role assignment list is returned in XML or JSON format. content: application/vnd.ibexa.api.RoleAssignmentList+json: schema: $ref: '#/components/schemas/RoleAssignmentListWrapper' example: RoleAssignment: _media-type: application/vnd.ibexa.api.RoleAssignment+json _href: /api/ibexa/v2/user/groups/1/42/44/roles/1 Role: _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/1 application/vnd.ibexa.api.RoleAssignmentList+xml: schema: $ref: '#/components/schemas/RoleAssignmentList' example: | <?xml version="1.0" encoding="UTF-8"?> <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/42/44/roles/1"> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/1"/> </RoleAssignment> '400': description: Error - the user has no permission to read Roles. summary: Load Roles for User Group description: Returns a list of all Roles assigned to the given User Group. parameters: - name: path in: path description: RoleAssignmentForUserGroupListController identifier required: true deprecated: false schema: type: string style: simple explode: false post: operationId: ibexa.rest.assign_role_to_user_group tags: - User Group responses: '200': description: If set, the updated Role assignment list is returned in XML or JSON format. content: application/vnd.ibexa.api.RoleAssignmentList+json: schema: $ref: '#/components/schemas/RoleAssignmentListWrapper' example: RoleAssignmentList: _media-type: application/vnd.ibexa.api.RoleAssignmentList+json _href: /api/ibexa/v2/user/groups/1/12/2/roles RoleAssignment: - _media-type: application/vnd.ibexa.api.RoleAssignment+json _href: /api/ibexa/v2/user/groups/1/12/2/roles/2 Role: _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/2 application/vnd.ibexa.api.RoleAssignmentList+xml: schema: $ref: '#/components/schemas/RoleAssignmentList' example: | <?xml version="1.0" encoding="UTF-8"?> <RoleAssignmentList media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles"> <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles/3"> <limitation identifier="Section"> <values> <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/> </values> </limitation> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/3"/> </RoleAssignment> <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles/10"> <limitation identifier="Section"> <values> <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/> </values> </limitation> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/10"/> </RoleAssignment> <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles/10"> <limitation identifier="Section"> <values> <ref media-type="application/vnd.ibexa.api.ref+xml" href="4"/> </values> </limitation> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/10"/> </RoleAssignment> </RoleAssignmentList> '400': description: Error - validation of limitation in RoleAssignInput fails. '401': description: Error - the user is not authorized to assign this Role. summary: Assign Role to User Group description: Assigns a Role to a User Group. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: path in: path description: RoleAssignToUserGroupController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The RoleAssignInput schema encoded in XML or JSON format. content: application/vnd.ibexa.api.RoleAssignInput+json: schema: $ref: '#/components/schemas/RoleAssignInputWrapper' example: RoleAssignInput: Role: _href: /api/ibexa/v2/user/roles/2 _media-type: application/vnd.ibexa.api.RoleAssignInput+json limitation: _identifier: Section values: ref: - _href: /api/ibexa/v2/content/sections/1 _media-type: application/vnd.ibexa.api.Section+json - _href: /api/ibexa/v2/content/sections/4 _media-type: application/vnd.ibexa.api.Section+json application/vnd.ibexa.api.RoleAssignInput+xml: schema: $ref: '#/components/schemas/RoleAssignInput' example: | <?xml version="1.0" encoding="UTF-8"?> <RoleAssignInput> <Role href="/api/ibexa/v2/user/roles/10" media-type="application/vnd.ibexa.api.RoleAssignInput+xml"/> <limitation identifier="Section"> <values> <ref href="/api/ibexa/v2/content/sections/1" media-type="application/vnd.ibexa.api.Section+xml" /> <ref href="/api/ibexa/v2/content/sections/4" media-type="application/vnd.ibexa.api.Section+xml" /> </values> </limitation> </RoleAssignInput> required: false /user/groups/{path}/roles/{roleId}: get: operationId: ibexa.rest.load_role_assignment_for_user_group tags: - User Group responses: '200': description: OK - returns a Role assignment of the given User Group. content: application/vnd.ibexa.api.RoleAssignment+json: schema: $ref: '#/components/schemas/RoleAssignmentWrapper' example: RoleAssignment: _media-type: application/vnd.ibexa.api.RoleAssignment+json _href: /api/ibexa/v2/user/groups/1/11/12/roles/1 Role: _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/1 application/vnd.ibexa.api.RoleAssignment+xml: schema: $ref: '#/components/schemas/RoleAssignment' example: | <?xml version="1.0" encoding="UTF-8"?> <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/11/12/roles/1"> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/1"/> </RoleAssignment> '401': description: Error - the user has no permission to read Roles. summary: Load User Group Role Assignment description: Returns a Role assignment of the given User Group. parameters: - name: path in: path description: RoleAssignmentForUserGroupLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: roleId in: path description: RoleAssignmentForUserGroupLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: ibexa.rest.unassign_role_from_user_group tags: - User Group responses: '200': description: If set, the updated Role assignment list is returned in XML or JSON format. content: application/vnd.ibexa.api.RoleAssignmentList+json: schema: $ref: '#/components/schemas/RoleAssignmentListWrapper' example: RoleAssignmentList: _media-type: application/vnd.ibexa.api.RoleAssignmentList+json _href: /api/ibexa/v2/user/groups/1/57/58/roles RoleAssignment: - _media-type: application/vnd.ibexa.api.RoleAssignment+json _href: /api/ibexa/v2/user/groups/1/57/58/roles/3 limitation: _identifier: Section values: ref: - _media-type: application/vnd.ibexa.api.ref+json _href: '1' Role: _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/3 application/vnd.ibexa.api.RoleAssignmentList+xml: schema: $ref: '#/components/schemas/RoleAssignmentList' example: | <?xml version="1.0" encoding="UTF-8"?> <RoleAssignmentList media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles"> <RoleAssignment media-type="application/vnd.ibexa.api.RoleAssignment+xml" href="/api/ibexa/v2/user/groups/1/5/65/roles/3"> <limitation identifier="Section"> <values> <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/> </values> </limitation> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/3"/> </RoleAssignment> </RoleAssignmentList> '401': description: Error - the user is not authorized to delete this Role assignment. summary: Unassign Role from User Group description: The given Role is removed from the User or User Group. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: path in: path description: RoleUnassignFromUserGroupController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: roleId in: path description: RoleUnassignFromUserGroupController identifier required: true deprecated: false schema: type: string style: simple explode: false /user/groups/{path}/subgroups: get: operationId: api_usergroups_pathsubgroups_get tags: - User Group responses: '200': description: OK - list of the subgroups. content: application/vnd.ibexa.api.UserGroupList+xml: schema: $ref: '#/components/schemas/UserGroupList' example: | <?xml version="1.0" encoding="UTF-8"?> <UserGroupList media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/groups"> <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13/15" id="14" remoteId="1bb4fe25487f05527efa8bfd394cecc7"> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/> <name>Administrator User</name> <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/14/versions"/> <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/13/15"/> <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/14/locations"/> <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <publishDate>2002-10-06T16:13:50+00:00</publishDate> <lastModificationDate>2011-03-25T14:07:04+00:00</lastModificationDate> <mainLanguageCode>eng-GB</mainLanguageCode> <alwaysAvailable>true</alwaysAvailable> <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/14/versions/3"> <VersionInfo> <id>499</id> <versionNo>3</versionNo> <status>PUBLISHED</status> <modificationDate>2011-03-25T14:07:04+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <creationDate>2011-03-25T14:03:03+00:00</creationDate> <initialLanguageCode>eng-GB</initialLanguageCode> <languageCodes>eng-GB</languageCodes> <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> <Language> <languageCode>eng-GB</languageCode> </Language> </VersionTranslationInfo> <names> <value languageCode="eng-GB">Administrator User</value> </names> <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/14"/> </VersionInfo> <Fields> <field> <id>28</id> <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>Administrator</fieldValue> </field> <field> <id>29</id> <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>User</fieldValue> </field> <field> <id>30</id> <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> <fieldValue> <value key="hasStoredLogin">true</value> <value key="contentId">14</value> <value key="login">admin</value> <value key="email">admin@link.invalid</value> <value key="passwordUpdatedAt"/> <value key="enabled">true</value> <value key="maxLogin">10</value> <value key="plainPassword"/> </fieldValue> </field> <field> <id>178</id> <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier> <fieldValue/> </field> <field> <id>180</id> <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier> <fieldValue/> </field> </Fields> <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/14/versions/3/relations"/> <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource> <width></width> <height></height> <mimeType>image/svg+xml</mimeType> </Thumbnail> </Version> <ParentUserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13"/> <Subgroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/groups/1/5/13/15/subgroups"/> <Users media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/groups/1/5/13/15/users"/> <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/13/15/roles"/> </UserGroup> </UserGroupList> application/vnd.ibexa.api.UserGroupList+json: schema: $ref: '#/components/schemas/UserGroupListWrapper' example: UserGroupList: _media-type: application/vnd.ibexa.api.UserGroupList+json _href: /api/ibexa/v2/user/groups UserGroup: - _media-type: application/vnd.ibexa.api.UserGroup+json _href: /api/ibexa/v2/user/groups/1/5/13/15 _id: 14 _remoteId: 1bb4fe25487f05527efa8bfd394cecc7 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/4 name: Administrator User Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/14/versions Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/2 MainLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/5/13/15 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/14/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 publishDate: '2002-10-06T16:13:50+00:00' lastModificationDate: '2011-03-25T14:07:04+00:00' mainLanguageCode: eng-GB alwaysAvailable: true Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/14/versions/3 VersionInfo: id: 499 versionNo: 3 status: PUBLISHED modificationDate: '2011-03-25T14:07:04+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2011-03-25T14:03:03+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Administrator User Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/14 Fields: field: - id: 28 fieldDefinitionIdentifier: first_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Administrator - id: 29 fieldDefinitionIdentifier: last_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: User - id: 30 fieldDefinitionIdentifier: user_account languageCode: eng-GB fieldTypeIdentifier: ibexa_user fieldValue: hasStoredLogin: true contentId: 14 login: admin email: admin@link.invalid passwordUpdatedAt: null enabled: true maxLogin: 10 plainPassword: null - id: 178 fieldDefinitionIdentifier: signature languageCode: eng-GB fieldTypeIdentifier: ibexa_text fieldValue: null - id: 180 fieldDefinitionIdentifier: image languageCode: eng-GB fieldTypeIdentifier: ibexa_image fieldValue: null Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/14/versions/3/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ezplatformadminui/img/ez-icons.svg#user width: null height: null mimeType: image/svg+xml ParentUserGroup: _media-type: application/vnd.ibexa.api.UserGroup+json _href: /api/ibexa/v2/user/groups/1/5/13 Subgroups: _media-type: application/vnd.ibexa.api.UserGroupList+json _href: /api/ibexa/v2/user/groups/1/5/13/15/subgroups Users: _media-type: application/vnd.ibexa.api.UserList+json _href: /api/ibexa/v2/user/groups/1/5/13/15/users Roles: _media-type: application/vnd.ibexa.api.RoleAssignmentList+json _href: /api/ibexa/v2/user/groups/1/5/13/15/roles application/vnd.ibexa.api.UserGroupRefList+xml: schema: $ref: '#/components/schemas/UserGroupRefList' example: | <?xml version="1.0" encoding="UTF-8"?> <UserGroupRefList media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/115/groups"> <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/12"> <unassign href="/api/ibexa/v2/user/users/79/groups/12" method="DELETE"/> </UserGroup> <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/13"> <unassign href="/api/ibexa/v2/user/users/115/groups/13" method="DELETE"/> </UserGroup> </UserGroupRefList> application/vnd.ibexa.api.UserGroupRefList+json: schema: $ref: '#/components/schemas/UserGroupRefListWrapper' example: UserGroupRefList: _media-type: application/vnd.ibexa.api.UserGroupRefList+json _href: /api/ibexa/v2/user/users/57/groups UserGroup: - _media-type: application/vnd.ibexa.api.UserGroup+json _href: /api/ibexa/v2/user/groups/1/5/13 '401': description: Error - the user has no permission to read User Groups. '404': description: Error - the User Group does not exist. summary: Load subgroups description: Returns a list of the subgroups. parameters: - name: Accept in: header description: UserGroupList - If set, the User Group list is returned in XML or JSON format. UserGroupRefList - If set, the link list of User Groups is returned in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false - name: path in: path description: UserSubGroupListController identifier required: true deprecated: false schema: type: string style: simple explode: false post: operationId: api_usergroups_pathsubgroups_post tags: - User Group responses: '201': description: Created - the User Group has been created. content: application/vnd.ibexa.api.UserGroup+xml: schema: $ref: '#/components/schemas/UserGroup' example: | <?xml version="1.0" encoding="UTF-8"?> <UserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5/79" id="85" remoteId="remoteId-qwert098"> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/3"/> <name>UserGroup2</name> <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/85/versions"/> <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/79"/> <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/85/locations"/> <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <publishDate>2021-08-09T09:03:35+00:00</publishDate> <lastModificationDate>2021-08-09T09:03:35+00:00</lastModificationDate> <mainLanguageCode>eng-GB</mainLanguageCode> <alwaysAvailable>true</alwaysAvailable> <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/85/versions/1"> <VersionInfo> <id>576</id> <versionNo>1</versionNo> <status>PUBLISHED</status> <modificationDate>2021-08-09T09:03:35+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <creationDate>2021-08-09T09:03:35+00:00</creationDate> <initialLanguageCode>eng-GB</initialLanguageCode> <languageCodes>eng-GB</languageCodes> <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> <Language> <languageCode>eng-GB</languageCode> </Language> </VersionTranslationInfo> <names> <value languageCode="eng-GB">UserGroup2</value> </names> <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/85"/> </VersionInfo> <Fields> <field> <id>380</id> <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>UserGroup2</fieldValue> </field> <field> <id>381</id> <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>This is the description of the user group</fieldValue> </field> </Fields> <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/85/versions/1/relations"/> <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user_group</resource> <width></width> <height></height> <mimeType>image/svg+xml</mimeType> </Thumbnail> </Version> <ParentUserGroup media-type="application/vnd.ibexa.api.UserGroup+xml" href="/api/ibexa/v2/user/groups/1/5"/> <Subgroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/groups/1/5/79/subgroups"/> <Users media-type="application/vnd.ibexa.api.UserList+xml" href="/api/ibexa/v2/user/groups/1/5/79/users"/> <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/groups/1/5/79/roles"/> </UserGroup> application/vnd.ibexa.api.UserGroup+json: schema: $ref: '#/components/schemas/UserGroupWrapper' example: UserGroup: _media-type: application/vnd.ibexa.api.UserGroup+json _href: /api/ibexa/v2/user/groups/1/5/81 _id: 87 _remoteId: remoteId-qwert098 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/3 name: UserGroup2 Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/87/versions Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/2 MainLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/5/81 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/87/locations Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 publishDate: '2021-08-09T09:06:49+00:00' lastModificationDate: '2021-08-09T09:06:49+00:00' mainLanguageCode: eng-GB alwaysAvailable: true Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/87/versions/1 VersionInfo: id: 578 versionNo: 1 status: PUBLISHED modificationDate: '2021-08-09T09:06:49+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2021-08-09T09:06:49+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': UserGroup2 Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/87 Fields: field: - id: 384 fieldDefinitionIdentifier: name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: UserGroup2 - id: 385 fieldDefinitionIdentifier: description languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: This is the description of the user group Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/87/versions/1/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ezplatformadminui/img/ez-icons.svg#user_group width: null height: null mimeType: image/svg+xml ParentUserGroup: _media-type: application/vnd.ibexa.api.UserGroup+json _href: /api/ibexa/v2/user/groups/1/5 Subgroups: _media-type: application/vnd.ibexa.api.UserGroupList+json _href: /api/ibexa/v2/user/groups/1/5/81/subgroups Users: _media-type: application/vnd.ibexa.api.UserList+json _href: /api/ibexa/v2/user/groups/1/5/81/users Roles: _media-type: application/vnd.ibexa.api.RoleAssignmentList+json _href: /api/ibexa/v2/user/groups/1/5/81/roles '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to create this User Group. summary: Create User Group description: Creates a new User Group under the given parent. To create a top level group use '/user/groups/subgroups'. parameters: - name: Accept in: header description: If set, the new User Group is returned in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false - name: Content-Type in: header description: The UserGroupCreate schema encoded in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false - name: path in: path description: UserGroupCreateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The new UserGroupCreateController resource content: application/vnd.ibexa.api.UserGroupCreate+xml: schema: $ref: '#/components/schemas/UserGroupCreate' example: |- <?xml version="1.0" encoding="UTF-8"?> <UserGroupCreate> <mainLanguageCode>eng-GB</mainLanguageCode> <remoteId>remoteId-qwert098</remoteId> <fields> <field> <fieldDefinitionIdentifier>name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldValue>UserGroup</fieldValue> </field> <field> <fieldDefinitionIdentifier>description</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldValue>This is the description of the user group</fieldValue> </field> </fields> </UserGroupCreate> application/vnd.ibexa.api.UserGroupCreate+json: schema: $ref: '#/components/schemas/UserGroupCreateWrapper' example: UserGroupCreate: mainLanguageCode: eng-GB remoteId: remoteId-qwert098 fields: field: - fieldDefinitionIdentifier: name languageCode: eng-GB fieldValue: UserGroup2 - fieldDefinitionIdentifier: description languageCode: eng-GB fieldValue: This is the description of the user group required: false /user/groups/{path}/users: get: operationId: api_usergroups_pathusers_get tags: - User Group responses: '200': description: OK - the Users of the Group with the given ID. content: application/vnd.ibexa.api.UserList+xml: schema: $ref: '#/components/schemas/UserList' application/vnd.ibexa.api.UserList+json: schema: $ref: '#/components/schemas/UserList' application/vnd.ibexa.api.UserRefList+xml: schema: $ref: '#/components/schemas/UserRefList' example: | <?xml version="1.0" encoding="UTF-8"?> <UserRefList media-type="application/vnd.ibexa.api.UserRefList+xml" href="/api/ibexa/v2/user/users"> <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> </UserRefList> application/vnd.ibexa.api.UserRefList+json: schema: $ref: '#/components/schemas/UserRefListWrapper' example: UserRefList: _media-type: application/vnd.ibexa.api.UserRefList+json _href: /api/ibexa/v2/user/groups/13/users User: - _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/113 - _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 '401': description: Error - the user has no permission to read User Groups. '404': description: Error - the User Group does not exist. summary: Load Users of Group description: Loads the Users of the Group with the given ID. parameters: - name: Accept in: header description: UserList - If set, the User list returned in XML or JSON format. UserRefList - If set, the link list of Users returned in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false - name: path in: path description: UserGroupUsersListController identifier required: true deprecated: false schema: type: string style: simple explode: false post: operationId: api_usergroups_pathusers_post tags: - User Group responses: '201': description: Created - the User has been created. content: application/vnd.ibexa.api.User+xml: schema: $ref: '#/components/schemas/User' example: | <?xml version="1.0" encoding="UTF-8"?> <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/79" id="79" remoteId="bcf0764b417f05af21852a1f03fb1f13"> <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/4"/> <name>Jose Vargas</name> <Versions media-type="application/vnd.ibexa.api.VersionList+xml" href="/api/ibexa/v2/content/objects/79/versions"/> <Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/2"/> <MainLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/5/12/79"/> <Locations media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/objects/79/locations"/> <Groups media-type="application/vnd.ibexa.api.UserGroupRefList+xml" href="/api/ibexa/v2/user/users/79/groups"/> <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/10"/> <publishDate>2021-06-29T08:23:42+00:00</publishDate> <lastModificationDate>2021-07-29T11:45:07+00:00</lastModificationDate> <mainLanguageCode>eng-GB</mainLanguageCode> <alwaysAvailable>true</alwaysAvailable> <Version media-type="application/vnd.ibexa.api.Version+xml" href="/api/ibexa/v2/content/objects/79/versions/6"> <VersionInfo> <id>609</id> <versionNo>6</versionNo> <status>PUBLISHED</status> <modificationDate>2021-07-29T11:45:07+00:00</modificationDate> <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> <creationDate>2021-07-29T11:45:07+00:00</creationDate> <initialLanguageCode>eng-GB</initialLanguageCode> <languageCodes>eng-GB</languageCodes> <VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml"> <Language> <languageCode>eng-GB</languageCode> </Language> </VersionTranslationInfo> <names> <value languageCode="eng-GB">Jose Vargas</value> </names> <Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/79"/> </VersionInfo> <Fields> <field> <id>342</id> <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>Jose</fieldValue> </field> <field> <id>343</id> <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_string</fieldTypeIdentifier> <fieldValue>Vargas</fieldValue> </field> <field> <id>344</id> <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_user</fieldTypeIdentifier> <fieldValue> <value key="hasStoredLogin">true</value> <value key="contentId">79</value> <value key="login">josevargas</value> <value key="email">aa@bb.cc</value> <value key="passwordUpdatedAt"/> <value key="enabled">false</value> <value key="maxLogin">0</value> <value key="plainPassword"/> </fieldValue> </field> <field> <id>345</id> <fieldDefinitionIdentifier>signature</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_text</fieldTypeIdentifier> <fieldValue/> </field> <field> <id>346</id> <fieldDefinitionIdentifier>image</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldTypeIdentifier>ibexa_image</fieldTypeIdentifier> <fieldValue/> </field> </Fields> <Relations media-type="application/vnd.ibexa.api.RelationList+xml" href="/api/ibexa/v2/content/objects/79/versions/6/relations"/> <Thumbnail media-type="application/vnd.ibexa.api.Thumbnail+xml"> <resource>/bundles/ezplatformadminui/img/ez-icons.svg#user</resource> <width></width> <height></height> <mimeType>image/svg+xml</mimeType> </Thumbnail> </Version> <login>josevargas</login> <email>aa@bb.cc</email> <enabled>false</enabled> <UserGroups media-type="application/vnd.ibexa.api.UserGroupList+xml" href="/api/ibexa/v2/user/users/79/groups"/> <Roles media-type="application/vnd.ibexa.api.RoleAssignmentList+xml" href="/api/ibexa/v2/user/users/79/roles"/> </User> application/vnd.ibexa.api.User+json: schema: $ref: '#/components/schemas/UserWrapper' example: User: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/79 _id: 79 _remoteId: bcf0764b417f05af21852a1f03fb1f13 ContentType: _media-type: application/vnd.ibexa.api.ContentType+json _href: /api/ibexa/v2/content/types/4 name: Jose Vargas Versions: _media-type: application/vnd.ibexa.api.VersionList+json _href: /api/ibexa/v2/content/objects/79/versions Section: _media-type: application/vnd.ibexa.api.Section+json _href: /api/ibexa/v2/content/sections/2 MainLocation: _media-type: application/vnd.ibexa.api.Location+json _href: /api/ibexa/v2/content/locations/1/5/12/79 Locations: _media-type: application/vnd.ibexa.api.LocationList+json _href: /api/ibexa/v2/content/objects/79/locations Groups: _media-type: application/vnd.ibexa.api.UserGroupRefList+json _href: /api/ibexa/v2/user/users/79/groups Owner: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/10 publishDate: '2021-06-29T08:23:42+00:00' lastModificationDate: '2021-07-29T12:00:24+00:00' mainLanguageCode: eng-GB alwaysAvailable: true Version: _media-type: application/vnd.ibexa.api.Version+json _href: /api/ibexa/v2/content/objects/79/versions/11 VersionInfo: id: 614 versionNo: 11 status: PUBLISHED modificationDate: '2021-07-29T12:00:24+00:00' Creator: _media-type: application/vnd.ibexa.api.User+json _href: /api/ibexa/v2/user/users/14 creationDate: '2021-07-29T12:00:24+00:00' initialLanguageCode: eng-GB languageCodes: eng-GB VersionTranslationInfo: _media-type: application/vnd.ibexa.api.VersionTranslationInfo+json Language: - languageCode: eng-GB names: value: - _languageCode: eng-GB '#text': Jose Vargas Content: _media-type: application/vnd.ibexa.api.ContentInfo+json _href: /api/ibexa/v2/content/objects/79 Fields: field: - id: 342 fieldDefinitionIdentifier: first_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Jose - id: 343 fieldDefinitionIdentifier: last_name languageCode: eng-GB fieldTypeIdentifier: ibexa_string fieldValue: Vargas - id: 344 fieldDefinitionIdentifier: user_account languageCode: eng-GB fieldTypeIdentifier: ibexa_user fieldValue: hasStoredLogin: true contentId: 79 login: josevargas email: aa@bb.cc passwordUpdatedAt: null enabled: false maxLogin: 0 plainPassword: null - id: 345 fieldDefinitionIdentifier: signature languageCode: eng-GB fieldTypeIdentifier: ibexa_text fieldValue: null - id: 346 fieldDefinitionIdentifier: image languageCode: eng-GB fieldTypeIdentifier: ibexa_image fieldValue: null Relations: _media-type: application/vnd.ibexa.api.RelationList+json _href: /api/ibexa/v2/content/objects/79/versions/11/relations Relation: [] Thumbnail: _media-type: application/vnd.ibexa.api.Thumbnail+json resource: /bundles/ezplatformadminui/img/ez-icons.svg#user width: null height: null mimeType: image/svg+xml login: josevargas email: aa@bb.cc enabled: false UserGroups: _media-type: application/vnd.ibexa.api.UserGroupList+json _href: /api/ibexa/v2/user/users/79/groups Roles: _media-type: application/vnd.ibexa.api.RoleAssignmentList+json _href: /api/ibexa/v2/user/users/79/roles '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to create this User. '403': description: Error - a User with the same login already exists. '404': description: Error - the Group with the given ID does not exist. summary: Create User description: Creates a new User in the given Group. parameters: - name: Accept in: header description: If set, the new User is returned in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false - name: Content-Type in: header description: The UserCreate schema encoded in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false - name: path in: path description: UserCreateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The new UserCreateController resource content: application/vnd.ibexa.api.UserCreate+xml: schema: $ref: '#/components/schemas/UserCreate' example: | <?xml version="1.0" encoding="UTF-8"?> <UserCreate> <mainLanguageCode>eng-GB</mainLanguageCode> <remoteId>remoteId-23456789</remoteId> <login>johnsmith</login> <email>example@example.com</email> <password>Secrepassword5!</password> <fields> <field> <fieldDefinitionIdentifier>first_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldValue>John</fieldValue> </field> <field> <fieldDefinitionIdentifier>last_name</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldValue>Smith</fieldValue> </field> <field> <fieldDefinitionIdentifier>user_account</fieldDefinitionIdentifier> <languageCode>eng-GB</languageCode> <fieldValue> <value key="hasStoredLogin">true</value> <value key="contentId">14</value> <value key="login">johnsmith</value> <value key="email">example@example.com</value> <value key="enabled">true</value> <value key="maxLogin">10</value> </fieldValue> </field> </fields> </UserCreate> application/vnd.ibexa.api.UserCreate+json: schema: $ref: '#/components/schemas/UserCreateWrapper' example: UserCreate: mainLanguageCode: eng-GB remoteId: remoteId-23456789 login: johnsmith2 email: example@example.com password: Secrepassword5! fields: field: - fieldDefinitionIdentifier: first_name languageCode: eng-GB fieldValue: John - fieldDefinitionIdentifier: last_name languageCode: eng-GB fieldValue: Smith - fieldDefinitionIdentifier: user_account languageCode: eng-GB fieldValue: hasStoredLogin: true contentId: 14 login: johnsmith email: example@example.com enabled: true maxLogin: 10 required: false /user/policies: get: operationId: ibexa.rest.list_policies_for_user tags: - User Policy responses: '200': description: OK - Policies which are applied to a given User. content: application/vnd.ibexa.api.PolicyList+json: schema: $ref: '#/components/schemas/PolicyListWrapper' example: PolicyList: _media-type: application/vnd.ibexa.api.PolicyList+json _href: /api/ibexa/v2/user/policies Policy: - _media-type: application/vnd.ibexa.api.Policy+json _href: /api/ibexa/v2/user/roles/1/policies/349 id: 349 module: content function: read limitations: limitation: - _identifier: Section values: ref: - _media-type: application/vnd.ibexa.api.ref+json _href: '1' - _media-type: application/vnd.ibexa.api.ref+json _href: '3' - _media-type: application/vnd.ibexa.api.ref+json _href: '6' - _media-type: application/vnd.ibexa.api.Policy+json _href: /api/ibexa/v2/user/roles/1/policies/350 id: 350 module: user function: login limitations: limitation: - _identifier: SiteAccess values: ref: - _media-type: application/vnd.ibexa.api.ref+json _href: '2282622326' - _media-type: application/vnd.ibexa.api.ref+json _href: '1766001124' - _media-type: application/vnd.ibexa.api.Policy+json _href: /api/ibexa/v2/user/roles/1/policies/351 id: 351 module: content function: view_embed limitations: limitation: - _identifier: Class values: ref: - _media-type: application/vnd.ibexa.api.ref+json _href: '5' - _media-type: application/vnd.ibexa.api.ref+json _href: '12' - _media-type: application/vnd.ibexa.api.Policy+json _href: /api/ibexa/v2/user/roles/1/policies/352 id: 352 module: user function: register - _media-type: application/vnd.ibexa.api.Policy+json _href: /api/ibexa/v2/user/roles/1/policies/353 id: 353 module: user function: password application/vnd.ibexa.api.PolicyList+xml: schema: $ref: '#/components/schemas/PolicyList' example: | <?xml version="1.0" encoding="UTF-8"?> <PolicyList media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/policies"> <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/349"> <id>349</id> <module>content</module> <function>read</function> <limitations> <limitation identifier="Section"> <values> <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/> <ref media-type="application/vnd.ibexa.api.ref+xml" href="3"/> <ref media-type="application/vnd.ibexa.api.ref+xml" href="6"/> </values> </limitation> </limitations> </Policy> <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/350"> <id>350</id> <module>user</module> <function>login</function> <limitations> <limitation identifier="SiteAccess"> <values> <ref media-type="application/vnd.ibexa.api.ref+xml" href="2282622326"/> <ref media-type="application/vnd.ibexa.api.ref+xml" href="1766001124"/> </values> </limitation> </limitations> </Policy> <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/351"> <id>351</id> <module>content</module> <function>view_embed</function> <limitations> <limitation identifier="Class"> <values> <ref media-type="application/vnd.ibexa.api.ref+xml" href="5"/> <ref media-type="application/vnd.ibexa.api.ref+xml" href="12"/> </values> </limitation> </limitations> </Policy> <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/352"> <id>352</id> <module>user</module> <function>register</function> </Policy> <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/353"> <id>353</id> <module>user</module> <function>password</function> </Policy> </PolicyList> '401': description: Error - the user has no permission to read Roles. summary: List Policies for User description: Search all Policies which are applied to a given User. parameters: [] /user/roles: get: operationId: ibexa.rest.list_roles tags: - User Role responses: '200': description: OK - list of all Roles. content: application/vnd.ibexa.api.RoleList+json: schema: $ref: '#/components/schemas/RoleListWrapper' example: RoleList: _media-type: application/vnd.ibexa.api.RoleList+json _href: /api/ibexa/v2/user/roles Role: - _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/1 identifier: Anonymous Policies: _media-type: application/vnd.ibexa.api.PolicyList+json _href: /api/ibexa/v2/user/roles/1/policies - _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/2 identifier: Administrator Policies: _media-type: application/vnd.ibexa.api.PolicyList+json _href: /api/ibexa/v2/user/roles/2/policies - _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/3 identifier: Editor Policies: _media-type: application/vnd.ibexa.api.PolicyList+json _href: /api/ibexa/v2/user/roles/3/policies - _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/4 identifier: Member Policies: _media-type: application/vnd.ibexa.api.PolicyList+json _href: /api/ibexa/v2/user/roles/4/policies - _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/10 identifier: NewRole Policies: _media-type: application/vnd.ibexa.api.PolicyList+json _href: /api/ibexa/v2/user/roles/10/policies - _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/14 identifier: NewRole5 Policies: _media-type: application/vnd.ibexa.api.PolicyList+json _href: /api/ibexa/v2/user/roles/14/policies - _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/15 identifier: NewRole7 Policies: _media-type: application/vnd.ibexa.api.PolicyList+json _href: /api/ibexa/v2/user/roles/15/policies application/vnd.ibexa.api.RoleList+xml: schema: $ref: '#/components/schemas/RoleList' example: | <?xml version="1.0" encoding="UTF-8"?> <RoleList media-type="application/vnd.ibexa.api.RoleList+xml" href="/api/ibexa/v2/user/roles"> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/1"> <identifier>Anonymous</identifier> <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/1/policies"/> </Role> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/2"> <identifier>Administrator</identifier> <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/2/policies"/> </Role> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/3"> <identifier>Editor</identifier> <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/3/policies"/> </Role> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/4"> <identifier>Member</identifier> <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/4/policies"/> </Role> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/10"> <identifier>NewRole</identifier> <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/10/policies"/> </Role> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/14"> <identifier>NewRole5</identifier> <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/14/policies"/> </Role> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/15"> <identifier>NewRole7</identifier> <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/15/policies"/> </Role> </RoleList> '401': description: Error - the user has no permission to read Roles. summary: Load Roles description: Returns a list of all Roles. parameters: [] post: operationId: ibexa.rest.create_role tags: - User Role responses: '201': description: If set, the new user is returned in XML or JSON format. content: application/vnd.ibexa.api.Role+json: schema: $ref: '#/components/schemas/RoleWrapper' example: Role: _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/21 identifier: NewRole Policies: _media-type: application/vnd.ibexa.api.PolicyList+json _href: /api/ibexa/v2/user/roles/21/policies application/vnd.ibexa.api.Role+xml: schema: $ref: '#/components/schemas/Role' example: | <?xml version="1.0" encoding="UTF-8"?> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/19"> <identifier>NewRole</identifier> <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/19/policies"/> </Role> '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to create a Role or a Role draft. summary: Create Role or Role draft description: Creates a new Role or Role draft. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The RoleInput schema encoded in XML or JSON. content: application/vnd.ibexa.api.RoleInput+json: schema: $ref: '#/components/schemas/RoleInputWrapper' example: RoleInput: identifier: NewRole application/vnd.ibexa.api.RoleInput+xml: schema: $ref: '#/components/schemas/RoleInput' example: |- <?xml version="1.0" encoding="UTF-8"?> <RoleInput> <identifier>NewRole</identifier> </RoleInput> required: false /user/roles/{id}: get: operationId: ibexa.rest.load_role tags: - User Role responses: '200': description: OK - Role for the given ID. content: application/vnd.ibexa.api.Role+json: schema: $ref: '#/components/schemas/RoleWrapper' example: Role: _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/21 identifier: NewRole Policies: _media-type: application/vnd.ibexa.api.PolicyList+json _href: /api/ibexa/v2/user/roles/21/policies application/vnd.ibexa.api.Role+xml: schema: $ref: '#/components/schemas/Role' example: | <?xml version="1.0" encoding="UTF-8"?> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/21"> <identifier>NewRole</identifier> <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/21/policies"/> </Role> '401': description: Error - the user has no permission to read Roles. '404': description: Error - the Role does not exist. summary: Load Role description: Loads a Role for the given ID. parameters: - name: If-None-Match in: header description: ETag required: false deprecated: false schema: type: string style: simple explode: false - name: id in: path description: RoleLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false post: operationId: ibexa.rest.create_role_draft tags: - User Role responses: '201': description: If set, the new user is returned in XML or JSON format. content: application/vnd.ibexa.api.RoleDraft+json: schema: $ref: '#/components/schemas/RoleDraftWrapper' example: Role: _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/6 identifier: Editor Policies: _media-type: application/vnd.ibexa.api.PolicyList+json _href: /api/ibexa/v2/user/roles/6/policies application/vnd.ibexa.api.RoleDraft+xml: schema: $ref: '#/components/schemas/RoleDraft' example: | <?xml version="1.0" encoding="UTF-8"?> <Role href="/user/roles/11" media-type="application/vnd.ibexa.api.RoleDraft+xml"> <identifier>MyRole</identifier> <Policies href="/user/roles/11/policies" media-type="application/vnd.ibexa.api.PolicyList+xml"/> </Role> '401': description: Error - the user is not authorized to create a Role or a Role draft summary: Create Role Draft description: Creates a new Role draft from an existing Role. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: id in: path description: RoleDraftCreateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: No payload required content: {} required: false delete: operationId: ibexa.rest.delete_role tags: - User Role responses: '204': description: No Content. '401': description: Error - the User is not authorized to delete this Role. summary: Delete Role description: The given Role and all assignments to Users or User Groups are deleted. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: id in: path description: RoleDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: ibexa.rest.update_role tags: - User Role responses: '200': description: OK - Role updated content: application/vnd.ibexa.api.Role+json: schema: $ref: '#/components/schemas/RoleWrapper' example: Role: _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/21 identifier: NewIdentifier Policies: _media-type: application/vnd.ibexa.api.PolicyList+json _href: /api/ibexa/v2/user/roles/21/policies application/vnd.ibexa.api.Role+xml: schema: $ref: '#/components/schemas/Role' example: | <?xml version="1.0" encoding="UTF-8"?> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/5"> <identifier>NewIdentifier</identifier> <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/5/policies"/> </Role> '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to update the Role. '412': description: Error - the current ETag does not match with the provided one in the If-Match header. summary: Update Role description: Updates a Role. PATCH or POST with header X-HTTP-Method-Override PATCH parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: If-Match in: header description: ETag Causes to patch only if the specified ETag is the current one. Otherwise a 412 is returned. required: true deprecated: false schema: type: string style: simple explode: false - name: id in: path description: RoleUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The RoleInput schema encoded in XML or JSON format. content: application/vnd.ibexa.api.RoleInput+json: schema: $ref: '#/components/schemas/RoleInputWrapper' example: RoleInput: identifier: NewIdentifier application/vnd.ibexa.api.RoleInput+xml: schema: $ref: '#/components/schemas/RoleInput' example: | <?xml version="1.0" encoding="UTF-8"?> <RoleInput> <identifier>NewIdentifier</identifier> </RoleInput> required: false /user/roles/{id}/draft: get: operationId: ibexa.rest.load_role_draft tags: - User Role responses: '200': description: OK - Role draft by original Role ID. content: application/vnd.ibexa.api.Role+json: schema: $ref: '#/components/schemas/RoleWrapper' example: Role: _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/27 identifier: Anonymous Policies: _media-type: application/vnd.ibexa.api.PolicyList+json _href: /api/ibexa/v2/user/roles/27/policies application/vnd.ibexa.api.Role+xml: schema: $ref: '#/components/schemas/Role' example: | <?xml version="1.0" encoding="UTF-8"?> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/27"> <identifier>Anonymous</identifier> <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/27/policies"/> </Role> '401': description: Error - the user has no permission to read Roles. '404': description: Error - there is no draft or Role with the given ID. summary: Load Role draft description: Loads a Role draft by original Role ID. parameters: - name: If-None-Match in: header description: ETag required: false deprecated: false schema: type: string style: simple explode: false - name: id in: path description: RoleDraftLoadByRoleIdController identifier required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: ibexa.rest.delete_role_draft tags: - User Role responses: '204': description: No Content. '401': description: Error - the user is not authorized to delete this Role. summary: Delete Role draft description: The given Role draft is deleted. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: id in: path description: RoleDraftDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: ibexa.rest.update_role_draft tags: - User Role responses: '200': description: OK - Role draft updated. content: application/vnd.ibexa.api.Role+json: schema: $ref: '#/components/schemas/RoleWrapper' example: Role: _media-type: application/vnd.ibexa.api.Role+json _href: /api/ibexa/v2/user/roles/6 identifier: UpdatedIdentifier Policies: _media-type: application/vnd.ibexa.api.PolicyList+json _href: /api/ibexa/v2/user/roles/6/policies application/vnd.ibexa.api.Role+xml: schema: $ref: '#/components/schemas/Role' example: | <?xml version="1.0" encoding="UTF-8"?> <Role media-type="application/vnd.ibexa.api.Role+xml" href="/api/ibexa/v2/user/roles/9"> <identifier>UpdatedIdentifier</identifier> <Policies media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/9/policies"/> </Role> '400': description: Error - the input does not match the input schema definition. '401': description: Error - the user is not authorized to update the Role. '404': description: Error - there is no draft or Role with the given ID. '412': description: Error - the current ETag does not match with the one provided in the If-Match header. summary: Update Role draft description: Updates a Role draft. PATCH or POST with header X-HTTP-Method-Override PATCH. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: If-Match in: header description: Performs a PATCH only if the specified ETag is the current one. Otherwise a 412 is returned. required: true deprecated: false schema: type: string style: simple explode: false - name: id in: path description: RoleDraftUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The RoleInput schema encoded in XML or JSON format. content: application/vnd.ibexa.api.RoleInput+json: schema: $ref: '#/components/schemas/RoleInputWrapper' example: RoleInput: identifier: UpdatedIdentifier application/vnd.ibexa.api.RoleInput+xml: schema: $ref: '#/components/schemas/RoleInput' example: | <?xml version="1.0" encoding="UTF-8"?> <RoleInput> <identifier>UpdatedIdentifier</identifier> </RoleInput> required: false /user/roles/{id}/policies: get: operationId: ibexa.rest.load_policies tags: - User Role responses: '200': description: If set, the Policy list is returned in XML or JSON format. content: application/vnd.ibexa.api.PolicyList+json: schema: $ref: '#/components/schemas/PolicyListWrapper' example: PolicyList: _media-type: application/vnd.ibexa.api.PolicyList+json _href: /api/ibexa/v2/user/roles/1/policies Policy: - _media-type: application/vnd.ibexa.api.Policy+json _href: /api/ibexa/v2/user/roles/1/policies/349 id: 349 module: content function: read limitations: limitation: - _identifier: Section values: ref: - _media-type: application/vnd.ibexa.api.ref+json _href: '1' - _media-type: application/vnd.ibexa.api.ref+json _href: '3' - _media-type: application/vnd.ibexa.api.ref+json _href: '6' - _media-type: application/vnd.ibexa.api.Policy+json _href: /api/ibexa/v2/user/roles/1/policies/350 id: 350 module: user function: login limitations: limitation: - _identifier: SiteAccess values: ref: - _media-type: application/vnd.ibexa.api.ref+json _href: '2282622326' - _media-type: application/vnd.ibexa.api.ref+json _href: '1766001124' - _media-type: application/vnd.ibexa.api.Policy+json _href: /api/ibexa/v2/user/roles/1/policies/351 id: 351 module: content function: view_embed limitations: limitation: - _identifier: Class values: ref: - _media-type: application/vnd.ibexa.api.ref+json _href: '5' - _media-type: application/vnd.ibexa.api.ref+json _href: '12' - _media-type: application/vnd.ibexa.api.Policy+json _href: /api/ibexa/v2/user/roles/1/policies/352 id: 352 module: user function: register - _media-type: application/vnd.ibexa.api.Policy+json _href: /api/ibexa/v2/user/roles/1/policies/353 id: 353 module: user function: password application/vnd.ibexa.api.PolicyList+xml: schema: $ref: '#/components/schemas/PolicyList' example: | <?xml version="1.0" encoding="UTF-8"?> <PolicyList media-type="application/vnd.ibexa.api.PolicyList+xml" href="/api/ibexa/v2/user/roles/1/policies"> <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/349"> <id>349</id> <module>content</module> <function>read</function> <limitations> <limitation identifier="Section"> <values> <ref media-type="application/vnd.ibexa.api.ref+xml" href="1"/> <ref media-type="application/vnd.ibexa.api.ref+xml" href="3"/> <ref media-type="application/vnd.ibexa.api.ref+xml" href="6"/> </values> </limitation> </limitations> </Policy> <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/350"> <id>350</id> <module>user</module> <function>login</function> <limitations> <limitation identifier="SiteAccess"> <values> <ref media-type="application/vnd.ibexa.api.ref+xml" href="2282622326"/> <ref media-type="application/vnd.ibexa.api.ref+xml" href="1766001124"/> </values> </limitation> </limitations> </Policy> <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/351"> <id>351</id> <module>content</module> <function>view_embed</function> <limitations> <limitation identifier="Class"> <values> <ref media-type="application/vnd.ibexa.api.ref+xml" href="5"/> <ref media-type="application/vnd.ibexa.api.ref+xml" href="12"/> </values> </limitation> </limitations> </Policy> <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/352"> <id>352</id> <module>user</module> <function>register</function> </Policy> <Policy media-type="application/vnd.ibexa.api.Policy+xml" href="/api/ibexa/v2/user/roles/1/policies/353"> <id>353</id> <module>user</module> <function>password</function> </Policy> </PolicyList> '401': description: Error - the user has no permission to read Roles. '404': description: Error - the Role does not exist. summary: Load Policies description: Loads Policies for the given Role. parameters: - name: id in: path description: RolePolicyListController identifier required: true deprecated: false schema: type: string style: simple explode: false post: operationId: ibexa.rest.add_policy tags: - User Role responses: '201': description: If set, the updated Policy is returned in XML or JSON format. content: application/vnd.ibexa.api.Policy+json: schema: $ref: '#/components/schemas/PolicyWrapper' example: Policy: _media-type: application/vnd.ibexa.api.Policy+json _href: /api/ibexa/v2/user/roles/1/policies/352 id: 352 module: user function: register application/vnd.ibexa.api.Policy+xml: schema: $ref: '#/components/schemas/Policy' example: | <Policy href="/user/roles/11/policies/55" media-type="application/vnd.ibexa.api.Policy+xml"> <id>55</id> <module>content</module> <function>create</function> <limitations> <limitation identifier="Class"> <values> <ref href="/content/types/13"/> </values> </limitation> <limitation identifier="ParentClass"> <values> <ref href="/content/types/12"/> </values> </limitation> </limitations> </Policy> '400': description: Error - the input does not match the input schema definition or validation of limitation in PolicyCreate fails. '401': description: Error - the user is not authorized to create the Policy. '404': description: Error - the Role does not exist. summary: Create Policy description: Creates a Policy parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: id in: path description: RolePolicyCreateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: If set, the updated Policy is returned in XML or JSON format. content: application/vnd.ibexa.api.PolicyCreate+json: schema: $ref: '#/components/schemas/PolicyCreateWrapper' application/vnd.ibexa.api.PolicyCreate+xml: schema: $ref: '#/components/schemas/PolicyCreate' example: | <?xml version="1.0" encoding="UTF-8"?> <PolicyCreate> <module>content</module> <function>create</function> <limitations> <limitation identifier="Class"> <values> <ref href="2"/> </values> </limitation> <limitation identifier="ParentClass"> <values> <ref href="1"/> </values> </limitation> </limitations> </PolicyCreate> required: false delete: operationId: ibexa.rest.delete_policies tags: - User Role responses: '204': description: No Content - all Policies of the given Role are deleted. '401': description: Error - the user is not authorized to delete this content type. summary: Delete Policies description: All Policies of the given Role are deleted. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: id in: path description: RolePolicyDeleteAllFromRoleController identifier required: true deprecated: false schema: type: string style: simple explode: false /user/roles/{roleId}/policies/{policyId}: get: operationId: ibexa.rest.load_policy tags: - User Role responses: '200': description: If set, the Policy is returned in XML or JSON format. content: application/vnd.ibexa.api.Policy+json: schema: $ref: '#/components/schemas/PolicyWrapper' example: Policy: _media-type: application/vnd.ibexa.api.Policy+json _href: /api/ibexa/v2/user/roles/1/policies/352 id: 352 module: user function: register application/vnd.ibexa.api.Policy+xml: schema: $ref: '#/components/schemas/Policy' example: | <Policy href="/user/roles/11/policies/45" media-type="application/vnd.ibexa.api.Policy+xml"> <id>45</id> <module>content</module> <function>create</function> <limitations> <limitation identifier="Class"> <values> <ref href="/content/types/10" media-type="application/vnd.ibexa.api.ContentType+xml" /> <ref href="/content/types/11" media-type="application/vnd.ibexa.api.ContentType+xml" /> <ref href="/content/types/12" media-type="application/vnd.ibexa.api.ContentType+xml" /> </values> </limitation> <limitation identifier="ParentClass"> <values> <ref href="/content/types/4" media-type="application/vnd.ibexa.api.ContentType+xml" /> </values> </limitation> </limitations> </Policy> '401': description: Error - the user has no permission to read Roles. '404': description: Error - the Role or Policy does not exist. summary: Load Policy description: Loads a Policy for the given module and function. parameters: - name: If-None-Match in: header description: ETag required: false deprecated: false schema: type: string style: simple explode: false - name: policyId in: path description: RolePolicyLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: roleId in: path description: RolePolicyLoadByIdController identifier required: true deprecated: false schema: type: string style: simple explode: false delete: operationId: ibexa.rest.delete_policy tags: - User Role responses: '204': description: No Content - the given Policy is deleted. '401': description: Error - the user is not authorized to delete this content type. '404': description: Error - the Role or Policy does not exist. summary: Delete Policy description: Deletes given Policy. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: policyId in: path description: RolePolicyDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: roleId in: path description: RolePolicyDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false patch: operationId: ibexa.rest.update_policy tags: - User Role responses: '200': description: If set, the updated Policy is returned in XML or JSON format. content: application/vnd.ibexa.api.Policy+json: schema: $ref: '#/components/schemas/PolicyWrapper' example: Policy: _media-type: application/vnd.ibexa.api.Policy+json _href: /api/ibexa/v2/user/roles/1/policies/352 id: 352 module: user function: register application/vnd.ibexa.api.Policy+xml: schema: $ref: '#/components/schemas/Policy' example: | <Policy href="/user/roles/11/policies/55" media-type="application/vnd.ibexa.api.Policy+xml"> <id>55</id> <module>content</module> <function>create</function> <limitations> <limitation identifier="Class"> <values> <ref href="/content/types/14"/> </values> </limitation> <limitation identifier="ParentClass"> <values> <ref href="/content/types/10"/> </values> </limitation> </limitations> </Policy> '400': description: Error - the input does not match the input schema definition or validation of limitation in PolicyUpdate fails. '401': description: Error - the user is not authorized to update the Policy. '404': description: Error - the Role does not exist. '412': description: Error - the current ETag does not match with the one provided in the If-Match header. summary: Update Policy description: Updates a Policy. PATCH or POST with header X-HTTP-Method-Override PATCH. parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: If-Match in: header description: Causes to patch only if the specified ETag is the current one. Otherwise a 412 is returned. required: true deprecated: false schema: type: string style: simple explode: false - name: policyId in: path description: RolePolicyUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false - name: roleId in: path description: RolePolicyUpdateController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: If set, the updated Policy is returned in XML or JSON format. content: application/vnd.ibexa.api.PolicyUpdate+json: schema: $ref: '#/components/schemas/PolicyUpdateWrapper' application/vnd.ibexa.api.PolicyUpdate+xml: schema: $ref: '#/components/schemas/PolicyUpdate' example: | <?xml version="1.0" encoding="UTF-8"?> <PolicyUpdate> <limitations> <limitation identifier="Class"> <values> <ref href="2"/> </values> </limitation> <limitation identifier="ParentClass"> <values> <ref href="1"/> </values> </limitation> </limitations> </PolicyUpdate> required: false /user/sessions: post: operationId: api_usersessions_post tags: - User Session responses: '200': description: Session already exists. content: application/vnd.ibexa.api.Session+xml: schema: $ref: '#/components/schemas/Session' example: | <?xml version="1.0" encoding="UTF-8"?> <Session media-type="application/vnd.ibexa.api.Session+xml" href="/api/ibexa/v2/user/sessions/ABCDEFGHIJKLMNOPQRSTUVWXYZ"> <name>IBX_SESSION_ID0123456789ABCDEFGHIJKLMNOPQRSTUV</name> <identifier>ABCDEFGHIJKLMNOPQRSTUVWXYZ</identifier> <csrfToken>0123456789ABCDEF.GHIJKLMNOP_QRSTUVWXYZabcdefghijklmnopqrstuv.wxyz0123456-789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopq</csrfToken> <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> </Session> application/vnd.ibexa.api.Session+json: schema: $ref: '#/components/schemas/SessionWrapper' example: Session: _media-type: application/vnd.ibexa.api.Session name: eZSSID identifier: go327ij2cirpo59pb6rrv2a4el2 csrfToken: 23lkneri34ijajedfw39orj3j93 User: _href: /user/users/14 _media-type: application/vnd.ibexa.api.User+json '201': description: Session is created. content: application/vnd.ibexa.api.Session+xml: schema: $ref: '#/components/schemas/Session' example: | <?xml version="1.0" encoding="UTF-8"?> <Session media-type="application/vnd.ibexa.api.Session+xml" href="/api/ibexa/v2/user/sessions/ABCDEFGHIJKLMNOPQRSTUVWXYZ"> <name>IBX_SESSION_ID0123456789ABCDEFGHIJKLMNOPQRSTUV</name> <identifier>ABCDEFGHIJKLMNOPQRSTUVWXYZ</identifier> <csrfToken>0123456789ABCDEF.GHIJKLMNOP_QRSTUVWXYZabcdefghijklmnopqrstuv.wxyz0123456-789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopq</csrfToken> <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> </Session> application/vnd.ibexa.api.Session+json: schema: $ref: '#/components/schemas/SessionWrapper' example: Session: _media-type: application/vnd.ibexa.api.Session name: eZSSID identifier: go327ij2cirpo59pb6rrv2a4el2 csrfToken: 23lkneri34ijajedfw39orj3j93 User: _href: /user/users/14 _media-type: application/vnd.ibexa.api.User+json '400': description: Error - the input does not match the input schema definition. '401': description: Error - the authorization failed. '409': description: Error - header contained a session cookie but different user was authorized. summary: Create session (login a User) description: Performs a login for the user or checks if session exists and returns the session and session cookie. The client will need to remember both session name/ID and CSRF token as this is for security reasons not exposed via GET. parameters: - name: Accept in: header description: If set, the session is returned in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false - name: Content-Type in: header description: The SessionInput schema encoded in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false - name: Cookie in: header description: Only needed for session's checking {sessionName}={sessionID}. required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: Only needed for session's checking. The {csrfToken} needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The new SessionCreateController resource content: application/vnd.ibexa.api.SessionInput+xml: schema: $ref: '#/components/schemas/SessionInput' example: | <?xml version="1.0" encoding="UTF-8"?> <SessionInput> <login>admin</login> <password>secret</password> </SessionInput> application/vnd.ibexa.api.SessionInput+json: schema: $ref: '#/components/schemas/SessionInputWrapper' example: SessionInput: login: admin password: secret required: false /user/sessions/current: get: operationId: api_usersessionscurrent_get tags: - User Session responses: '200': description: User is currently logged in and has a valid session. content: application/vnd.ibexa.api.Session+xml: schema: $ref: '#/components/schemas/Session' example: | <?xml version="1.0" encoding="UTF-8"?> <Session media-type="application/vnd.ibexa.api.Session+xml" href="/api/ibexa/v2/user/sessions/ABCDEFGHIJKLMNOPQRSTUVWXYZ"> <name>IBX_SESSION_ID0123456789ABCDEFGHIJKLMNOPQRSTUV</name> <identifier>ABCDEFGHIJKLMNOPQRSTUVWXYZ</identifier> <csrfToken>0123456789ABCDEF.GHIJKLMNOP_QRSTUVWXYZabcdefghijklmnopqrstuv.wxyz0123456-789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopq</csrfToken> <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> </Session> application/vnd.ibexa.api.Session+json: schema: $ref: '#/components/schemas/SessionWrapper' example: Session: _media-type: application/vnd.ibexa.api.Session name: eZSSID identifier: go327ij2cirpo59pb6rrv2a4el2 csrfToken: 23lkneri34ijajedfw39orj3j93 User: _href: /user/users/14 _media-type: application/vnd.ibexa.api.User+json '404': description: User does not have a valid session, or it has expired. summary: Get current session description: Get current user session, if any. parameters: - name: Cookie in: header description: Only needed for session's checking {sessionName}={sessionID}. required: true deprecated: false schema: type: string style: simple explode: false - name: Accept in: header description: If set, the session is returned in XML or JSON format. required: true deprecated: false schema: type: string style: simple explode: false /user/sessions/{sessionId}: delete: operationId: api_usersessions_sessionId_delete tags: - User Session responses: '204': description: OK - session deleted. '404': description: Error - the session does not exist. summary: Delete session (logout a User) description: The user session is removed i.e. the user is logged out. parameters: - name: Cookie in: header description: '{sessionName}={sessionID}' required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The {csrfToken} needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: sessionId in: path description: SessionDeleteController identifier required: true deprecated: false schema: type: string style: simple explode: false /user/sessions/{sessionId}/refresh: post: operationId: api_usersessions_sessionIdrefresh_post tags: - User Session responses: '200': description: OK - session refreshed. content: application/vnd.ibexa.api.Session+xml: schema: $ref: '#/components/schemas/Session' example: | <?xml version="1.0" encoding="UTF-8"?> <Session media-type="application/vnd.ibexa.api.Session+xml" href="/api/ibexa/v2/user/sessions/ABCDEFGHIJKLMNOPQRSTUVWXYZ"> <name>IBX_SESSION_ID0123456789ABCDEFGHIJKLMNOPQRSTUV</name> <identifier>ABCDEFGHIJKLMNOPQRSTUVWXYZ</identifier> <csrfToken>0123456789ABCDEF.GHIJKLMNOP_QRSTUVWXYZabcdefghijklmnopqrstuv.wxyz0123456-789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopq</csrfToken> <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> </Session> application/vnd.ibexa.api.Session+json: schema: $ref: '#/components/schemas/SessionWrapper' example: Session: _media-type: application/vnd.ibexa.api.Session name: eZSSID identifier: go327ij2cirpo59pb6rrv2a4el2 csrfToken: 23lkneri34ijajedfw39orj3j93 User: _href: /user/users/14 _media-type: application/vnd.ibexa.api.User+json '404': description: Error - the session does not exist. summary: Refresh session (deprecated) description: Get the session's User information. Deprecated as of Ibexa DXP 4.6, use GET /user/sessions/current instead. parameters: - name: Cookie in: header description: '{sessionName}={sessionID}' required: true deprecated: false schema: type: string style: simple explode: false - name: X-CSRF-Token in: header description: The {csrfToken} needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false - name: Accept in: header description: '' required: true deprecated: false schema: type: string style: simple explode: false - name: sessionId in: path description: SessionRefreshController identifier required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The new SessionRefreshController resource content: {} required: false /views: post: operationId: ibexa.rest.views.create tags: - Views responses: '200': description: The view in XML or JSON format. content: application/vnd.ibexa.api.View+xml; version=1.1: schema: $ref: '#/components/schemas/View' example: | <?xml version="1.0" encoding="UTF-8"?> <View href="/views/TitleView" media-type="application/vnd.ibexa.api.View+xml; version=1.1"> <identifier>TitleView</identifier> <User href="/user/users/14" media-type="vnd.ibexa.api.User+xml"/> <public>false</public> <LocationQuery> <Filter> <ParentLocationIdCriterion>2</ParentLocationIdCriterion> </Filter> <limit>10</limit> <offset>0</offset> <SortClauses> <ContentName>ascending</ContentName> </SortClauses> <FacetBuilders> <contentTypeFacetBuilder/> </FacetBuilders> </LocationQuery> <Result href="/content/views/view1234/results" media-type="application/vnd.ibexa.api.ViewResult+xml" count="34" time="31" maxScore="1.0"> <searchHits> <searchHit score="1.0" index="installid1234567890"> <hightlight/> <value> <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2"> <id>2</id> <priority>0</priority> <hidden>false</hidden> <invisible>false</invisible> <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1"/> <pathString>/1/2/</pathString> <depth>1</depth> <childCount>8</childCount> <remoteId>f3e90596361e31d496d4026eb624c983</remoteId> <Children media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/2/children"/> <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/57"/> <sortField>PRIORITY</sortField> <sortOrder>ASC</sortOrder> <UrlAliases media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/urlaliases"/> </Location> </value> </searchHit> <!-- ... --> </searchHits> <facets> <contentTypeFacet> <contentTypeFacetEntry> <contentType href="/content/types/1" media-type="application/vnd.ibexa.api.ContentType+xml"/> <count>3</count> </contentTypeFacetEntry> <contentTypeFacetEntry> <contentType href="/content/types/7" media-type="application/vnd.ibexa.api.ContentType+xml"/> <count>9</count> </contentTypeFacetEntry> <contentTypeFacetEntry> <contentType href="/content/types/11" media-type="application/vnd.ibexa.api.ContentType+xml"/> <count>1</count> </contentTypeFacetEntry> <contentTypeFacetEntry> <contentType href="/content/types/15" media-type="application/vnd.ibexa.api.ContentType+xml"/> <count>8</count> </contentTypeFacetEntry> </contentTypeFacet> </facets> </Result> </View> '400': description: Error - the input does not match the input schema definition. summary: Search content description: |- Executes a query and returns a View including the results. View input reflects the criteria model of the public PHP API. Refer to [Search Criteria Reference](/en/latest/search/criteria_reference/search_criteria_reference/) parameters: - name: X-CSRF-Token in: header description: The CSRF Token needed on all unsafe HTTP methods with session. required: true deprecated: false schema: type: string style: simple explode: false requestBody: description: The view input in XML or JSON format. content: application/vnd.ibexa.api.ViewInput+json: schema: $ref: '#/components/schemas/ViewInputWrapper' example: ViewInput: identifier: TitleView Query: Filter: ContentTypeIdentifierCriterion: image SectionIdentifierCriterion: media DateMetadataCriterion: Target: modified Value: 1675681020 Operator: gte limit: 10 offset: 0 SortClauses: ContentName: ascending Aggregations: - ContentTypeTermAggregation: name: some name application/vnd.ibexa.api.ViewInput+xml: schema: $ref: '#/components/schemas/ViewInput' example: | <?xml version="1.0" encoding="UTF-8"?> <ViewInput> <identifier>TitleView</identifier> <Query> <Filter> <ContentTypeIdentifierCriterion>image</ContentTypeIdentifierCriterion> <SectionIdentifierCriterion>media</SectionIdentifierCriterion> <DateMetadataCriterion> <Target>modified</Target> <Value>1675681020</Value> <Operator>gte</Operator> </DateMetadataCriterion> </Filter> <limit>10</limit> <offset>0</offset> <SortClauses> <ContentName>ascending</ContentName> </SortClauses> <Aggregations> <Aggregation> <ContentTypeTermAggregation> <name>some name</name> </ContentTypeTermAggregation> </Aggregation> </Aggregations> </Query> </ViewInput> required: false webhooks: {} components: schemas: BaseObject: type: object required: - _media-type properties: _media-type: xml: attribute: true name: media-type type: string _href: xml: attribute: true name: href type: string Ref: $ref: '#/components/schemas/BaseObject' UnixTimestamp: type: integer Href: type: object required: - _href properties: _href: xml: attribute: true name: href type: string Target: description: Struct that stores extra target information for a SortClause object. type: object SortClause: description: This class is the base for SortClause classes, used to set sorting of content queries. type: object required: - direction - target - targetData properties: direction: description: Sort direction. One of Query::SORT_ASC or Query::SORT_DESC. type: string target: description: 'Sort target, high level: section_identifier, attribute_value, etc.' type: string targetData: description: Extra target data, required by some sort clauses, field for instance. $ref: '#/components/schemas/Target' ErrorMessage: description: Represents an error response. Might contain additional properties depending on an error type. type: object required: - errorCode - errorMessage - errorDescription properties: errorCode: type: integer errorMessage: type: string errorDescription: type: string Value: description: Struct that stores extra value information for a Criterion object. type: object required: - _languageCode - '#text' properties: _languageCode: description: Language code. type: string '#text': description: Content type description. type: - string - 'null' ValueObject: type: object required: - value properties: value: type: array items: $ref: '#/components/schemas/Value' ValueArray: type: object required: - value properties: value: type: array items: $ref: '#/components/schemas/Value' DateRange: allOf: - $ref: '#/components/schemas/BaseObject' - description: Representation of date range. type: object required: - startDate - endDate properties: startDate: type: string endDate: type: string BookmarkList: description: List of bookmarked Locations. type: object required: - count - items properties: count: description: The total number of bookmarks. type: integer items: description: List of bookmarked Locations. type: array items: type: object required: - Location - _media-type - __href properties: Location: $ref: '#/components/schemas/Location' _media-type: type: string __href: type: string BookmarkListWrapper: type: object required: - BookmarkList properties: BookmarkList: $ref: '#/components/schemas/BookmarkList' Location: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a Location in the Repository. type: object required: - id - priority - hidden - invisible - remoteId - ContentInfo - ParentLocation - pathString - depth - childCount - sortField - sortOrder - Content properties: id: description: The ID of the Location. type: integer priority: description: Location priority. Position of the Location among its siblings when sorted using priority sort order. type: integer hidden: description: Indicates that the Location entity has been explicitly marked as hidden. type: boolean invisible: description: Indicates that the Location is implicitly marked as hidden by a parent Location. type: boolean remoteId: description: Remote ID, universally unique identifier. type: string ContentInfo: description: This class provides all version independent information of the content item. $ref: '#/components/schemas/ContentInfo' ParentLocation: description: Parent Location. Children: description: Children Location. pathString: description: The materialized path of the Location entry e.g. /1/2/. type: string depth: description: Depth Location has in the Location tree. type: integer childCount: description: Depth Location has in the Location tree. type: integer sortField: description: 'Specifies which property the child Locations should be sorted on. Map for Location sort fields to their respective SortClauses - class name/identifier and modified subnode. One of the fallowing values: PATH.' enum: - PATH - PUBLISHED - MODIFIED - SECTION - DEPTH - CLASS_IDENTIFIER - CLASS_NAME - PRIORITY - NAME - MODIFIED_SUBNODE - NODE_ID - CONTENTOBJECT_ID type: string sortOrder: description: 'Specifies whether the sort order should be ascending or descending. Map for Location sort order to their respective Query SORT constants. One of the fallowing values: const SORT_ORDER_DESC = 0; const SORT_ORDER_ASC = 1.' enum: - ASC - DESC type: string Content: description: Represents a content item in a specific version. UrlAliases: description: This class represents URL aliases. LocationWrapper: type: object required: - Location properties: Location: $ref: '#/components/schemas/Location' LocationCreate: allOf: - $ref: '#/components/schemas/BaseObject' - type: object required: - ParentLocation - priority - hidden - sortField - sortOrder properties: ParentLocation: type: object required: - _href properties: _href: xml: attribute: true name: href type: string priority: type: string hidden: type: - string - boolean sortField: type: string sortOrder: type: string LocationCreateWrapper: type: object required: - LocationCreate properties: LocationCreate: $ref: '#/components/schemas/LocationCreate' LocationUpdateStruct: description: This class is used for updating Location meta data. type: object required: - priority - remoteId - hidden - sortField - sortOrder properties: priority: description: If set the Location priority is changed to the new value. type: string remoteId: description: If set the Location gets a new remoteId. Needs to be a unique Location->remoteId string value. type: string hidden: type: boolean sortField: description: If set the sortField is changed. The sort field specifies which property the child Locations should be sorted on. Valid values are found at {@link Location::SORT_FIELD_*}. enum: - PATH - PUBLISHED - MODIFIED - SECTION - DEPTH - CLASS_IDENTIFIER - CLASS_NAME - PRIORITY - NAME - MODIFIED_SUBNODE - NODE_ID - CONTENTOBJECT_ID type: string sortOrder: description: If set the sortOrder is changed. The sort order specifies whether the sort order should be ascending or descending. Valid values are {@link Location::SORT_ORDER_*}. enum: - ASC - DESC type: string LocationUpdateStructWrapper: type: object required: - LocationUpdate properties: LocationUpdate: $ref: '#/components/schemas/LocationUpdateStruct' LocationList: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a queried Location list holding a totalCount and a partial list of Locations (by offset/limit parameters and permission filters). type: object required: - Location properties: Location: description: The partial list of Locations controlled by offset/limit. type: array items: $ref: '#/components/schemas/Ref' LocationListWrapper: type: object required: - LocationList properties: LocationList: $ref: '#/components/schemas/LocationList' Content: allOf: - $ref: '#/components/schemas/BaseObject' - description: Content ID matcher class. type: object required: - _remoteId - _id - ContentType - Name - Versions - CurrentVersion - Section - Locations - Owner - mainLanguageCode - currentVersionNo - alwaysAvailable - status - ObjectStates properties: _remoteId: description: Remote ID of the content type. xml: attribute: true name: remoteId type: string _id: description: Unique ID of the content type. xml: attribute: true name: id type: integer ContentType: description: Content type. $ref: '#/components/schemas/BaseObject' Name: description: Name of the domain object in a given language. type: string Versions: description: Returns the VersionInfo for this version. $ref: '#/components/schemas/BaseObject' CurrentVersion: description: Current version. $ref: '#/components/schemas/BaseObject' Section: description: The Section to which the content item is assigned to. $ref: '#/components/schemas/BaseObject' Locations: description: Location of the content item. $ref: '#/components/schemas/BaseObject' Owner: description: The owner of the content item. $ref: '#/components/schemas/BaseObject' lastModificationDate: description: Content item modification date. type: string format: date-time publishedDate: description: Content item publication date. type: string format: date-time mainLanguageCode: description: The main language code of the content item. type: string currentVersionNo: description: Current version number is the version number of the published version or the version number of a newly created draft (which is 1). type: integer alwaysAvailable: description: Indicates if the content item is shown in the main language if it's not present in an other requested language. type: boolean status: description: 'Status of the content. Possible values: const STATUS_DRAFT = 0;const STATUS_PUBLISHED = 1; const STATUS_TRASHED = 2.' type: string ObjectStates: description: Object states. $ref: '#/components/schemas/BaseObject' ContentWrapper: type: object required: - Content properties: Content: $ref: '#/components/schemas/Content' ContentCreate: description: This class is used for creating a new content item. type: object required: - ContentType - mainLanguageCode - LocationCreate - fields properties: ContentType: description: The content type for which the new content item is created. oneOf: - $ref: '#/components/schemas/Content' - $ref: '#/components/schemas/Href' Section: description: The Section the content item is assigned to. If not set the Section of the parent is used or a default Section. $ref: '#/components/schemas/Href' User: description: The owner of the content. If not given the current authenticated User is set as owner. type: integer alwaysAvailable: description: Indicates if the content item is shown in the main language if it's not present in an other requested language. type: string remoteId: description: Remote identifier used as a custom identifier for the content item. Needs to be a unique Content->remoteId string value. type: string mainLanguageCode: description: The main language code for the content. This language will also be used for as initial language for the first created version. It is also used as default language for added fields. type: string modificationDate: description: Modification date. If not given, the current integer is used. type: string format: date-time LocationCreate: type: object fields: type: object required: - field properties: field: type: array items: type: object ContentCreateWrapper: type: object required: - ContentCreate properties: ContentCreate: $ref: '#/components/schemas/ContentCreate' ContentUpdate: description: This class is used to update a Content. type: object required: - mainLanguageCode - Section - MainLocation - Owner - alwaysAvailable - remoteId properties: mainLanguageCode: type: string Section: $ref: '#/components/schemas/Section' MainLocation: $ref: '#/components/schemas/Location' Owner: $ref: '#/components/schemas/User' alwaysAvailable: type: boolean remoteId: type: string ContentInfo: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class provides all version independent information of the content item. type: object required: - Content properties: Content: description: Content ID matcher class. $ref: '#/components/schemas/Content' ContentInfoWrapper: type: object required: - ContentInfo properties: ContentInfo: $ref: '#/components/schemas/ContentInfo' ContentObjectStates: description: Represents a list of object states. type: object required: - ObjectState properties: ObjectState: description: List of object state values. type: array items: $ref: '#/components/schemas/Href' ContentObjectStatesWrapper: type: object required: - ContentObjectStates properties: ContentObjectStates: $ref: '#/components/schemas/ContentObjectStates' VersionInfo: description: This class holds version information data. It also contains the corresponding {@link Content} to which the version belongs to. type: object required: - id - versionNo - status - modificationDate - Creator - creationDate - initialLanguageCode - languageCodes - VersionTranslationInfo - names - Content properties: id: description: Version ID. type: integer versionNo: description: Version number. In contrast to {@link $id}, this is the version number, which only increments in scope of a single content item. type: integer status: description: 'One of: VersionInfo::STATUS_DRAFT=0, VersionInfo::STATUS_PUBLISHED=1, VersionInfo::STATUS_ARCHIVED=3.' enum: - DRAFT - PUBLISHED - ARCHIVED type: string modificationDate: description: The last modified date of this version. type: string format: date-time Creator: description: Creator of the version, in the search API this is referred to as the modifier of the published content. $ref: '#/components/schemas/BaseObject' creationDate: description: Content creation date. type: string format: date-time initialLanguageCode: description: The language code which is used for labeling a translation. type: string languageCodes: description: List of languages in this version. Reflects which languages fields exists in for this version. type: string VersionTranslationInfo: description: Translation information. names: description: Names. $ref: '#/components/schemas/ValueArray' Content: description: Represents a content item in a specific version. $ref: '#/components/schemas/BaseObject' Version: allOf: - $ref: '#/components/schemas/BaseObject' - description: Returns the VersionInfo for this version. type: object required: - VersionInfo - Fields - Relations properties: VersionInfo: description: VersionInfo for this version. Fields: type: object required: - field properties: field: description: Fields of a Company content item. type: array items: $ref: '#/components/schemas/Field' Relations: allOf: - $ref: '#/components/schemas/BaseObject' - description: Relations of the user. type: object required: - Relation properties: Relation: type: array items: $ref: '#/components/schemas/Relation' VersionWrapper: type: object required: - Version properties: Version: $ref: '#/components/schemas/Version' VersionUpdate: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class is used to update a content version. type: object required: - modificationDate - initialLanguageCode - fields properties: modificationDate: type: string format: date-time initialLanguageCode: type: string fields: type: array items: $ref: '#/components/schemas/Field' VersionUpdateWrapper: type: object required: - VersionUpdate properties: VersionUpdate: $ref: '#/components/schemas/VersionUpdate' VersionList: allOf: - $ref: '#/components/schemas/BaseObject' - description: List of all versions of the content. type: object required: - VersionItem properties: VersionItem: type: array items: $ref: '#/components/schemas/VersionItem' VersionListWrapper: type: object required: - VersionList properties: VersionList: $ref: '#/components/schemas/VersionList' VersionItem: description: Version of content. type: object required: - Version - VersionInfo properties: Version: description: Returns the VersionInfo for this version. $ref: '#/components/schemas/BaseObject' VersionInfo: $ref: '#/components/schemas/VersionInfo' Relation: allOf: - $ref: '#/components/schemas/BaseObject' - description: Class representing a relation between content. type: object required: - SourceContent - DestinationContent - RelationType properties: SourceContent: description: The content of the source content of the relation. $ref: '#/components/schemas/Ref' DestinationContent: description: The content of the destination content of the relation. $ref: '#/components/schemas/Ref' RelationType: description: 'The relation type bitmask. Relations: Relation::COMMON = 1, Relation::EMBED = 2, Relation::LINK = 4, Relation::FIELD = 8, Relation::ASSET = 16' type: string RelationWrapper: type: object required: - Relation properties: Relation: $ref: '#/components/schemas/Relation' RelationCreate: type: object required: - Destination properties: Destination: $ref: '#/components/schemas/Href' RelationCreateWrapper: type: object required: - RelationCreate properties: RelationCreate: $ref: '#/components/schemas/RelationCreate' RelationList: allOf: - $ref: '#/components/schemas/BaseObject' - description: Class representing a list of relations between content. type: object required: - Relation properties: Relation: type: array items: $ref: '#/components/schemas/Relation' RelationListWrapper: type: object required: - Relations properties: Relations: $ref: '#/components/schemas/RelationList' Fields: type: object required: - field properties: field: type: array items: $ref: '#/components/schemas/Field' Section: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a Section. type: object required: - sectionId - identifier - name properties: sectionId: description: ID of the Section. type: integer identifier: description: Unique identifier of the Section. type: string name: description: Name of the Section. type: string SectionWrapper: type: object required: - Section properties: Section: $ref: '#/components/schemas/Section' SectionInput: type: object required: - identifier - name properties: identifier: type: string name: type: string SectionInputWrapper: type: object required: - SectionInput properties: SectionInput: $ref: '#/components/schemas/SectionInput' SectionList: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a Section list. type: object required: - Section properties: Section: type: array items: $ref: '#/components/schemas/Section' SectionListWrapper: type: object required: - SectionList properties: SectionList: $ref: '#/components/schemas/SectionList' Trash: allOf: - $ref: '#/components/schemas/BaseObject' - type: object required: - TrashItem properties: TrashItem: type: array items: $ref: '#/components/schemas/TrashItem' TrashWrapper: type: object required: - Trash properties: Trash: $ref: '#/components/schemas/Trash' TrashItem: description: This class represents a trash item, which is actually a trashed Location. $ref: '#/components/schemas/Location' TrashItemWrapper: type: object required: - TrashItem properties: TrashItem: $ref: '#/components/schemas/TrashItem' ContentTypeGroup: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a content type group value. type: object required: - id - identifier - created - modified - Creator - Modifier - ContentTypes properties: id: description: Primary key. type: integer identifier: description: Readable string identifier of a group. type: string created: description: Created date (integer). type: string format: date-time modified: description: Modified date (integer). type: string format: date-time Creator: description: Creator User ID. $ref: '#/components/schemas/BaseObject' Modifier: description: Modifier User ID. $ref: '#/components/schemas/BaseObject' ContentTypes: description: Content types. $ref: '#/components/schemas/BaseObject' ContentTypeGroupWrapper: type: object required: - ContentTypeGroup properties: ContentTypeGroup: $ref: '#/components/schemas/ContentTypeGroup' ContentTypeGroupInput: type: object ContentTypeGroupInputWrapper: type: object required: - ContentTypeGroupInput properties: ContentTypeGroupInput: $ref: '#/components/schemas/ContentTypeGroupInput' ContentTypeGroupListWrapper: type: object required: - ContentTypeGroupList properties: ContentTypeGroupList: $ref: '#/components/schemas/ContentTypeGroupList' ContentTypeGroupRef: description: Content type group reference. type: array items: allOf: - $ref: '#/components/schemas/BaseObject' type: object properties: unlink: $ref: '#/components/schemas/Unlink' ContentTypeGroupRefList: allOf: - $ref: '#/components/schemas/BaseObject' - description: List of content type groups references. type: object required: - ContentTypeGroupRef properties: ContentTypeGroupRef: $ref: '#/components/schemas/ContentTypeGroupRef' ContentTypeGroupList: allOf: - $ref: '#/components/schemas/BaseObject' - description: List of content type groups. type: object required: - ContentTypeGroup properties: ContentTypeGroup: type: array items: $ref: '#/components/schemas/ContentTypeGroup' ContentTypeGroupRefListWrapper: type: object required: - ContentTypeGroupRefList properties: ContentTypeGroupRefList: $ref: '#/components/schemas/ContentTypeGroupRefList' ContentType: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a content type. type: object required: - id - status - identifier - names - descriptions - creationDate - modificationDate - Creator - Modifier - Groups - Draft - remoteId - urlAliasSchema - nameSchema - isContainer - defaultAlwaysAvailable - defaultSortField - defaultSortOrder - FieldDefinitions properties: id: description: Content type ID. type: integer status: description: 'The status of the content type. Possible values: const STATUS_DEFINED = 0; Status constant for defined (aka published) Type, const STATUS_DRAFT = 1; Status constant for draft (aka temporary) Type; const STATUS_MODIFIED = 2; Status constant for modified (aka deferred for publishing) Type.' enum: - DEFINED - DRAFT - MODIFIED - PUBLISHED type: string identifier: description: String identifier of a content type. type: string names: description: Name of a content type. descriptions: description: Description of a content type. creationDate: description: Creation date of the content type. type: string format: date-time modificationDate: description: Modification date of the content type. type: string format: date-time Creator: description: Creator User of the content type. $ref: '#/components/schemas/BaseObject' Modifier: description: Modifier User of the content type. $ref: '#/components/schemas/BaseObject' Groups: description: Group User of the content type. $ref: '#/components/schemas/BaseObject' Draft: description: Draft of the content type. $ref: '#/components/schemas/BaseObject' remoteId: description: Unique remote ID of the content type. type: string urlAliasSchema: description: URL alias schema. If nothing is provided, $nameSchema will be used instead. type: - string - 'null' nameSchema: description: Name schema. Can be composed of FieldDefinition identifier place holders. type: string isContainer: description: A flag used to hint if content of this type may have children or not. It is highly recommended to respect this flag and not create/move content below non-containers. But this flag is not considered as part of the content model and the API will not in any way enforce this flag to be respected. type: boolean defaultAlwaysAvailable: description: If an instance of a content type is created the always available flag is set by default to this value. type: boolean defaultSortField: description: 'Specifies which property the child Locations should be sorted on by default when created. Map for Location sort fields to their respective SortClauses - class name/identifier and modified subnode. One of the fallowing values: const SORT_FIELD_PATH = 1; const SORT_FIELD_PUBLISHED = 2; const SORT_FIELD_MODIFIED = 3; const SORT_FIELD_SECTION = 4; const SORT_FIELD_DEPTH = 5; const SORT_FIELD_PRIORITY = 8; const SORT_FIELD_NAME = 9; const SORT_FIELD_NODE_ID = 11; const SORT_FIELD_CONTENTOBJECT_ID = 12.' enum: - PATH - PUBLISHED - MODIFIED - SECTION - DEPTH - PRIORITY - NAME - NODE_ID - CONTENTOBJECT_ID type: string defaultSortOrder: description: 'Specifies whether the sort order should be ascending or descending by default when created. Map for Location sort order to their respective Query SORT constants. Possible values: const SORT_ORDER_DESC = 0; const SORT_ORDER_ASC = 1.' enum: - ASC - DESC type: string FieldDefinitions: description: This method returns the content type Field definitions from this type. ContentTypeWrapper: type: object required: - ContentType properties: ContentType: $ref: '#/components/schemas/ContentType' ContentTypeCreate: description: This class is used to create a content type. type: object required: - identifier - mainLanguageCode - remoteId - urlAliasSchema - nameSchema - isContainer - defaultSortField - defaultSortOrder - defaultAlwaysAvailable - names - descriptions properties: identifier: type: string mainLanguageCode: type: string remoteId: type: string urlAliasSchema: type: string nameSchema: type: string isContainer: type: boolean defaultSortField: description: Specifies which property the child Locations should be sorted on by default when created. defaultSortOrder: description: Specifies whether the sort order should be ascending or descending by default when created. defaultAlwaysAvailable: type: boolean names: $ref: '#/components/schemas/ValueObject' descriptions: $ref: '#/components/schemas/ValueObject' FieldDefinition: $ref: '#/components/schemas/FieldDefinition' creatorId: description: If set, this value overrides the current user as creator. creationDate: type: string format: date-time ContentTypeCreateWrapper: type: object required: - ContentTypeCreate properties: ContentTypeCreate: $ref: '#/components/schemas/ContentTypeCreate' ContentTypeUpdateStruct: description: This class is used for updating a content type. type: object properties: identifier: description: If set the unique identifier of a type is changed to this value. type: string remoteId: description: If set the remote ID is changed to this value. type: string urlAliasSchema: description: If set the URL alias schema is changed to this value. type: string nameSchema: description: f set the name schema is changed to this value. type: string isContainer: description: If set the container flag is set to this value. type: boolean mainLanguageCode: description: If set the main language is changed to this value. type: string defaultSortField: description: If set the default sort field is changed to this value. enum: - PATH - PUBLISHED - MODIFIED - SECTION - DEPTH - PRIORITY - NAME - NODE_ID - CONTENTOBJECT_ID type: string defaultSortOrder: description: If set the default sort order is set to this value. enum: - ASC - DESC type: string defaultAlwaysAvailable: description: If set the default always available flag is set to this value. type: boolean modifierId: description: If set this value overrides the current User as creator. type: integer modificationDate: description: If set this value overrides the current time for creation. type: string format: date-time names: description: If set this array of names with languageCode keys replace the complete name collection. descriptions: description: If set this array of descriptions with languageCode keys replace the complete description collection. ContentTypeUpdate: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class is used to update a content type. type: object properties: identifier: type: string mainLanguageCode: type: string remoteId: type: string urlAliasSchema: type: - string - 'null' nameSchema: type: string isContainer: type: boolean defaultSortField: description: Specifies which property the child Locations should be sorted on by default when updated. defaultSortOrder: description: Specifies whether the sort order should be ascending or descending by default when updated. defaultAlwaysAvailable: type: - string - boolean names: $ref: '#/components/schemas/ValueObject' descriptions: $ref: '#/components/schemas/ValueObject' modifierId: description: If set, this value overrides the current user as creator. modificationDate: type: string format: date-time ContentTypeUpdateWrapper: type: object required: - ContentTypeUpdate properties: ContentTypeUpdate: $ref: '#/components/schemas/ContentTypeUpdate' ContentTypeList: allOf: - $ref: '#/components/schemas/BaseObject' - description: List of content types. type: object required: - ContentType properties: ContentType: type: array items: $ref: '#/components/schemas/ContentType' ContentTypeListWrapper: type: object required: - ContentTypeList properties: ContentTypeList: $ref: '#/components/schemas/ContentTypeList' ContentTypeInfo: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class stores content type information. type: object required: - id - status - identifier - names - descriptions - creationDate - modificationDate - Creator - Modifier - Groups - Draft - remoteId - urlAliasSchema - nameSchema - isContainer - mainLanguageCode - defaultAlwaysAvailable - defaultSortField - defaultSortOrder properties: id: description: Content type ID. type: integer status: description: 'The status of the content type. Possible values: const STATUS_DEFINED = 0; Status constant for defined (aka published) Type, const STATUS_DRAFT = 1; Status constant for draft (aka temporary) Type; const STATUS_MODIFIED = 2; Status constant for modified (aka deferred for publishing) Type.' enum: - DEFINED - DRAFT - MODIFIED - PUBLISHED type: string identifier: description: String identifier of a content type. type: string names: description: Name of a content type. descriptions: description: Description of a content type. creationDate: description: Creation date of the content type. type: string format: date-time modificationDate: description: Modification date of the content type. type: string format: date-time Creator: description: Creator User of the content type. $ref: '#/components/schemas/BaseObject' Modifier: description: Modifier User of the content type. $ref: '#/components/schemas/BaseObject' Groups: description: Group User of the content type. $ref: '#/components/schemas/BaseObject' Draft: description: Draft of the content type. $ref: '#/components/schemas/BaseObject' remoteId: description: Unique remote ID of the content type. type: string urlAliasSchema: description: URL alias schema. If nothing is provided, $nameSchema will be used instead. type: - string - 'null' nameSchema: description: Name schema. Can be composed of FieldDefinition identifier place holders. type: string isContainer: description: A flag used to hint if content of this type may have children or not. It is highly recommended to respect this flag and not create/move content below non-containers. But this flag is not considered as part of the content model and the API will not in any way enforce this flag to be respected. type: boolean mainLanguageCode: description: Main language code. type: string defaultAlwaysAvailable: description: If an instance of a content type is created the always available flag is set by default to this value. type: boolean defaultSortField: description: 'Specifies which property the child Locations should be sorted on by default when created. Map for Location sort fields to their respective SortClauses - class name/identifier and modified subnode. One of the fallowing values: const SORT_FIELD_PATH = 1; const SORT_FIELD_PUBLISHED = 2; const SORT_FIELD_MODIFIED = 3; const SORT_FIELD_SECTION = 4; const SORT_FIELD_DEPTH = 5; const SORT_FIELD_PRIORITY = 8; const SORT_FIELD_NAME = 9; const SORT_FIELD_NODE_ID = 11; const SORT_FIELD_CONTENTOBJECT_ID = 12.' enum: - PATH - PUBLISHED - MODIFIED - SECTION - DEPTH - PRIORITY - NAME - NODE_ID - CONTENTOBJECT_ID type: string defaultSortOrder: description: 'Specifies whether the sort order should be ascending or descending by default when created. Map for Location sort order to their respective Query SORT constants. Possible values: const SORT_ORDER_DESC = 0; const SORT_ORDER_ASC = 1.' enum: - ASC - DESC type: string ContentTypeInfoWrapper: type: object required: - ContentTypeInfo properties: ContentTypeInfo: $ref: '#/components/schemas/ContentTypeInfo' ContentTypeInfoList: allOf: - $ref: '#/components/schemas/BaseObject' - description: List of content type information. type: object required: - ContentType properties: ContentType: description: This class stores content type information. type: array items: $ref: '#/components/schemas/ContentTypeInfo' ContentTypeInfoListWrapper: type: object required: - ContentTypeList properties: ContentTypeList: $ref: '#/components/schemas/ContentTypeInfoList' ContentTypeQuery: description: This class represents a content type query. type: object properties: limit: description: The maximum number of results to return. type: integer offset: description: The offset to start returning results from. type: integer Query: description: An array of filters to apply to the query. type: object properties: ContentTypeIdCriterion: oneOf: - type: array items: type: integer - type: integer ContentTypeIdentifierCriterion: oneOf: - type: array items: type: string - type: string IsSystemCriterion: type: boolean ContentTypeGroupIdCriterion: oneOf: - type: array items: type: integer - type: integer ContainsFieldDefinitionIdCriterion: oneOf: - type: array items: type: integer - type: integer SortClauses: description: An array of sort clauses to apply to the query. type: object properties: Id: type: string enum: - ascending - descending Identifier: type: string enum: - ascending - descending ContentTypeViewInput: description: This class represents a content type view input. xml: name: ViewInput type: object required: - identifier - ContentTypeQuery properties: identifier: description: The identifier of a view. type: string ContentTypeQuery: $ref: '#/components/schemas/ContentTypeQuery' ContentTypeViewInputWrapper: type: object required: - ViewInput properties: ViewInput: $ref: '#/components/schemas/ContentTypeViewInput' Field: description: This class represents a field of a content item. type: object required: - fieldDefinitionIdentifier - fieldValue properties: id: description: The field ID. type: integer fieldDefinitionIdentifier: description: The Field definition identifier. type: string languageCode: description: The language code. type: string fieldTypeIdentifier: description: Field Type identifier. type: string fieldValue: description: A Field Type value or a value type which can be converted by the corresponding field type. FieldDefinition: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a Field definition. type: object required: - id - identifier - fieldType - fieldGroup - position - isTranslatable - isRequired - isInfoCollector - defaultValue - isSearchable - names - descriptions - fieldSettings - validatorConfiguration properties: id: description: The unique ID of this Field definition. type: integer identifier: description: Readable string identifier of a Field definition. type: string fieldType: description: String identifier of the field type. type: string fieldGroup: description: Field group name. type: string position: description: The position of the Field definition in the content type. type: integer isTranslatable: description: If the field is translatable. type: boolean isRequired: description: Is the field required. type: boolean isInfoCollector: description: The flag if this field is used for information collection. type: boolean defaultValue: description: Default value of the field. isSearchable: description: Indicates if th the content is searchable by this attribute. type: boolean names: description: Names of content types. descriptions: description: Descriptions of content types. fieldSettings: description: Settings for the Field definition supported by the field type. validatorConfiguration: description: Validator configuration of this Field definition supported by the field type. oneOf: - $ref: '#/components/schemas/StringLengthValidator' - $ref: '#/components/schemas/StringLengthValidatorWrapper' - type: array FieldDefinitionWrapper: type: object required: - FieldDefinition properties: FieldDefinition: $ref: '#/components/schemas/FieldDefinition' FieldDefinitionCreate: $ref: '#/components/schemas/BaseObject' FieldDefinitionCreateWrapper: type: object required: - FieldDefinitionCreate properties: FieldDefinitionCreate: $ref: '#/components/schemas/FieldDefinitionCreate' FieldDefinitionUpdate: $ref: '#/components/schemas/BaseObject' FieldDefinitionUpdateWrapper: type: object required: - FieldDefinitionUpdate properties: FieldDefinitionUpdate: $ref: '#/components/schemas/FieldDefinitionUpdate' FieldDefinitions: type: object required: - FieldDefinition properties: FieldDefinition: type: array items: $ref: '#/components/schemas/FieldDefinition' FieldDefinitionsWrapper: type: object required: - FieldDefinitions properties: FieldDefinitions: $ref: '#/components/schemas/FieldDefinitions' StringLengthValidator: description: Validator for checking min. and max. length of strings. type: object required: - maxStringLength - minStringLength properties: maxStringLength: description: Maximum length of strings. type: - integer - 'null' minStringLength: description: Minimum length of strings. type: - integer - 'null' StringLengthValidatorWrapper: type: object required: - StringLengthValidator properties: StringLengthValidator: $ref: '#/components/schemas/StringLengthValidator' UrlAlias: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a URL alias in the Repository. type: object required: - _id - _type - resource - path - languageCodes - alwaysAvailable - isHistory - forward - custom properties: _id: description: A unique identifier for the alias. xml: attribute: true name: id type: string _type: description: The type of the URL Alias i.e. one of URLAlias::LOCATION=0, URLAlias::RESOURCE=1, URLAlias::VIRTUAL=2. enum: - LOCATION - RESOURCE - VIRTUAL xml: attribute: true name: type type: string resource: description: If type = URLAlias::LOCATION it is a Location ID otherwise a string (e.g. /content/search). path: description: The full path of the alias. type: string languageCodes: description: The languageCodes for which this path is valid. type: string alwaysAvailable: description: Fallback indicator for other languages. type: boolean isHistory: description: Indicates that this alias was autogenerated for an in the meanwhile archived version of the content. type: boolean forward: description: Indicates if the URL should be redirected. type: boolean custom: description: If false this alias was autogenerated otherwise manually created. type: boolean UrlAliasWrapper: type: object required: - UrlAlias properties: UrlAlias: $ref: '#/components/schemas/UrlAlias' UrlAliasCreate: type: object required: - _type properties: _type: type: string location: $ref: '#/components/schemas/Href' resource: type: string languageCode: type: string alwaysAvailable: type: - string - boolean forward: type: - string - boolean UrlAliasCreateWrapper: type: object required: - UrlAliasCreate properties: UrlAliasCreate: $ref: '#/components/schemas/UrlAliasCreate' UrlAliasRefList: allOf: - $ref: '#/components/schemas/BaseObject' - description: List of URL alias in the Repository. type: object required: - UrlAlias properties: UrlAlias: type: array items: $ref: '#/components/schemas/Ref' UrlAliasRefListWrapper: type: object required: - UrlAliasRefList properties: UrlAliasRefList: $ref: '#/components/schemas/UrlAliasRefList' Language: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a language in the Repository. type: object required: - languageId - languageCode - name properties: languageId: description: The language ID (auto generated). type: - string - 'null' languageCode: description: The languageCode code. type: string name: description: Human readable name of the language. type: string LanguageWrapper: type: object required: - Language properties: Language: $ref: '#/components/schemas/Language' LanguageList: allOf: - $ref: '#/components/schemas/BaseObject' - description: List of languages. type: object required: - Language properties: Language: type: array items: $ref: '#/components/schemas/Language' LanguageListWrapper: type: object required: - LanguageList properties: LanguageList: $ref: '#/components/schemas/LanguageList' ObjectState: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a Object state value. type: object required: - id - identifier - priority - ObjectStateGroup - languageCodes - names - descriptions properties: id: description: Primary key. type: integer identifier: description: Readable string identifier of the Object state. type: string priority: description: Priority for ordering. type: integer ObjectStateGroup: description: The Object state group this Object state belongs to. $ref: '#/components/schemas/BaseObject' languageCodes: description: The available language codes for names an descriptions. type: string names: description: Names. descriptions: description: Descriptions. ObjectStateWrapper: type: object required: - ObjectState properties: ObjectState: $ref: '#/components/schemas/ObjectState' ObjectStateCreate: description: This class represents a value for creating Object states. type: object required: - identifier - priority - defaultLanguageCode - languageCodes - names - descriptions properties: identifier: description: Readable unique string identifier of a group. type: string priority: description: Priority for ordering. If not set the Object state is created as the last one. type: string defaultLanguageCode: description: The default language code. type: string languageCodes: description: Language codes. type: string names: description: An array of names with languageCode keys. At least one name in the main language is required. type: object required: - value properties: value: type: array items: $ref: '#/components/schemas/Value' descriptions: description: An array of descriptions with languageCode keys. type: object required: - value properties: value: type: array items: $ref: '#/components/schemas/Value' ObjectStateCreateWrapper: type: object required: - ObjectStateCreate properties: ObjectStateCreate: $ref: '#/components/schemas/ObjectStateCreate' ObjectStateUpdate: description: This class represents a value for updating Object states. type: object properties: identifier: description: Readable unique string identifier of a group. type: string defaultLanguageCode: description: The default language code. type: string names: description: An array of names with languageCode keys. descriptions: description: An array of descriptions with languageCode keys. ObjectStateUpdateWrapper: type: object required: - ObjectStateUpdate properties: ObjectStateUpdate: $ref: '#/components/schemas/ObjectStateUpdate' ObjectStateList: allOf: - $ref: '#/components/schemas/BaseObject' - description: List of Object states. type: object required: - ObjectState properties: ObjectState: type: array items: $ref: '#/components/schemas/ObjectState' ObjectStateListWrapper: type: object required: - ObjectStateList properties: ObjectStateList: $ref: '#/components/schemas/ObjectStateList' ObjectStateGroup: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents an Object state group value. type: object required: - id - identifier - defaultLanguageCode - languageCodes - ObjectStates - names - descriptions properties: id: description: Primary key. type: integer identifier: description: Readable string identifier of a group. type: string defaultLanguageCode: description: The default language code. type: string languageCodes: description: The available language codes for names an descriptions. type: string ObjectStates: description: Object States. $ref: '#/components/schemas/BaseObject' names: description: List of names. descriptions: description: List of descriptions. ObjectStateGroupWrapper: type: object required: - ObjectStateGroup properties: ObjectStateGroup: $ref: '#/components/schemas/ObjectStateGroup' ObjectStateGroupCreate: description: This class represents a value for creating Object state groups. type: object required: - identifier - defaultLanguageCode - names - descriptions properties: identifier: description: Readable unique string identifier of a group. type: string defaultLanguageCode: description: The default language code. type: string names: description: An array of names with languageCode keys. At least one name in the main language is required. descriptions: description: An array of descriptions with languageCode keys. ObjectStateGroupCreateWrapper: type: object required: - ObjectStateGroupCreate properties: ObjectStateGroupCreate: $ref: '#/components/schemas/ObjectStateGroupCreate' ObjectStateGroupUpdate: description: This class represents a value for updating Object state groups. type: object properties: identifier: description: Readable unique string identifier of a group. type: string defaultLanguageCode: description: The default language code. type: string names: description: An array of names with languageCode keys. descriptions: description: An array of descriptions with languageCode keys. ObjectStateGroupUpdateWrapper: type: object required: - ObjectStateGroupUpdate properties: ObjectStateGroupUpdate: $ref: '#/components/schemas/ObjectStateGroupUpdate' ObjectStateGroupList: allOf: - $ref: '#/components/schemas/BaseObject' - description: List of Object state groups. type: object required: - ObjectStateGroup properties: ObjectStateGroup: description: This class represents an Object state group value. type: array items: $ref: '#/components/schemas/ObjectStateGroup' ObjectStateGroupListWrapper: type: object required: - ObjectStateGroupList properties: ObjectStateGroupList: $ref: '#/components/schemas/ObjectStateGroupList' View: description: View. type: object required: - identifier - User - public - LocationQuery - Result properties: identifier: description: Content identifier. type: string User: $ref: '#/components/schemas/User' public: type: boolean LocationQuery: $ref: '#/components/schemas/LocationQuery' Result: $ref: '#/components/schemas/BaseObject' ViewInput: description: This class represents a View input. type: object required: - identifier - Query properties: identifier: description: Content identifier. type: string languageCode: type: string useAlwaysAvailable: type: string Query: $ref: '#/components/schemas/Query' ViewInputWrapper: type: object required: - ViewInput properties: ViewInput: $ref: '#/components/schemas/ViewInput' Query: description: This class is used to perform a Content query. type: object properties: Filter: description: The Query filter. Can contain multiple criterion, as items of a logical one (by default AND). $ref: '#/components/schemas/Criterion' Query: description: The Query query. Can contain multiple criterion, as items of a logical one (by default AND). $ref: '#/components/schemas/Criterion' sortClauses: description: Query sorting clauses. type: array items: $ref: '#/components/schemas/SortClause' facetBuilders: description: An array of facet builders. Search engines may ignore any, or given facet builders they don't support and will just return search result facets supported by the engine. API consumer should dynamically iterate over returned facets for further use. type: array items: $ref: '#/components/schemas/FacetBuilder' offset: description: Query offset. Sets the offset for search hits, used for paging the results. type: integer limit: description: Query limit. Limit for number of search hits to return. If value is `0`, search query will not return any search hits, useful for doing a count. type: integer spellcheck: description: If true spellcheck suggestions are returned. type: boolean performCount: description: If true, search engine should perform count even if that means extra lookup. type: boolean LocationQuery: description: This class is used to perform a Location query. $ref: '#/components/schemas/Query' Criterion: description: Criterion implementations. type: object properties: operator: description: The operator used by the Criterion. type: string value: description: The value(s) matched by the Criteria. type: array items: type: [] target: description: The target used by the Criteria (field, metadata...). type: string valueData: description: Additional value data, required by some Criteria, MapLocationDistance for instance. Specifications: description: Criterion description function. Returns the combination of the Criterion's supported operator/value, as an array of objects. type: array items: $ref: '#/components/schemas/Specifications' FacetBuilder: description: This class is the base class for facet builders. type: object required: - name - global - filter - limit - minCount properties: name: description: The name of the facet. type: string global: description: If true the facet runs in a global mode not restricted by the query. type: boolean filter: description: An additional facet filter that will further filter the documents the facet will be executed on. $ref: '#/components/schemas/Criterion' limit: description: Number of facets (terms) returned. type: integer minCount: description: Specifies the minimum count. Only facet groups with more or equal results are returned. type: integer Specifications: description: This class is used by Criteria to describe which operators they support. Instances of this class are returned in an array by the {@see Criterion::getSpecifications()} method. type: object required: - operator - valueFormat - valueTypes - valueCount properties: operator: description: Specified operator, as one of the Operator::* constants. type: string valueFormat: description: Format supported for the Criterion value, either {@see self::FORMAT_SINGLE} for single or {@see self::FORMAT_ARRAY} for multiple. type: string valueTypes: description: 'Accepted values types, specifying what type of variables are accepted as a value. Criterion input value type description constants: const TYPE_INTEGER = 1; const TYPE_STRING = 2; const TYPE_BOOLEAN = 4.' type: integer valueCount: description: Limitation on the number of items as the value. Only usable if {@see $valueFormat} is {@see self::FORMAT_ARRAY}. type: integer Role: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a role. type: object required: - identifier - Policies properties: identifier: description: Readable string identifier of a role. type: string Policies: description: Returns the list of policies of this role. $ref: '#/components/schemas/BaseObject' RoleWrapper: type: object required: - Role properties: Role: $ref: '#/components/schemas/Role' RoleDraft: description: This class represents a draft of a role, extends Role. $ref: '#/components/schemas/Role' RoleDraftWrapper: type: object required: - Role properties: Role: $ref: '#/components/schemas/RoleDraft' RoleInput: description: This class represents a Role input. type: object required: - identifier properties: identifier: type: string RoleInputWrapper: type: object required: - RoleInput properties: RoleInput: $ref: '#/components/schemas/RoleInput' RoleList: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a list roles. type: object required: - Role properties: Role: type: array items: $ref: '#/components/schemas/Role' RoleListWrapper: type: object required: - RoleList properties: RoleList: $ref: '#/components/schemas/RoleList' Policy: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a policy value. type: object required: - id - module - function properties: id: description: ID of the policy. type: integer module: description: Name of module, associated with the Policy e.g. content. type: string function: description: Name of the module function Or all functions with '*' e.g. read. type: string limitations: description: Limitations. type: object required: - limitation properties: limitation: type: array items: $ref: '#/components/schemas/Limitation' PolicyWrapper: type: object required: - Policy properties: Policy: $ref: '#/components/schemas/Policy' Limitation: description: This class represents a Limitation applied to a policy. type: object required: - _identifier - values properties: _identifier: description: 'Returns the limitation identifier (one of the defined constants) or a custom limitation. Constants: CONTENTTYPE = Class; LANGUAGE = Language; LOCATION = Node; OWNER = Owner; PARENTOWNER = ParentOwner; PARENTCONTENTTYPE = ParentClass; PARENTDEPTH = ParentDepth; SECTION = Section; NEWSECTION = NewSection; SITEACCESS = SiteAccess; STATE = State; NEWSTATE = NewState; SUBTREE = Subtree; USERGROUP = Group; PARENTUSERGROUP = ParentGroup; STATUS = Status.' enum: - ContentType - Language - Location - Owner - Parentowner - ParentContentType - ParentDepth - Section - NewSection - SiteAccess - State - NewState - Subtree - UserGroup - ParentUserGroup - Status - Class xml: attribute: true name: identifier type: string values: description: A read-only list of IDs or identifiers for which the limitation should be applied. The value of this property must conform to a hash, which means that it may only consist of array and scalar values, but must not contain objects or resources. type: object required: - $ref properties: ref: type: array items: $ref: '#/components/schemas/Ref' PolicyList: allOf: - $ref: '#/components/schemas/BaseObject' - description: List of policies. type: object required: - Policy properties: Policy: type: array items: $ref: '#/components/schemas/Policy' PolicyListWrapper: type: object required: - PolicyList properties: PolicyList: $ref: '#/components/schemas/PolicyList' PolicyCreate: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class is used to create a Policy. type: object required: - module - function - Limitations properties: module: description: Name of module associated with the Policy. For example, content. type: string function: description: Name of the module function, or all functions with ''*''. For example, read. type: string Limitations: type: array items: $ref: '#/components/schemas/Limitation' PolicyCreateWrapper: type: object required: - PolicyCreate properties: PolicyCreate: $ref: '#/components/schemas/PolicyCreate' PolicyUpdate: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class is used to update a Policy. type: object required: - Limitations properties: Limitations: type: array items: $ref: '#/components/schemas/Limitation' PolicyUpdateWrapper: type: object required: - PolicyUpdate properties: PolicyUpdate: $ref: '#/components/schemas/PolicyUpdate' RoleAssignment: allOf: - $ref: '#/components/schemas/BaseObject' - description: This value object represents an assignment of a User or User group to a role including a limitation. type: object required: - Role properties: limitation: description: Returns the limitation of the role assignment. Role: description: Returns the role to which the User or User group is assigned to. $ref: '#/components/schemas/Ref' RoleAssignmentWrapper: type: object required: - RoleAssignment properties: RoleAssignment: $ref: '#/components/schemas/RoleAssignment' RoleAssignInput: description: This class represents a Role assign input. type: object required: - Role - limitation properties: Role: description: Returns the Role to which the user or user group is assigned to. $ref: '#/components/schemas/Ref' limitation: description: Returns the Limitation of the Role assignment. $ref: '#/components/schemas/Limitation' RoleAssignInputWrapper: type: object required: - RoleAssignInput properties: RoleAssignInput: $ref: '#/components/schemas/RoleAssignInput' RoleAssignmentList: allOf: - $ref: '#/components/schemas/BaseObject' - description: This value object represents a list of assignments of a User or User group to a role including a limitation. type: object required: - RoleAssignment properties: RoleAssignment: type: array items: $ref: '#/components/schemas/RoleAssignment' RoleAssignmentListWrapper: type: object required: - RoleAssignmentList properties: RoleAssignmentList: $ref: '#/components/schemas/RoleAssignmentList' Session: allOf: - $ref: '#/components/schemas/BaseObject' - description: Value for session. type: object required: - name - identifier - csrfToken - User properties: name: description: Name. type: string identifier: description: Identifier. type: string csrfToken: description: csrfToken. type: string User: description: User. $ref: '#/components/schemas/BaseObject' SessionWrapper: type: object required: - Session properties: Session: $ref: '#/components/schemas/Session' SessionInput: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a session input. type: object required: - login - password properties: login: type: string password: type: string SessionInputWrapper: type: object required: - SessionInput properties: SessionInput: $ref: '#/components/schemas/SessionInput' UserGroup: allOf: - $ref: '#/components/schemas/BaseObject' - description: Content ID matcher class. type: object required: - _remoteId - _id - ContentType - name - Versions - Section - MainLocation - Locations - Owner - lastModificationDate - mainLanguageCode - alwaysAvailable - Version - ParentUserGroup - Subgroups - Users - Roles properties: _remoteId: description: Remote ID of the content type. xml: attribute: true name: remoteId type: string _id: description: Unique ID of the content type. xml: attribute: true name: id type: integer ContentType: description: Content type. $ref: '#/components/schemas/Ref' name: type: string Versions: description: Returns the VersionInfo for this version. $ref: '#/components/schemas/Ref' Section: description: The Section to which the content item is assigned to. $ref: '#/components/schemas/Ref' MainLocation: $ref: '#/components/schemas/Ref' Locations: description: Location of the content item. $ref: '#/components/schemas/Ref' Owner: description: The owner of the content item. $ref: '#/components/schemas/Ref' lastModificationDate: description: Content item modification date. type: string format: date-time mainLanguageCode: description: The main language code of the content item. type: string alwaysAvailable: type: boolean Version: $ref: '#/components/schemas/Version' ParentUserGroup: $ref: '#/components/schemas/Ref' Subgroups: $ref: '#/components/schemas/Ref' Users: $ref: '#/components/schemas/Ref' Roles: $ref: '#/components/schemas/Ref' UserGroupWrapper: type: object required: - UserGroup properties: UserGroup: $ref: '#/components/schemas/UserGroup' UserGroupList: description: This class represents a User Group list. $ref: '#/components/schemas/BaseObject' UserGroupListWrapper: type: object required: - UserGroupList properties: UserGroupList: $ref: '#/components/schemas/UserGroupList' UserGroupRefList: allOf: - $ref: '#/components/schemas/BaseObject' - description: Returns a list of the sub groups. type: object required: - UserGroup properties: UserGroup: description: This class represents a User group. type: array items: $ref: '#/components/schemas/Ref' UserGroupRefListWrapper: type: object required: - UserGroupRefList properties: UserGroupRefList: $ref: '#/components/schemas/UserGroupRefList' UserGroupCreate: description: This class is used to create a User Group. type: object required: - mainLanguageCode - remoteId - fields properties: mainLanguageCode: type: string remoteId: type: string fields: $ref: '#/components/schemas/Fields' UserGroupCreateWrapper: type: object required: - UserGroupCreate properties: UserGroupCreate: $ref: '#/components/schemas/UserGroupCreate' UserGroupUpdate: description: This class is used to update a User group in the Repository. type: object required: - Section properties: Section: type: object required: - _href properties: _href: xml: attribute: true name: href type: string UserGroupUpdateWrapper: type: object required: - UserGroupUpdate properties: UserGroupUpdate: $ref: '#/components/schemas/UserGroupUpdate' Unlink: description: Unlink a content type group from a content type. type: object required: - _href - _method properties: _href: type: string _method: enum: - DELETE type: string User: type: object description: Reference to a registered user account properties: _media-type: type: string description: Media type identifier for the user reference _href: type: string description: REST API URL reference to the user resource format: uri required: - _media-type - _href additionalProperties: false UserWrapper: type: object required: - User properties: User: $ref: '#/components/schemas/User' UserList: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a list of users. type: object required: - User properties: User: type: array items: $ref: '#/components/schemas/User' UserListWrapper: type: object required: - UserList properties: UserList: $ref: '#/components/schemas/UserList' UserRefList: allOf: - $ref: '#/components/schemas/BaseObject' - description: Returns a list of the users. type: object required: - User properties: User: description: This class represents a User. type: array items: $ref: '#/components/schemas/BaseObject' UserRefListWrapper: type: object required: - UserRefList properties: UserRefList: $ref: '#/components/schemas/UserRefList' UserUpdate: description: This class is used to update a User. type: object required: - login properties: login: type: string email: type: string password: type: string enabled: type: boolean maxLogin: type: integer ContentUpdate: description: The update structure for the profile content. ContentMetadataUpdate: description: The update structure for the profile metadata. UserUpdateWrapper: type: object required: - UserUpdate properties: UserUpdate: $ref: '#/components/schemas/UserUpdate' UserCreate: description: This class is used to create a User. type: object required: - mainLanguageCode - remoteId - login - email - password properties: mainLanguageCode: type: string remoteId: type: string login: type: string email: type: string password: type: string enabled: type: boolean UserCreateWrapper: type: object required: - UserCreate properties: UserCreate: $ref: '#/components/schemas/UserCreate' Event: allOf: - $ref: '#/components/schemas/BaseObject' - description: Calendar event. type: object required: - id - datetime - type - name - attributes properties: id: description: The unique ID. type: string datetime: type: string format: date-time type: description: Event type identifier or name. type: string name: description: Name of the calendar event. type: string attributes: description: List of event attributes. type: array items: $ref: '#/components/schemas/EventAttribute' EventAttribute: type: object required: - label - value properties: label: description: Label of the attribute. type: string value: description: Value of the attribute. type: string EventList: allOf: - $ref: '#/components/schemas/BaseObject' - description: List of calendar events. type: object required: - _currentPage - totalCount - events properties: _currentPage: description: Current page representation. xml: attribute: true name: currentPage type: string nextPage: description: Next page representation. type: string totalCount: description: Total count of events. type: integer events: type: array items: $ref: '#/components/schemas/Event' EventListWrapper: type: object required: - EventList properties: EventList: $ref: '#/components/schemas/EventList' EventGroup: allOf: - $ref: '#/components/schemas/BaseObject' - description: Event group. type: object required: - _currentPage - totalCount - events properties: _currentPage: description: Current page representation. xml: attribute: true name: currentPage type: string nextPage: description: Next page representation. type: string groupKey: $ref: '#/components/schemas/DateRange' totalCount: description: Total count of events. type: integer events: type: array items: $ref: '#/components/schemas/Event' EventGroupList: allOf: - $ref: '#/components/schemas/BaseObject' - description: Grouped calendar event list. type: object required: - groups properties: groups: type: array items: $ref: '#/components/schemas/EventGroup' EventGroupListWrapper: type: object required: - EventGroupList properties: EventGroupList: $ref: '#/components/schemas/EventGroupList' RescheduleAction: description: This class represents events to reschedule type: object required: - events - dateTime properties: events: description: list of events type: array items: type: string dateTime: description: timestamp to reschedule events to type: integer RescheduleActionWrapper: type: object required: - RescheduleAction properties: RescheduleAction: $ref: '#/components/schemas/RescheduleAction' UnscheduleAction: description: This class represents events to unschedule type: object required: - events properties: events: description: list of events type: array items: type: string UnscheduleActionWrapper: type: object required: - UnscheduleAction properties: UnscheduleAction: $ref: '#/components/schemas/UnscheduleAction' AttributeGroup: description: This class represents an attribute group. type: object required: - name - identifier - position properties: name: type: string identifier: type: string position: type: integer AttributeGroupWrapper: type: object required: - AttributeGroup properties: AttributeGroup: $ref: '#/components/schemas/AttributeGroup' AttributeGroupCreate: description: This class is used to create an attribute group. type: object required: - identifier - names - position properties: identifier: type: string names: type: object position: type: integer AttributeGroupCreateWrapper: type: object required: - AttributeGroupCreate properties: AttributeGroupCreate: $ref: '#/components/schemas/AttributeGroupCreate' AttributeGroupUpdate: description: This class is used to update an attribute group. type: object required: - identifier - names - position properties: identifier: type: string names: type: object position: type: integer AttributeGroupUpdateWrapper: type: object required: - AttributeGroupUpdate properties: AttributeGroupUpdate: $ref: '#/components/schemas/AttributeGroupUpdate' AttributeGroupList: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents an attribute group list. type: object required: - AttributeGroup properties: AttributeGroup: type: array items: $ref: '#/components/schemas/AttributeGroup' AttributeGroupListWrapper: type: object required: - AttributeGroupList properties: AttributeGroupList: $ref: '#/components/schemas/AttributeGroupList' AttributeGroupListGet: description: This class represents an attribute group list request. type: object required: - prefix - offset - limit properties: prefix: type: string offset: type: integer limit: type: integer AttributeGroupListGetWrapper: type: object required: - AttributeGroupListGet properties: AttributeGroupListGet: $ref: '#/components/schemas/AttributeGroupListGet' AttributeGroupGet: description: This class represents an attribute group query. type: object required: - languages properties: languages: type: array items: type: string AttributeGroupGetWrapper: type: object required: - AttributeGroupGet properties: AttributeGroupGet: $ref: '#/components/schemas/AttributeGroupGet' AttributeGroupListResult: allOf: - $ref: '#/components/schemas/BaseObject' - type: object required: - count - AttributeGroupList properties: count: type: integer AttributeGroupList: $ref: '#/components/schemas/AttributeGroupList' AttributeGroupView: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents an attribute group view. type: object required: - identifier - Result properties: identifier: type: string Result: $ref: '#/components/schemas/AttributeGroupListResult' AttributeGroupViewWrapper: type: object required: - AttributeGroupView properties: AttributeGroupView: $ref: '#/components/schemas/AttributeGroupView' AttributeGroupViewInput: description: This class represents an attribute group view input. xml: name: ViewInput type: object required: - identifier - AttributeGroupQuery properties: identifier: type: string AttributeGroupQuery: type: object required: - limit - offset - name_prefix properties: limit: type: string offset: type: string name_prefix: type: string AttributeGroupViewInputWrapper: type: object required: - ViewInput properties: ViewInput: $ref: '#/components/schemas/AttributeGroupViewInput' AttributeType: description: This class represents an attribute type. type: object required: - identifier - name properties: identifier: type: string name: type: string AttributeTypeWrapper: type: object required: - AttributeType properties: AttributeType: $ref: '#/components/schemas/AttributeType' AttributeTypeList: description: This class represents an attribute type list. type: object required: - attributeTypes properties: attributeTypes: type: array items: $ref: '#/components/schemas/AttributeType' AttributeTypeListWrapper: type: object required: - AttributeTypeList properties: AttributeTypeList: $ref: '#/components/schemas/AttributeTypeList' Attribute: description: This class represents an attribute. type: object required: - name - identifier - description - type - type_identifier - value - group - position - options properties: name: type: string identifier: type: string description: type: string type: type: string type_identifier: type: string value: type: [] group: type: string position: type: integer options: type: - object - array AttributeWrapper: type: object required: - Attribute properties: Attribute: $ref: '#/components/schemas/Attribute' AttributeCreate: description: This class is used to create an attribute. type: object required: - identifier - type - group - names - descriptions - position - options properties: identifier: type: string type: type: string group: type: string names: type: object descriptions: type: object position: type: integer options: type: - object - array AttributeCreateWrapper: type: object required: - AttributeCreate properties: AttributeCreate: $ref: '#/components/schemas/AttributeCreate' AttributeUpdate: description: This class is used to update an attribute. type: object required: - identifier - names - descriptions - position - options properties: identifier: type: string names: type: object descriptions: type: object position: type: integer options: type: object AttributeUpdateWrapper: type: object required: - AttributeUpdate properties: AttributeUpdate: $ref: '#/components/schemas/AttributeUpdate' AttributeListGet: description: This class represents an attribute list query type: object properties: group_name_prefix: type: string name_prefix: type: string offset: type: integer limit: type: integer AttributeListGetWrapper: type: object required: - AttributeListGet properties: AttributeListGet: $ref: '#/components/schemas/AttributeListGet' AttributeList: description: This class represents an attribute list. type: object required: - Attribute properties: Attribute: type: array items: $ref: '#/components/schemas/Attribute' AttributeListWrapper: type: object required: - AttributeList properties: AttributeList: $ref: '#/components/schemas/AttributeList' AttributeView: description: This class represents an attribute view. type: object required: - identifier - AttributeQuery - Result properties: identifier: type: string AttributeQuery: type: object Result: type: object AttributeViewWrapper: type: object required: - AttributeView properties: AttributeView: $ref: '#/components/schemas/AttributeView' AttributeViewInput: description: This class represents an attribute view input. xml: name: ViewInput type: object required: - identifier - AttributeQuery properties: identifier: type: string AttributeQuery: type: object AttributeViewInputWrapper: type: object required: - ViewInput properties: ViewInput: $ref: '#/components/schemas/AttributeViewInput' AttributeAssignment: type: object required: - is_required - is_discriminator - Attribute properties: is_required: type: boolean is_discriminator: type: boolean Attribute: $ref: '#/components/schemas/Attribute' Catalog: description: This class represents a catalog. type: object required: - identifier - name - description - created - modified - status - User - Criteria properties: identifier: type: string name: type: string description: type: string created: type: integer modified: type: integer status: type: string User: $ref: '#/components/schemas/Ref' Criteria: type: array items: $ref: '#/components/schemas/Criterion' CatalogWrapper: type: object required: - Catalog properties: Catalog: $ref: '#/components/schemas/Catalog' CatalogCreate: description: This class is used to create a catalog. type: object required: - identifier - criteria - names - status properties: identifier: type: string criteria: $ref: '#/components/schemas/Criterion' names: type: object descriptions: type: object status: type: string creator_id: type: integer CatalogCreateWrapper: type: object required: - CatalogCreate properties: CatalogCreate: $ref: '#/components/schemas/CatalogCreate' CatalogUpdate: description: This class is used to update a catalog. type: object required: - identifier - transition - criteria - names - descriptions properties: identifier: type: string transition: type: string criteria: $ref: '#/components/schemas/Criterion' names: type: object descriptions: type: object CatalogUpdateWrapper: type: object required: - CatalogUpdate properties: CatalogUpdate: $ref: '#/components/schemas/CatalogUpdate' CatalogCopy: description: This class is used to copy a catalog. type: object required: - identifier - creator_id properties: identifier: type: string creator_id: description: Optional type: integer CatalogCopyWrapper: type: object required: - CatalogCopy properties: CatalogCopy: $ref: '#/components/schemas/CatalogCopy' CatalogList: description: This class represents a catalog list. type: object required: - Catalog properties: Catalog: type: array items: $ref: '#/components/schemas/Catalog' CatalogListViewResult: allOf: - $ref: '#/components/schemas/BaseObject' - type: object required: - CatalogList properties: CatalogList: $ref: '#/components/schemas/CatalogList' CatalogView: allOf: - $ref: '#/components/schemas/BaseObject' - type: object required: - identifier - CatalogQuery - Result properties: identifier: type: string CatalogQuery: $ref: '#/components/schemas/Ref' Result: $ref: '#/components/schemas/CatalogListViewResult' CatalogViewWrapper: type: object required: - CatalogView properties: CatalogView: $ref: '#/components/schemas/CatalogView' CatalogViewInput: description: This class represents a catalog view input. xml: name: ViewInput type: object required: - CatalogQuery properties: CatalogQuery: type: object CatalogViewInputWrapper: type: object required: - ViewInput properties: ViewInput: $ref: '#/components/schemas/CatalogViewInput' Currency: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents currency. type: object required: - id - code - subunits - enabled properties: id: type: integer code: type: string subunits: type: integer enabled: type: boolean CurrencyWrapper: type: object required: - Currency properties: Currency: $ref: '#/components/schemas/Currency' CurrencyCreate: description: This class is used to create currency. type: object required: - code - subunits - enabled properties: code: type: string subunits: type: integer enabled: type: boolean CurrencyCreateWrapper: type: object required: - CurrencyCreate properties: CurrencyCreate: $ref: '#/components/schemas/CurrencyCreate' CurrencyUpdate: description: This class is used to update currency. type: object required: - subunits - enabled properties: subunits: type: integer enabled: type: boolean CurrencyUpdateWrapper: type: object required: - CurrencyUpdate properties: CurrencyUpdate: $ref: '#/components/schemas/CurrencyUpdate' CurrencyView: description: This class represents a currency view. type: object required: - identifier - CurrencyQuery - Result properties: identifier: type: string CurrencyQuery: type: object Result: type: object CurrencyViewWrapper: type: object required: - CurrencyView properties: CurrencyView: $ref: '#/components/schemas/CurrencyView' CurrencyViewInput: description: This class represents a currency view input. xml: name: ViewInput type: object required: - CurrencyQuery properties: CurrencyQuery: type: object CurrencyViewInputWrapper: type: object required: - ViewInput properties: ViewInput: $ref: '#/components/schemas/CurrencyViewInput' CurrencyList: description: This class represents a currency list. type: object required: - Currency properties: Currency: type: array items: $ref: '#/components/schemas/Currency' CurrencyListWrapper: type: object required: - CurrencyList properties: CurrencyList: $ref: '#/components/schemas/CurrencyList' CustomerGroup: description: This class represents a customer group. type: object required: - id - name - identifier - description - users - global_price_rate properties: id: type: integer name: type: string identifier: type: string description: type: string users: description: A list of users attached to the customer group. type: array items: $ref: '#/components/schemas/User' global_price_rate: description: A numeric string type: string CustomerGroupWrapper: type: object required: - CustomerGroup properties: CustomerGroup: $ref: '#/components/schemas/CustomerGroup' CustomerGroupCreate: description: This class is used to create a customer group. type: object required: - identifier - names - descriptions - global_price_rate properties: identifier: type: string names: type: object descriptions: type: object global_price_rate: description: numeric-string type: string CustomerGroupCreateWrapper: type: object required: - CustomerGroupCreate properties: CustomerGroupCreate: $ref: '#/components/schemas/CustomerGroupCreate' CustomerGroupUpdate: description: This class is used to update a customer group. type: object required: - names - identifier - global_price_rate properties: names: type: object identifier: type: string global_price_rate: type: string descriptions: type: array items: type: string CustomerGroupUpdateWrapper: type: object required: - CustomerGroupUpdate properties: CustomerGroupUpdate: $ref: '#/components/schemas/CustomerGroupUpdate' CustomerGroupList: description: This class represents a customer group list. type: object required: - CustomerGroup properties: CustomerGroup: type: array items: $ref: '#/components/schemas/CustomerGroup' CustomerGroupListWrapper: type: object required: - CustomerGroupList properties: CustomerGroupList: $ref: '#/components/schemas/CustomerGroupList' CustomerGroupListResult: allOf: - $ref: '#/components/schemas/BaseObject' - type: object required: - CustomerGroupList properties: CustomerGroupList: allOf: - $ref: '#/components/schemas/BaseObject' - type: object required: - CustomerGroup properties: CustomerGroup: type: array items: $ref: '#/components/schemas/CustomerGroup' CustomerGroupViewInput: description: This class represents a customer group view input. xml: name: ViewInput type: object required: - CustomerGroupQuery properties: CustomerGroupQuery: type: object CustomerGroupViewInputWrapper: type: object required: - ViewInput properties: ViewInput: $ref: '#/components/schemas/CustomerGroupViewInput' CustomerGroupView: description: This class represents a customer group view. type: object required: - identifier - CustomerGroupQuery - Result properties: identifier: type: string CustomerGroupQuery: type: object Result: $ref: '#/components/schemas/CustomerGroupListResult' CustomerGroupViewWrapper: type: object required: - CustomerGroupView properties: CustomerGroupView: $ref: '#/components/schemas/CustomerGroupView' Region: description: This class represents a region. type: object required: - identifier properties: identifier: type: string RegionWrapper: type: object required: - Region properties: Region: $ref: '#/components/schemas/Region' RegionList: description: This class represents a region list. type: object required: - Region properties: Region: type: array items: $ref: '#/components/schemas/Ref' RegionListWrapper: type: object required: - RegionList properties: RegionList: $ref: '#/components/schemas/RegionList' RegionView: description: This class represents a region view. type: object required: - identifier - RegionQuery - Result properties: identifier: type: string RegionQuery: type: object Result: type: object RegionViewWrapper: type: object required: - RegionView properties: RegionView: $ref: '#/components/schemas/RegionView' RegionViewInput: description: This class represents a region view input. xml: name: ViewInput type: object required: - RegionQuery properties: RegionQuery: type: object RegionViewInputWrapper: type: object required: - ViewInput properties: ViewInput: $ref: '#/components/schemas/RegionViewInput' ProductType: description: This class represents a product type. type: object required: - identifier - name - AttributeAssignmentList properties: identifier: type: string name: type: string AttributeAssignmentList: type: array items: $ref: '#/components/schemas/AttributeAssignment' ProductTypeWrapper: type: object required: - ProductType properties: ProductType: $ref: '#/components/schemas/ProductType' ProductTypeCreate: description: This class is used to create a product type. type: object required: - ContentTypeCreateStruct - main_language_code - assigned_attributes properties: ContentTypeCreateStruct: type: object main_language_code: type: string assigned_attributes: type: array items: $ref: '#/components/schemas/ProductTypeAssignedAttribute' ProductTypeCreateWrapper: type: object required: - ProductTypeCreate properties: ProductTypeCreate: $ref: '#/components/schemas/ProductTypeCreate' ProductTypeUpdate: description: This class is used to update a product type. type: object required: - ContentTypeUpdateStruct - assigned_attributes properties: ContentTypeUpdateStruct: $ref: '#/components/schemas/ContentTypeUpdateStruct' assigned_attributes: type: array items: $ref: '#/components/schemas/ProductTypeAssignedAttribute' ProductTypeUpdateWrapper: type: object required: - ProductTypeUpdate properties: ProductTypeUpdate: $ref: '#/components/schemas/ProductTypeUpdate' ProductTypeUsage: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a product type usage. type: object required: - is_used properties: is_used: type: boolean ProductTypeUsageWrapper: type: object required: - ProductTypeUsage properties: ProductTypeUsage: $ref: '#/components/schemas/ProductTypeUsage' ProductTypeView: description: This class represents a product type view. type: object required: - identifier - ProductTypeQuery - Result properties: identifier: type: string ProductTypeQuery: type: object Result: type: object ProductTypeViewWrapper: type: object required: - ProductTypeView properties: ProductTypeView: $ref: '#/components/schemas/ProductTypeView' ProductTypeList: description: This class represents a product type list. type: object required: - ProductType properties: ProductType: type: array items: $ref: '#/components/schemas/ProductType' ProductTypeListWrapper: type: object required: - ProductTypeList properties: ProductTypeList: $ref: '#/components/schemas/ProductTypeList' ProductTypeListGet: description: This class represents a product type list query. type: object required: - name_prefix - offset - limit properties: name_prefix: type: string offset: type: integer limit: type: integer languages: type: array items: type: string ProductTypeListGetWrapper: type: object required: - ProductTypeListGet properties: ProductTypeListGet: $ref: '#/components/schemas/ProductTypeListGet' ProductTypeViewInput: description: This class represents a product type view input. xml: name: ViewInput type: object required: - ProductTypeQuery properties: ProductTypeQuery: type: object ProductTypeViewInputWrapper: type: object required: - ViewInput properties: ViewInput: $ref: '#/components/schemas/ProductTypeViewInput' ProductTypeAssignedAttribute: type: object required: - identifier - is_required - is_discriminator properties: identifier: type: string is_required: type: boolean is_discriminator: type: boolean ProductVariant: description: This class represents a product variant. type: object required: - code - name - Product - DiscriminatorAttributesList properties: code: type: string name: type: string Product: $ref: '#/components/schemas/Product' DiscriminatorAttributesList: type: array items: $ref: '#/components/schemas/Attribute' ProductVariantWrapper: type: object required: - ProductVariant properties: ProductVariant: $ref: '#/components/schemas/ProductVariant' ProductVariantView: description: This class represents a product variant view. type: object required: - identifier - ProductVariantQuery - Result properties: identifier: type: string ProductVariantQuery: type: object Result: type: object ProductVariantViewWrapper: type: object required: - ProductVariantView properties: ProductVariantView: $ref: '#/components/schemas/ProductVariantView' ProductVariantViewInput: description: This class represents a product variant view input. type: object required: - ProductVariantQuery properties: ProductVariantQuery: type: object ProductVariantViewInputWrapper: type: object required: - ViewInput properties: ViewInput: $ref: '#/components/schemas/ProductVariantViewInput' ProductVariantCreate: description: This class is used to create a product variant. type: object required: - code - attributes properties: code: type: string attributes: description: array<int|string,mixed> type: object ProductVariantCreateWrapper: type: object required: - ProductVariantCreate properties: ProductVariantCreate: $ref: '#/components/schemas/ProductVariantCreate' ProductVariantUpdate: description: This class is used to update a product variant. type: object required: - code - attributes properties: code: type: string attributes: description: array<int|string,mixed> type: object ProductVariantUpdateWrapper: type: object required: - ProductVariantUpdate properties: ProductVariantUpdate: $ref: '#/components/schemas/ProductVariantUpdate' ProductVariantGenerate: description: This class is used to generate a product variant. type: object required: - attributes properties: attributes: description: array<int|string,mixed> type: object ProductVariantGenerateWrapper: type: object required: - ProductVariantGenerate properties: ProductVariantGenerate: $ref: '#/components/schemas/ProductVariantGenerate' ProductSortClause: type: object required: - name properties: name: type: string ProductSortClauseList: description: This class represents a product sort clause list. type: object required: - ProductSortClause properties: ProductSortClause: type: array items: $ref: '#/components/schemas/ProductSortClause' ProductSortClauseListWrapper: type: object required: - ProductSortClauseList properties: ProductSortClauseList: $ref: '#/components/schemas/ProductSortClauseList' Product: description: This class represents a product. type: object required: - code - name - ProductType - AttributesList properties: isVariant: type: boolean isBaseProduct: type: boolean code: type: string name: type: string ProductType: $ref: '#/components/schemas/ProductType' Content: $ref: '#/components/schemas/Content' Thumbnail: $ref: '#/components/schemas/Thumbnail' created_at: type: integer updated_at: type: integer AttributesList: type: array items: $ref: '#/components/schemas/Attribute' ProductWrapper: type: object required: - Product properties: Product: $ref: '#/components/schemas/Product' ProductCreate: description: This class is used to create a product. type: object required: - ContentCreate - code - attributes properties: ContentCreate: $ref: '#/components/schemas/ContentCreate' code: type: string attributes: type: object ProductCreateWrapper: type: object required: - ProductCreate properties: ProductCreate: $ref: '#/components/schemas/ProductCreate' ProductUpdate: description: This class is used to update a product. type: object required: - ContentUpdate - code properties: ContentUpdate: $ref: '#/components/schemas/ContentUpdate' code: type: string attributes: type: array items: type: object ProductUpdateWrapper: type: object required: - ProductUpdate properties: ProductUpdate: $ref: '#/components/schemas/ProductUpdate' ProductView: description: This class represents a product view. type: object required: - identifier - ProductQuery - Result properties: identifier: type: string ProductQuery: type: object Result: type: object ProductViewWrapper: type: object required: - ProductView properties: ProductView: $ref: '#/components/schemas/ProductView' ProductViewInput: description: This class represents a product view input. xml: name: ViewInput type: object required: - ProductQuery properties: ProductQuery: type: object ProductViewInputWrapper: type: object required: - ViewInput properties: ViewInput: $ref: '#/components/schemas/ProductViewInput' ProductList: description: This class represents a product list. type: object required: - Product properties: Product: type: array items: $ref: '#/components/schemas/Product' ProductListWrapper: type: object required: - ProductList properties: ProductList: $ref: '#/components/schemas/ProductList' ProductListGet: description: This class represents a product list GET. type: object required: - offset - limit - languages properties: offset: type: integer limit: type: integer languages: type: array items: type: string ProductListGetWrapper: type: object required: - ProductListGet properties: ProductListGet: $ref: '#/components/schemas/ProductListGet' ProductGet: description: This class represents a product GET. type: object required: - languages properties: languages: type: array items: type: string ProductGetWrapper: type: object required: - ProductGet properties: ProductGet: $ref: '#/components/schemas/ProductGet' ProductFilter: type: object required: - name properties: name: type: string ProductFilterList: description: This class represents a product filter list. type: object required: - ProductFilter properties: ProductFilter: type: array items: $ref: '#/components/schemas/ProductFilter' ProductFilterListWrapper: type: object required: - ProductFilterList properties: ProductFilterList: $ref: '#/components/schemas/ProductFilterList' Price: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a price. type: object required: - amount - Currency properties: amount: type: string base_amount: type: string Currency: $ref: '#/components/schemas/Currency' money: type: string base_money: type: string PriceWrapper: type: object required: - Price properties: Price: $ref: '#/components/schemas/Price' PriceCreateStruct: description: This class represents a price creation structure. type: object required: - amount - currency properties: amount: type: integer currency: type: string PriceCreateStructWrapper: type: object required: - PriceCreateStruct properties: PriceCreateStruct: $ref: '#/components/schemas/PriceCreateStruct' CustomPrice: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a custom price. type: object required: - amount - base_amount - Currency - money - base_money - custom_money - custom_amount properties: amount: type: string base_amount: type: string Currency: $ref: '#/components/schemas/Currency' money: type: string base_money: type: string custom_money: type: string custom_amount: type: string custom_rule: type: - string - 'null' CustomPriceWrapper: type: object required: - CustomPrice properties: CustomPrice: $ref: '#/components/schemas/CustomPrice' CustomPriceCreateStruct: description: This class represents a custom price creation structure. type: object required: - amount - currency - customAmount - customerGroup properties: amount: type: integer currency: type: string customAmount: type: integer customerGroup: type: string CustomPriceCreateStructWrapper: type: object required: - CustomPriceCreateStruct properties: CustomPriceCreateStruct: $ref: '#/components/schemas/CustomPriceCreateStruct' CustomPriceUpdateStruct: description: This class represents a custom price updating structure. type: object required: - amount - currency - customAmount properties: amount: type: integer currency: type: string customAmount: type: integer CustomPriceUpdateStructWrapper: type: object required: - CustomPriceUpdateStruct properties: CustomPriceUpdateStruct: $ref: '#/components/schemas/CustomPriceUpdateStruct' PriceUpdateStruct: description: This class represents a price updating structure. type: object required: - amount - currency properties: amount: type: integer currency: type: string PriceUpdateStructWrapper: type: object required: - PriceUpdateStruct properties: PriceUpdateStruct: $ref: '#/components/schemas/PriceUpdateStruct' PriceList: description: This class represents a price list. type: object required: - prices properties: prices: type: array items: $ref: '#/components/schemas/Price' PriceListWrapper: type: object required: - PriceList properties: PriceList: $ref: '#/components/schemas/PriceList' Thumbnail: description: This class represents a thumbnail that can be a target URL or a Base64 data. type: object required: - resource - width - height - mimeType properties: resource: type: string width: type: - integer - 'null' height: type: - integer - 'null' mimeType: type: string VatCategory: description: This class represents a VAT category. type: object required: - identifier - region - vatValue properties: identifier: type: string region: type: string vatValue: type: - number - 'null' VatCategoryWrapper: type: object required: - VatCategory properties: VatCategory: $ref: '#/components/schemas/VatCategory' VatCategoryList: description: This class represents a VAT category list. type: object required: - VatCategory properties: VatCategory: type: array items: $ref: '#/components/schemas/VatCategory' VatCategoryListWrapper: type: object required: - VatCategoryList properties: VatCategoryList: $ref: '#/components/schemas/VatCategoryList' TaxonomyEntry: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a taxonomy entry. type: object required: - id - identifier - name - content - taxonomy properties: id: type: integer identifier: type: string name: type: string content: $ref: '#/components/schemas/Ref' taxonomy: type: string TaxonomyEntryWrapper: type: object required: - TaxonomyEntry properties: TaxonomyEntry: $ref: '#/components/schemas/TaxonomyEntry' TaxonomyEntryBulkRemove: description: This class is used to bulk remove taxonomy entries. type: object required: - entries properties: entries: type: array items: type: integer TaxonomyEntryBulkRemoveWrapper: type: object required: - TaxonomyEntryBulkRemove properties: TaxonomyEntryBulkRemove: $ref: '#/components/schemas/TaxonomyEntryBulkRemove' TaxonomyEntryMove: type: object required: - entry - sibling - position properties: entry: type: integer sibling: type: integer position: type: string TaxonomyEntryBulkMove: description: This class is used to bulk move taxonomy entries. type: object required: - entries properties: entries: type: array items: $ref: '#/components/schemas/TaxonomyEntryMove' TaxonomyEntryBulkMoveWrapper: type: object required: - TaxonomyEntryBulkMove properties: TaxonomyEntryBulkMove: $ref: '#/components/schemas/TaxonomyEntryBulkMove' TaxonomyEntryAssignment: description: This class represents a taxonomy entry assignment. type: object required: - id - content - entry properties: id: type: integer content: allOf: - $ref: '#/components/schemas/BaseObject' - type: object required: - Content properties: Content: $ref: '#/components/schemas/Content' entry: allOf: - $ref: '#/components/schemas/BaseObject' - type: object required: - TaxonomyEntry properties: TaxonomyEntry: $ref: '#/components/schemas/TaxonomyEntry' TaxonomyEntryAssignmentWrapper: type: object required: - TaxonomyEntryAssignment properties: TaxonomyEntryAssignment: $ref: '#/components/schemas/TaxonomyEntryAssignment' TaxonomyEntryAssignToContent: description: This class is used to assign taxonomy entry to content. type: object required: - content - entries properties: content: type: integer entries: type: array items: type: integer TaxonomyEntryAssignToContentWrapper: type: object required: - TaxonomyEntryAssignToContent properties: TaxonomyEntryAssignToContent: $ref: '#/components/schemas/TaxonomyEntryAssignToContent' TaxonomyEntryUnassignFromContent: description: This class is used to unassign taxonomy entry from content. type: object required: - content - entries properties: content: type: integer entries: type: array items: type: integer TaxonomyEntryUnassignFromContentWrapper: type: object required: - TaxonomyEntryUnassignFromContent properties: TaxonomyEntryUnassignFromContent: $ref: '#/components/schemas/TaxonomyEntryUnassignFromContent' EntryAssignmentCollection: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a taxonomy assignment collection. type: object required: - content - assignments properties: content: allOf: - $ref: '#/components/schemas/BaseObject' - type: object required: - Content properties: Content: $ref: '#/components/schemas/Content' assignments: type: array items: $ref: '#/components/schemas/TaxonomyEntryAssignment' EntryAssignmentCollectionWrapper: type: object required: - EntryAssignmentCollection properties: EntryAssignmentCollection: $ref: '#/components/schemas/EntryAssignmentCollection' PageStructure: description: Catalogue of the layouts and blocks available for building Pages. type: object required: - _media-type - layouts - blocks properties: _media-type: type: string layouts: description: Page layouts available for building Pages. type: array items: $ref: '#/components/schemas/PageStructureLayout' blocks: description: Page blocks available for placing in the zones of a layout. type: array items: $ref: '#/components/schemas/PageStructureBlock' PageStructureWrapper: type: object required: - PageStructure properties: PageStructure: $ref: '#/components/schemas/PageStructure' PageStructureLayout: description: Page layout, together with the zones it is divided into. type: object required: - _media-type - identifier - name - description - zones properties: _media-type: type: string identifier: description: Unique layout identifier, as used in configuration. type: string name: description: Human-readable layout name. type: string description: description: Human-readable layout description. Empty string when the layout declares no description. type: string zones: description: Zones the layout is divided into. Blocks are placed in zones. type: array items: $ref: '#/components/schemas/PageStructureZone' PageStructureZone: description: Zone of a Page layout. type: object required: - _media-type - identifier - name - description properties: _media-type: type: string identifier: description: Unique zone identifier within its layout. type: string name: description: Human-readable zone name. type: string description: description: Human-readable zone description. Empty string when the zone declares no description. type: string PageStructureBlock: description: Page block, together with its views and attributes. type: object required: - _media-type - identifier - name - description - category - views - attributes properties: _media-type: type: string identifier: description: Unique block identifier, as used in configuration. type: string name: description: Human-readable block name. type: string description: description: Human-readable block description. Empty string when the block declares no description. type: string category: description: Identifier of the category the block is grouped under in the editor. type: string views: description: Views the block can be rendered with. type: array items: $ref: '#/components/schemas/PageStructureView' attributes: description: Attributes the block accepts. type: array items: $ref: '#/components/schemas/PageStructureAttribute' PageStructureView: description: View a Page block can be rendered with. type: object required: - _media-type - identifier - name - description properties: _media-type: type: string identifier: description: Unique view identifier within its block. type: string name: description: Human-readable view name. type: string description: description: Human-readable view description. Empty string when the view declares no description. type: string PageStructureAttribute: description: Attribute of a Page block. type: object required: - _media-type - identifier - name - type - category - options properties: _media-type: type: string identifier: description: Unique attribute identifier within its block. type: string name: description: Human-readable attribute name. type: string type: description: Identifier of the attribute type, which determines how the value is edited and stored. type: string category: description: Identifier of the category the attribute is grouped under in the block edit form. type: string options: description: | Attribute type specific configuration, passed through from the block definition as-is. Always serialized as a JSON object, empty when the attribute declares no options. type: object additionalProperties: true Segment: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a segment. type: object required: - id - identifier - name - source - SegmentGroup properties: id: type: integer identifier: type: string name: type: string source: type: string lastUpdatedBy: type: string nullable: true updatedAt: type: string format: date-time nullable: true SegmentGroup: $ref: '#/components/schemas/SegmentGroup' SegmentWrapper: type: object required: - Segment properties: Segment: $ref: '#/components/schemas/Segment' SegmentList: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class lists segments. type: object required: - Segment properties: Segment: type: array items: $ref: '#/components/schemas/Segment' SegmentListWrapper: type: object required: - SegmentList properties: SegmentList: $ref: '#/components/schemas/SegmentList' SegmentGroup: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class represents a segment group. type: object required: - id - identifier - name properties: id: type: integer identifier: type: string name: type: string SegmentGroupWrapper: type: object required: - SegmentGroup properties: SegmentGroup: $ref: '#/components/schemas/SegmentGroup' SegmentGroupList: allOf: - $ref: '#/components/schemas/BaseObject' - description: This class lists segment groups. type: object required: - SegmentGroup properties: SegmentGroup: type: array items: $ref: '#/components/schemas/SegmentGroup' SegmentGroupListWrapper: type: object required: - SegmentGroupList properties: SegmentGroupList: $ref: '#/components/schemas/SegmentGroupList' UserSegment: description: This class represents a segment and a user it's associate to. type: object properties: id: type: integer identifier: type: string name: type: string source: type: string lastUpdatedBy: type: string nullable: true updatedAt: type: string format: date-time nullable: true SegmentGroup: $ref: '#/components/schemas/Ref' User: $ref: '#/components/schemas/Ref' UserSegmentList: description: this class lists segments associated to users. allOf: - $ref: '#/components/schemas/BaseObject' - type: object properties: UserSegment: type: array items: $ref: '#/components/schemas/UserSegment' UserSegmentListWrapper: type: object required: - UserSegmentList properties: UserSegmentList: $ref: '#/components/schemas/SegmentList' UserSegmentAssignInput: type: object properties: segments: type: array items: type: string UserSegmentAssignInputWrapper: type: object required: - UserSegmentAssignInput properties: UserSegmentAssignInput: $ref: '#/components/schemas/UserSegmentAssignInput' ActivityLog: description: This class represents an activity log entry. type: object ActivityLogGroup: type: object required: - user_id - logged_at - ActivityLogEntries properties: user_id: description: The ID of the user performing the logged actions type: integer logged_at: description: Timestamp representing when the group has been logged type: integer ActivityLogEntries: description: Log entries from the group type: array items: $ref: '#/components/schemas/ActivityLog' ActivityLogGroupListInput: description: This class represents the activity log group search query's criteria and sort clauses. type: object properties: offset: description: The offset of the first item to return type: integer limit: description: The maximum number of items to return - default is set by `activity_log.pagination.activity_logs_limit` which is 25 if not overridden type: integer criteria: description: Search criteria for activity log groups type: array items: description: Search criterion for activity log groups type: object required: - type properties: type: description: The type of the search criterion type: string enum: - action - logged_at - object_class - user value: description: The value of the search criterion oneOf: - type: string - type: array operator: description: The operator of the search criterion type: string class: description: The class of the `object_class` criterion type: string sort_clause: description: Sort clauses for activity log groups type: array items: description: Sort clause for activity log groups type: object required: - type properties: type: description: The type of the sort clause type: string enum: - logged_at direction: description: The direction of the sort clause type: string enum: - ASC - DESC ActivityLogGroupListInputWrapper: type: object required: - ActivityLogGroupListInput properties: ActivityLogGroupListInput: $ref: '#/components/schemas/ActivityLogGroupListInput' ActivityLogGroupList: description: This class represents activity log context groups type: object required: - ActivityLogGroups properties: ActivityLogGroups: type: array items: $ref: '#/components/schemas/ActivityLogGroup' ActivityLogGroupListWrapper: type: object required: - ActivityLogGroupList properties: ActivityLogGroupList: $ref: '#/components/schemas/ActivityLogGroupList' ActionType: type: object required: - ActionType properties: ActionType: type: object required: - _media-type - identifier - name - inputIdentifier - outputIdentifier - options properties: _media-type: type: string enum: - application/vnd.ibexa.api.ai.ActionType+json - application/vnd.ibexa.api.ai.ActionType+xml identifier: type: string name: type: string inputIdentifier: type: string outputIdentifier: type: string options: type: object additionalProperties: true ActionTypeList: type: object required: - _media-type - _href - ActionType properties: _media-type: type: string enum: - application/vnd.ibexa.api.ai.ActionTypeList+json - application/vnd.ibexa.api.ai.ActionTypeList+xml _href: type: string enum: - /api/ibexa/v2/ai/action-types ActionType: type: array items: $ref: '#/components/schemas/ActionType' ActionConfiguration: type: object properties: ActionConfiguration: type: object required: - _media-type - identifier - name - enabled - ActionType - actionTypeOptions - actionHandlerIdentifier - actionHandlerOptions - createdAt - updatedAt properties: _media-type: type: string enum: - application/vnd.ibexa.api.ai.ActionConfiguration+json - application/vnd.ibexa.api.ai.ActionConfiguration+xml identifier: type: string name: type: string description: type: string enabled: type: boolean ActionType: $ref: '#/components/schemas/ActionType' actionTypeOptions: type: object additionalProperties: true actionHandlerIdentifier: type: string actionHandlerOptions: type: object additionalProperties: true createdAt: type: string updatedAt: type: string ActionConfigurationList: type: object required: - _media-type - ActionConfiguration properties: _media-type: type: string enum: - application/vnd.ibexa.api.ai.ActionConfigurationList+json - application/vnd.ibexa.api.ai.ActionConfigurationList+xml _href: type: string examples: - /api/ibexa/v2/ai/actions ActionConfiguration: type: array items: $ref: '#/components/schemas/ActionConfiguration' ActionConfigurationListInput: type: object properties: query: type: string action_type_identifier: type: string enabled: type: boolean limit: type: integer page: type: integer RuntimeContext: type: object additionalProperties: true Text: type: object required: - _media-type - text properties: _media-type: type: string enum: - application/vnd.ibexa.api.ai.Text+json - application/vnd.ibexa.api.ai.Text+xml text: type: array items: type: string RefineText: type: object required: - Text - RuntimeContext properties: _media-type: type: string enum: - application/vnd.ibexa.api.ai.RefineText+json - application/vnd.ibexa.api.ai.RefineText+xml Text: type: object required: - text properties: text: type: array items: type: string RuntimeContext: $ref: '#/components/schemas/RuntimeContext' GenerateAltText: type: object required: - Image - RuntimeContext properties: Image: type: object required: - base64 properties: base64: type: string RuntimeContext: $ref: '#/components/schemas/RuntimeContext' AltText: type: object required: - _media-type - Text properties: _media-type: type: string enum: - application/vnd.ibexa.api.ai.AltText+json - application/vnd.ibexa.api.ai.AltText+xml Text: type: object required: - _media-type - text properties: _media-type: type: string enum: - application/vnd.ibexa.api.ai.Text+json - application/vnd.ibexa.api.ai.Text+xml text: type: array items: type: string ExampleSessionCreate: type: object description: Schema for creating a new collaboration session properties: ExampleSessionCreate: type: object properties: Owner: $ref: '#/components/schemas/UserReference' description: Reference to the session owner ParticipantListCreate: $ref: '#/components/schemas/ParticipantListCreate' description: List of participants to add to the session subject: type: string description: Subject or title of the collaboration session required: - Owner - ParticipantListCreate - subject required: - ExampleSessionCreate additionalProperties: false ExampleSessionUpdate: type: object description: Schema for updating a collaboration session properties: ExampleSessionUpdate: type: object properties: hasPublicLink: type: boolean description: Whether the session should have a public access link enabled required: - hasPublicLink required: - ExampleSessionUpdate additionalProperties: false InternalParticipantUpdate: type: object description: Schema for updating an internal participant properties: InternalParticipantUpdate: type: object properties: scope: type: string description: Permission scope for the participant enum: - view - edit - admin required: - scope required: - InternalParticipantUpdate additionalProperties: false ExternalParticipantUpdate: type: object description: Schema for updating an external participant properties: ExternalParticipantUpdate: type: object properties: scope: type: string description: Permission scope for the participant enum: - view - edit - admin required: - scope required: - ExternalParticipantUpdate additionalProperties: false InvitationCreate: type: object description: Schema for creating a new invitation properties: InvitationCreate: type: object properties: email: type: string description: Email address of the invitation recipient format: email Sender: $ref: '#/components/schemas/UserReference' description: Reference to the user sending the invitation context: type: object description: Additional context information for the invitation properties: single_value: type: string description: A single context value simple_array: type: array description: An array of simple values items: type: string extended_array: type: object description: An object with key-value pairs additionalProperties: type: string additionalProperties: true required: - email - Sender - context required: - InvitationCreate additionalProperties: false ParticipantListCreate: type: object description: Schema for creating a list of participants properties: ParticipantListCreate: type: object properties: ParticipantCreate: type: array description: Array of participants to create items: oneOf: - $ref: '#/components/schemas/InternalParticipantCreate' - $ref: '#/components/schemas/ExternalParticipantCreate' minItems: 1 required: - ParticipantCreate required: - ParticipantListCreate additionalProperties: false InternalParticipantCreate: type: object description: Schema for creating an internal participant properties: _media-type: type: string description: Media type identifier for internal participant creation enum: - application/vnd.ibexa.api.InternalParticipantCreate+json User: $ref: '#/components/schemas/UserReference' description: Reference to the user account scope: type: string description: Permission scope for the participant enum: - view - edit - admin required: - _media-type - User - scope additionalProperties: false ExternalParticipantCreate: type: object description: Schema for creating an external participant properties: _media-type: type: string description: Media type identifier for external participant creation enum: - application/vnd.ibexa.api.ExternalParticipantCreate+json email: type: string description: Email address of the external participant format: email scope: type: string description: Permission scope for the participant enum: - view - edit - admin required: - _media-type - email - scope additionalProperties: false UserReference: type: object description: Reference to a user resource properties: _media-type: type: string description: Media type identifier for the user reference enum: - application/vnd.ibexa.api.User+json _href: type: string description: REST API URL reference to the user resource format: uri pattern: ^/api/ibexa/v2/user/users/[0-9]+$ required: - _media-type - _href additionalProperties: false ExampleSessionWrapper: type: object description: Wrapper object containing a collaboration session properties: CollaborationSession: $ref: '#/components/schemas/CollaborationSession' description: The collaboration session object required: - CollaborationSession additionalProperties: false CollaborationSession: type: object description: A collaboration session representing a shared workspace for participants properties: _media-type: type: string description: Media type identifier for the collaboration session id: type: integer description: Unique identifier of the collaboration session token: type: string description: Session access token for authentication and authorization ParticipantList: $ref: '#/components/schemas/ParticipantListObject' description: List of participants in the collaboration session Owner: $ref: '#/components/schemas/Owner' description: Owner of the collaboration session createdAt: type: string description: ISO 8601 timestamp when the session was created format: date-time updatedAt: type: string description: ISO 8601 timestamp when the session was last updated format: date-time subject: type: string description: Subject or title of the collaboration session isActive: type: boolean description: Whether the collaboration session is currently active hasPublicLink: type: boolean description: Whether the session has a public access link enabled required: - _media-type - id - token - ParticipantList - Owner - createdAt - updatedAt - subject additionalProperties: false Owner: type: object description: Owner of a collaboration session properties: _media-type: type: string description: Media type identifier for the owner _href: type: string description: REST API URL reference to the owner resource format: uri required: - _media-type - _href additionalProperties: false ExternalParticipantWrapper: type: object description: Wrapper object containing an external participant properties: Participant: $ref: '#/components/schemas/ExternalParticipant' description: The external participant object required: - Participant additionalProperties: false ExternalParticipant: type: object description: An external participant in a collaboration session (not a registered user) properties: _media-type: type: string description: Media type identifier for the external participant id: type: integer description: Unique identifier of the participant name: type: string description: Display name of the external participant scope: type: string description: Permission scope for the participant (e.g., 'read', 'write', 'admin') email: type: string description: Email address of the external participant format: email createdAt: type: string description: ISO 8601 timestamp when the participant was added format: date-time updatedAt: type: string description: ISO 8601 timestamp when the participant was last updated format: date-time required: - _media-type - id - name - scope - email - createdAt - updatedAt additionalProperties: false InternalParticipantWrapper: type: object description: Wrapper object containing an internal participant properties: Participant: $ref: '#/components/schemas/InternalParticipant' description: The internal participant object required: - Participant additionalProperties: false InternalParticipant: type: object description: An internal participant in a collaboration session (registered user) properties: _media-type: type: string description: Media type identifier for the internal participant id: type: integer description: Unique identifier of the participant name: type: string description: Display name of the internal participant scope: type: string description: Permission scope for the participant (e.g., 'read', 'write', 'admin') User: $ref: '#/components/schemas/User' description: Reference to the associated user account createdAt: type: string description: ISO 8601 timestamp when the participant was added format: date-time updatedAt: type: string description: ISO 8601 timestamp when the participant was last updated format: date-time required: - _media-type - id - name - scope - User - createdAt - updatedAt additionalProperties: false ParticipantListWrapper: type: object description: Wrapper object containing a list of participants properties: ParticipantList: $ref: '#/components/schemas/ParticipantListObject' description: The participant list object required: - ParticipantList additionalProperties: false ParticipantListObject: type: object description: A list of participants in a collaboration session properties: _media-type: type: string description: Media type identifier for the participant list Participants: type: array description: Array of participants in the collaboration session items: $ref: '#/components/schemas/ParticipantItem' required: - _media-type - Participants additionalProperties: false ParticipantItem: type: object description: A participant item that can be either internal or external properties: _media-type: type: string description: Media type identifier for the participant id: type: integer description: Unique identifier of the participant name: type: string description: Display name of the participant scope: type: string description: Permission scope for the participant (e.g., 'read', 'write', 'admin') User: $ref: '#/components/schemas/User' description: Reference to the associated user account (for internal participants only) email: type: string description: Email address of the participant (for external participants only) format: email createdAt: type: string description: ISO 8601 timestamp when the participant was added format: date-time updatedAt: type: string description: ISO 8601 timestamp when the participant was last updated format: date-time required: - _media-type - id - name - scope - createdAt - updatedAt additionalProperties: false InvitationWrapper: type: object description: Wrapper object containing an invitation properties: Invitation: $ref: '#/components/schemas/Invitation' description: The invitation object required: - Invitation additionalProperties: false Invitation: type: object description: An invitation to join a collaboration session properties: _media-type: type: string description: Media type identifier for the invitation id: type: integer description: Unique identifier of the invitation status: type: string description: Current status of the invitation (e.g., 'pending', 'accepted', 'declined') enum: - pending - accepted - declined - expired createdAt: type: string description: ISO 8601 timestamp when the invitation was created format: date-time updatedAt: type: string description: ISO 8601 timestamp when the invitation was last updated format: date-time context: oneOf: - type: array description: Additional context data as an array - type: object description: Additional context data as an object description: Additional context information for the invitation Sender: $ref: '#/components/schemas/Sender' description: Reference to the user who sent the invitation required: - _media-type - id - status - createdAt - updatedAt - context - Sender additionalProperties: false Sender: type: object description: Reference to the sender of an invitation properties: _media-type: type: string description: Media type identifier for the sender reference _href: type: string description: REST API URL reference to the sender resource format: uri required: - _media-type - _href additionalProperties: false responses: {} parameters: {} examples: {} requestBodies: {} headers: {} securitySchemes: {}