Retrieve a Connection
get
/ic/api/integration/v1/connections/{id}
Retrieves detailed information about the connection with the specified ID.
Request
Supported Media Types
- application/json; charset=utf-8
Path Parameters
-
id(required): string
Connection identifier
Query Parameters
-
expand: string
Includes additional details about the adapter in the response. Valid value: adapter
Response
Supported Media Types
- application/json; charset=UTF-8
- application/vnd.oracle.resource+json;type=singular
200 Response
Successful operation
Root Schema : connection
Type:
Show Source
object
-
adapter:
object adapter
-
adapterType:
object adapterbase
-
adminEmail:
string
-
agentGroupId:
string
-
agentRequired:
boolean
Default Value:
false
-
agentSupported:
boolean
Default Value:
false
-
connectionProperties:
array connectionProperties
-
created:
string(date-time)
-
createdBy:
string
-
description:
string
-
id:
string
-
keywords:
string
-
lastRefreshedDate:
string(date-time)
-
lastUpdated:
string(date-time)
-
lastUpdatedBy:
string
-
links:
array links
-
lockedBy:
string
-
lockedDate:
string(date-time)
-
lockedFlag:
boolean
Default Value:
false
-
metadataDownloadState:
string
Allowed Values:
[ "NOT_STARTED", "IN_PROGRESS", "DOWNLOAD_ERROR", "COMPLETE" ]
-
metadataDownloadSupportedFlag:
boolean
Default Value:
false
-
name:
string
-
percentageComplete:
number
-
refreshedStatus:
string
-
role:
string
Allowed Values:
[ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
-
securityPolicy:
string
Allowed Values:
[ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "USERNAME_PASSWORD_IGNORE_TIMESTAMP", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TEMPLATE_BASED", "TOKEN_BASED", "NONE", "PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "TIMEOUT_AUTHORIZATION_CODE_CREDENTIALS", "PLUGIN_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "PLUGIN_CLIENT_CREDENTIALS", "MIN_PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH20_AUTHORIZATION_CODE_CREDENTIALS", "CUSTOM_THREE_LEGGED", "CUSTOM_TWO_LEGGED", "CUSTOM_SINGLE_TOKEN", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "AWS_SIGNATURE_VERSION4", "OAUTH2_PRECONFIGURED_CLINET_ID_SECRET", "OAUTH2_CCS_ROP_PRECONFIGURED", "OAUTH2_CCS_ROP", "OAUTH2", "CCS_BASIC_AUTH", "CCS_API_KEY", "JDBC_OVER_SSL", "JDBC_BASIC_AUTH", "FA_OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "FA_OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "ORACLE_WALLET", "OCI_SIGNATURE_VERSION1", "SASLPLAIN", "SASLPLAIN_OVER_SSL", "SASLPLAIN_OVER_SSL_OSS", "TLS", "MUTUAL_TLS", "UIPATH_CLOUD", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS" ]
-
securityPolicyInfo:
array securityPolicyInfo
-
securityProperties:
array securityProperties
-
status:
string
-
testStatus:
boolean
Default Value:
false
-
usage:
integer(int32)
-
usageActive:
integer(int32)
-
wsdlListDir:
array wsdlListDir
Nested Schema : adapter
Type:
Show Source
object
-
customSecurityPolicyDescription:
string
-
defaultSecurityPolicies:
string
-
description:
string
-
displayName:
string
-
features:
string
-
genericAuthSupport:
array genericAuthSupport
-
icons:
object adaptericons
-
id:
string
-
infoMessage:
string
-
integrationRole:
string
Allowed Values:
[ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
-
links:
array links
-
name:
string
-
oauth3LeggedSupport:
array oauth3LeggedSupport
-
otherVersions:
string
-
supportedSecurityPolicies:
string
-
testKey:
string
-
testMessage:
string
-
type:
string
-
validateAndTestKey:
string
-
validateAndTestMessage:
string
-
vendorInfo:
object VendorInfo
-
version:
string
-
wsdlvalidation:
boolean
Default Value:
false
Nested Schema : genericAuthSupport
Type:
Show Source
array
-
Array of:
string
Allowed Values:
[ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "USERNAME_PASSWORD_IGNORE_TIMESTAMP", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TEMPLATE_BASED", "TOKEN_BASED", "NONE", "PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "TIMEOUT_AUTHORIZATION_CODE_CREDENTIALS", "PLUGIN_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "PLUGIN_CLIENT_CREDENTIALS", "MIN_PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH20_AUTHORIZATION_CODE_CREDENTIALS", "CUSTOM_THREE_LEGGED", "CUSTOM_TWO_LEGGED", "CUSTOM_SINGLE_TOKEN", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "AWS_SIGNATURE_VERSION4", "OAUTH2_PRECONFIGURED_CLINET_ID_SECRET", "OAUTH2_CCS_ROP_PRECONFIGURED", "OAUTH2_CCS_ROP", "OAUTH2", "CCS_BASIC_AUTH", "CCS_API_KEY", "JDBC_OVER_SSL", "JDBC_BASIC_AUTH", "FA_OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "FA_OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "ORACLE_WALLET", "OCI_SIGNATURE_VERSION1", "SASLPLAIN", "SASLPLAIN_OVER_SSL", "SASLPLAIN_OVER_SSL_OSS", "TLS", "MUTUAL_TLS", "UIPATH_CLOUD", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS" ]
Nested Schema : oauth3LeggedSupport
Type:
Show Source
array
-
Array of:
string
Allowed Values:
[ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "USERNAME_PASSWORD_IGNORE_TIMESTAMP", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TEMPLATE_BASED", "TOKEN_BASED", "NONE", "PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "TIMEOUT_AUTHORIZATION_CODE_CREDENTIALS", "PLUGIN_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "PLUGIN_CLIENT_CREDENTIALS", "MIN_PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH20_AUTHORIZATION_CODE_CREDENTIALS", "CUSTOM_THREE_LEGGED", "CUSTOM_TWO_LEGGED", "CUSTOM_SINGLE_TOKEN", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "AWS_SIGNATURE_VERSION4", "OAUTH2_PRECONFIGURED_CLINET_ID_SECRET", "OAUTH2_CCS_ROP_PRECONFIGURED", "OAUTH2_CCS_ROP", "OAUTH2", "CCS_BASIC_AUTH", "CCS_API_KEY", "JDBC_OVER_SSL", "JDBC_BASIC_AUTH", "FA_OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "FA_OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "ORACLE_WALLET", "OCI_SIGNATURE_VERSION1", "SASLPLAIN", "SASLPLAIN_OVER_SSL", "SASLPLAIN_OVER_SSL_OSS", "TLS", "MUTUAL_TLS", "UIPATH_CLOUD", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS" ]
Nested Schema : connectionproperty
Type:
Show Source
object
-
acceptableKeys:
array acceptableKeys
-
attachment:
object ConnectionAttachmentRs
-
displayName:
string
-
hasAttachment:
boolean
Default Value:
false
- hiddenFlag: boolean
-
integrationRole:
string
Allowed Values:
[ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
-
propertyDescription:
string
-
propertyGroup:
string
Allowed Values:
[ "CREDENTIALS", "SOURCE_ARTIFACTS", "CONNECTION_PROPS", "CUSTOM", "OTHER" ]
-
propertyName:
string
-
propertyShortDesc:
string
-
propertyType:
string
Allowed Values:
[ "STRING", "NUMBER", "URL", "WSDL_URL", "XSD_URL", "WADL_URL", "FILE", "PASSWORD", "URL_OR_FILE", "LIST", "MAP", "TEXT", "CHOICE", "BOOLEAN", "ARTIFACT_URL", "LIST_OF_MAPS", "CONCRETE_WSDL" ]
-
propertyValue:
string
-
requiredFlag:
boolean
Default Value:
false
Nested Schema : Key
Type:
Show Source
object
-
displayName:
string
-
keyName:
string
-
scope:
string
Allowed Values:
[ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
Nested Schema : securitypolicyinfo
Type:
Show Source
object
-
securityPolicy:
string
Allowed Values:
[ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "USERNAME_PASSWORD_IGNORE_TIMESTAMP", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TEMPLATE_BASED", "TOKEN_BASED", "NONE", "PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "TIMEOUT_AUTHORIZATION_CODE_CREDENTIALS", "PLUGIN_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "PLUGIN_CLIENT_CREDENTIALS", "MIN_PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH20_AUTHORIZATION_CODE_CREDENTIALS", "CUSTOM_THREE_LEGGED", "CUSTOM_TWO_LEGGED", "CUSTOM_SINGLE_TOKEN", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "AWS_SIGNATURE_VERSION4", "OAUTH2_PRECONFIGURED_CLINET_ID_SECRET", "OAUTH2_CCS_ROP_PRECONFIGURED", "OAUTH2_CCS_ROP", "OAUTH2", "CCS_BASIC_AUTH", "CCS_API_KEY", "JDBC_OVER_SSL", "JDBC_BASIC_AUTH", "FA_OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "FA_OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "ORACLE_WALLET", "OCI_SIGNATURE_VERSION1", "SASLPLAIN", "SASLPLAIN_OVER_SSL", "SASLPLAIN_OVER_SSL_OSS", "TLS", "MUTUAL_TLS", "UIPATH_CLOUD", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS" ]
-
securityProperties:
array securityProperties
404 Response
Connection not found
500 Response
Server error
Examples
The following examples show how to get details about a connection by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.
Example: Get details about the connection REST_SAMPLE with additional details about the adapter
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "expand=adapter" https://integration.us.oraclecloud.com/ic/api/integration/v1/connections/REST_SAMPLE
Example: Get details about the connection ACME_WEATHER_CONNECTION
Request:
curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" \
https://integration.us.oraclecloud.com/ic/api/integration/v1/connections/ACME_WEATHER_CONNECTION
Response Body:
The following example shows the contents of the response body in JSON format.
{ "links": { "@rel": "self", "@href": "https://integration.us.oraclecloud.com/ic/api/integration/v1/connections/ACME_WEATHER_CONNECTION" }, "connectionproperties": [ { "displayName": "WSDL URL", "hasAttachment": "false", "hidden": "false", "length": "0", "propertyGroup": "CONNECTION_PROPS", "propertyName": "targetWSDLURL", "propertyType": "URL_OR_FILE", "required": "true" }, { "displayName": "Target Server's TLS version (Optional)", "hasAttachment": "false", "hidden": "false", "length": "0", "propertyDescription": "Target server's TLS protocol version. Default is TLSv1.1. Possible values TLSv1, TLSv1.1, TLSv1.2", "propertyGroup": "CONNECTION_PROPS", "propertyName": "tlsVersion", "propertyShortDesc": "Target server's Transport Layer Security (TLS) protocol version. Default is TLSv1.1", "propertyType": "CHOICE", "required": "false" }, { "displayName": "Suppress insertion of timestamp into the request (Optional)", "hasAttachment": "false", "hidden": "false", "length": "0", "propertyDescription": "In secure Web Services transactions, a WS-Utility (WSU) Timestamp can be inserted into a WS-Security Header \nto define the lifetime of the message in which it is placed. \n\n If \"Yes\" is selected, no timestamp will be added to WS-Security \n header sent as part of the outbound request. For inbound requests with Basic Auth security policy, no timestamp is required to be sent by the client.", "propertyGroup": "CONNECTION_PROPS", "propertyName": "suppressTimestampForRequest", "propertyShortDesc": "If \"Yes\" is selected, no timestamp will be added to WS-Security header sent as part of the outbound request. For inbound requests with Basic Auth security policy, no timestamp is required.", "propertyType": "CHOICE", "required": "false" }, { "displayName": "Ignore timestamp in the response message (Optional)", "hasAttachment": "false", "hidden": "false", "length": "0", "propertyDescription": "Property used by the client to ignore the timestamp \n in the SOAP security header when it receives the response from the service. \n If \"Yes\", then the timestamp is not required in the response \n message; if the timestamp is present, it is ignored.", "propertyGroup": "CONNECTION_PROPS", "propertyName": "ignoreTimestampInResponse", "propertyShortDesc": "If \"Yes\", then the timestamp is not required in the response message", "propertyType": "CHOICE", "required": "false" } ], "adaptertype": { "appTypeConnProperties": [ { "displayName": "WSDL URL", "hasAttachment": "false", "hidden": "false", "length": "0", "propertyGroup": "CONNECTION_PROPS", "propertyName": "targetWSDLURL", "propertyType": "URL_OR_FILE", "required": "true" }, { "displayName": "Target Server's TLS version (Optional)", "hasAttachment": "false", "hidden": "false", "length": "0", "propertyDescription": "Target server's TLS protocol version. Default is TLSv1.1. Possible values TLSv1, TLSv1.1, TLSv1.2", "propertyGroup": "CONNECTION_PROPS", "propertyName": "tlsVersion", "propertyShortDesc": "Target server's Transport Layer Security (TLS) protocol version. Default is TLSv1.1", "propertyType": "CHOICE", "required": "false" }, { "displayName": "Suppress insertion of timestamp into the request (Optional)", "hasAttachment": "false", "hidden": "false", "length": "0", "propertyDescription": "In secure Web Services transactions, a WS-Utility (WSU) Timestamp can be inserted into a WS-Security Header \nto define the lifetime of the message in which it is placed. \n\n If \"Yes\" is selected, no timestamp will be added to WS-Security \n header sent as part of the outbound request. For inbound requests with Basic Auth security policy, no timestamp is required to be sent by the client.", "propertyGroup": "CONNECTION_PROPS", "propertyName": "suppressTimestampForRequest", "propertyShortDesc": "If \"Yes\" is selected, no timestamp will be added to WS-Security header sent as part of the outbound request. For inbound requests with Basic Auth security policy, no timestamp is required.", "propertyType": "CHOICE", "required": "false" }, { "displayName": "Ignore timestamp in the response message (Optional)", "hasAttachment": "false", "hidden": "false", "length": "0", "propertyDescription": "Property used by the client to ignore the timestamp \n in the SOAP security header when it receives the response from the service. \n If \"Yes\", then the timestamp is not required in the response \n message; if the timestamp is present, it is ignored.", "propertyGroup": "CONNECTION_PROPS", "propertyName": "ignoreTimestampInResponse", "propertyShortDesc": "If \"Yes\", then the timestamp is not required in the response message", "propertyType": "CHOICE", "required": "false" } ], "appTypeCredProperties": [ { "displayName": "Username", "hasAttachment": "false", "hidden": "false", "length": "0", "propertyDescription": "A username credential", "propertyGroup": "CREDENTIALS", "propertyName": "username", "propertyType": "STRING", "required": "true" }, { "displayName": "Password", "hasAttachment": "false", "hidden": "false", "length": "0", "propertyDescription": "A password credential", "propertyGroup": "CREDENTIALS", "propertyName": "password", "propertyType": "PASSWORD", "required": "true" } ], "appTypeLargeIconUrl": "/images/soap/wssoap_92.png", "appTypeMediumGrayIconUrl": "/images/soap/wssoap_g_46.png", "appTypeMediumIconUrl": "/images/soap/wssoap_46.png", "appTypeMediumWhiteIconUrl": "/images/soap/wssoap_w_46.png", "appTypeName": "soap", "appTypeSmallIconUrl": "/images/soap/wssoap_32.png", "displayName": "SOAP", "features": "jcaTransportEnabled", "source": "PREINSTALLED", "supportedSecurityPolicies": "Basic Authentication, Username Password Token, No Security Policy", "usage": "0", "vedorInfo": { "name": "Oracle Corporation", "description": "https://www.oracle.com/about", "contactUS": "http://www.oracle.com/us/corporate/contact/index.html", "supportURL": "http://otn.oracle.com", "documentationURL": "https://docs.oracle.com/cloud/latest/intcs_gs/index.html", "releaseNotes": "" } }, "code": "ACME_WEATHER_CONNECTION", "imageURL": "/images/soap/wssoap_w_46.png", "name": "Acme Weather Connection", "percentageComplete": "100", "securityPolicy": "NONE", "status": "CONFIGURED", "supportsCache": "true" }