Jump to

• Request
• Response
• Examples

Upload Connection Property Attachment

post

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

Uploads an attachment (such as a WSDL file) to a connection and associates the attachment with a specific connection property. If you are using cURL, use the -F option to specify the file to upload.

Request

Supported Media Types

• multipart/form-data

Path Parameters

• connPropName: string
  Connection property name. For example: targetWSDLURL
• id: string
  Connection identifier.

Query Parameters

• serviceWSDL(optional): string
  Path and name of the WSDL file in the zip file. For example: serviceWSDL=/path/source.wsdl

Form Parameters

• file: file
  Upload connection attachment.

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : connection

Type: object

Show Source

• adapter(optional): object adapter
• adapterType(optional): object adapterbase
• adminEmail(optional): string
• agentGroupId(optional): string
• agentRequired(optional): boolean
  Default Value: false
• agentSupported(optional): boolean
  Default Value: false
• connectionProperties(optional): array connectionProperties
• created(optional): string(date-time)
• createdBy(optional): string
• description(optional): string
• id(optional): string
• keywords(optional): string
• lastRefreshedDate(optional): string(date-time)
• lastUpdated(optional): string(date-time)
• lastUpdatedBy(optional): string
• links(optional): array links
• lockedBy(optional): string
• lockedDate(optional): string(date-time)
• lockedFlag(optional): boolean
  Default Value: false
• metadataDownloadState(optional): string
  Allowed Values: [ "NOT_STARTED", "IN_PROGRESS", "DOWNLOAD_ERROR", "COMPLETE" ]
• metadataDownloadSupportedFlag(optional): boolean
  Default Value: false
• name(optional): string
• percentageComplete(optional): number
• refreshedStatus(optional): string
• role(optional): string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
• securityPolicy(optional): 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(optional): array securityPolicyInfo
• securityProperties(optional): array securityProperties
• status(optional): string
• testStatus(optional): boolean
  Default Value: false
• usage(optional): integer(int32)
• usageActive(optional): integer(int32)
• wsdlListDir(optional): 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(optional): string
• defaultSecurityPolicies(optional): string
• description(optional): string
• displayName(optional): string
• features(optional): string
• genericAuthSupport(optional): array genericAuthSupport
• icons(optional): object adaptericons
• id(optional): string
• infoMessage(optional): string
• integrationRole(optional): string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
• links(optional): array links
• name(optional): string
• oauth3LeggedSupport(optional): array oauth3LeggedSupport
• otherVersions(optional): string
• supportedSecurityPolicies(optional): string
• testKey(optional): string
• testMessage(optional): string
• type(optional): string
• validateAndTestKey(optional): string
• validateAndTestMessage(optional): string
• vendorInfo(optional): object VendorInfo
• version(optional): string
• wsdlvalidation(optional): 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(optional): string
• id(optional): string
• links(optional): array links
• name(optional): string
• type(optional): 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(optional): string
• mediumGrayIconUrl(optional): string
• mediumIconUrl(optional): string
• mediumWhiteIconUrl(optional): string
• smallIconUrl(optional): 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(optional): string
• description(optional): string
• documentationURL(optional): string
• name(optional): string
• releaseNotes(optional): string
• supportURL(optional): 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(optional): string
• mediaType(optional): string
• rel(optional): 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(optional): array acceptableKeys
• attachment(optional): object ConnectionAttachmentRs
• displayName(optional): string
• hasAttachment(optional): boolean
  Default Value: false
• hiddenFlag(optional): boolean
  Default Value: false
• integrationRole(optional): string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
• propertyDescription(optional): string
• propertyGroup(optional): string
  Allowed Values: [ "CREDENTIALS", "SOURCE_ARTIFACTS", "CONNECTION_PROPS", "CUSTOM", "OTHER" ]
• propertyName(optional): string
• propertyShortDesc(optional): string
• propertyType(optional): 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(optional): string
• requiredFlag(optional): 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(optional): string
• decodedContentBytes(optional): array decodedContentBytes
• propertyName(optional): string
• signature(optional): 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(optional): string
• keyName(optional): string
• scope(optional): 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(optional): string
• mediaType(optional): string
• rel(optional): string

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

Nested Schema : securitypolicyinfo

Type: object

Show Source

• securityPolicy(optional): 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(optional): 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

No file is uploaded

404 Response

Connection not found

423 Response

Connection is locked

500 Response

Server error

Back to Top

Examples

The following examples show how to update the connection by uploading a file to the connection's attachment property 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: Update the connection by uploading a WSDL file

This command updates the connection by uploading a WSDL file to the connection's targetWSDLURL property.

curl -X POST -H 'Authorization: Bearer access_token' -F file=@source.wsdl -F type=application/octet-stream https://integration.us.oraclecloud.com/ic/api/integration/v1/connections/{id}/attachments/targetWSDLURL

Required options for this request:

• -F file=@source.wsdl: The location and the name of the file to attach to the connection's targetWSDLURL property.
• -F type=application/octet-stream: The type of file included in the request.

Example: Update the connection by uploading a zip file

This command updates the connection by uploading a zip file to the connection's targetWSDLURL property. Specify the path of the WSDL file in the zip file in the command.

curl -G -X POST -H 'Authorization: Bearer access_token' -F file=@source.zip -F type=application/octet-stream -d "serviceWSDL=/path/source.wsdl" https://integration.us.oraclecloud.com/ic/api/integration/v1/connections/{id}/attachments/targetWSDLURL 

Back to Top