Create a Lookup
post
/ic/api/integration/v1/lookups
Creates a lookup. The request body must contain:
- name: defines the name of the lookup. For example:
"name":"myLookup"
- columns: defines the domains or adapters to map. The request body can contain two or more columns. For example:
"columns":["rightnow","soap"]
- rowData: specifies the mappings to each adapter or domain. For example:
"rows":[{"rowData":["RN1","SOAP1"]},{"rowData":["RN2","SOAP2"]}]
Request
Supported Media Types
- application/json; charset=utf-8
Lookup resource
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" ]
Response
Supported Media Types
- application/json; charset=utf-8
200 Response
Successful operation
400 Response
Bad request, missing required data
500 Response
Server error
Examples
The following example shows how to create a lookup by submitting a POST 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.
This command creates a lookup with the name and values specified in the request body.
The command consumes JSON data.
curl -X POST -H 'Authorization: Bearer access_token' -H "Content-Type:application/json" -d @lookup.json https://integration.us.oraclecloud.com/ic/api/integration/v1/lookupsExample: Request Body to map country codes to country names
The following example shows the contents of a request body in JSON format. This is the contents of the lookup.json file listed in the cURL command with the -d option.
In this example, we are mapping the short country codes to the country names.
Let's say we have these country codes:
- IN India
- USA United States
- CA Canada
- FR France
- GR Germany
We can create a lookup called CountryLookup to map these values and then reference this lookup in any integration. Note that you can have as many columns as needed, but here we only needed two columns.
{"columns":["CountryCode","CountryName"],"rows":[{"rowData":["IN","India"]},{"rowData":["USA","United States"]}, {"rowData":["CA","Canada"]},{"rowData":["FR","France"]},{"rowData":["GR","Germany"]},],"name":"CountryLookup"}