プロジェクト内の接続の取得
get
/ic/api/integration/v1/projects/{projectId}/connections
プロジェクト内のすべての接続に関する情報を、最後に更新された時間順に取得します。
リクエスト
パス・パラメータ
- projectId(required): string
プロジェクト識別子
問合せパラメータ
- integrationInstance(required): string
これはサービス・インスタンスの名前です。 この値は、サービス・インスタンス・フィールドで指定した情報ページから取得できます。
- limit: integer(int32)
返される結果のページ区切りには、オフセット・パラメータを使用します。 この制限は、一度に返すアイテムの最大数です。 たとえば、offset=3&limit=16は、4アイテムから始まる接続をリストすること、および16アイテムがリストに含まれることを示します。
- offset: integer(int32)
戻される結果のページ区切りには、制限パラメータを使用します。 オフセットは、レコードを返す開始ポイントです。 たとえば、offset=3&limit=16は、4アイテムから始まる接続をリストすること、および16アイテムがリストに含まれることを示します。
- orderBy: string
名前、最終更新時間またはアダプタ・タイプでソートされた接続をリストします。
有効な値:
- name: 接続を接続名順に並替え。 例: orderBy=name.
- time: 最後の更新時間で接続を順序付けします。 例: orderBy=time.
- type: PREINSTALLED、PRIVATEまたはMARKETPLACEのアダプタ・タイプによる接続を順序付けします。 例: orderBy=type
- q: string
名前、ステータスおよびロールで接続をフィルタします。
有効なパラメータ:
- name: 接続の名前。 完全一致または次をサポートします。 たとえば:
- 接続名の完全一致である接続を取得するには、次を指定します:
q={name:'My Connection Name'}. - 接続名に指定した文字列を含むすべての接続を取得するには、次のように指定します:
q={name: /Oracle/}
- 接続名の完全一致である接続を取得するには、次を指定します:
- status: 接続のステータス。 有効な値: CONFIGURED, INPROGRESS. INPROGRESSは、グラフィカル・ユーザー・インタフェースでドラフトとして表示されます。
たとえば、RNを含み、ステータスが構成済であるすべての接続を取得するには、次を指定します:
{name : /RN/, status : 'CONFIGURED'} - role: 接続のロール。
有効な値: SOURCE, SOURCE_AND_TARGET, TARGET. 値は大文字と小文字が区別されます。 グラフィカル・ユーザー・インタフェースで: ソースがトリガーとして表示され、SOURCE_AND_TARGETがトリガーと起動として表示され、TARGETが起動として表示されます。
- name: 接続の名前。 完全一致または次をサポートします。 たとえば:
この操作のリクエスト本文がありません。
トップに戻るレスポンス
サポートされているメディア・タイプ
- application/json;charset=utf-8, application/vnd.oracle.model+json;type=collection
200レスポンス
操作の成功
ルート・スキーマ : ConnectionsRs
型:
ソースを表示
object-
has-more: boolean
レコードが他に存在するかどうかを確認するフラグ
-
items: array items
接続の一覧
-
limit: integer (int32)
表示するレコードの制限
-
links: array links
スイート・リンク・リスト
-
total-results: integer (int32)
結果合計
ネストされたスキーマ: schema
型:
ソースを表示
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
400レスポンス
パラメータの形式が正しくありません
500レスポンス
サーバー・エラー
例
次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行して、プロジェクト内の接続の詳細を取得する方法を示しています。 cURLの詳細は、「cURLの使用」を参照してください。 エンドポイントURLの構造の詳細は、「リクエストの送信」を参照してください。
例: プロジェクトTEST_PROJECTにRNまたはRNが含まれ、ステータスがCONFIGUREDである接続を取得
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={name: /RN/, status: 'CONFIGURED'}" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/connections?integrationInstance=service-instance
例: プロジェクトTEST_PROJECT内の戻された接続をページ区切り
ページ区切りは制限とオフセットで実行されます。 この例では、4番目のアイテムから始まる接続を一覧表示します。 リストには16アイテムが含まれます。
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "offset=3&limit=16" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/connections?integrationInstance=service-instance
例: 接続名をプロジェクトTEST_PROJECTのアルファベット順に並べた接続を取得
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "orderBy=name" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/connections?integrationInstance=service-instance
例: プロジェクトTEST_PROJECT内のすべての接続を取得
curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/connections?integrationInstance=service-instance