Retrieve a Lookup
get
/ic/api/integration/v1/lookups/{name}
Retrieves detailed information about the lookup with the specified name.
Request
Supported Media Types
- application/json; charset=utf-8
Path Parameters
-
name(required): string
Lookup name.
Query Parameters
-
expand: string
Expand the lookup resource by adding related resources.
Response
Supported Media Types
- application/json; charset=utf-8
- application/vnd.oracle.resource+json;type=singular
200 Response
Successful operation
Root Schema : lookup
Type:
Show Source
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
Default Value:
false
-
lockedFlag:
boolean
Default Value:
false
-
name:
string
-
resourcePath:
string
-
rowCount:
integer(int32)
-
rows:
array rows
-
rowsAsArray:
array rowsAsArray
-
status:
string
-
usage:
integer(int32)
-
usageActive:
integer(int32)
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" ]
404 Response
Not found
500 Response
Server error
Examples
The following examples show how to retrieve details about a lookup 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 lookup Country with additional details about adapters used in the lookup
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/Country
Example: Get details about the lookup Country
Request:
curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://integration.us.oraclecloud.com/ic/api/integration/v1/lookups/Country
Response Body:
The following example shows the contents of the response body in JSON format.
{ "columns": [ "osc", "rightnow" ], "description": "Add Description", "lastUpdated": "2017-01-11T13:54:05.100+0000", "lastUpdatedBy": "jstein", "links": [ { "href": "https://integrations.us.oraclecloud.com/ic/api/integration/v1/lookups/Country", "rel": "self" }, { "href": "https://integrations.us.oraclecloud.com/ic/api/integration/v1/lookups/Country", "rel": "canonical" } ], "lockedDVMFlag": false, "name": "Country", "rowCount": 2, "status": "CONFIGURED" } { "columns": [ "D1", "D2" ], "lastUpdated": "2016-12-18T15:50:26.964+0000", "lastUpdatedBy": "jstein", "links": [ { "href": "https://integrations.us.oraclecloud.com/ic/api/integration/v1/lookups/Country", "rel": "self" }, { "href": "https://integrations.us.oraclecloud.com/ic/api/integration/v1/lookups/Country", "rel": "canonical" } ], "lockedDVMFlag": false, "name": "Country", "rowCount": 2, "status": "CONFIGURED" }