REST API for Oracle Integration

Update a Connection

post

/ic/api/integration/v1/connections/{id}

Updates the security properties, connection properties, agentGroupId, or securityPolicy of a connection. Other properties are ignored.

Supported security properties depend on the selected securityPolicy and the connection type. The connection type also determines the supported securityPolicy values.

Request

Supported Media Types

application/json; charset=utf-8

Path Parameters

id(required): string

Connection identifier

Header Parameters

X-HTTP-Method-Override(required): string

HTTP Method override in the header

Connection resource

Root Schema : connection

Type: object

Show Source

adapter: object adapter
adapterType: object adapterbase
adminEmail: string
agentGroupId: string
agentRequired: boolean

Default Value: false
agentSupported: boolean

Default Value: false
connectionProperties: array connectionProperties
created: string(date-time)
createdBy: string
description: string
id: string
keywords: string
lastRefreshedDate: string(date-time)
lastUpdated: string(date-time)
lastUpdatedBy: string
links: array links
lockedBy: string
lockedDate: string(date-time)
lockedFlag: boolean

Default Value: false
metadataDownloadState: string

Allowed Values: [ "NOT_STARTED", "IN_PROGRESS", "DOWNLOAD_ERROR", "COMPLETE" ]
metadataDownloadSupportedFlag: boolean

Default Value: false
name: string
percentageComplete: number
refreshedStatus: string
role: string

Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
securityPolicy: 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" ]
securityPolicyInfo: array securityPolicyInfo
securityProperties: array securityProperties
status: string
testStatus: boolean

Default Value: false
usage: integer(int32)
usageActive: integer(int32)
wsdlListDir: array wsdlListDir

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string"
        },
        "connectionProperties":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ConnectionPropertyRs"
            }
        },
        "securityProperties":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ConnectionPropertyRs"
            }
        },
        "securityPolicy":{
            "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"
            ]
        },
        "name":{
            "type":"string"
        },
        "percentageComplete":{
            "type":"number"
        },
        "status":{
            "type":"string"
        },
        "lastUpdatedBy":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "agentGroupId":{
            "type":"string"
        },
        "role":{
            "type":"string",
            "enum":[
                "SOURCE",
                "TARGET",
                "SOURCE_AND_TARGET"
            ]
        },
        "lockedFlag":{
            "type":"boolean",
            "default":false
        },
        "description":{
            "type":"string"
        },
        "created":{
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "type":"string"
        },
        "adapter":{
            "$ref":"#/definitions/AdapterTypeRs"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "usageActive":{
            "type":"integer",
            "format":"int32"
        },
        "adminEmail":{
            "type":"string"
        },
        "metadataDownloadSupportedFlag":{
            "type":"boolean",
            "default":false
        },
        "metadataDownloadState":{
            "type":"string",
            "enum":[
                "NOT_STARTED",
                "IN_PROGRESS",
                "DOWNLOAD_ERROR",
                "COMPLETE"
            ]
        },
        "securityPolicyInfo":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SecurityPolicyInfoRs"
            }
        },
        "agentSupported":{
            "type":"boolean",
            "default":false
        },
        "agentRequired":{
            "type":"boolean",
            "default":false
        },
        "wsdlListDir":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "testStatus":{
            "type":"boolean",
            "default":false
        },
        "lockedBy":{
            "type":"string"
        },
        "lockedDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastRefreshedDate":{
            "type":"string",
            "format":"date-time"
        },
        "refreshedStatus":{
            "type":"string"
        },
        "keywords":{
            "type":"string"
        },
        "adapterType":{
            "$ref":"#/definitions/AdapterTypeBaseRs"
        }
    },
    "xml":{
        "name":"connection"
    }
}

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 : adapterbase

Type: object

Show Source

displayName: string
id: string
links: array links
name: string
type: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    },
    "xml":{
        "name":"adapterbase"
    }
}

Nested Schema : connectionProperties

Type: array

Show Source

Array of: object connectionproperty

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

Nested Schema : links

Type: array

Show Source

Array of: object Link

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

Nested Schema : securityPolicyInfo

Type: array

Show Source

Array of: object securitypolicyinfo

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

Nested Schema : securityProperties

Type: array

Show Source

Array of: object connectionproperty

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

Nested Schema : wsdlListDir

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "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", "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 : links

Type: array

Show Source

Array of: object SuiteLink

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

Nested Schema : connectionproperty

Type: object

Show Source

acceptableKeys: array acceptableKeys
attachment: object ConnectionAttachmentRs
displayName: string
hasAttachment: boolean

Default Value: false
hiddenFlag: boolean

Default Value: false
integrationRole: string

Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
propertyDescription: string
propertyGroup: string

Allowed Values: [ "CREDENTIALS", "SOURCE_ARTIFACTS", "CONNECTION_PROPS", "CUSTOM", "OTHER" ]
propertyName: string
propertyShortDesc: string
propertyType: string

Allowed Values: [ "STRING", "NUMBER", "URL", "WSDL_URL", "XSD_URL", "WADL_URL", "FILE", "PASSWORD", "URL_OR_FILE", "LIST", "MAP", "TEXT", "CHOICE", "BOOLEAN", "ARTIFACT_URL", "LIST_OF_MAPS", "CONCRETE_WSDL" ]
propertyValue: string
requiredFlag: boolean

Default Value: false

{
    "type":"object",
    "properties":{
        "propertyName":{
            "type":"string"
        },
        "propertyValue":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "requiredFlag":{
            "type":"boolean",
            "default":false
        },
        "hiddenFlag":{
            "type":"boolean",
            "default":false
        },
        "propertyType":{
            "type":"string",
            "enum":[
                "STRING",
                "NUMBER",
                "URL",
                "WSDL_URL",
                "XSD_URL",
                "WADL_URL",
                "FILE",
                "PASSWORD",
                "URL_OR_FILE",
                "LIST",
                "MAP",
                "TEXT",
                "CHOICE",
                "BOOLEAN",
                "ARTIFACT_URL",
                "LIST_OF_MAPS",
                "CONCRETE_WSDL"
            ]
        },
        "propertyGroup":{
            "type":"string",
            "enum":[
                "CREDENTIALS",
                "SOURCE_ARTIFACTS",
                "CONNECTION_PROPS",
                "CUSTOM",
                "OTHER"
            ]
        },
        "integrationRole":{
            "type":"string",
            "enum":[
                "SOURCE",
                "TARGET",
                "SOURCE_AND_TARGET"
            ]
        },
        "acceptableKeys":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Key"
            }
        },
        "attachment":{
            "$ref":"#/definitions/ConnectionAttachmentRs"
        },
        "hasAttachment":{
            "type":"boolean",
            "default":false
        },
        "propertyDescription":{
            "type":"string"
        },
        "propertyShortDesc":{
            "type":"string"
        }
    },
    "xml":{
        "name":"connectionproperty"
    }
}

Nested Schema : acceptableKeys

Type: array

Show Source

Array of: object Key

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

Nested Schema : ConnectionAttachmentRs

Type: object

Show Source

attachmentName: string
decodedContentBytes: array decodedContentBytes
propertyName: string
signature: string

{
    "type":"object",
    "properties":{
        "propertyName":{
            "type":"string"
        },
        "attachmentName":{
            "type":"string"
        },
        "signature":{
            "type":"string"
        },
        "decodedContentBytes":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"byte"
            }
        }
    }
}

Nested Schema : Key

Type: object

Show Source

displayName: string
keyName: string
scope: string

Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]

{
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string"
        },
        "keyName":{
            "type":"string"
        },
        "scope":{
            "type":"string",
            "enum":[
                "SOURCE",
                "TARGET",
                "SOURCE_AND_TARGET"
            ]
        }
    }
}

Nested Schema : decodedContentBytes

Type: array

Show Source

Array of: string(byte)

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

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 : securitypolicyinfo

Type: object

Show Source

securityPolicy: 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" ]
securityProperties: array securityProperties

{
    "type":"object",
    "properties":{
        "securityPolicy":{
            "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"
            ]
        },
        "securityProperties":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ConnectionPropertyRs"
            }
        }
    },
    "xml":{
        "name":"securitypolicyinfo"
    }
}

Nested Schema : securityProperties

Type: array

Show Source

Array of: object connectionproperty

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

Response

Supported Media Types

application/json; charset=UTF-8
application/vnd.oracle.resource+json;type=singular

200 Response

Successful operation

Root Schema : connection

Type: object

Show Source

adapter: object adapter
adapterType: object adapterbase
adminEmail: string
agentGroupId: string
agentRequired: boolean

Default Value: false
agentSupported: boolean

Default Value: false
connectionProperties: array connectionProperties
created: string(date-time)
createdBy: string
description: string
id: string
keywords: string
lastRefreshedDate: string(date-time)
lastUpdated: string(date-time)
lastUpdatedBy: string
links: array links
lockedBy: string
lockedDate: string(date-time)
lockedFlag: boolean

Default Value: false
metadataDownloadState: string

Allowed Values: [ "NOT_STARTED", "IN_PROGRESS", "DOWNLOAD_ERROR", "COMPLETE" ]
metadataDownloadSupportedFlag: boolean

Default Value: false
name: string
percentageComplete: number
refreshedStatus: string
role: string

Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
securityPolicy: 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" ]
securityPolicyInfo: array securityPolicyInfo
securityProperties: array securityProperties
status: string
testStatus: boolean

Default Value: false
usage: integer(int32)
usageActive: integer(int32)
wsdlListDir: array wsdlListDir

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string"
        },
        "connectionProperties":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ConnectionPropertyRs"
            }
        },
        "securityProperties":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ConnectionPropertyRs"
            }
        },
        "securityPolicy":{
            "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"
            ]
        },
        "name":{
            "type":"string"
        },
        "percentageComplete":{
            "type":"number"
        },
        "status":{
            "type":"string"
        },
        "lastUpdatedBy":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "agentGroupId":{
            "type":"string"
        },
        "role":{
            "type":"string",
            "enum":[
                "SOURCE",
                "TARGET",
                "SOURCE_AND_TARGET"
            ]
        },
        "lockedFlag":{
            "type":"boolean",
            "default":false
        },
        "description":{
            "type":"string"
        },
        "created":{
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "type":"string"
        },
        "adapter":{
            "$ref":"#/definitions/AdapterTypeRs"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "usageActive":{
            "type":"integer",
            "format":"int32"
        },
        "adminEmail":{
            "type":"string"
        },
        "metadataDownloadSupportedFlag":{
            "type":"boolean",
            "default":false
        },
        "metadataDownloadState":{
            "type":"string",
            "enum":[
                "NOT_STARTED",
                "IN_PROGRESS",
                "DOWNLOAD_ERROR",
                "COMPLETE"
            ]
        },
        "securityPolicyInfo":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SecurityPolicyInfoRs"
            }
        },
        "agentSupported":{
            "type":"boolean",
            "default":false
        },
        "agentRequired":{
            "type":"boolean",
            "default":false
        },
        "wsdlListDir":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "testStatus":{
            "type":"boolean",
            "default":false
        },
        "lockedBy":{
            "type":"string"
        },
        "lockedDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastRefreshedDate":{
            "type":"string",
            "format":"date-time"
        },
        "refreshedStatus":{
            "type":"string"
        },
        "keywords":{
            "type":"string"
        },
        "adapterType":{
            "$ref":"#/definitions/AdapterTypeBaseRs"
        }
    },
    "xml":{
        "name":"connection"
    }
}

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 : adapterbase

Type: object

Show Source

displayName: string
id: string
links: array links
name: string
type: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    },
    "xml":{
        "name":"adapterbase"
    }
}

Nested Schema : connectionProperties

Type: array

Show Source

Array of: object connectionproperty

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

Nested Schema : links

Type: array

Show Source

Array of: object Link

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

Nested Schema : securityPolicyInfo

Type: array

Show Source

Array of: object securitypolicyinfo

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

Nested Schema : securityProperties

Type: array

Show Source

Array of: object connectionproperty

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

Nested Schema : wsdlListDir

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "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", "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 : links

Type: array

Show Source

Array of: object SuiteLink

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

Nested Schema : connectionproperty

Type: object

Show Source

acceptableKeys: array acceptableKeys
attachment: object ConnectionAttachmentRs
displayName: string
hasAttachment: boolean

Default Value: false
hiddenFlag: boolean

Default Value: false
integrationRole: string

Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
propertyDescription: string
propertyGroup: string

Allowed Values: [ "CREDENTIALS", "SOURCE_ARTIFACTS", "CONNECTION_PROPS", "CUSTOM", "OTHER" ]
propertyName: string
propertyShortDesc: string
propertyType: string

Allowed Values: [ "STRING", "NUMBER", "URL", "WSDL_URL", "XSD_URL", "WADL_URL", "FILE", "PASSWORD", "URL_OR_FILE", "LIST", "MAP", "TEXT", "CHOICE", "BOOLEAN", "ARTIFACT_URL", "LIST_OF_MAPS", "CONCRETE_WSDL" ]
propertyValue: string
requiredFlag: boolean

Default Value: false

{
    "type":"object",
    "properties":{
        "propertyName":{
            "type":"string"
        },
        "propertyValue":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "requiredFlag":{
            "type":"boolean",
            "default":false
        },
        "hiddenFlag":{
            "type":"boolean",
            "default":false
        },
        "propertyType":{
            "type":"string",
            "enum":[
                "STRING",
                "NUMBER",
                "URL",
                "WSDL_URL",
                "XSD_URL",
                "WADL_URL",
                "FILE",
                "PASSWORD",
                "URL_OR_FILE",
                "LIST",
                "MAP",
                "TEXT",
                "CHOICE",
                "BOOLEAN",
                "ARTIFACT_URL",
                "LIST_OF_MAPS",
                "CONCRETE_WSDL"
            ]
        },
        "propertyGroup":{
            "type":"string",
            "enum":[
                "CREDENTIALS",
                "SOURCE_ARTIFACTS",
                "CONNECTION_PROPS",
                "CUSTOM",
                "OTHER"
            ]
        },
        "integrationRole":{
            "type":"string",
            "enum":[
                "SOURCE",
                "TARGET",
                "SOURCE_AND_TARGET"
            ]
        },
        "acceptableKeys":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Key"
            }
        },
        "attachment":{
            "$ref":"#/definitions/ConnectionAttachmentRs"
        },
        "hasAttachment":{
            "type":"boolean",
            "default":false
        },
        "propertyDescription":{
            "type":"string"
        },
        "propertyShortDesc":{
            "type":"string"
        }
    },
    "xml":{
        "name":"connectionproperty"
    }
}

Nested Schema : acceptableKeys

Type: array

Show Source

Array of: object Key

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

Nested Schema : ConnectionAttachmentRs

Type: object

Show Source

attachmentName: string
decodedContentBytes: array decodedContentBytes
propertyName: string
signature: string

{
    "type":"object",
    "properties":{
        "propertyName":{
            "type":"string"
        },
        "attachmentName":{
            "type":"string"
        },
        "signature":{
            "type":"string"
        },
        "decodedContentBytes":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"byte"
            }
        }
    }
}

Nested Schema : Key

Type: object

Show Source

displayName: string
keyName: string
scope: string

Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]

{
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string"
        },
        "keyName":{
            "type":"string"
        },
        "scope":{
            "type":"string",
            "enum":[
                "SOURCE",
                "TARGET",
                "SOURCE_AND_TARGET"
            ]
        }
    }
}

Nested Schema : decodedContentBytes

Type: array

Show Source

Array of: string(byte)

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

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 : securitypolicyinfo

Type: object

Show Source

securityPolicy: 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" ]
securityProperties: array securityProperties

{
    "type":"object",
    "properties":{
        "securityPolicy":{
            "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"
            ]
        },
        "securityProperties":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ConnectionPropertyRs"
            }
        }
    },
    "xml":{
        "name":"securitypolicyinfo"
    }
}

Nested Schema : securityProperties

Type: array

Show Source

Array of: object connectionproperty

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

400 Response

Missing header information

404 Response

Connection not found

423 Response

Connection is locked

500 Response

Server error

Examples

The following example shows how to update a connection 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 updates the connection details with the data attached in the file specified with the -d option. The command consumes JSON data. To update a connection, the cURL command must contain the header -H "X-HTTP-Method-Override:PATCH".

curl -X POST -H 'Authorization: Bearer access_token' -H "X-HTTP-Method-Override:PATCH" -H "Content-Type:application/json" -d @connprop.json https://integration.us.oraclecloud.com/ic/api/integration/v1/connections/{id}

The following examples show the contents of a request body in JSON format. This is the contents of the connprop.json file listed in the cURL command. The request body only needs to include the properties you want to change. For the complete format, see the example response body for Retrieve a Connection.

Example: Request Body to update WSDL URL and connection user name and password

{"connectionProperties":[{"propertyName":"targetWSDLURL","propertyValue":"http://example.com/WeatherWS/Weather.asmx?WSDL"}],"securityProperties":[{"propertyName":"username","propertyValue":"jsmith"},{"propertyName":"password","propertyValue":"password"}]}

Example: Request Body to update the connection to have no security policy

{"securityPolicy": "NONE"}

Example: Request Body to update the connection WSDL URL only

{"connectionProperties":[{"propertyName":"targetWSDLURL","propertyValue":"http://example.com/WeatherWS/Weather.asmx?WSDL"}]}

Example: Request Body to update the connection user name only

{"securityProperties":[{"propertyName":"username","propertyValue":"user1"}]}

Example: Request Body to update the connection user password only

{"securityProperties":[{"propertyName":"password","propertyValue":"newpassword"}]}

Example: Request Body to update WSDL URL, security policy, and connection user name and password

{ 
   "connectionProperties": { 
      "propertyGroup": "CONNECTION_PROPS",     
      "propertyName": "targetWSDLURL",   
      "propertyType": "WSDL_URL",  
      "propertyValue": "http://example.com/WeatherWS/Weather.asmx?WSDL" 
   }, 
   "securityPolicy": "BASIC_AUTH", 
   "securityProperties":  [{ 
      "propertyGroup": "CREDENTIALS",     
      "propertyName": "username",   
      "propertyValue": "abcd7"
   }, 
   {
      "propertyGroup": "CREDENTIALS",     
      "propertyName": "password", 
      "propertyValue": "abc222" 
   }]  
}