1. REST API for Oracle Integration
  2. Tasks
  3. Integrations
  4. Lookups

Retrieve Lookups

get

/ic/api/integration/v1/lookups

Retrieves information about all lookups ordered by the last updated time.

Request

Supported Media Types
Query Parameters
  • Includes additional details in the response about the adapters used in the lookups. Valid value: adapter
  • Use with the offset parameter for paginating through the returned results. The limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list lookups starting at the 4th item, and the list will contain 16 items.
  • Use with the limit parameter for paginating through the returned results. The offset is the starting point from which to return records. For example, offset=3&limit=16 indicates to list lookups starting at the 4th item, and the list will contain 16 items.

  • Lists lookups ordered by name.

    Valid value:

    • name: Order lookups by lookup name. Example: orderBy=name.

  • Filters lookups by name and status.

    Valid parameters:

    • name: Name of the the lookup. Supports exact matches or contains. For example:
      • To retrieve lookups that are an exact match in the lookup name, specify: 
        q={name:'MyLookup'}
      • To retrieve all lookups that contain the specified string in the lookup name, specify: 
        q={name: /MyLookup/}
    • status: Status of the lookup. Valid values: CONFIGURED, LOCKED.

      For example, to retrieve all lookups that contain Lookup and have the status LOCKED, specify:

      q={name : /Lookup/, status : 'LOCKED'}
Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : lookups
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : lookup
Type: object
Show Source
Nested Schema : adapters
Type: array
Show Source
Nested Schema : columns
Type: array
Show Source
Nested Schema : rows
Type: array
Show Source
Nested Schema : rowsAsArray
Type: array
Show Source
Nested Schema : adapter
Type: object
Show Source
Nested Schema : genericAuthSupport
Type: array
Show Source
  • 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 : adaptericons
Type: object
Show Source
Nested Schema : oauth3LeggedSupport
Type: array
Show Source
  • 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 : VendorInfo
Type: object
Show Source
Nested Schema : SuiteLookupRowData
Type: object
Show Source
Nested Schema : rowData
Type: array
Show Source
Nested Schema : items
Type: array
Show Source

400 Response

Malformed parameters

500 Response

Server error
Back to Top

Examples

The following examples show how to get details about lookups 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 only lookups that contain MyLookup in any case and have the status 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

Example: Get lookup information with additional details about the 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

Example: Paginate through returned connections

Pagination is done with limit and offset. In this example, we list lookups starting at the fourth item. The list contains 16 items. 

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

Example: Get all lookups ordered by the lookup name in alphabetical order

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

Example: Combine parameters to retrieve lookups, sort by lookup name, and paginate through the results

To combine query parameters, use q with the --data-urlencode option. The other parameters can be added after the -d option.

In this example, we are retrieving lookups that contain myLookup in uppercase or lowercase, and have the status CONFIGURED. We display the results in alphabetical order by name, 5 items at a time, starting at the 12th returned item. We also want to have additional details about adapters used in the lookups.

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

Example: Get all lookups

Request:

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://integration.us.oraclecloud.com/ic/api/integration/v1/lookups

Response Body:

The following example shows the contents of the response body in JSON format.

{
    "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
}
Back to Top