接続の取得
get
/ic/api/integration/v1/connections/{id}
指定されたIDを持つ接続の詳細情報を取得します。
リクエスト
パス・パラメータ
- id(required): string
接続識別子
問合せパラメータ
- expand: string
アダプタに関する追加詳細がレスポンスに含まれています。 有効な値: adapter
- integrationInstance(required): string
これはサービス・インスタンスの名前です。 この値は、サービス・インスタンス・フィールドで指定した情報ページから取得できます。
この操作のリクエスト本文がありません。
トップに戻るレスポンス
サポートされているメディア・タイプ
- application/json; charset=utf-8, application/vnd.oracle.resource+json;type=singular
200レスポンス
操作の成功
ルート・スキーマ : ConnectionRs
型:
ソースを表示
object-
adapter: AdapterTypeRs
-
adapter-type: AdapterTypeBaseRs
-
admin-email: string
管理者の電子メール
-
agent-group-id: string
エージェント・グループ識別子
-
agent-required: boolean
エージェントが必須
-
agent-supported: boolean
エージェント・サポート
-
connection-properties: array connection-properties
接続プロパティのリスト
-
created: string (date-time)
作成
-
created-by: string
作成者
-
description: string
説明
-
keywords: string
キーワード
-
last-refreshed-date: string (date-time)
最終リフレッシュ日付
-
last-updated: string (date-time)
最終更新
-
last-updated-by: string
最終更新者
-
locked-by: string
ロック者
-
locked-date: string (date-time)
ロック日
-
locked-flag: boolean
ロック・フラグ
-
metadata-download-state: string
Metadataダウンロード状態
-
metadata-download-supported-flag: boolean
Metadataダウンロード・サポート済フラグ
-
name: string
Connection Name
-
percentage-complete: number
接続完了率
-
project-id: string
-
refreshed-status: string
リフレッシュ済ステータス
-
role: string
許容値:
[ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ] -
security-policy: 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", "SHOPIFY_AUTH_POLICY", "SUCCESSFACTORS", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "NETSUITE_3STEP_TBA_FLOW", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "MULTI_TOKEN_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_OVER_SSL_WITH_OCI_SIGNATURE", "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", "OCI_OBO_TOKEN", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS", "JWT_USER_ASSERTION_FOR_OAUTH", "JWT_CLIENT_CREDENTIALS_ASSERTION_FOR_OAUTH", "OCI_SERVICE_INVOCATION" ] -
security-policy-info: array security-policy-info
セキュリティ・ポリシーのリスト
-
security-properties: array security-properties
セキュリティ・プロパティのリスト
-
status: string
接続ステータス
-
test-status: boolean
テスト・ステータス
-
usage: integer (int32)
使用方法
-
usage-active: integer (int32)
アクティブな使用量
-
wsdl-list-dir: array wsdl-list-dir
WSDLのリスト
ネストされたスキーマ : AdapterTypeRs-allOf[3]
型:
ソースを表示
object-
customSecurityPolicyDescription: string
-
defaultSecurityPolicies: string
-
description: string
-
features: string
-
genericAuthSupport: array genericAuthSupport
-
icons: object AdapterIconsRs
-
infoMessage: string
-
integrationRole: string
許容値:
[ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ] -
oAuth3LeggedSupport: array oAuth3LeggedSupport
-
otherVersions: string
-
supportedSecurityPolicies: string
-
testKey: string
-
testMessage: string
-
validateAndTestKey: string
-
validateAndTestMessage: string
-
vendorInfo: object AdapterVendorInfo
-
version: string
-
wsdlvalidation: boolean
ネストされたスキーマ : genericAuthSupport
型:
ソースを表示
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", "SHOPIFY_AUTH_POLICY", "SUCCESSFACTORS", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "NETSUITE_3STEP_TBA_FLOW", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "MULTI_TOKEN_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_OVER_SSL_WITH_OCI_SIGNATURE", "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", "OCI_OBO_TOKEN", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS", "JWT_USER_ASSERTION_FOR_OAUTH", "JWT_CLIENT_CREDENTIALS_ASSERTION_FOR_OAUTH", "OCI_SERVICE_INVOCATION" ]
ネストされたスキーマ : oAuth3LeggedSupport
型:
ソースを表示
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", "SHOPIFY_AUTH_POLICY", "SUCCESSFACTORS", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "NETSUITE_3STEP_TBA_FLOW", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "MULTI_TOKEN_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_OVER_SSL_WITH_OCI_SIGNATURE", "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", "OCI_OBO_TOKEN", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS", "JWT_USER_ASSERTION_FOR_OAUTH", "JWT_CLIENT_CREDENTIALS_ASSERTION_FOR_OAUTH", "OCI_SERVICE_INVOCATION" ]
ネストされたスキーマ : ConnectionPropertyRs
型:
ソースを表示
object-
acceptable-keys: array acceptable-keys
-
attachment: object ConnectionAttachmentRs
-
default-property-value: string
-
display-name: string
-
has-attachment: boolean
- hidden-flag: boolean
-
integration-role: string
許容値:
[ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ] -
property-description: string
-
property-group: string
許容値:
[ "CREDENTIALS", "SOURCE_ARTIFACTS", "CONNECTION_PROPS", "CUSTOM", "OTHER" ] -
property-name: string
-
property-short-desc: string
-
property-type: string
許容値:
[ "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" ] -
property-value: string
-
required-flag: boolean
ネストされたスキーマ : AdapterKey
型:
ソースを表示
object-
display-name: string
-
key-name: string
-
scope: string
許容値:
[ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
ネストされたスキーマ : SecurityPolicyInfoRs
型:
ソースを表示
object-
scope: string
許容値:
[ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ] -
security-policy: 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", "SHOPIFY_AUTH_POLICY", "SUCCESSFACTORS", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "NETSUITE_3STEP_TBA_FLOW", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "MULTI_TOKEN_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_OVER_SSL_WITH_OCI_SIGNATURE", "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", "OCI_OBO_TOKEN", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS", "JWT_USER_ASSERTION_FOR_OAUTH", "JWT_CLIENT_CREDENTIALS_ASSERTION_FOR_OAUTH", "OCI_SERVICE_INVOCATION" ] -
security-properties: array security-properties
404レスポンス
接続が見つかりません
500レスポンス
サーバー・エラー
例
次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、接続の詳細を取得する方法を示しています。 cURLの詳細は、「cURLの使用」を参照してください。 エンドポイントURLの構造の詳細は、「リクエストの送信」を参照してください。
例: アダプタの追加詳細を含む接続REST_SAMPLEの詳細を取得
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "expand=adapter" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/connections/REST_SAMPLE?integrationInstance=service-instance例: 接続ACME_WEATHER_CONNECTIONの詳細を取得
Request:
curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" \
https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/connections/ACME_WEATHER_CONNECTION?integrationInstance=service-instanceレスポンス本文:
JSON形式のレスポンス本文のコンテンツの例を次に示します。
{
"links": {
"@rel": "self",
"@href": "https://design.integration.region.ocp.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"
}