REST API for Oracle Integration 3

Retrieve Lookups in a Project

get

/ic/api/integration/v1/projects/{projectId}/lookups

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

Request

Path Parameters

projectId(required): string

Project identifier

Query Parameters

integrationInstance(required): string

This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.
limit: integer(int32)

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.
offset: integer(int32)

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.
orderBy: string
Lists lookups ordered by name.
Valid value:
- name: Order lookups by lookup name. Example: orderBy=name.
q: string
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'}
```

There's no request body for this operation.

Response

Supported Media Types

application/json;charset=utf-8, application/vnd.oracle.model+json;type=collection

200 Response

Successful operation

Root Schema : LookupsRs

Type: object

Show Source

has-more: boolean

Flag to Check if More Records Exists
items: array items

List of Lookups
limit: integer (int32)

Limit of Records to be Displayed
project-id: string
total-results: integer (int32)

Total Results

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Lookups",
            "items":{
                "$ref":"#/components/schemas/LookupRs"
            }
        },
        "total-results":{
            "type":"integer",
            "description":"Total Results",
            "format":"int32"
        },
        "has-more":{
            "type":"boolean",
            "description":"Flag to Check if More Records Exists"
        },
        "limit":{
            "type":"integer",
            "description":"Limit of Records to be Displayed",
            "format":"int32"
        },
        "project-id":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

List of Lookups

Show Source

Array of: object schema

{
    "type":"array",
    "description":"List of Lookups",
    "items":{
        "$ref":"#/components/schemas/LookupRs"
    }
}

Nested Schema : schema

Type: object

Show Source

adapters: array adapters

Adapter List
columns: array columns

Column List
created: string (date-time)

Created Date
created-by: string

Created By
description: string

Lookup Description
keywords: string

Keywords
last-updated: string (date-time)

Last Updated
last-updated-by: string

Last Updated By
locked-by: string

Locked By
locked-date: string (date-time)

Locked Date
locked-dvm-flag: boolean

Locked DVM Flag
locked-flag: boolean

Locked Flag
name: string

Lookup Name
resource-path: string

Resource Path
row-count: integer (int32)

Lookup Row Count
rows: array rows

Row List
rows-as-array: array rows-as-array
status: string

Lookup Status
usage: integer (int32)

Lookup Usage
usage-active: integer (int32)

Lookup Active Usage

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Lookup Name"
        },
        "description":{
            "type":"string",
            "description":"Lookup Description"
        },
        "row-count":{
            "type":"integer",
            "description":"Lookup Row Count",
            "format":"int32"
        },
        "status":{
            "type":"string",
            "description":"Lookup Status"
        },
        "last-updated-by":{
            "type":"string",
            "description":"Last Updated By"
        },
        "last-updated":{
            "type":"string",
            "description":"Last Updated",
            "format":"date-time"
        },
        "locked-by":{
            "type":"string",
            "description":"Locked By"
        },
        "locked-date":{
            "type":"string",
            "description":"Locked Date",
            "format":"date-time"
        },
        "locked-dvm-flag":{
            "type":"boolean",
            "description":"Locked DVM Flag"
        },
        "columns":{
            "type":"array",
            "description":"Column List",
            "items":{
                "type":"string"
            }
        },
        "created":{
            "type":"string",
            "description":"Created Date",
            "format":"date-time"
        },
        "created-by":{
            "type":"string",
            "description":"Created By"
        },
        "locked-flag":{
            "type":"boolean",
            "description":"Locked Flag"
        },
        "adapters":{
            "type":"array",
            "description":"Adapter List",
            "items":{
                "$ref":"#/components/schemas/AdapterTypeRs"
            }
        },
        "usage":{
            "type":"integer",
            "description":"Lookup Usage",
            "format":"int32"
        },
        "usage-active":{
            "type":"integer",
            "description":"Lookup Active Usage",
            "format":"int32"
        },
        "rows":{
            "type":"array",
            "description":"Row List",
            "items":{
                "$ref":"#/components/schemas/SuiteLookupRowData"
            }
        },
        "rows-as-array":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "resource-path":{
            "type":"string",
            "description":"Resource Path"
        },
        "keywords":{
            "type":"string",
            "description":"Keywords"
        }
    }
}

Nested Schema : adapters

Type: array

Adapter List

Show Source

Array of: AdapterTypeRs

{
    "type":"array",
    "description":"Adapter List",
    "items":{
        "$ref":"#/components/schemas/AdapterTypeRs"
    }
}

Nested Schema : columns

Type: array

Column List

Show Source

Array of: string

{
    "type":"array",
    "description":"Column List",
    "items":{
        "type":"string"
    }
}

Nested Schema : rows

Type: array

Row List

Show Source

Array of: object SuiteLookupRowData

{
    "type":"array",
    "description":"Row List",
    "items":{
        "$ref":"#/components/schemas/SuiteLookupRowData"
    }
}

Nested Schema : rows-as-array

Type: array

Show Source

Array of: array items

{
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : AdapterTypeRs

Match All

Show Source

allOf AdapterTypeBaseRs
allOf IdRs
object GenericRestRs
object AdapterTypeRs-allOf[3]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/AdapterTypeBaseRs"
        },
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "otherVersions":{
                    "type":"string"
                },
                "customSecurityPolicyDescription":{
                    "type":"string"
                },
                "oAuth3LeggedSupport":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/SecurityPolicy"
                    }
                },
                "genericAuthSupport":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/SecurityPolicy"
                    }
                },
                "testKey":{
                    "type":"string"
                },
                "validateAndTestKey":{
                    "type":"string"
                },
                "testMessage":{
                    "type":"string"
                },
                "validateAndTestMessage":{
                    "type":"string"
                },
                "infoMessage":{
                    "type":"string"
                },
                "wsdlvalidation":{
                    "type":"boolean"
                },
                "vendorInfo":{
                    "$ref":"#/components/schemas/AdapterVendorInfo"
                },
                "supportedSecurityPolicies":{
                    "type":"string"
                },
                "features":{
                    "type":"string"
                },
                "version":{
                    "type":"string"
                },
                "description":{
                    "type":"string"
                },
                "integrationRole":{
                    "$ref":"#/components/schemas/AdapterIntegrationRole"
                },
                "defaultSecurityPolicies":{
                    "type":"string"
                },
                "icons":{
                    "$ref":"#/components/schemas/AdapterIconsRs"
                }
            }
        }
    ]
}

Nested Schema : AdapterTypeBaseRs

Match All

Show Source

allOf IdRs
object GenericRestRs
object AdapterTypeBaseRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string"
                },
                "displayName":{
                    "type":"string"
                },
                "type":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IdRs

Match All

Show Source

object GenericRestRs
object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

Nested Schema : IdRs-allOf[1]

Type: object

Show Source

id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : AdapterTypeBaseRs-allOf[2]

Type: object

Show Source

displayName: string
name: string
type: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : AdapterTypeRs-allOf[3]

Type: object

Show Source

customSecurityPolicyDescription: string
defaultSecurityPolicies: string
description: string
features: string
genericAuthSupport: array genericAuthSupport
icons: object AdapterIconsRs
infoMessage: string
integrationRole: string

Allowed Values: [ "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

{
    "type":"object",
    "properties":{
        "otherVersions":{
            "type":"string"
        },
        "customSecurityPolicyDescription":{
            "type":"string"
        },
        "oAuth3LeggedSupport":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SecurityPolicy"
            }
        },
        "genericAuthSupport":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SecurityPolicy"
            }
        },
        "testKey":{
            "type":"string"
        },
        "validateAndTestKey":{
            "type":"string"
        },
        "testMessage":{
            "type":"string"
        },
        "validateAndTestMessage":{
            "type":"string"
        },
        "infoMessage":{
            "type":"string"
        },
        "wsdlvalidation":{
            "type":"boolean"
        },
        "vendorInfo":{
            "$ref":"#/components/schemas/AdapterVendorInfo"
        },
        "supportedSecurityPolicies":{
            "type":"string"
        },
        "features":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "integrationRole":{
            "$ref":"#/components/schemas/AdapterIntegrationRole"
        },
        "defaultSecurityPolicies":{
            "type":"string"
        },
        "icons":{
            "$ref":"#/components/schemas/AdapterIconsRs"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SuiteLink"
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

href: string
media-type: string
method: string
rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : genericAuthSupport

Type: array

Show Source

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" ]

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SecurityPolicy"
    }
}

Nested Schema : AdapterIconsRs

Type: object

Show Source

large-icon-url: string
medium-gray-icon-url: string
medium-icon-url: string
medium-white-icon-url: string
small-icon-url: string

{
    "type":"object",
    "properties":{
        "small-icon-url":{
            "type":"string"
        },
        "medium-icon-url":{
            "type":"string"
        },
        "large-icon-url":{
            "type":"string"
        },
        "medium-gray-icon-url":{
            "type":"string"
        },
        "medium-white-icon-url":{
            "type":"string"
        }
    }
}

Nested Schema : oAuth3LeggedSupport

Type: array

Show Source

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" ]

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SecurityPolicy"
    }
}

Nested Schema : AdapterVendorInfo

Type: object

Show Source

contact-us: string
description: string
documentation-url: string
name: string
release-notes: string
support-url: string

{
    "type":"object",
    "properties":{
        "support-url":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "contact-us":{
            "type":"string"
        },
        "documentation-url":{
            "type":"string"
        },
        "release-notes":{
            "type":"string"
        }
    }
}

Nested Schema : SuiteLookupRowData

Type: object

Show Source

row-data: array row-data

{
    "type":"object",
    "properties":{
        "row-data":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : row-data

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Malformed parameters

500 Response

Server error

Examples

The following examples show how to get details of lookups in a project 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://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/lookups?integrationInstance=service-instance

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://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/lookups?integrationInstance=service-instance

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://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/lookups?integrationInstance=service-instance

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.

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"
      https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/lookups?integrationInstance=service-instance

Example: Get all the lookups in the project 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/lookups?integrationInstance=service-instance