user-favorites
Operations addressed under /user-favorites — 3 operations.
aurax-bff-redirect-get-user-favorite-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-user-favorite-list; this entry declares none of its own.
Response body, read from the service source
The route declares its response as IEnumerable<UserFavoriteDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
FormDefinitionId | Guid? | yes |
FormName | string | no |
UrlPath | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ARXMNGMNT_5 | 400 | KEYCLOAK_AUTHORIZATION_SERVICE_ERROR | Keycloak authorization service error. |
query Parameters
orderByorderSortpageIndexpageSizewithAuthorizationaurax-bff-redirect-get-user-favorite-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
aurax-bff-redirect-create-user-favorite
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 create-user-favorite; this entry declares none of its own.
Response body, read from the service source
The route declares its response as AuraCommandDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ARXMNGMNT_1 | 400 | USER_FAVORITE_ALREADY_ADDED | Screen already added to favorites. |
ERR_ARXMNGMNT_2 | 400 | USER_FAVORITE_COUNT_CANNOT_MORE_LIMIT | Total number of favorites can be at most {0}. |
aurax-bff-redirect-create-user-favorite › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
aurax-bff-redirect-delete-user-favorite
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-user-favorite; this entry declares none of its own.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ARXMNGMNT_3 | 400 | USER_FAVORITE_NOT_FOUND | User favorite not found. |
path Parameters
formDefinitionIdaurax-bff-redirect-delete-user-favorite › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.