REST API for Oracle Integration Cloud Service on Oracle Public Cloud Machine

Update a Connection

put

/icsapis/v1/connections/{code}

Updates a Connection.

Request

Supported Media Types

application/xml
application/json

Path Parameters

code: Type: string

Required: true

Connection identifier

Body Parameter

Root Schema : ConnectionItem

Type: object

Properties

appInstConnProperties: Type: array appInstConnProperties

Required: true
appInstCredProperties: Type: array appInstCredProperties

Required: true
appType: Type: object ApplicationTypeResource
code: Type: string
imageURL: Type: string
links: Type: array links

Required: true
name: Type: string
percentageComplete: Type: number (double)
securityPolicy: Type: string

Allowed Values: [ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TOKEN_BASED", "NONE", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS" ]
status: Type: string
supportsCache: Type: boolean

Default Value: false

Nested Schema : appInstConnProperties

Type: array

Items

Type: object ConnectionProperty

Nested Schema : appInstCredProperties

Type: array

Items

Type: object ConnectionProperty

Nested Schema : ApplicationTypeResource

Type: object

Properties

appTypeConnProperties: Type: array appTypeConnProperties
appTypeCredProperties: Type: array appTypeCredProperties
appTypeLargeIconUrl: Type: string
appTypeMediumGrayIconUrl: Type: string
appTypeMediumIconUrl: Type: string
appTypeMediumWhiteIconUrl: Type: string
appTypeName: Type: string
appTypeSmallIconUrl: Type: string
displayName: Type: string
features: Type: string
source: Type: string
supportedSecurityPolicies: Type: string
vedorInfo: Type: object VendorInfo

Nested Schema : links

Type: array

Items

Type: object Link

Nested Schema : ConnectionProperty

Type: object

Properties

acceptableKeys: Type: array acceptableKeys
attachment: Type: object Attachment
customProperties: Type: array customProperties
displayName: Type: string
hasAttachment: Type: boolean

Default Value: false
integrationRole: Type: string

Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
length: Type: integer (int32)
propertyDescription: Type: string
propertyGroup: Type: string

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

Allowed Values: [ "STRING", "NUMBER", "URL", "WSDL_URL", "XSD_URL", "WADL_URL", "FILE", "PASSWORD", "URL_OR_FILE", "LIST", "MAP", "TEXT", "CHOICE" ]
propertyValue: Type: string
required: Type: boolean

Default Value: false

Nested Schema : acceptableKeys

Type: array

Items

Type: object Key

Nested Schema : Attachment

Type: object

Properties

attachmentName: Type: string
attachmentPropertyName: Type: string
decodedContent: Type: string
decodedContentBytes: Type: array decodedContentBytes
localFilePath: Type: string

Nested Schema : customProperties

Type: array

Items

Type: object ConnectionProperty

Nested Schema : Key

Type: object

Properties

displayName: Type: string
keyName: Type: string

Nested Schema : decodedContentBytes

Type: array

Items

Type: string (byte)

Nested Schema : appTypeConnProperties

Type: array

Items

Type: object ConnectionProperty

Nested Schema : appTypeCredProperties

Type: array

Items

Type: object ConnectionProperty

Nested Schema : VendorInfo

Type: object

Properties

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

Nested Schema : Link

Type: object

Properties

href: Type: string
rel: Type: string

Response

Supported Media Types

application/json; charset=UTF-8
application/xml; charset=UTF-8

200 Response

Successful operation

Body

Root Schema : ConnectionItem

Type: object

Properties

appInstConnProperties: Type: array appInstConnProperties

Required: true
appInstCredProperties: Type: array appInstCredProperties

Required: true
appType: Type: object ApplicationTypeResource
code: Type: string
imageURL: Type: string
links: Type: array links

Required: true
name: Type: string
percentageComplete: Type: number (double)
securityPolicy: Type: string

Allowed Values: [ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TOKEN_BASED", "NONE", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS" ]
status: Type: string
supportsCache: Type: boolean

Default Value: false

Nested Schema : appInstConnProperties

Type: array

Items

Type: object ConnectionProperty

Nested Schema : appInstCredProperties

Type: array

Items

Type: object ConnectionProperty

Nested Schema : ApplicationTypeResource

Type: object

Properties

appTypeConnProperties: Type: array appTypeConnProperties
appTypeCredProperties: Type: array appTypeCredProperties
appTypeLargeIconUrl: Type: string
appTypeMediumGrayIconUrl: Type: string
appTypeMediumIconUrl: Type: string
appTypeMediumWhiteIconUrl: Type: string
appTypeName: Type: string
appTypeSmallIconUrl: Type: string
displayName: Type: string
features: Type: string
source: Type: string
supportedSecurityPolicies: Type: string
vedorInfo: Type: object VendorInfo

Nested Schema : links

Type: array

Items

Type: object Link

Nested Schema : ConnectionProperty

Type: object

Properties

acceptableKeys: Type: array acceptableKeys
attachment: Type: object Attachment
customProperties: Type: array customProperties
displayName: Type: string
hasAttachment: Type: boolean

Default Value: false
integrationRole: Type: string

Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
length: Type: integer (int32)
propertyDescription: Type: string
propertyGroup: Type: string

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

Allowed Values: [ "STRING", "NUMBER", "URL", "WSDL_URL", "XSD_URL", "WADL_URL", "FILE", "PASSWORD", "URL_OR_FILE", "LIST", "MAP", "TEXT", "CHOICE" ]
propertyValue: Type: string
required: Type: boolean

Default Value: false