customer-groups
Operations addressed under /customer-groups — 6 operations.
aurax-bff-get-customer-group-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-customer-group-list; this entry declares none of its own.
query Parameters
orderByorderSortpageIndexpageSizeaurax-bff-get-customer-group-list › Responses
Success. Returns a page of records: the collection under data, with total carrying the unpaged count.
Response records carried by this page.
totalTotal matching records, ignoring paging.
create-customer-group-ui-bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-bff-create-customer-group-ui-bpmn service definition through POST /customer-groups.
Request and response fields are declared on the routing target create-customer-group-ui-bpmn; this entry declares none of its own.
create-customer-group-ui-bpmn › Request Body
nametypecreate-customer-group-ui-bpmn › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
customerGroupIdaurax-bff-redirect-get-customer-groups-by-customer-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-customer-groups-by-customer-id; this entry declares none of its own.
path Parameters
customerIdquery Parameters
orderByorderSortpageIndexpageSizeaurax-bff-redirect-get-customer-groups-by-customer-id › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
codeidnametypeaurax-bff-get-customer-group-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-customer-group-by-id; this entry declares none of its own.
path Parameters
idaurax-bff-get-customer-group-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
codeidnametypeupdate-customer-group-ui-bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-bff-update-customer-group-ui-bpmn service definition through PUT /customer-groups/{id}.
Request and response fields are declared on the routing target update-customer-group-ui-bpmn; this entry declares none of its own.
Declared as Route-bound but absent from the route template, so not sendable: code.
path Parameters
idPresent in this route template but not among the Route-bound fields of the routing target update-customer-group-ui-bpmn, whose own path is decoupled from this one.
update-customer-group-ui-bpmn › Request Body
idnametypeupdate-customer-group-ui-bpmn › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-delete-customer-group-ui-bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target delete-customer-group-ui-bpmn; this entry declares none of its own.
path Parameters
idaurax-bff-delete-customer-group-ui-bpmn › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.