Get connection details
/api/20210901/catalog/connections/{connectionId}
Request
-
connectionId(required): string(byte)
The ID of the connection with Base64 encoding. For example, if your connection has the object ID 'user'.'connId', enter the Base64 encoded value, J3VzZXInLidjb25uSWQn
There's no request body for this operation.
Back to TopResponse
- application/json
200 Response
object
400 Response
403 Response
500 Response
object
-
code(required): string
Short error code that defines the error, meant for programmatic parsing.
-
message(required): string
Human-readable error string.
Examples
- Example 1 - No field criteria
- Example 2 - Multiple field criteria
Example 1 - No field criteria
In this example, you return the details of an existing connection with
the given ID without specifying fields to return. Listing no fields returns all
details except for content
. The object ID of the connection is
'Admin'.'oracle_adw_walletless' which has the Base64URL-safe encoded ID value:
J0FkbWluJy4nb3JhY2xlX2Fkd193YWxsZXRsZXNzJw==
. You can get the
ID of a connection by using Get catalog items by type.
cURL Example:
curl --header 'Authorization: Bearer <token>' \ --request GET 'https://<hostname>/api/20210901/catalog/connection/J0FkbWluJy4nb3JhY2xlX2Fkd193YWxsZXRsZXNzJw=='
Example of Request Body
Not applicable.
Example of Response Body
{ "owner": "admin", "name": "oracle_adw_walletless", "description": "Sample Oracle ADW connection without a wallet created using Connections API", "id": "J0FkbWluJy4nb3JhY2xlX2Fkd193YWxsZXRsZXNzJw==", "last modified": "2025-01-01T19:53:07Z", "type": "connections", "parent": "L29yYWNsZUNvbm5lY3Rpb25zLw", }
Example 2 - Multiple field criteria
In this example, you return the details of an existing connection with
the given ID. Which details are returned is determined by listed fields after
?fields=
, in this case the connection name, description, and
content details. The object ID of the connection is 'Admin'.'oracle_adw_walletless'
which has the Base64URL-safe encoded ID value:
J0FkbWluJy4nb3JhY2xlX2Fkd193YWxsZXRsZXNzJw==
.
cURL Example:
curl --header 'Authorization: Bearer <token>' \ --request GET 'https://<hostname>/api/20210901/catalog/connections/J0FkbWluJy4nb3JhY2xlX2Fkd193YWxsZXRsZXNzJw==?fields=name,description,content'
Example of Request Body
Not applicable.
Example of Response Body
{ "name": "oracle_adw_walletless", "description": "Sample Oracle ADW connection without a wallet created using Connections API", "content": "<connections-content>" }