@@ -66468,30 +66383,213 @@ Types
+
+
+
+ -
+ Request
+
+ -
+
+ xml
+
+
+ -
+
+ json
+
+
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<SegmentCreate>
+ <identifier>segment_identifier</identifier>
+ <name>Segment Name</name>
+ <group>corporate_accounts</group>
+</SegmentCreate>
+
+
+
+ View more
+
+
+
+
+ file_copy
+
+
+
+ {
+ "SegmentCreate": {
+ "identifier": "segment_identifier",
+ "name": "Segment Name",
+ "group": "corporate_accounts"
+ }
+}
+
+
+
+ View more
+
+
+
+
+
+
+
+
+
+
+ -
+
+ Request
+
+
+ -
+
+ xml
+
+
+ -
+
+
+ -
+
+ json
+
+
+ -
+
+
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<SegmentCreate>
+ <identifier>segment_identifier</identifier>
+ <name>Segment Name</name>
+ <group>corporate_accounts</group>
+</SegmentCreate>
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ {
+ "SegmentCreate": {
+ "identifier": "segment_identifier",
+ "name": "Segment Name",
+ "group": "corporate_accounts"
+ }
+}
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
+
+
file_copy
-
+
<?xml version="1.0" encoding="UTF-8"?>
-<SegmentGroupList media-type="application/vnd.ibexa.api.SegmentGroupList+xml" href="/api/ibexa/v2/segment_groups">
- <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts">
- <id>1</id>
- <identifier>corporate_accounts</identifier>
- <name>Corporate Accounts</name>
- </SegmentGroup>
-</SegmentGroupList>
+<Segment media-type="application/vnd.ibexa.api.Segment+xml" href="/api/ibexa/v2/segments/segment_identifier">
+ <id>3</id>
+ <identifier>segment_identifier</identifier>
+ <name>Segment Name</name>
+ <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts"/>
+</Segment>
- View more
+ View more
-
+
file_copy
-
+
{
- "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"
- }
- ]
+ "Segment": {
+ "_media-type": "application/vnd.ibexa.api.Segment+json",
+ "_href": "/api/ibexa/v2/segments/segment_identifier",
+ "id": 3,
+ "identifier": "segment_identifier",
+ "name": "Segment Name",
+ "SegmentGroup": {
+ "_media-type": "application/vnd.ibexa.api.SegmentGroup+json",
+ "_href": "/api/ibexa/v2/segment_groups/corporate_accounts"
+ }
}
-}
+}
+
- View more
+ View more
-
+
-
+
-
Responses
-
-
xml
@@ -66595,11 +66691,11 @@
Types
-
-
json
@@ -66613,60 +66709,58 @@
Types
-
+
+ id="segments-post-response-200-xml-modal" role="tabpanel"
+ aria-labelledby="segments-post-response-200-xml-modal-tab">
file_copy
-
+
<?xml version="1.0" encoding="UTF-8"?>
-<SegmentGroupList media-type="application/vnd.ibexa.api.SegmentGroupList+xml" href="/api/ibexa/v2/segment_groups">
- <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts">
- <id>1</id>
- <identifier>corporate_accounts</identifier>
- <name>Corporate Accounts</name>
- </SegmentGroup>
-</SegmentGroupList>
+<Segment media-type="application/vnd.ibexa.api.Segment+xml" href="/api/ibexa/v2/segments/segment_identifier">
+ <id>3</id>
+ <identifier>segment_identifier</identifier>
+ <name>Segment Name</name>
+ <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts"/>
+</Segment>
+ id="segments-post-response-200-json-modal" role="tabpanel"
+ aria-labelledby="segments-post-response-200-json-modal-tab">
file_copy
-
+
{
- "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"
- }
- ]
+ "Segment": {
+ "_media-type": "application/vnd.ibexa.api.Segment+json",
+ "_href": "/api/ibexa/v2/segments/segment_identifier",
+ "id": 3,
+ "identifier": "segment_identifier",
+ "name": "Segment Name",
+ "SegmentGroup": {
+ "_media-type": "application/vnd.ibexa.api.SegmentGroup+json",
+ "_href": "/api/ibexa/v2/segment_groups/corporate_accounts"
+ }
}
-}
+}
+
@@ -66677,9 +66771,27 @@ Types
-
+
+
+
+
@@ -66689,41 +66801,55 @@ Types
- /segment_groups/{identifier}
+ /segments/{identifier}
-
+
-
- Load segment group
- ¶
+ data-search="load-segment">
+ Load segment
+ ¶
GET
- /segment_groups/{identifier}
+ /segments/{identifier}
- Loads segment group.
+ Loads the identified segment.
Header parameters
Accept
- If set, the segment group is returned in XML or JSON format.
+ If set, the segment is returned in XML or JSON
@@ -66748,8 +66874,8 @@ Header parameters
| Examples |
- vnd.ibexa.api.SegmentGroup+xml
-vnd.ibexa.api.SegmentGroup+json
+ application/vnd.ibexa.api.Segment+xml
+application/vnd.ibexa.api.Segment+json
|
@@ -66773,13 +66899,13 @@ Possible responses
|
-
200
|
- OK - return the segment group.
+ OK - Return the segment.
|
@@ -66787,7 +66913,7 @@ Possible responses
401
- Error - the user is not authorized to load this segment group.
+ Error - the user is not authorized to load this segment.
|
@@ -66795,7 +66921,7 @@ Possible responses
404
- Error - the identifier doesn't match any segment group.
+ Error - the identifier doesn't match any segment.
|
@@ -66815,6 +66941,2502 @@ Types
+ |
+
+ Segment
+
+ |
+ This class represents a segment. |
+
+
+ |
+
+ SegmentWrapper
+
+ |
+ JSON object with only a Segment property. |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<Segment media-type="application/vnd.ibexa.api.Segment+xml" href="/api/ibexa/v2/segments/segment_identifier">
+ <id>3</id>
+ <identifier>segment_identifier</identifier>
+ <name>Segment Name</name>
+ <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts"/>
+</Segment>
+
+
+
+ View more
+
+
+
+
+ file_copy
+
+
+
+ {
+ "Segment": {
+ "_media-type": "application/vnd.ibexa.api.Segment+json",
+ "_href": "/api/ibexa/v2/segments/segment_identifier",
+ "id": 3,
+ "identifier": "segment_identifier",
+ "name": "Segment Name",
+ "SegmentGroup": {
+ "_media-type": "application/vnd.ibexa.api.SegmentGroup+json",
+ "_href": "/api/ibexa/v2/segment_groups/corporate_accounts"
+ }
+ }
+}
+
+
+
+ View more
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<Segment media-type="application/vnd.ibexa.api.Segment+xml" href="/api/ibexa/v2/segments/segment_identifier">
+ <id>3</id>
+ <identifier>segment_identifier</identifier>
+ <name>Segment Name</name>
+ <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts"/>
+</Segment>
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ {
+ "Segment": {
+ "_media-type": "application/vnd.ibexa.api.Segment+json",
+ "_href": "/api/ibexa/v2/segments/segment_identifier",
+ "id": 3,
+ "identifier": "segment_identifier",
+ "name": "Segment Name",
+ "SegmentGroup": {
+ "_media-type": "application/vnd.ibexa.api.SegmentGroup+json",
+ "_href": "/api/ibexa/v2/segment_groups/corporate_accounts"
+ }
+ }
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Update segment data
+ ¶
+
+
+
+
+ PATCH
+ /segments/{identifier}
+
+ Updates the segment's data.
+
+
+ Header parameters
+
+ Content-Type
+ The SegmentUpdate schema encoded in XML or JSON format.
+
+
+
+
+ | Property |
+ Value |
+
+
+
+
+ | Type |
+
+
+
+ string
+
+
+
+
+ |
+
+
+ | Examples |
+
+ application/vnd.ibexa.api.SegmentUpdate+xml
+application/vnd.ibexa.api.SegmentUpdate+json
+
+ |
+
+
+
+
+
+
+ Accept
+ A segment is returned in XML or JSON format.
+
+
+
+
+ | Property |
+ Value |
+
+
+
+
+ | Type |
+
+
+
+ string
+
+
+
+
+ |
+
+
+ | Examples |
+
+ application/vnd.ibexa.api.Segment+xml
+application/vnd.ibexa.api.Segment+json
+
+ |
+
+
+
+
+
+
+
+
+
+ Possible responses
+
+
+
+
+ | Code |
+ Description |
+
+
+
+
+ |
+
+ 200
+
+ |
+
+ OK - returns updated segment's data.
+ |
+
+
+ |
+
+ 400
+
+ |
+
+ Error - input data validation failed.
+ |
+
+
+ |
+
+ 401
+
+ |
+
+ Error - the user is not authorized to create segments.
+ |
+
+
+ |
+
+ 404
+
+ |
+
+ Error - segment or segment group with given identifier does not exist.
+ |
+
+
+ |
+
+ 406
+
+ |
+
+ Error - input data is not acceptable, for example segment identifier is not unique.
+ |
+
+
+
+
+
+
+
+ Types
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+
+ SegmentUpdate
+
+ |
+ This class represents an update to an existing segment. |
+
+
+ |
+
+ SegmentUpdateWrapper
+
+ |
+ JSON object with only a SegmentUpdate property. |
+
+
+ |
+
+ Segment
+
+ |
+ This class represents a segment. |
+
+
+ |
+
+ SegmentWrapper
+
+ |
+ JSON object with only a Segment property. |
+
+
+ |
+
+ ErrorMessage
+
+ |
+ Represents an error response. Might contain additional properties depending on an error type. |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<SegmentUpdate>
+ <identifier>modified_segment_identifier</identifier>
+ <name>Modified Segment Name</name>
+ <group>small_companies</group>
+</SegmentUpdate>
+
+
+
+ View more
+
+
+
+
+ file_copy
+
+
+
+ {
+ "SegmentUpdate": {
+ "identifier": "modified_segment_identifier",
+ "name": "Modified Segment Name",
+ "group": "small_companies"
+ }
+}
+
+
+
+ View more
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<SegmentUpdate>
+ <identifier>modified_segment_identifier</identifier>
+ <name>Modified Segment Name</name>
+ <group>small_companies</group>
+</SegmentUpdate>
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ {
+ "SegmentUpdate": {
+ "identifier": "modified_segment_identifier",
+ "name": "Modified Segment Name",
+ "group": "small_companies"
+ }
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<Segment media-type="application/vnd.ibexa.api.Segment+xml" href="/api/ibexa/v2/segments/modified_segment_identifier">
+ <id>3</id>
+ <identifier>modified_segment_identifier</identifier>
+ <name>Modified Segment Name</name>
+ <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/small_companies"/>
+</Segment>
+
+
+
+ View more
+
+
+
+
+ file_copy
+
+
+
+ {
+ "Segment": {
+ "_media-type": "application/vnd.ibexa.api.Segment+json",
+ "_href": "/api/ibexa/v2/segments/modified_segment_identifier",
+ "id": 3,
+ "identifier": "modified_segment_identifier",
+ "name": "Modified Segment Name",
+ "SegmentGroup": {
+ "_media-type": "application/vnd.ibexa.api.SegmentGroup+json",
+ "_href": "/api/ibexa/v2/segment_groups/small_companies"
+ }
+ }
+}
+
+
+
+ View more
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<Segment media-type="application/vnd.ibexa.api.Segment+xml" href="/api/ibexa/v2/segments/modified_segment_identifier">
+ <id>3</id>
+ <identifier>modified_segment_identifier</identifier>
+ <name>Modified Segment Name</name>
+ <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/small_companies"/>
+</Segment>
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ {
+ "Segment": {
+ "_media-type": "application/vnd.ibexa.api.Segment+json",
+ "_href": "/api/ibexa/v2/segments/modified_segment_identifier",
+ "id": 3,
+ "identifier": "modified_segment_identifier",
+ "name": "Modified Segment Name",
+ "SegmentGroup": {
+ "_media-type": "application/vnd.ibexa.api.SegmentGroup+json",
+ "_href": "/api/ibexa/v2/segment_groups/small_companies"
+ }
+ }
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Delete a segment
+ ¶
+
+
+
+
+ DELETE
+ /segments/{identifier}
+
+ Deletes the segment.
+
+
+
+
+ Possible responses
+
+
+
+
+ | Code |
+ Description |
+
+
+
+
+ |
+ 204
+ |
+
+ Segment deleted.
+ |
+
+
+ |
+
+ 401
+
+ |
+
+ Error - the user is not authorized to delete segments.
+ |
+
+
+ |
+
+ 404
+
+ |
+
+ Error - the identifier doesn't match any segment.
+ |
+
+
+
+
+
+
+
+ Types
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+
+ ErrorMessage
+
+ |
+ Represents an error response. Might contain additional properties depending on an error type. |
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Segment groups
+ ¶
+
+
+
+
+
+
+ List segment groups
+ ¶
+
+
+
+
+ GET
+ /segment_groups
+
+ Lists segment groups.
+
+
+ Header parameters
+
+ Accept
+ If set, the list of segment groups is returned in XML or JSON format.
+
+
+
+
+ | Property |
+ Value |
+
+
+
+
+ | Type |
+
+
+
+ string
+
+
+
+
+ |
+
+
+ | Examples |
+
+ vnd.ibexa.api.SegmentGroupList+xml
+vnd.ibexa.api.SegmentGroupList+json
+
+ |
+
+
+
+
+
+
+
+
+
+ Possible responses
+
+
+
+
+ | Code |
+ Description |
+
+
+
+
+ |
+
+ 200
+
+ |
+
+ OK - list the segment groups.
+ |
+
+
+ |
+
+ 401
+
+ |
+
+ Error - the user is not authorized to list segment groups.
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<SegmentGroupList media-type="application/vnd.ibexa.api.SegmentGroupList+xml" href="/api/ibexa/v2/segment_groups">
+ <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts">
+ <id>1</id>
+ <identifier>corporate_accounts</identifier>
+ <name>Corporate Accounts</name>
+ </SegmentGroup>
+</SegmentGroupList>
+
+
+
+ View more
+
+
+
+
+ file_copy
+
+
+
+ {
+ "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"
+ }
+ ]
+ }
+}
+
+
+ View more
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<SegmentGroupList media-type="application/vnd.ibexa.api.SegmentGroupList+xml" href="/api/ibexa/v2/segment_groups">
+ <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts">
+ <id>1</id>
+ <identifier>corporate_accounts</identifier>
+ <name>Corporate Accounts</name>
+ </SegmentGroup>
+</SegmentGroupList>
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ {
+ "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"
+ }
+ ]
+ }
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Create a segment group
+ ¶
+
+
+
+
+ POST
+ /segment_groups
+
+ Creates a segment group.
+
+
+ Header parameters
+
+ Content-Type
+ A SegmentGroupCreate schema encoded in XML or JSON format.
+
+
+
+
+ | Property |
+ Value |
+
+
+
+
+ | Type |
+
+
+
+ string
+
+
+
+
+ |
+
+
+ | Examples |
+
+ application/vnd.ibexa.api.SegmentGroupCreate+xml
+application/vnd.ibexa.api.SegmentGroupCreate+json
+
+ |
+
+
+
+
+
+
+ Accept
+ A segment group is returned in XML or JSON format.
+
+
+
+
+ | Property |
+ Value |
+
+
+
+
+ | Type |
+
+
+
+ string
+
+
+
+
+ |
+
+
+ | Examples |
+
+ application/vnd.ibexa.api.SegmentGroup+xml
+application/vnd.ibexa.api.SegmentGroup+json
+
+ |
+
+
+
+
+
+
+
+
+
+ Possible responses
+
+
+
+
+ | Code |
+ Description |
+
+
+
+
+ |
+
+ 200
+
+ |
+
+ OK - list the segment groups.
+ |
+
+
+ |
+
+ 400
+
+ |
+
+ Error - input data validation failed.
+ |
+
+
+ |
+
+ 401
+
+ |
+
+ Error - the user is not authorized to list segment groups.
+ |
+
+
+ |
+
+ 406
+
+ |
+
+ Error - input data is not acceptable, for example, segment group identifier is not unique.
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+ Request
+
+ -
+
+ xml
+
+
+ -
+
+ json
+
+
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<SegmentGroupCreate>
+ <identifier>segment_group_identifier</identifier>
+ <name>Segment Group Name</name>
+</SegmentGroupCreate>
+
+
+
+ View more
+
+
+
+
+ file_copy
+
+
+
+ {
+ "SegmentGroupCreate": {
+ "identifier": "segment_group_identifier",
+ "name": "Segment Group Name"
+ }
+}
+
+
+
+ View more
+
+
+
+
+
+
+
+
+
+
+ -
+
+ Request
+
+
+ -
+
+ xml
+
+
+ -
+
+
+ -
+
+ json
+
+
+ -
+
+
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<SegmentGroupCreate>
+ <identifier>segment_group_identifier</identifier>
+ <name>Segment Group Name</name>
+</SegmentGroupCreate>
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ {
+ "SegmentGroupCreate": {
+ "identifier": "segment_group_identifier",
+ "name": "Segment Group Name"
+ }
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/segment_group_identifier">
+ <id>3</id>
+ <identifier>segment_group_identifier</identifier>
+ <name>Segment Group Name</name>
+</SegmentGroup>
+
+
+
+ View more
+
+
+
+
+ file_copy
+
+
+
+ {
+ "SegmentGroup": {
+ "_media-type": "application/vnd.ibexa.api.SegmentGroup+json",
+ "_href": "/api/ibexa/v2/segment_groups/segment_group_identifier",
+ "id": 3,
+ "identifier": "segment_group_identifier",
+ "name": "Segment Group Name"
+ }
+}
+
+
+
+ View more
+
+
+
+
+
+
+
+
+
+
+ -
+
+ Responses
+
+
+ -
+
+ xml
+
+
+ -
+
+
+ -
+
+ json
+
+
+ -
+
+
+
+
+ Code: 200
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/segment_group_identifier">
+ <id>3</id>
+ <identifier>segment_group_identifier</identifier>
+ <name>Segment Group Name</name>
+</SegmentGroup>
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ {
+ "SegmentGroup": {
+ "_media-type": "application/vnd.ibexa.api.SegmentGroup+json",
+ "_href": "/api/ibexa/v2/segment_groups/segment_group_identifier",
+ "id": 3,
+ "identifier": "segment_group_identifier",
+ "name": "Segment Group Name"
+ }
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ /segment_groups/{identifier}
+
+
+
+
+
+
+ Load segment group
+ ¶
+
+
+
+
+ GET
+ /segment_groups/{identifier}
+
+ Loads segment group.
+
+
+ Header parameters
+
+ Accept
+ If set, the segment group is returned in XML or JSON format.
+
+
+
+
+ | Property |
+ Value |
+
+
+
+
+ | Type |
+
+
+
+ string
+
+
+
+
+ |
+
+
+ | Examples |
+
+ application/vnd.ibexa.api.SegmentGroup+xml
+application/vnd.ibexa.api.SegmentGroup+json
+
+ |
+
+
+
+
+
+
+
+
+
+ Possible responses
+
+
+
+
+ | Code |
+ Description |
+
+
+
+
+ |
+
+ 200
+
+ |
+
+ OK - return the segment group.
+ |
+
+
+ |
+ 401
+ |
+
+ Error - the user is not authorized to load this segment group.
+ |
+
+
+ |
+ 404
+ |
+
+ Error - the identifier doesn't match any segment group.
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts">
+ <id>1</id>
+ <identifier>corporate_accounts</identifier>
+ <name>Corporate Accounts</name>
+</SegmentGroup>
+
+
+
+ View more
+
+
+
+
+ file_copy
+
+
+
+ {
+ "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"
+ }
+}
+
+
+ View more
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts">
+ <id>1</id>
+ <identifier>corporate_accounts</identifier>
+ <name>Corporate Accounts</name>
+</SegmentGroup>
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ {
+ "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"
+ }
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Update segment group data
+ ¶
+
+
+
+
+ PATCH
+ /segment_groups/{identifier}
+
+ Updates the segment group's data.
+
+
+ Header parameters
+
+ Content-Type
+ The SegmentGroupUpdate schema encoded in XML or JSON format.
+
+
+
+
+ | Property |
+ Value |
+
+
+
+
+ | Type |
+
+
+
+ string
+
+
+
+
+ |
+
+
+ | Examples |
+
+ application/vnd.ibexa.api.SegmentGroupUpdate+xml
+application/vnd.ibexa.api.SegmentGroupUpdate+json
+
+ |
+
+
+
+
+
+
+ Accept
+ A segment group is returned in XML or JSON format.
+
+
+
+
+ | Property |
+ Value |
+
+
+
+
+ | Type |
+
+
+
+ string
+
+
+
+
+ |
+
+
+ | Examples |
+
+ application/vnd.ibexa.api.SegmentGroup+xml
+application/vnd.ibexa.api.SegmentGroup+json
+
+ |
+
+
+
+
+
+
+
+
+
+ Possible responses
+
+
+
+
+ | Code |
+ Description |
+
+
+
+
+ |
+
+ 200
+
+ |
+
+ OK - returns updated segment group's data.
+ |
+
+
+
+
+
+
+
+ Types
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+
+ SegmentGroupUpdate
+
+ |
+ This class represents an update to an existing segment group. |
+
+
+ |
+
+ SegmentGroupUpdateWrapper
+
+ |
+ JSON object with only a SegmentGroupUpdate property. |
+
+
SegmentGroup
@@ -66839,30 +69461,209 @@ Types
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<SegmentGroupUpdate>
+ <identifier>modified_segment_group_identifier</identifier>
+ <name>Modified Segment Group Name</name>
+</SegmentGroupUpdate>
+
+
+
+ View more
+
+
+
+
+ file_copy
+
+
+
+ {
+ "SegmentGroupUpdate": {
+ "identifier": "modified_segment_group_identifier",
+ "name": "Modified Segment Group Name"
+ }
+}
+
+
+
+ View more
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<SegmentGroupUpdate>
+ <identifier>modified_segment_group_identifier</identifier>
+ <name>Modified Segment Group Name</name>
+</SegmentGroupUpdate>
+
+
+
+
+
+
+
+ file_copy
+
+
+
+ {
+ "SegmentGroupUpdate": {
+ "identifier": "modified_segment_group_identifier",
+ "name": "Modified Segment Group Name"
+ }
+}
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
+
+
file_copy
-
+
<?xml version="1.0" encoding="UTF-8"?>
-<SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts">
- <id>1</id>
- <identifier>corporate_accounts</identifier>
- <name>Corporate Accounts</name>
+<SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/modified_segment_group_identifier">
+ <id>4</id>
+ <identifier>modified_segment_group_identifier</identifier>
+ <name>Modified Segment Group Name</name>
</SegmentGroup>
- View more
+ View more
-
+
file_copy
-
+
{
"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"
+ "_media-type": "application/vnd.ibexa.api.SegmentGroup+json",
+ "_href": "/api/ibexa/v2/segment_groups/modified_segment_group_identifier",
+ "id": 3,
+ "identifier": "modified_segment_group_identifier",
+ "name": "Modified Segment Group Name"
}
-}
+}
+
- View more
+ View more
-
+
-
+
-
Responses
-
-
xml
@@ -66958,11 +69760,11 @@
Types
-
-
json
@@ -66976,52 +69778,53 @@
Types
-
+
+ id="segment_groups-identifier-patch-response-200-xml-modal" role="tabpanel"
+ aria-labelledby="segment_groups-identifier-patch-response-200-xml-modal-tab">
file_copy
-
+
<?xml version="1.0" encoding="UTF-8"?>
-<SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts">
- <id>1</id>
- <identifier>corporate_accounts</identifier>
- <name>Corporate Accounts</name>
+<SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/modified_segment_group_identifier">
+ <id>4</id>
+ <identifier>modified_segment_group_identifier</identifier>
+ <name>Modified Segment Group Name</name>
</SegmentGroup>
+ id="segment_groups-identifier-patch-response-200-json-modal" role="tabpanel"
+ aria-labelledby="segment_groups-identifier-patch-response-200-json-modal-tab">
file_copy
-
+
{
"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"
+ "_media-type": "application/vnd.ibexa.api.SegmentGroup+json",
+ "_href": "/api/ibexa/v2/segment_groups/modified_segment_group_identifier",
+ "id": 3,
+ "identifier": "modified_segment_group_identifier",
+ "name": "Modified Segment Group Name"
}
-}
+}
+
@@ -67032,7 +69835,117 @@ Types
-
+
+
+
+
+
+
+
+
+ Delete a segment group
+ ¶
+
+
+
+
+ DELETE
+ /segment_groups/{identifier}
+
+ Deletes the segment group.
+
+
+
+
+ Possible responses
+
+
+
+
+ | Code |
+ Description |
+
+
+
+
+ |
+ 204
+ |
+
+ Segment group deleted.
+ |
+
+
+ |
+
+ 401
+
+ |
+
+ Error - the user is not authorized to delete segment groups.
+ |
+
+
+ |
+
+ 404
+
+ |
+
+ Error - the identifier doesn't match any segment group.
+ |
+
+
+
+
+
+
+
+ Types
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+
+ ErrorMessage
+
+ |
+ Represents an error response. Might contain additional properties depending on an error type. |
+
+
+
+
+
+
+
+
@@ -67097,8 +70010,8 @@ Header parameters
| Examples |
- vnd.ibexa.api.SegmentList+xml
-vnd.ibexa.api.SegmentList+json
+ application/vnd.ibexa.api.SegmentList+xml
+application/vnd.ibexa.api.SegmentList+json
|
@@ -67260,7 +70173,8 @@ Types
"_href": "\/api\/ibexa\/v2\/segment_groups\/corporate_accounts\/segments",
"Segment": []
}
-}
+}
+
@@ -67358,7 +70272,8 @@ Types
"_href": "\/api\/ibexa\/v2\/segment_groups\/corporate_accounts\/segments",
"Segment": []
}
-}
+}
+
@@ -130291,11 +133206,8 @@ Query parameters
type: action, parameter: value (the action)
type: logged_at, parameters: value and operator
--
-
logged_at value value can be anything accepted by DateTimeImmutable
-
--
-
logged_at operator value can be one of the following:
+logged_at value value can be anything accepted by DateTimeImmutablelogged_at operator value can be one of the following:
@@ -142594,6 +145506,198 @@ Types
User.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SegmentGroupCreate
+
+ *
+
+( object)
+ -
+
+ This class represents a new segment group to create.
+
+
+
+
+ -
+ identifier
+
+ *
+
+(string)
+ -
+
+ A unique string identifier for the segment group.
+
+
+
+ -
+ name
+
+ *
+
+(string)
+ -
+
+ A name for the segment group.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SegmentGroupCreateWrapper
+
+ *
+
+( object)
+ -
+
+ JSON object with only a SegmentGroupCreate property.
+
+
+
+
+ -
+ SegmentGroupCreate
+
+ *
+
+(SegmentGroupCreate)
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SegmentGroupUpdate
+
+ *
+
+( object)
+ -
+
+ This class represents an update to an existing segment group.
+
+
+
+
+ -
+ identifier
+
+ *
+
+(string)
+ -
+
+ A unique string identifier for the segment group.
+
+
+
+ -
+ name
+
+ *
+
+(string)
+ -
+
+ A new name for the segment group.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SegmentGroupUpdateWrapper
+
+ *
+
+( object)
+ -
+
+ JSON object with only a SegmentGroupUpdate property.
+
+
+
+
+ -
+ SegmentGroupUpdate
+
+ *
+
+(SegmentGroupUpdate)
+ -
+
+
+
+
@@ -142756,7 +145860,7 @@ Types
( integer)
-
-
+ A unique numeric identifier of the segment group.
@@ -142768,7 +145872,7 @@ Types
( string)
-
-
+ A unique string identifier of the segment group.
@@ -142780,7 +145884,7 @@ Types
( string)
-
-
+ A name of the segment group.
@@ -142941,7 +146045,7 @@ Types
( integer)
-
-
+ A unique numeric identifier of the segment.
@@ -142953,7 +146057,7 @@ Types
( string)
-
-
+ A unique string identifier of the segment.
@@ -142965,7 +146069,7 @@ Types
( string)
-
-
+ A name of the segment.
@@ -142974,12 +146078,256 @@ Types
*
-( SegmentGroup)
+( object)
+ -
+
+ A reference to the segment group to which this segment belongs.
+
+
+
+
+ -
+ _media-type
+
+ *
+
+(string)
+ -
+
+ Media type of the segment group resource.
+
+
+
+ -
+ _href
+
+ *
+
+(string)
+ -
+
+ A URL reference to the segment group resource.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SegmentCreate
+
+ *
+
+( object)
+ -
+
+ This class represents a new segment to create.
+
+
+
+
+ -
+ identifier
+
+ *
+
+(string)
+ -
+
+ A unique string identifier for the segment.
+
+
+
+ -
+ name
+
+ *
+
+(string)
+ -
+
+ A name for the segment.
+
+
+
+ -
+ group
+
+ *
+
+(string)
+ -
+
+ A string identifier of a segment group to which the segment belongs.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SegmentCreateWrapper
+
+ *
+
+( object)
+ -
+
+ JSON object with only a SegmentCreate property.
+
+
+
+
+ -
+ SegmentCreate
+
+ *
+
+(SegmentCreate)
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SegmentUpdate
+
+ *
+
+( object)
+ -
+
+ This class represents an update to an existing segment.
+
+
+
+
+ -
+ identifier
+
+ *
+
+(string)
+ -
+
+ A unique string identifier for the segment.
+
+
+
+ -
+ name
+
+ *
+
+(string)
+ -
+
+ A new name for the segment.
+
+
+
+ -
+ group
+
+ *
+
+(string)
+ -
+
+ A string identifier of a segment group to which the segment belongs.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SegmentUpdateWrapper
+
+ *
+
+( object)
+ -
+
+ JSON object with only a SegmentUpdate property.
+
+
+
+
+ -
+ SegmentCreate
+
+ *
+
+(SegmentUpdate)
+ -
+
+
+
+
+
| |