channels
Operations addressed under /channels — 6 operations.
aurax-bff-get-channel-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<ChannelDefinitionDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
ChannelName | string | no |
ChannelType | int | no |
ChannelDescription | string | no |
ChannelDate | DateOnly | no |
ClientId | string | no |
IsShared | bool | no |
HasPartner | bool | no |
ClientSecret | string | no |
IsCustomDateEnabled | bool | no |
Member names are the service's declaration names.
aurax-bff-get-channel-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
aurax-bff-get-current-channel
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as ChannelDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
ClientId | string | no |
Date | DateOnly? | yes |
Type | int? | yes |
IsCustomDateEnabled | bool | no |
Member names are the service's declaration names.
aurax-bff-get-current-channel › 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.
aurax-bff-redirect-get-channel-definition-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as ChannelDefinitionDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
ChannelName | string | no |
ChannelType | int | no |
ChannelDescription | string | no |
ChannelDate | DateOnly | no |
ClientId | string | no |
IsShared | bool | no |
HasPartner | bool | no |
IsCustomDateEnabled | bool | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CORE_125 | 400 | CHANNEL_ID_IS_NOT_FOUND | Channel cannot be found. |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-channel-definition-by-id › 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.
aurax-bff-redirect-update-channel-bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-update-channel-bpmn › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-delete-channel-bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-delete-channel-bpmn › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.