POST /config/resilient/test/{id}
Test the Resilient connection by using the connection ID. You must have the System Administrator or Security Admin permission (ADMIN | SAASADMIN capability) to use this endpoint.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
id |
path |
Required |
Number (Integer) |
text/plain |
Required - The ID of a connection to test. |
fields |
query |
Optional |
String |
text/plain |
Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
HTTP Response Code | Unique Code | Description |
---|---|---|
201 |
The Resilient Connection Test was started. |
|
404 |
1002 |
The connection configuration for Resilient was not defined. |
409 |
1004 |
Another test is already running. |
500 |
1020 |
An error occurred while trying to run a test. |
500 |
1022 |
Timeout while performing the task. |
Response Description
Response code and the task status for this Resilient Connection Test request
Response Sample
{
"completed": 42,
"created": 42,
"created_by": "String",
"error_code": 42,
"error_message": "String",
"id": 42,
"modified": 42,
"name": "String",
"started": 42,
"status": "String <one of: CANCELLED, CANCELING, CANCEL_REQUESTED, COMPLETED, CONFLICT, EXCEPTION, INITIALIZING, INTERRUPTED, PAUSED, PROCESSING, QUEUED, RESUMING>"
}