Jump to

• Request
• Response
• Examples

Clone a Lookup

post

/ic/api/integration/v1/lookups/{name}/clone

Clones the lookup with the specified name. The request must contain a JSON file with the new lookup's details attached with the -d option. The JSON file must contain the name attribute.

Request

Supported Media Types

• application/json; charset=utf-8

Path Parameters

• name(required): string
  Lookup name.

Body ()

Lookup resource

Root Schema : lookup

Type: object

Show Source

• 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)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "rowCount":{
            "type":"integer",
            "format":"int32"
        },
        "status":{
            "type":"string"
        },
        "lastUpdatedBy":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "lockedBy":{
            "type":"string"
        },
        "lockedDate":{
            "type":"string",
            "format":"date-time"
        },
        "created":{
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "type":"string"
        },
        "lockedDVMFlag":{
            "type":"boolean",
            "default":false
        },
        "lockedFlag":{
            "type":"boolean",
            "default":false
        },
        "columns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "adapters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AdapterTypeRs"
            }
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "usageActive":{
            "type":"integer",
            "format":"int32"
        },
        "resourcePath":{
            "type":"string"
        },
        "rows":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLookupRowData"
            }
        },
        "keywords":{
            "type":"string"
        },
        "rowsAsArray":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    },
    "xml":{
        "name":"lookup"
    }
}

Nested Schema : adapters

Type: array

Show Source

• Array of: object adapter

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/AdapterTypeRs"
    }
}

Nested Schema : columns

Type: array

Show Source

• Array of: string

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : rows

Type: array

Show Source

• Array of: object SuiteLookupRowData

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SuiteLookupRowData"
    }
}

Nested Schema : rowsAsArray

Type: array

Show Source

• Array of: array items

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

Nested Schema : adapter

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "supportedSecurityPolicies":{
            "type":"string"
        },
        "defaultSecurityPolicies":{
            "type":"string"
        },
        "features":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "integrationRole":{
            "type":"string",
            "enum":[
                "SOURCE",
                "TARGET",
                "SOURCE_AND_TARGET"
            ]
        },
        "vendorInfo":{
            "$ref":"#/definitions/VendorInfo"
        },
        "icons":{
            "$ref":"#/definitions/AdapterIconsRs"
        },
        "wsdlvalidation":{
            "type":"boolean",
            "default":false
        },
        "testKey":{
            "type":"string"
        },
        "validateAndTestKey":{
            "type":"string"
        },
        "testMessage":{
            "type":"string"
        },
        "validateAndTestMessage":{
            "type":"string"
        },
        "infoMessage":{
            "type":"string"
        },
        "genericAuthSupport":{
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "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"
                ]
            }
        },
        "customSecurityPolicyDescription":{
            "type":"string"
        },
        "otherVersions":{
            "type":"string"
        },
        "oauth3LeggedSupport":{
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "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"
                ]
            }
        }
    },
    "xml":{
        "name":"adapter"
    }
}

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

{
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "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

• largeIconUrl: string
• mediumGrayIconUrl: string
• mediumIconUrl: string
• mediumWhiteIconUrl: string
• smallIconUrl: string

{
    "type":"object",
    "properties":{
        "smallIconUrl":{
            "type":"string"
        },
        "mediumIconUrl":{
            "type":"string"
        },
        "largeIconUrl":{
            "type":"string"
        },
        "mediumGrayIconUrl":{
            "type":"string"
        },
        "mediumWhiteIconUrl":{
            "type":"string"
        }
    },
    "xml":{
        "name":"adaptericons"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

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

{
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "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

• contactUS: string
• description: string
• documentationURL: string
• name: string
• releaseNotes: string
• supportURL: string

{
    "type":"object",
    "properties":{
        "supportURL":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "contactUS":{
            "type":"string"
        },
        "documentationURL":{
            "type":"string"
        },
        "releaseNotes":{
            "type":"string"
        }
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

Nested Schema : SuiteLookupRowData

Type: object

Show Source

• rowData: array rowData

{
    "type":"object",
    "properties":{
        "rowData":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : rowData

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

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

Successful operation

400 Response

Bad request, missing required data

404 Response

Lookup not found

500 Response

Server error

Back to Top

Examples

The following example shows how to clone 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.

Example: Clone a lookup

This command clones the specified lookup. The request must attach a JSON file containing the new lookup's details with the -d option.

Request:

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/lookups/myLookup/clone

Request Body:

The following example shows the contents of the request body in JSON format. This is the contents of the lookup.json file listed in the cURL command.

{"description":"Cloned lookup","name":"clonedLookup"}

Back to Top