ルックアップの取得
get
/ic/api/integration/v1/lookups
最後に更新された時間でソートされたすべてのルックアップに関する情報を取得します。
リクエスト
サポートされているメディア・タイプ
- application/json; charset=utf-8
問合せパラメータ
- expand: string
ルックアップで使用されるアダプタに関するレスポンスに、追加の詳細が含まれています。 有効な値: adapter
- limit: integer(int32)
返される結果のページ区切りには、オフセット・パラメータを使用します。 この制限は、一度に返すアイテムの最大数です。 たとえば、offset=3&limit=16は4番目のアイテムから始まる参照をリストすることを示し、リストには16個のアイテムが含まれます。
- offset: integer(int32)
戻される結果のページ区切りには、制限パラメータを使用します。 オフセットは、レコードを返す開始ポイントです。 たとえば、offset=3&limit=16は4番目のアイテムから始まる参照をリストすることを示し、リストには16個のアイテムが含まれます。
- orderBy: string
名前の順にルックアップがリストされます。
有効値:
- name: 参照名順に並替え。 例: orderBy=name.
- q: string
名前およびステータスでルックアップをフィルタします。
有効なパラメータ:
- name: 参照の名前。 完全一致または次をサポートします。 たとえば:
- ルックアップ名の完全一致であるルックアップを取得するには、次を指定します:
q={name:'MyLookup'} - ルックアップ名に指定された文字列を含むすべてのルックアップを取得するには、次のように指定します:
q={name: /MyLookup/}
- ルックアップ名の完全一致であるルックアップを取得するには、次を指定します:
- status: ルックアップのステータス。 有効な値: CONFIGURED, LOCKED.
たとえば、ルックアップが含まれ、ステータスがLOCKEDであるすべての参照を取得するには、次を指定します:
q={name : /Lookup/, status : 'LOCKED'}
- name: 参照の名前。 完全一致または次をサポートします。 たとえば:
レスポンス
サポートされているメディア・タイプ
- application/json; charset=utf-8
- application/vnd.oracle.resource+json;type=collection
200レスポンス
操作の成功
ネストされたスキーマ : lookup
型:
ソースを表示
object- adapters: array adapters
- columns: array columns
- created: string(date-time)
- createdBy: string
- description: string
- id: string
- keywords: string
- lastUpdated: string(date-time)
- lastUpdatedBy: string
- links: array links
- lockedBy: string
- lockedDate: string(date-time)
- lockedDVMFlag: boolean
デフォルト値:
false - lockedFlag: boolean
デフォルト値:
false - name: string
- resourcePath: string
- rowCount: integer(int32)
- rows: array rows
- rowsAsArray: array rowsAsArray
- status: string
- usage: integer(int32)
- usageActive: integer(int32)
ネストされたスキーマ : adapter
型:
ソースを表示
object- customSecurityPolicyDescription: string
- defaultSecurityPolicies: string
- description: string
- displayName: string
- features: string
- genericAuthSupport: array genericAuthSupport
- icons: object adaptericons
- id: string
- infoMessage: string
- integrationRole: string
許容値:
[ "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
デフォルト値:
false
ネストされたスキーマ : 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", "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" ]
ネストされたスキーマ : 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", "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" ]
400レスポンス
パラメータの形式が正しくありません
500レスポンス
サーバー・エラー
例
次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、参照の詳細を取得する方法を示しています。 cURLの詳細は、「cURLの使用」を参照してください。 エンドポイントURLの構造の詳細は、「リクエストの送信」を参照してください。
例: いずれかのケースでMyLookupを含む参照のみを取得し、ステータスがCONFIGUREDです
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={name: /myLookup/, status: 'CONFIGURED'}" https://integration.us.oraclecloud.com/ic/api/integration/v1/lookups例: ルックアップに使用されるアダプタの詳細を参照情報とともに取得
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/lookups例: 戻された接続のページ区切り
limitおよびoffsetでページ区切りが行われます。 この例では、参照を4番目のアイテムから順にリストします。 リストには16アイテムが含まれます。
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "offset=3&limit=16" https://integration.us.oraclecloud.com/ic/api/integration/v1/lookups例: ルックアップ名の順にすべてのルックアップをアルファベット順に取得
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "orderBy=name" https://integration.us.oraclecloud.com/ic/api/integration/v1/lookups例: パラメータを組み合せて参照を取得し、参照名でソートし、結果のページを区切る
問合せパラメータを組み合せるには、qで--data-urlencodeオプションを使用します。 その他のパラメータは、-dオプションの後に追加できます。
この例では、myLookupを大文字または小文字で含み、ステータスがCONFIGUREDであるルックアップを取得しています。 結果は、アルファベット順に名前順に表示されます。5アイテムは、返される12番目のアイテムから始まります。 ルックアップで使用されるアダプタに関する追加詳細も必要です。
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={name: /myLookup/, status: 'CONFIGURED'}" -d "orderBy=name&offset=12&limit=5&expand=adapter" https://integration.us.oraclecloud.com/ic/api/integration/v1/lookups例: すべてのルックアップの取得
Request:
curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://integration.us.oraclecloud.com/ic/api/integration/v1/lookupsレスポンス本文:
JSON形式のレスポンス本文のコンテンツの例を次に示します。
{
"items": [
{
"columns": [
"testa",
"testb"
],
"lastUpdated": "2017-01-01T21:53:54.817+0000",
"lastUpdatedBy": "jstein",
"links": [
{
"href": "https://integrations.us.oraclecloud.com/ic/api/integration/v1/lookups/testLookup",
"rel": "self"
},
{
"href": "integrations.us.oraclecloud.com/ic/api/integration/v1/lookups/testLookup",
"rel": "canonical"
}
],
"lockedDVMFlag": false,
"name": "testLookup",
"rowCount": 1,
"status": "CONFIGURED"
}
],
"links": [
{
"href": "integrations.us.oraclecloud.com/ic/api/integration/v1/lookups/",
"rel": "self"
},
{
"href": "integrations.us.oraclecloud.com/ic/api/integration/v1/lookups/",
"rel": "canonical"
}
],
"totalResults": 1
}