external-services
Operations addressed under /external-services — 7 operations.
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.
query Parameters
orderByorderSortget-external-service-definition-list › 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.
authDataauthExpirePeriodauthTypePermitted values — validated against the auth_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Basic | no label seeded |
2 | xyz | no label seeded |
idisActiveserviceDefinitionIdtimeoutDurationurlget-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
serviceDefinitionIdget-external-service-definition-by-service-definition-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-external-service-result-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
serviceDefinitionIdresultIdget-external-service-result-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.
externalServiceDefinitionIdrequestMessagerequestTimeresponseMessageresponseStatusget-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
idget-external-service-definition-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
update-external-service-definition
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
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 |
ERR_INTGRTN_33 | 400 | EXTERNAL_SERVICE_DEFINITION_MUST_BE_UNIQUE | External service definition must be unique |
path Parameters
idupdate-external-service-definition › Request Body
authDataauthExpirePeriodauthTypePermitted values — validated against the auth_type parameter.
| Value | Meaning |
|---|---|
1 | Basic |
2 | xyz |
Permitted values — validated against the auth_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Basic | no label seeded |
2 | xyz | no label seeded |
isActiveserviceDefinitionIdurltimeoutDurationupdate-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.
create-external-service-result
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idcreate-external-service-result › Request Body
citizenNumbercitizenNumberTyperequestMessagerequestTimeresponseMessageresponseStatuscreate-external-service-result › 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 |
idhas-external-service-usage
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route returns bool, a scalar rather than an object. There is no field tree below because there are no fields: the body is the JSON literal true or false. This is a complete answer read from the declaration, not a gap.
path Parameters
idhas-external-service-usage › 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.