Jump to

• Request
• Response

Validate and Test a Connection

post

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

Validates and tests the connection for certain adapters. For example, for the FTP adapter performs a full validation of the WSDL including imported schemas and WSDLs, and then tests the connection.

Request

Path Parameters

• id(required): string
  Connection identifier

Query Parameters

• action: string
  When action=validate performs a full validation of the WSDL, including processing of the imported schemas and WSDLs.
• integrationInstance(required): string
  This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.
• patchAttachments: boolean
  Indicates whether it is a partial or a full update of the attachments. Set patchAttachments=true to send in the request payload only attachments that have changed. Set patchAttachments=false to send in the request payload all attachments (changed and unchanged).

Header Parameters

• X-HTTP-Method-Override(required): string
  HTTP Method override in the header

Supported Media Types

• multipart/form-data

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• adapter: AdapterTypeRs
• adapter-type: AdapterTypeBaseRs
• admin-email: string
  Administrator's Email
• agent-group-id: string
  Agent Group Identifier
• agent-required: boolean
  Agent Required
• agent-supported: boolean
  Agent Supported
• connection-properties: array connection-properties
  List of Connection Properties
• created: string (date-time)
  Created
• created-by: string
  Created By
• description: string
  Description
• keywords: string
  Keywords
• last-refreshed-date: string (date-time)
  Last Refresh Date
• last-updated: string (date-time)
  Last Updated
• last-updated-by: string
  Last Updated By
• locked-by: string
  Locked By
• locked-date: string (date-time)
  Locked Date
• locked-flag: boolean
  Locked Flag
• metadata-download-state: string
  Metadata Download State
• metadata-download-supported-flag: boolean
  Metadata Download Supported Flag
• name: string
  Connection Name
• percentage-complete: number
  Connection Completion Percentage
• project-id: string
• refreshed-status: string
  Refreshed Status
• role: string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
• security-policy: string
  Allowed Values: [ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "USERNAME_PASSWORD_IGNORE_TIMESTAMP", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TEMPLATE_BASED", "TOKEN_BASED", "NONE", "PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "TIMEOUT_AUTHORIZATION_CODE_CREDENTIALS", "PLUGIN_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "PLUGIN_CLIENT_CREDENTIALS", "MIN_PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH20_AUTHORIZATION_CODE_CREDENTIALS", "CUSTOM_THREE_LEGGED", "CUSTOM_TWO_LEGGED", "CUSTOM_SINGLE_TOKEN", "SHOPIFY_AUTH_POLICY", "SUCCESSFACTORS", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "NETSUITE_3STEP_TBA_FLOW", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "MULTI_TOKEN_INBOUND", "AWS_SIGNATURE_VERSION4", "OAUTH2_PRECONFIGURED_CLINET_ID_SECRET", "OAUTH2_CCS_ROP_PRECONFIGURED", "OAUTH2_CCS_ROP", "OAUTH2", "CCS_BASIC_AUTH", "CCS_API_KEY", "JDBC_OVER_SSL", "JDBC_OVER_SSL_WITH_OCI_SIGNATURE", "JDBC_BASIC_AUTH", "FA_OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "FA_OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "ORACLE_WALLET", "OCI_SIGNATURE_VERSION1", "SASLPLAIN", "SASLPLAIN_OVER_SSL", "SASLPLAIN_OVER_SSL_OSS", "TLS", "MUTUAL_TLS", "UIPATH_CLOUD", "OCI_OBO_TOKEN", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS", "JWT_USER_ASSERTION_FOR_OAUTH", "JWT_CLIENT_CREDENTIALS_ASSERTION_FOR_OAUTH", "OCI_SERVICE_INVOCATION" ]
• security-policy-info: array security-policy-info
  List of Security Policies
• security-properties: array security-properties
  List of Security Properties
• status: string
  Connection Status
• test-status: boolean
  Test Status
• usage: integer (int32)
  Usage
• usage-active: integer (int32)
  Active Usage
• wsdl-list-dir: array wsdl-list-dir
  List of WSDL

{
    "type":"object",
    "properties":{
        "test-status":{
            "type":"boolean",
            "description":"Test Status"
        },
        "wsdl-list-dir":{
            "type":"array",
            "description":"List of WSDL",
            "items":{
                "type":"string"
            }
        },
        "security-policy-info":{
            "type":"array",
            "description":"List of Security Policies",
            "items":{
                "$ref":"#/components/schemas/SecurityPolicyInfoRs"
            }
        },
        "metadata-download-supported-flag":{
            "type":"boolean",
            "description":"Metadata Download Supported Flag"
        },
        "metadata-download-state":{
            "type":"string",
            "description":"Metadata Download State"
        },
        "adapter-type":{
            "$ref":"#/components/schemas/AdapterTypeBaseRs"
        },
        "status":{
            "type":"string",
            "description":"Connection Status"
        },
        "connection-properties":{
            "type":"array",
            "description":"List of Connection Properties",
            "items":{
                "$ref":"#/components/schemas/ConnectionPropertyRs"
            }
        },
        "security-properties":{
            "type":"array",
            "description":"List of Security Properties",
            "items":{
                "$ref":"#/components/schemas/ConnectionPropertyRs"
            }
        },
        "name":{
            "type":"string",
            "description":"Connection Name"
        },
        "percentage-complete":{
            "type":"number",
            "description":"Connection Completion Percentage"
        },
        "security-policy":{
            "$ref":"#/components/schemas/SecurityPolicy"
        },
        "last-updated-by":{
            "type":"string",
            "description":"Last Updated By"
        },
        "last-updated":{
            "type":"string",
            "description":"Last Updated",
            "format":"date-time"
        },
        "agent-group-id":{
            "type":"string",
            "description":"Agent Group Identifier"
        },
        "role":{
            "$ref":"#/components/schemas/AdapterIntegrationRole"
        },
        "locked-flag":{
            "type":"boolean",
            "description":"Locked Flag"
        },
        "description":{
            "type":"string",
            "description":"Description"
        },
        "created":{
            "type":"string",
            "description":"Created",
            "format":"date-time"
        },
        "created-by":{
            "type":"string",
            "description":"Created By"
        },
        "adapter":{
            "$ref":"#/components/schemas/AdapterTypeRs"
        },
        "usage":{
            "type":"integer",
            "description":"Usage",
            "format":"int32"
        },
        "usage-active":{
            "type":"integer",
            "description":"Active Usage",
            "format":"int32"
        },
        "admin-email":{
            "type":"string",
            "description":"Administrator's Email"
        },
        "agent-supported":{
            "type":"boolean",
            "description":"Agent Supported"
        },
        "agent-required":{
            "type":"boolean",
            "description":"Agent Required"
        },
        "keywords":{
            "type":"string",
            "description":"Keywords"
        },
        "locked-by":{
            "type":"string",
            "description":"Locked By"
        },
        "locked-date":{
            "type":"string",
            "description":"Locked Date",
            "format":"date-time"
        },
        "last-refreshed-date":{
            "type":"string",
            "description":"Last Refresh Date",
            "format":"date-time"
        },
        "refreshed-status":{
            "type":"string",
            "description":"Refreshed Status"
        },
        "project-id":{
            "type":"string"
        }
    }
}

Nested Schema : AdapterTypeRs

Match All

Show Source

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

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

Nested Schema : AdapterTypeBaseRs

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object AdapterTypeBaseRs-allOf[2]

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

Nested Schema : connection-properties

Type: array

List of Connection Properties

Show Source

• Array of: object ConnectionPropertyRs

{
    "type":"array",
    "description":"List of Connection Properties",
    "items":{
        "$ref":"#/components/schemas/ConnectionPropertyRs"
    }
}

Nested Schema : security-policy-info

Type: array

List of Security Policies

Show Source

• Array of: object SecurityPolicyInfoRs

{
    "type":"array",
    "description":"List of Security Policies",
    "items":{
        "$ref":"#/components/schemas/SecurityPolicyInfoRs"
    }
}

Nested Schema : security-properties

Type: array

List of Security Properties

Show Source

• Array of: object ConnectionPropertyRs

{
    "type":"array",
    "description":"List of Security Properties",
    "items":{
        "$ref":"#/components/schemas/ConnectionPropertyRs"
    }
}

Nested Schema : wsdl-list-dir

Type: array

List of WSDL

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of WSDL",
    "items":{
        "type":"string"
    }
}

Nested Schema : IdRs

Match All

Show Source

• object GenericRestRs
• object IdRs-allOf[1]

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

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

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

Nested Schema : IdRs-allOf[1]

Type: object

Show Source

• id: string

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

Nested Schema : AdapterTypeBaseRs-allOf[2]

Type: object

Show Source

• displayName: string
• name: string
• type: string

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

Nested Schema : AdapterTypeRs-allOf[3]

Type: object

Show Source

• customSecurityPolicyDescription: string
• defaultSecurityPolicies: string
• description: string
• features: string
• genericAuthSupport: array genericAuthSupport
• icons: object AdapterIconsRs
• infoMessage: string
• integrationRole: string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
• oAuth3LeggedSupport: array oAuth3LeggedSupport
• otherVersions: string
• supportedSecurityPolicies: string
• testKey: string
• testMessage: string
• validateAndTestKey: string
• validateAndTestMessage: string
• vendorInfo: object AdapterVendorInfo
• version: string
• wsdlvalidation: boolean

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

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : SuiteLink

Type: object

Show Source

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

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

Nested Schema : genericAuthSupport

Type: array

Show Source

• Array of: string
  Allowed Values: [ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "USERNAME_PASSWORD_IGNORE_TIMESTAMP", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TEMPLATE_BASED", "TOKEN_BASED", "NONE", "PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "TIMEOUT_AUTHORIZATION_CODE_CREDENTIALS", "PLUGIN_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "PLUGIN_CLIENT_CREDENTIALS", "MIN_PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH20_AUTHORIZATION_CODE_CREDENTIALS", "CUSTOM_THREE_LEGGED", "CUSTOM_TWO_LEGGED", "CUSTOM_SINGLE_TOKEN", "SHOPIFY_AUTH_POLICY", "SUCCESSFACTORS", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "NETSUITE_3STEP_TBA_FLOW", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "MULTI_TOKEN_INBOUND", "AWS_SIGNATURE_VERSION4", "OAUTH2_PRECONFIGURED_CLINET_ID_SECRET", "OAUTH2_CCS_ROP_PRECONFIGURED", "OAUTH2_CCS_ROP", "OAUTH2", "CCS_BASIC_AUTH", "CCS_API_KEY", "JDBC_OVER_SSL", "JDBC_OVER_SSL_WITH_OCI_SIGNATURE", "JDBC_BASIC_AUTH", "FA_OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "FA_OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "ORACLE_WALLET", "OCI_SIGNATURE_VERSION1", "SASLPLAIN", "SASLPLAIN_OVER_SSL", "SASLPLAIN_OVER_SSL_OSS", "TLS", "MUTUAL_TLS", "UIPATH_CLOUD", "OCI_OBO_TOKEN", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS", "JWT_USER_ASSERTION_FOR_OAUTH", "JWT_CLIENT_CREDENTIALS_ASSERTION_FOR_OAUTH", "OCI_SERVICE_INVOCATION" ]

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

Nested Schema : AdapterIconsRs

Type: object

Show Source

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

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

Nested Schema : oAuth3LeggedSupport

Type: array

Show Source

• Array of: string
  Allowed Values: [ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "USERNAME_PASSWORD_IGNORE_TIMESTAMP", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TEMPLATE_BASED", "TOKEN_BASED", "NONE", "PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "TIMEOUT_AUTHORIZATION_CODE_CREDENTIALS", "PLUGIN_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "PLUGIN_CLIENT_CREDENTIALS", "MIN_PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH20_AUTHORIZATION_CODE_CREDENTIALS", "CUSTOM_THREE_LEGGED", "CUSTOM_TWO_LEGGED", "CUSTOM_SINGLE_TOKEN", "SHOPIFY_AUTH_POLICY", "SUCCESSFACTORS", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "NETSUITE_3STEP_TBA_FLOW", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "MULTI_TOKEN_INBOUND", "AWS_SIGNATURE_VERSION4", "OAUTH2_PRECONFIGURED_CLINET_ID_SECRET", "OAUTH2_CCS_ROP_PRECONFIGURED", "OAUTH2_CCS_ROP", "OAUTH2", "CCS_BASIC_AUTH", "CCS_API_KEY", "JDBC_OVER_SSL", "JDBC_OVER_SSL_WITH_OCI_SIGNATURE", "JDBC_BASIC_AUTH", "FA_OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "FA_OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "ORACLE_WALLET", "OCI_SIGNATURE_VERSION1", "SASLPLAIN", "SASLPLAIN_OVER_SSL", "SASLPLAIN_OVER_SSL_OSS", "TLS", "MUTUAL_TLS", "UIPATH_CLOUD", "OCI_OBO_TOKEN", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS", "JWT_USER_ASSERTION_FOR_OAUTH", "JWT_CLIENT_CREDENTIALS_ASSERTION_FOR_OAUTH", "OCI_SERVICE_INVOCATION" ]

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

Nested Schema : AdapterVendorInfo

Type: object

Show Source

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

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

Nested Schema : ConnectionPropertyRs

Type: object

Show Source

• acceptable-keys: array acceptable-keys
• attachment: object ConnectionAttachmentRs
• default-property-value: string
• display-name: string
• has-attachment: boolean
• hidden-flag: boolean
• integration-role: string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
• property-description: string
• property-group: string
  Allowed Values: [ "CREDENTIALS", "SOURCE_ARTIFACTS", "CONNECTION_PROPS", "CUSTOM", "OTHER" ]
• property-name: string
• property-short-desc: string
• property-type: 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" ]
• property-value: string
• required-flag: boolean

{
    "type":"object",
    "properties":{
        "property-description":{
            "type":"string"
        },
        "property-short-desc":{
            "type":"string"
        },
        "acceptable-keys":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AdapterKey"
            }
        },
        "integration-role":{
            "$ref":"#/components/schemas/AdapterIntegrationRole"
        },
        "property-name":{
            "type":"string"
        },
        "property-value":{
            "type":"string"
        },
        "display-name":{
            "type":"string"
        },
        "required-flag":{
            "type":"boolean"
        },
        "hidden-flag":{
            "type":"boolean"
        },
        "property-type":{
            "$ref":"#/components/schemas/AdapterPropertyType"
        },
        "property-group":{
            "$ref":"#/components/schemas/AdapterPropertyGroup"
        },
        "attachment":{
            "$ref":"#/components/schemas/ConnectionAttachmentRs"
        },
        "has-attachment":{
            "type":"boolean"
        },
        "default-property-value":{
            "type":"string"
        }
    }
}

Nested Schema : acceptable-keys

Type: array

Show Source

• Array of: object AdapterKey

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

Nested Schema : ConnectionAttachmentRs

Type: object

Show Source

• attachment: object BaseAttachmentRs
• attachment-name: string
• property-name: string
• signature: string

{
    "type":"object",
    "properties":{
        "attachment":{
            "$ref":"#/components/schemas/BaseAttachmentRs"
        },
        "property-name":{
            "type":"string"
        },
        "attachment-name":{
            "type":"string"
        },
        "signature":{
            "type":"string"
        }
    }
}

Nested Schema : AdapterKey

Type: object

Show Source

• display-name: string
• key-name: string
• scope: string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]

{
    "type":"object",
    "properties":{
        "display-name":{
            "type":"string"
        },
        "key-name":{
            "type":"string"
        },
        "scope":{
            "$ref":"#/components/schemas/AdapterIntegrationRole"
        }
    }
}

Nested Schema : BaseAttachmentRs

Type: object

Show Source

• attachment-name: string
• content: string
• local-file-path: string
• property-name: string
• signature: string

{
    "type":"object",
    "properties":{
        "property-name":{
            "type":"string"
        },
        "attachment-name":{
            "type":"string"
        },
        "content":{
            "type":"string"
        },
        "local-file-path":{
            "type":"string"
        },
        "signature":{
            "type":"string"
        }
    }
}

Nested Schema : SecurityPolicyInfoRs

Type: object

Show Source

• scope: string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
• security-policy: string
  Allowed Values: [ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "USERNAME_PASSWORD_IGNORE_TIMESTAMP", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TEMPLATE_BASED", "TOKEN_BASED", "NONE", "PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "TIMEOUT_AUTHORIZATION_CODE_CREDENTIALS", "PLUGIN_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "PLUGIN_CLIENT_CREDENTIALS", "MIN_PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH20_AUTHORIZATION_CODE_CREDENTIALS", "CUSTOM_THREE_LEGGED", "CUSTOM_TWO_LEGGED", "CUSTOM_SINGLE_TOKEN", "SHOPIFY_AUTH_POLICY", "SUCCESSFACTORS", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "NETSUITE_3STEP_TBA_FLOW", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "MULTI_TOKEN_INBOUND", "AWS_SIGNATURE_VERSION4", "OAUTH2_PRECONFIGURED_CLINET_ID_SECRET", "OAUTH2_CCS_ROP_PRECONFIGURED", "OAUTH2_CCS_ROP", "OAUTH2", "CCS_BASIC_AUTH", "CCS_API_KEY", "JDBC_OVER_SSL", "JDBC_OVER_SSL_WITH_OCI_SIGNATURE", "JDBC_BASIC_AUTH", "FA_OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "FA_OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "ORACLE_WALLET", "OCI_SIGNATURE_VERSION1", "SASLPLAIN", "SASLPLAIN_OVER_SSL", "SASLPLAIN_OVER_SSL_OSS", "TLS", "MUTUAL_TLS", "UIPATH_CLOUD", "OCI_OBO_TOKEN", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS", "JWT_USER_ASSERTION_FOR_OAUTH", "JWT_CLIENT_CREDENTIALS_ASSERTION_FOR_OAUTH", "OCI_SERVICE_INVOCATION" ]
• security-properties: array security-properties

{
    "type":"object",
    "properties":{
        "scope":{
            "$ref":"#/components/schemas/IntegrationRole"
        },
        "security-policy":{
            "$ref":"#/components/schemas/SecurityPolicy"
        },
        "security-properties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ConnectionPropertyRs"
            }
        }
    }
}

Nested Schema : security-properties

Type: array

Show Source

• Array of: object ConnectionPropertyRs

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

404 Response

Connection not found

409 Response

Connection is not configured

412 Response

Connection is locked

500 Response

Server error

Back to Top