external-services
Operations addressed under /external-services — 8 operations.
aurax-bff-redirect-create-external-service-definition
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-external-service-definition; this entry declares none of its own.
Fields with no binding_source in the catalog, so their position on the request is undocumented: id.
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_INTGRTN_33 | 400 | EXTERNAL_SERVICE_DEFINITION_MUST_BE_UNIQUE | External service definition must be unique |
aurax-bff-redirect-create-external-service-definition › Request Body
authDataauthExpirePeriodauthTypePermitted values — validated against the auth_type parameter.
| Value | Meaning |
|---|---|
1 | Basic |
2 | xyz |
serviceDefinitionIdurltimeoutDurationaurax-bff-redirect-create-external-service-definition › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
aurax-bff-redirect-delete-external-service-definition
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-external-service-definition; this entry declares none of its own.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_INTGRTN_26 | 400 | EXTERNAL_SERVICE_DEFINITION_NOT_FOUND | Service definition cannot be found |
path Parameters
idaurax-bff-redirect-delete-external-service-definition › 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-external-service-definition-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<ExternalServiceDefinitionDto>.
| Field | Declared type | Nullable |
|---|---|---|
ServiceDefinitionId | Guid? | yes |
Url | string | no |
AuthType | int? | yes |
AuthData | string | no |
AuthExpirePeriod | int? | yes |
TimeoutDuration | long? | yes |
IsActive | bool | no |
Member names are the service's declaration names.
aurax-bff-redirect-get-external-service-definition-list › 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-external-service-definition-by-service-definition-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 ExternalServiceDefinitionDto.
| Field | Declared type | Nullable |
|---|---|---|
ServiceDefinitionId | Guid? | yes |
Url | string | no |
AuthType | int? | yes |
AuthData | string | no |
AuthExpirePeriod | int? | yes |
TimeoutDuration | long? | yes |
IsActive | bool | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_INTGRTN_26 | 400 | EXTERNAL_SERVICE_DEFINITION_NOT_FOUND | Service definition cannot be found |
path Parameters
serviceDefinitionIdPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-external-service-definition-by-service-definition-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-get-external-service-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 ExternalServiceDefinitionDto.
| Field | Declared type | Nullable |
|---|---|---|
ServiceDefinitionId | Guid? | yes |
Url | string | no |
AuthType | int? | yes |
AuthData | string | no |
AuthExpirePeriod | int? | yes |
TimeoutDuration | long? | yes |
IsActive | bool | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_INTGRTN_26 | 400 | EXTERNAL_SERVICE_DEFINITION_NOT_FOUND | Service definition 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-external-service-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-integration-service-edit-ui-bpm
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-integration-service-edit-ui-bpm › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-integration-service-delete-ui-bpm
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-integration-service-delete-ui-bpm › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.