Jump to

• Request
• Response
• Examples

Update a Project MCP Server

post

/ic/api/integration/v1/projects/{projectId}/mcp/servers/{id}

Updates a project MCP server connection or its stored metadata. Set the X-HTTP-Method-Override header to PATCH. The spec field accepts a JSON value; a nonblank string is parsed as JSON before storage. Invalid JSON text returns HTTP 400. The release implementation does not return an asynchronous work-request header.

Request

Path Parameters

• id(required): string
  MCP server code. The default backend version is 01.00.0000.

  Example:

  MCP_SERVER

• projectId(required): string
  Project identifier

  Example:

  MCP_PROJECT

Query Parameters

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

  Example:

  example-instance

Header Parameters

• X-HTTP-Method-Override(required): string
  Set to PATCH to update the resource using this POST operation.

  Example:

  PATCH

Supported Media Types

• application/json; charset=utf-8

Request Body - application/json; charset=utf-8 ()

Root Schema : schema

Type: object

Project MCP server resource. Same as ConnectionRs with the MCP spec payload.

Show Source

• adapter: adapter
  Adapter identity and capabilities.
• adapterType: adapterType
  Adapter identity and type.
• adminEmail: string
  Administrator's Email
• agentGroupId: string
  Agent Group Identifier
• agentRequired: boolean
  Agent Required
• agentSupported: boolean
  Agent Supported
• connectionProperties: array connectionProperties
  List of Connection Properties
• created: string (date-time)
  Created
• createdBy: string
  Created By
• description: string
  Description
• hasOverride: boolean
  hasOverride the Connection
• id: string
  Resource identifier.
• keywords: string
  Keywords
• lastRefreshedDate: string (date-time)
  Last Refresh Date
• lastUpdated: string (date-time)
  Last Updated
• lastUpdatedBy: string
  Last Updated By
• links: array links
  Links to related resources.
• lockedBy: string
  Locked By
• lockedDate: string (date-time)
  Locked Date
• lockedFlag: boolean
  Locked Flag
• metadataDownloadState: string
  Metadata Download State
• metadataDownloadSupportedFlag: boolean
  Metadata Download Supported Flag
• name: string
  Connection Name
• overrideProperties: overrideProperties
  Override Properties.
• percentageComplete: number
  Connection Completion Percentage
• privateEndpoint: boolean
  Private EndPoint
• privateEndpointSupported: boolean
  Private Endpoint Supported
• processingTime: number (float)
  Server-reported processing time.
• projectId: string
  Project identifier.
• projectName: string
  Project display name.
• refreshedStatus: string
  Refreshed Status
• role: string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]

  Adapter Integration Role
• scope: string
  Scope of the Connection
• securityPolicy: string
  Security Policy
• securityPolicyInfo: array securityPolicyInfo
  List of Security Policies
• securityProperties: array securityProperties
  List of Security Properties
• sharedFlag: boolean
  shared the Connection
• spec:
  Stored MCP server metadata as a JSON value. On update, nonblank string values must contain valid JSON and are parsed before storage. Empty or null values are treated as no supplied metadata.
• status: string
  Connection Status
• testStatus: boolean
  Test Status
• testWarnings: string
  Test Warning
• usage: integer (int32)
  Usage
• usageActive: integer (int32)
  Active Usage
• wsdlListDir: array wsdlListDir
  List of WSDL

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MCP2610_Link"
            },
            "description":"Links to related resources."
        },
        "processingTime":{
            "type":"number",
            "format":"float",
            "description":"Server-reported processing time."
        },
        "id":{
            "type":"string",
            "description":"Resource identifier."
        },
        "projectId":{
            "type":"string",
            "description":"Project identifier."
        },
        "projectName":{
            "type":"string",
            "description":"Project display name."
        },
        "connectionProperties":{
            "type":"array",
            "description":"List of Connection Properties",
            "items":{
                "$ref":"#/components/schemas/MCP2610_ConnectionPropertyRs"
            }
        },
        "securityProperties":{
            "type":"array",
            "description":"List of Security Properties",
            "items":{
                "$ref":"#/components/schemas/MCP2610_ConnectionPropertyRs"
            }
        },
        "securityPolicy":{
            "type":"string",
            "description":"Security Policy"
        },
        "name":{
            "type":"string",
            "description":"Connection Name"
        },
        "percentageComplete":{
            "type":"number",
            "description":"Connection Completion Percentage"
        },
        "status":{
            "type":"string",
            "description":"Connection Status"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"Last Updated By"
        },
        "lastUpdated":{
            "type":"string",
            "description":"Last Updated",
            "format":"date-time"
        },
        "agentGroupId":{
            "type":"string",
            "description":"Agent Group Identifier"
        },
        "role":{
            "type":"string",
            "description":"Adapter Integration Role",
            "enum":[
                "SOURCE",
                "TARGET",
                "SOURCE_AND_TARGET"
            ]
        },
        "lockedFlag":{
            "type":"boolean",
            "description":"Locked Flag"
        },
        "description":{
            "type":"string",
            "description":"Description"
        },
        "created":{
            "type":"string",
            "description":"Created",
            "format":"date-time"
        },
        "createdBy":{
            "type":"string",
            "description":"Created By"
        },
        "adapter":{
            "description":"Adapter identity and capabilities.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/MCP2610_AdapterTypeRs"
                }
            ]
        },
        "usageActive":{
            "type":"integer",
            "description":"Active Usage",
            "format":"int32"
        },
        "adminEmail":{
            "type":"string",
            "description":"Administrator's Email"
        },
        "metadataDownloadSupportedFlag":{
            "type":"boolean",
            "description":"Metadata Download Supported Flag"
        },
        "metadataDownloadState":{
            "type":"string",
            "description":"Metadata Download State"
        },
        "securityPolicyInfo":{
            "type":"array",
            "description":"List of Security Policies",
            "items":{
                "$ref":"#/components/schemas/MCP2610_SecurityPolicyInfoRs"
            }
        },
        "agentSupported":{
            "type":"boolean",
            "description":"Agent Supported"
        },
        "agentRequired":{
            "type":"boolean",
            "description":"Agent Required"
        },
        "wsdlListDir":{
            "type":"array",
            "description":"List of WSDL",
            "items":{
                "type":"string",
                "description":"List of WSDL"
            }
        },
        "testStatus":{
            "type":"boolean",
            "description":"Test Status"
        },
        "lockedBy":{
            "type":"string",
            "description":"Locked By"
        },
        "lockedDate":{
            "type":"string",
            "description":"Locked Date",
            "format":"date-time"
        },
        "lastRefreshedDate":{
            "type":"string",
            "description":"Last Refresh Date",
            "format":"date-time"
        },
        "refreshedStatus":{
            "type":"string",
            "description":"Refreshed Status"
        },
        "keywords":{
            "type":"string",
            "description":"Keywords"
        },
        "privateEndpointSupported":{
            "type":"boolean",
            "description":"Private Endpoint Supported"
        },
        "privateEndpoint":{
            "type":"boolean",
            "description":"Private EndPoint"
        },
        "testWarnings":{
            "type":"string",
            "description":"Test Warning"
        },
        "scope":{
            "type":"string",
            "description":"Scope of the Connection"
        },
        "hasOverride":{
            "type":"boolean",
            "description":"hasOverride the Connection"
        },
        "overrideProperties":{
            "description":"Override Properties.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/OverridePropertiesRs"
                }
            ]
        },
        "sharedFlag":{
            "type":"boolean",
            "description":"shared the Connection"
        },
        "spec":{
            "description":"Stored MCP server metadata as a JSON value. On update, nonblank string values must contain valid JSON and are parsed before storage. Empty or null values are treated as no supplied metadata."
        },
        "adapterType":{
            "description":"Adapter identity and type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/MCP2610_AdapterTypeBaseRs"
                }
            ]
        },
        "usage":{
            "type":"integer",
            "description":"Usage",
            "format":"int32"
        }
    },
    "description":"Project MCP server resource. Same as ConnectionRs with the MCP spec payload."
}

Nested Schema : adapter

Adapter identity and capabilities.

Match All

Adapter identity and capabilities.

Show Source

• object MCP2610_AdapterTypeRs
  Adapter

{
    "description":"Adapter identity and capabilities.",
    "allOf":[
        {
            "$ref":"#/components/schemas/MCP2610_AdapterTypeRs"
        }
    ]
}

Nested Schema : adapterType

Adapter identity and type.

Match All

Adapter identity and type.

Show Source

• object MCP2610_AdapterTypeBaseRs
  Adapter identity and display metadata.

{
    "description":"Adapter identity and type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/MCP2610_AdapterTypeBaseRs"
        }
    ]
}

Nested Schema : connectionProperties

Type: array

List of Connection Properties

Show Source

• Array of: object MCP2610_ConnectionPropertyRs
  A connection or security property, including its value, validation metadata, and optional attachment.

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

Nested Schema : links

Type: array

Links to related resources.

Show Source

• Array of: object MCP2610_Link
  A link to a related REST resource.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MCP2610_Link"
    },
    "description":"Links to related resources."
}

Nested Schema : overrideProperties

Override Properties.

Match All

Override Properties.

Show Source

• object OverridePropertiesRs
  Project-specific connection override metadata.

{
    "description":"Override Properties.",
    "allOf":[
        {
            "$ref":"#/components/schemas/OverridePropertiesRs"
        }
    ]
}

Nested Schema : securityPolicyInfo

Type: array

List of Security Policies

Show Source

• Array of: object MCP2610_SecurityPolicyInfoRs
  Connection authentication policy and its security properties.

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

Nested Schema : securityProperties

Type: array

List of Security Properties

Show Source

• Array of: object MCP2610_ConnectionPropertyRs
  A connection or security property, including its value, validation metadata, and optional attachment.

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

Nested Schema : wsdlListDir

Type: array

List of WSDL

Show Source

• Array of: string
  List of WSDL

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

Nested Schema : MCP2610_AdapterTypeRs

Type: object

Adapter

Show Source

• allowedDomains: array allowedDomains
  Allowed Domains.
• customSecurityPolicyDescription: string
  Custom Security Policy Description.
• defaultSecurityPolicies: string
  Default Security Policies.
• description: string
  Resource description.
• displayName: string
  Display Name.
• features: string
  Features.
• genericAuthSupport: array genericAuthSupport
  Generic Auth Support.
• icons: icons
  Adapter icon URLs.
• id: string
  Resource identifier.
• infoMessage: string
  Info Message.
• integrationRole: string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]

  Integration Role.
• links: array links
  Links to related resources.
• name: string
  Resource display name.
• oauth3LeggedSupport: array oauth3LeggedSupport
  Oauth3 Legged Support.
• otherVersions: string
  Other Versions.
• supportedSecurityPolicies: string
  Supported Security Policies.
• testKey: string
  Test Key.
• testMessage: string
  Test Message.
• type: string
  Type.
• validateAndTestKey: string
  Validate And Test Key.
• validateAndTestMessage: string
  Validate And Test Message.
• vendorInfo: vendorInfo
  Adapter vendor information.
• version: string
  Resource version.
• wsdlvalidation: boolean
  Wsdlvalidation.

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MCP2610_SuiteLink"
            },
            "description":"Links to related resources."
        },
        "id":{
            "type":"string",
            "description":"Resource identifier."
        },
        "name":{
            "type":"string",
            "description":"Resource display name."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name."
        },
        "type":{
            "type":"string",
            "description":"Type."
        },
        "supportedSecurityPolicies":{
            "type":"string",
            "description":"Supported Security Policies."
        },
        "defaultSecurityPolicies":{
            "type":"string",
            "description":"Default Security Policies."
        },
        "features":{
            "type":"string",
            "description":"Features."
        },
        "version":{
            "type":"string",
            "description":"Resource version."
        },
        "description":{
            "type":"string",
            "description":"Resource description."
        },
        "integrationRole":{
            "type":"string",
            "enum":[
                "SOURCE",
                "TARGET",
                "SOURCE_AND_TARGET"
            ],
            "description":"Integration Role."
        },
        "vendorInfo":{
            "description":"Adapter vendor information.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/MCP2610_AdapterVendorInfo"
                }
            ]
        },
        "icons":{
            "description":"Adapter icon URLs.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/MCP2610_AdapterIconsRs"
                }
            ]
        },
        "wsdlvalidation":{
            "type":"boolean",
            "description":"Wsdlvalidation."
        },
        "testKey":{
            "type":"string",
            "description":"Test Key."
        },
        "validateAndTestKey":{
            "type":"string",
            "description":"Validate And Test Key."
        },
        "testMessage":{
            "type":"string",
            "description":"Test Message."
        },
        "validateAndTestMessage":{
            "type":"string",
            "description":"Validate And Test Message."
        },
        "infoMessage":{
            "type":"string",
            "description":"Info Message."
        },
        "genericAuthSupport":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Authentication policy identifier provided by the adapter."
            },
            "description":"Generic Auth Support."
        },
        "customSecurityPolicyDescription":{
            "type":"string",
            "description":"Custom Security Policy Description."
        },
        "otherVersions":{
            "type":"string",
            "description":"Other Versions."
        },
        "allowedDomains":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Allowed Domains."
        },
        "oauth3LeggedSupport":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Authentication policy identifier provided by the adapter."
            },
            "description":"Oauth3 Legged Support."
        }
    },
    "description":"Adapter"
}

Nested Schema : allowedDomains

Type: array

Allowed Domains.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Allowed Domains."
}

Nested Schema : genericAuthSupport

Type: array

Generic Auth Support.

Show Source

• Array of: string
  Authentication policy identifier provided by the adapter.

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Authentication policy identifier provided by the adapter."
    },
    "description":"Generic Auth Support."
}

Nested Schema : icons

Adapter icon URLs.

Match All

Adapter icon URLs.

Show Source

• object MCP2610_AdapterIconsRs
  Icon URLs associated with an adapter.

{
    "description":"Adapter icon URLs.",
    "allOf":[
        {
            "$ref":"#/components/schemas/MCP2610_AdapterIconsRs"
        }
    ]
}

Nested Schema : links

Type: array

Links to related resources.

Show Source

• Array of: object MCP2610_SuiteLink
  A link to a related REST resource, including its HTTP method when supplied.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MCP2610_SuiteLink"
    },
    "description":"Links to related resources."
}

Nested Schema : oauth3LeggedSupport

Type: array

Oauth3 Legged Support.

Show Source

• Array of: string
  Authentication policy identifier provided by the adapter.

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Authentication policy identifier provided by the adapter."
    },
    "description":"Oauth3 Legged Support."
}

Nested Schema : vendorInfo

Adapter vendor information.

Match All

Adapter vendor information.

Show Source

• object MCP2610_AdapterVendorInfo
  Vendor and documentation details for an adapter.

{
    "description":"Adapter vendor information.",
    "allOf":[
        {
            "$ref":"#/components/schemas/MCP2610_AdapterVendorInfo"
        }
    ]
}

Nested Schema : MCP2610_AdapterIconsRs

Type: object

Icon URLs associated with an adapter.

Show Source

• largeIconUrl: string
  Large Icon Url.
• mediumGrayIconUrl: string
  Medium Gray Icon Url.
• mediumIconUrl: string
  Medium Icon Url.
• mediumWhiteIconUrl: string
  Medium White Icon Url.
• smallIconUrl: string
  Small Icon Url.

{
    "type":"object",
    "properties":{
        "smallIconUrl":{
            "type":"string",
            "description":"Small Icon Url."
        },
        "mediumIconUrl":{
            "type":"string",
            "description":"Medium Icon Url."
        },
        "largeIconUrl":{
            "type":"string",
            "description":"Large Icon Url."
        },
        "mediumGrayIconUrl":{
            "type":"string",
            "description":"Medium Gray Icon Url."
        },
        "mediumWhiteIconUrl":{
            "type":"string",
            "description":"Medium White Icon Url."
        }
    },
    "description":"Icon URLs associated with an adapter."
}

Nested Schema : MCP2610_SuiteLink

Type: object

A link to a related REST resource, including its HTTP method when supplied.

Show Source

• href: string
  URL of the linked resource.
• mediaType: string
  Media type of the linked resource.
• method: string
  HTTP method for the link.
• rel: string
  Relationship of the linked resource.

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relationship of the linked resource."
        },
        "href":{
            "type":"string",
            "description":"URL of the linked resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type of the linked resource."
        },
        "method":{
            "type":"string",
            "description":"HTTP method for the link."
        }
    },
    "description":"A link to a related REST resource, including its HTTP method when supplied."
}

Nested Schema : MCP2610_AdapterVendorInfo

Type: object

Vendor and documentation details for an adapter.

Show Source

• contactUS: string
  Contact US.
• description: string
  Resource description.
• documentationURL: string
  Documentation URL.
• name: string
  Resource display name.
• releaseNotes: string
  Release Notes.
• supportURL: string
  Support URL.

{
    "type":"object",
    "properties":{
        "supportURL":{
            "type":"string",
            "description":"Support URL."
        },
        "name":{
            "type":"string",
            "description":"Resource display name."
        },
        "description":{
            "type":"string",
            "description":"Resource description."
        },
        "contactUS":{
            "type":"string",
            "description":"Contact US."
        },
        "documentationURL":{
            "type":"string",
            "description":"Documentation URL."
        },
        "releaseNotes":{
            "type":"string",
            "description":"Release Notes."
        }
    },
    "description":"Vendor and documentation details for an adapter."
}

Nested Schema : MCP2610_AdapterTypeBaseRs

Type: object

Adapter identity and display metadata.

Show Source

• displayName: string
  Display Name.
• id: string
  Resource identifier.
• links: array links
  Links to related resources.
• name: string
  Resource display name.
• type: string
  Type.

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MCP2610_SuiteLink"
            },
            "description":"Links to related resources."
        },
        "id":{
            "type":"string",
            "description":"Resource identifier."
        },
        "name":{
            "type":"string",
            "description":"Resource display name."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name."
        },
        "type":{
            "type":"string",
            "description":"Type."
        }
    },
    "description":"Adapter identity and display metadata."
}

Nested Schema : links

Type: array

Links to related resources.

Show Source

• Array of: object MCP2610_SuiteLink
  A link to a related REST resource, including its HTTP method when supplied.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MCP2610_SuiteLink"
    },
    "description":"Links to related resources."
}

Nested Schema : MCP2610_ConnectionPropertyRs

Type: object

A connection or security property, including its value, validation metadata, and optional attachment.

Show Source

• acceptableKeys: array acceptableKeys
  Permitted values for the adapter property.
• attachment: attachment
  Attachment associated with this connection property.
• defaultPropertyValue: string
  Default Property Value.
• displayName: string
  Display Name.
• hasAttachment: boolean
  Has Attachment.
• hiddenFlag: boolean
  Hidden Flag.
• integrationRole: string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]

  Integration Role.
• propertyDescription: string
  Property Description.
• propertyGroup: string
  Allowed Values: [ "CREDENTIALS", "SOURCE_ARTIFACTS", "CONNECTION_PROPS", "CUSTOM", "OTHER" ]

  Property Group.
• propertyName: string
  Property Name.
• propertyShortDesc: string
  Property Short Desc.
• 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" ]

  Property Type.
• propertyValue: string
  Property Value.
• requiredFlag: boolean
  Required Flag.

{
    "type":"object",
    "properties":{
        "propertyName":{
            "type":"string",
            "description":"Property Name."
        },
        "propertyValue":{
            "type":"string",
            "description":"Property Value."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name."
        },
        "requiredFlag":{
            "type":"boolean",
            "description":"Required Flag."
        },
        "hiddenFlag":{
            "type":"boolean",
            "description":"Hidden Flag."
        },
        "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"
            ],
            "description":"Property Type."
        },
        "propertyGroup":{
            "type":"string",
            "enum":[
                "CREDENTIALS",
                "SOURCE_ARTIFACTS",
                "CONNECTION_PROPS",
                "CUSTOM",
                "OTHER"
            ],
            "description":"Property Group."
        },
        "integrationRole":{
            "type":"string",
            "enum":[
                "SOURCE",
                "TARGET",
                "SOURCE_AND_TARGET"
            ],
            "description":"Integration Role."
        },
        "acceptableKeys":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MCP2610_AdapterKey"
            },
            "description":"Permitted values for the adapter property."
        },
        "attachment":{
            "description":"Attachment associated with this connection property.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/MCP2610_ConnectionAttachmentRs"
                }
            ]
        },
        "hasAttachment":{
            "type":"boolean",
            "description":"Has Attachment."
        },
        "propertyDescription":{
            "type":"string",
            "description":"Property Description."
        },
        "propertyShortDesc":{
            "type":"string",
            "description":"Property Short Desc."
        },
        "defaultPropertyValue":{
            "type":"string",
            "description":"Default Property Value."
        }
    },
    "description":"A connection or security property, including its value, validation metadata, and optional attachment."
}

Nested Schema : acceptableKeys

Type: array

Permitted values for the adapter property.

Show Source

• Array of: object MCP2610_AdapterKey
  An acceptable adapter property value and its integration-role scope.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MCP2610_AdapterKey"
    },
    "description":"Permitted values for the adapter property."
}

Nested Schema : attachment

Attachment associated with this connection property.

Match All

Attachment associated with this connection property.

Show Source

• object MCP2610_ConnectionAttachmentRs
  Connection attachment and the property to which it belongs.

{
    "description":"Attachment associated with this connection property.",
    "allOf":[
        {
            "$ref":"#/components/schemas/MCP2610_ConnectionAttachmentRs"
        }
    ]
}

Nested Schema : MCP2610_AdapterKey

Type: object

An acceptable adapter property value and its integration-role scope.

Show Source

• displayName: string
  Display Name.
• keyName: string
  Key Name.
• scope: string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]

  Integration-role scope.

{
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string",
            "description":"Display Name."
        },
        "keyName":{
            "type":"string",
            "description":"Key Name."
        },
        "scope":{
            "type":"string",
            "enum":[
                "SOURCE",
                "TARGET",
                "SOURCE_AND_TARGET"
            ],
            "description":"Integration-role scope."
        }
    },
    "description":"An acceptable adapter property value and its integration-role scope."
}

Nested Schema : MCP2610_ConnectionAttachmentRs

Type: object

Connection attachment and the property to which it belongs.

Show Source

• attachment: attachment
  Attachment associated with this connection property.
• attachmentName: string
  Attachment Name.
• propertyName: string
  Property Name.
• signature: string
  Signature.

{
    "type":"object",
    "properties":{
        "attachment":{
            "description":"Attachment associated with this connection property.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/MCP2610_BaseAttachmentRs"
                }
            ]
        },
        "propertyName":{
            "type":"string",
            "description":"Property Name."
        },
        "attachmentName":{
            "type":"string",
            "description":"Attachment Name."
        },
        "signature":{
            "type":"string",
            "description":"Signature."
        }
    },
    "description":"Connection attachment and the property to which it belongs."
}

Nested Schema : attachment

Attachment associated with this connection property.

Match All

Attachment associated with this connection property.

Show Source

• object MCP2610_BaseAttachmentRs
  Attachment metadata and content associated with a connection property.

{
    "description":"Attachment associated with this connection property.",
    "allOf":[
        {
            "$ref":"#/components/schemas/MCP2610_BaseAttachmentRs"
        }
    ]
}

Nested Schema : MCP2610_BaseAttachmentRs

Type: object

Attachment metadata and content associated with a connection property.

Show Source

• attachmentName: string
  Attachment Name.
• content: string
  Content.
• localFilePath: string
  Local File Path.
• propertyName: string
  Property Name.
• signature: string
  Signature.

{
    "type":"object",
    "properties":{
        "propertyName":{
            "type":"string",
            "description":"Property Name."
        },
        "attachmentName":{
            "type":"string",
            "description":"Attachment Name."
        },
        "content":{
            "type":"string",
            "description":"Content."
        },
        "localFilePath":{
            "type":"string",
            "description":"Local File Path."
        },
        "signature":{
            "type":"string",
            "description":"Signature."
        }
    },
    "description":"Attachment metadata and content associated with a connection property."
}

Nested Schema : MCP2610_Link

Type: object

A link to a related REST resource.

Show Source

• href: string
  URL of the linked resource.
• mediaType: string
  Media type of the linked resource.
• rel: string
  Relationship of the linked resource.

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relationship of the linked resource."
        },
        "href":{
            "type":"string",
            "description":"URL of the linked resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type of the linked resource."
        }
    },
    "description":"A link to a related REST resource."
}

Nested Schema : OverridePropertiesRs

Type: object

Project-specific connection override metadata.

Show Source

• code: string
  Resource code.
• name: string
  Resource display name.
• projectCode: string
  Project Code.
• status: string
  Current resource state.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Resource code."
        },
        "projectCode":{
            "type":"string",
            "description":"Project Code."
        },
        "name":{
            "type":"string",
            "description":"Resource display name."
        },
        "status":{
            "type":"string",
            "description":"Current resource state."
        }
    },
    "description":"Project-specific connection override metadata."
}

Nested Schema : MCP2610_SecurityPolicyInfoRs

Type: object

Connection authentication policy and its security properties.

Show Source

• scope: string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]

  Integration-role scope.
• securityPolicy: string
  Security Policy.
• securityProperties: array securityProperties
  Security Properties.

{
    "type":"object",
    "properties":{
        "securityPolicy":{
            "type":"string",
            "description":"Security Policy."
        },
        "securityProperties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MCP2610_ConnectionPropertyRs"
            },
            "description":"Security Properties."
        },
        "scope":{
            "type":"string",
            "enum":[
                "SOURCE",
                "TARGET",
                "SOURCE_AND_TARGET"
            ],
            "description":"Integration-role scope."
        }
    },
    "description":"Connection authentication policy and its security properties."
}

Nested Schema : securityProperties

Type: array

Security Properties.

Show Source

• Array of: object MCP2610_ConnectionPropertyRs
  A connection or security property, including its value, validation metadata, and optional attachment.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MCP2610_ConnectionPropertyRs"
    },
    "description":"Security Properties."
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.model+json;type=singular
• application/json; charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Project MCP server resource. Same as ConnectionRs with the MCP spec payload.

Show Source

• adapter: adapter
  Adapter identity and capabilities.
• adapterType: adapterType
  Adapter identity and type.
• adminEmail: string
  Administrator's Email
• agentGroupId: string
  Agent Group Identifier
• agentRequired: boolean
  Agent Required
• agentSupported: boolean
  Agent Supported
• connectionProperties: array connectionProperties
  List of Connection Properties
• created: string (date-time)
  Created
• createdBy: string
  Created By
• description: string
  Description
• hasOverride: boolean
  hasOverride the Connection
• id: string
  Resource identifier.
• keywords: string
  Keywords
• lastRefreshedDate: string (date-time)
  Last Refresh Date
• lastUpdated: string (date-time)
  Last Updated
• lastUpdatedBy: string
  Last Updated By
• links: array links
  Links to related resources.
• lockedBy: string
  Locked By
• lockedDate: string (date-time)
  Locked Date
• lockedFlag: boolean
  Locked Flag
• metadataDownloadState: string
  Metadata Download State
• metadataDownloadSupportedFlag: boolean
  Metadata Download Supported Flag
• name: string
  Connection Name
• overrideProperties: overrideProperties
  Override Properties.
• percentageComplete: number
  Connection Completion Percentage
• privateEndpoint: boolean
  Private EndPoint
• privateEndpointSupported: boolean
  Private Endpoint Supported
• processingTime: number (float)
  Server-reported processing time.
• projectId: string
  Project identifier.
• projectName: string
  Project display name.
• refreshedStatus: string
  Refreshed Status
• role: string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]

  Adapter Integration Role
• scope: string
  Scope of the Connection
• securityPolicy: string
  Security Policy
• securityPolicyInfo: array securityPolicyInfo
  List of Security Policies
• securityProperties: array securityProperties
  List of Security Properties
• sharedFlag: boolean
  shared the Connection
• spec:
  Stored MCP server metadata as a JSON value. On update, nonblank string values must contain valid JSON and are parsed before storage. Empty or null values are treated as no supplied metadata.
• status: string
  Connection Status
• testStatus: boolean
  Test Status
• testWarnings: string
  Test Warning
• usage: integer (int32)
  Usage
• usageActive: integer (int32)
  Active Usage
• wsdlListDir: array wsdlListDir
  List of WSDL

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MCP2610_Link"
            },
            "description":"Links to related resources."
        },
        "processingTime":{
            "type":"number",
            "format":"float",
            "description":"Server-reported processing time."
        },
        "id":{
            "type":"string",
            "description":"Resource identifier."
        },
        "projectId":{
            "type":"string",
            "description":"Project identifier."
        },
        "projectName":{
            "type":"string",
            "description":"Project display name."
        },
        "connectionProperties":{
            "type":"array",
            "description":"List of Connection Properties",
            "items":{
                "$ref":"#/components/schemas/MCP2610_ConnectionPropertyRs"
            }
        },
        "securityProperties":{
            "type":"array",
            "description":"List of Security Properties",
            "items":{
                "$ref":"#/components/schemas/MCP2610_ConnectionPropertyRs"
            }
        },
        "securityPolicy":{
            "type":"string",
            "description":"Security Policy"
        },
        "name":{
            "type":"string",
            "description":"Connection Name"
        },
        "percentageComplete":{
            "type":"number",
            "description":"Connection Completion Percentage"
        },
        "status":{
            "type":"string",
            "description":"Connection Status"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"Last Updated By"
        },
        "lastUpdated":{
            "type":"string",
            "description":"Last Updated",
            "format":"date-time"
        },
        "agentGroupId":{
            "type":"string",
            "description":"Agent Group Identifier"
        },
        "role":{
            "type":"string",
            "description":"Adapter Integration Role",
            "enum":[
                "SOURCE",
                "TARGET",
                "SOURCE_AND_TARGET"
            ]
        },
        "lockedFlag":{
            "type":"boolean",
            "description":"Locked Flag"
        },
        "description":{
            "type":"string",
            "description":"Description"
        },
        "created":{
            "type":"string",
            "description":"Created",
            "format":"date-time"
        },
        "createdBy":{
            "type":"string",
            "description":"Created By"
        },
        "adapter":{
            "description":"Adapter identity and capabilities.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/MCP2610_AdapterTypeRs"
                }
            ]
        },
        "usageActive":{
            "type":"integer",
            "description":"Active Usage",
            "format":"int32"
        },
        "adminEmail":{
            "type":"string",
            "description":"Administrator's Email"
        },
        "metadataDownloadSupportedFlag":{
            "type":"boolean",
            "description":"Metadata Download Supported Flag"
        },
        "metadataDownloadState":{
            "type":"string",
            "description":"Metadata Download State"
        },
        "securityPolicyInfo":{
            "type":"array",
            "description":"List of Security Policies",
            "items":{
                "$ref":"#/components/schemas/MCP2610_SecurityPolicyInfoRs"
            }
        },
        "agentSupported":{
            "type":"boolean",
            "description":"Agent Supported"
        },
        "agentRequired":{
            "type":"boolean",
            "description":"Agent Required"
        },
        "wsdlListDir":{
            "type":"array",
            "description":"List of WSDL",
            "items":{
                "type":"string",
                "description":"List of WSDL"
            }
        },
        "testStatus":{
            "type":"boolean",
            "description":"Test Status"
        },
        "lockedBy":{
            "type":"string",
            "description":"Locked By"
        },
        "lockedDate":{
            "type":"string",
            "description":"Locked Date",
            "format":"date-time"
        },
        "lastRefreshedDate":{
            "type":"string",
            "description":"Last Refresh Date",
            "format":"date-time"
        },
        "refreshedStatus":{
            "type":"string",
            "description":"Refreshed Status"
        },
        "keywords":{
            "type":"string",
            "description":"Keywords"
        },
        "privateEndpointSupported":{
            "type":"boolean",
            "description":"Private Endpoint Supported"
        },
        "privateEndpoint":{
            "type":"boolean",
            "description":"Private EndPoint"
        },
        "testWarnings":{
            "type":"string",
            "description":"Test Warning"
        },
        "scope":{
            "type":"string",
            "description":"Scope of the Connection"
        },
        "hasOverride":{
            "type":"boolean",
            "description":"hasOverride the Connection"
        },
        "overrideProperties":{
            "description":"Override Properties.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/OverridePropertiesRs"
                }
            ]
        },
        "sharedFlag":{
            "type":"boolean",
            "description":"shared the Connection"
        },
        "spec":{
            "description":"Stored MCP server metadata as a JSON value. On update, nonblank string values must contain valid JSON and are parsed before storage. Empty or null values are treated as no supplied metadata."
        },
        "adapterType":{
            "description":"Adapter identity and type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/MCP2610_AdapterTypeBaseRs"
                }
            ]
        },
        "usage":{
            "type":"integer",
            "description":"Usage",
            "format":"int32"
        }
    },
    "description":"Project MCP server resource. Same as ConnectionRs with the MCP spec payload."
}

Nested Schema : adapter

Adapter identity and capabilities.

Match All

Adapter identity and capabilities.

Show Source

• object MCP2610_AdapterTypeRs
  Adapter

{
    "description":"Adapter identity and capabilities.",
    "allOf":[
        {
            "$ref":"#/components/schemas/MCP2610_AdapterTypeRs"
        }
    ]
}

Nested Schema : adapterType

Adapter identity and type.

Match All

Adapter identity and type.

Show Source

• object MCP2610_AdapterTypeBaseRs
  Adapter identity and display metadata.

{
    "description":"Adapter identity and type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/MCP2610_AdapterTypeBaseRs"
        }
    ]
}

Nested Schema : connectionProperties

Type: array

List of Connection Properties

Show Source

• Array of: object MCP2610_ConnectionPropertyRs
  A connection or security property, including its value, validation metadata, and optional attachment.

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

Nested Schema : links

Type: array

Links to related resources.

Show Source

• Array of: object MCP2610_Link
  A link to a related REST resource.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MCP2610_Link"
    },
    "description":"Links to related resources."
}

Nested Schema : overrideProperties

Override Properties.

Match All

Override Properties.

Show Source

• object OverridePropertiesRs
  Project-specific connection override metadata.

{
    "description":"Override Properties.",
    "allOf":[
        {
            "$ref":"#/components/schemas/OverridePropertiesRs"
        }
    ]
}

Nested Schema : securityPolicyInfo

Type: array

List of Security Policies

Show Source

• Array of: object MCP2610_SecurityPolicyInfoRs
  Connection authentication policy and its security properties.

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

Nested Schema : securityProperties

Type: array

List of Security Properties

Show Source

• Array of: object MCP2610_ConnectionPropertyRs
  A connection or security property, including its value, validation metadata, and optional attachment.

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

Nested Schema : wsdlListDir

Type: array

List of WSDL

Show Source

• Array of: string
  List of WSDL

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

Nested Schema : MCP2610_AdapterTypeRs

Type: object

Adapter

Show Source

• allowedDomains: array allowedDomains
  Allowed Domains.
• customSecurityPolicyDescription: string
  Custom Security Policy Description.
• defaultSecurityPolicies: string
  Default Security Policies.
• description: string
  Resource description.
• displayName: string
  Display Name.
• features: string
  Features.
• genericAuthSupport: array genericAuthSupport
  Generic Auth Support.
• icons: icons
  Adapter icon URLs.
• id: string
  Resource identifier.
• infoMessage: string
  Info Message.
• integrationRole: string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]

  Integration Role.
• links: array links
  Links to related resources.
• name: string
  Resource display name.
• oauth3LeggedSupport: array oauth3LeggedSupport
  Oauth3 Legged Support.
• otherVersions: string
  Other Versions.
• supportedSecurityPolicies: string
  Supported Security Policies.
• testKey: string
  Test Key.
• testMessage: string
  Test Message.
• type: string
  Type.
• validateAndTestKey: string
  Validate And Test Key.
• validateAndTestMessage: string
  Validate And Test Message.
• vendorInfo: vendorInfo
  Adapter vendor information.
• version: string
  Resource version.
• wsdlvalidation: boolean
  Wsdlvalidation.

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MCP2610_SuiteLink"
            },
            "description":"Links to related resources."
        },
        "id":{
            "type":"string",
            "description":"Resource identifier."
        },
        "name":{
            "type":"string",
            "description":"Resource display name."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name."
        },
        "type":{
            "type":"string",
            "description":"Type."
        },
        "supportedSecurityPolicies":{
            "type":"string",
            "description":"Supported Security Policies."
        },
        "defaultSecurityPolicies":{
            "type":"string",
            "description":"Default Security Policies."
        },
        "features":{
            "type":"string",
            "description":"Features."
        },
        "version":{
            "type":"string",
            "description":"Resource version."
        },
        "description":{
            "type":"string",
            "description":"Resource description."
        },
        "integrationRole":{
            "type":"string",
            "enum":[
                "SOURCE",
                "TARGET",
                "SOURCE_AND_TARGET"
            ],
            "description":"Integration Role."
        },
        "vendorInfo":{
            "description":"Adapter vendor information.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/MCP2610_AdapterVendorInfo"
                }
            ]
        },
        "icons":{
            "description":"Adapter icon URLs.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/MCP2610_AdapterIconsRs"
                }
            ]
        },
        "wsdlvalidation":{
            "type":"boolean",
            "description":"Wsdlvalidation."
        },
        "testKey":{
            "type":"string",
            "description":"Test Key."
        },
        "validateAndTestKey":{
            "type":"string",
            "description":"Validate And Test Key."
        },
        "testMessage":{
            "type":"string",
            "description":"Test Message."
        },
        "validateAndTestMessage":{
            "type":"string",
            "description":"Validate And Test Message."
        },
        "infoMessage":{
            "type":"string",
            "description":"Info Message."
        },
        "genericAuthSupport":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Authentication policy identifier provided by the adapter."
            },
            "description":"Generic Auth Support."
        },
        "customSecurityPolicyDescription":{
            "type":"string",
            "description":"Custom Security Policy Description."
        },
        "otherVersions":{
            "type":"string",
            "description":"Other Versions."
        },
        "allowedDomains":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Allowed Domains."
        },
        "oauth3LeggedSupport":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Authentication policy identifier provided by the adapter."
            },
            "description":"Oauth3 Legged Support."
        }
    },
    "description":"Adapter"
}

Nested Schema : allowedDomains

Type: array

Allowed Domains.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Allowed Domains."
}

Nested Schema : genericAuthSupport

Type: array

Generic Auth Support.

Show Source

• Array of: string
  Authentication policy identifier provided by the adapter.

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Authentication policy identifier provided by the adapter."
    },
    "description":"Generic Auth Support."
}

Nested Schema : icons

Adapter icon URLs.

Match All

Adapter icon URLs.

Show Source

• object MCP2610_AdapterIconsRs
  Icon URLs associated with an adapter.

{
    "description":"Adapter icon URLs.",
    "allOf":[
        {
            "$ref":"#/components/schemas/MCP2610_AdapterIconsRs"
        }
    ]
}

Nested Schema : links

Type: array

Links to related resources.

Show Source

• Array of: object MCP2610_SuiteLink
  A link to a related REST resource, including its HTTP method when supplied.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MCP2610_SuiteLink"
    },
    "description":"Links to related resources."
}

Nested Schema : oauth3LeggedSupport

Type: array

Oauth3 Legged Support.

Show Source

• Array of: string
  Authentication policy identifier provided by the adapter.

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Authentication policy identifier provided by the adapter."
    },
    "description":"Oauth3 Legged Support."
}

Nested Schema : vendorInfo

Adapter vendor information.

Match All

Adapter vendor information.

Show Source

• object MCP2610_AdapterVendorInfo
  Vendor and documentation details for an adapter.

{
    "description":"Adapter vendor information.",
    "allOf":[
        {
            "$ref":"#/components/schemas/MCP2610_AdapterVendorInfo"
        }
    ]
}

Nested Schema : MCP2610_AdapterIconsRs

Type: object

Icon URLs associated with an adapter.

Show Source

• largeIconUrl: string
  Large Icon Url.
• mediumGrayIconUrl: string
  Medium Gray Icon Url.
• mediumIconUrl: string
  Medium Icon Url.
• mediumWhiteIconUrl: string
  Medium White Icon Url.
• smallIconUrl: string
  Small Icon Url.

{
    "type":"object",
    "properties":{
        "smallIconUrl":{
            "type":"string",
            "description":"Small Icon Url."
        },
        "mediumIconUrl":{
            "type":"string",
            "description":"Medium Icon Url."
        },
        "largeIconUrl":{
            "type":"string",
            "description":"Large Icon Url."
        },
        "mediumGrayIconUrl":{
            "type":"string",
            "description":"Medium Gray Icon Url."
        },
        "mediumWhiteIconUrl":{
            "type":"string",
            "description":"Medium White Icon Url."
        }
    },
    "description":"Icon URLs associated with an adapter."
}

Nested Schema : MCP2610_SuiteLink

Type: object

A link to a related REST resource, including its HTTP method when supplied.

Show Source

• href: string
  URL of the linked resource.
• mediaType: string
  Media type of the linked resource.
• method: string
  HTTP method for the link.
• rel: string
  Relationship of the linked resource.

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relationship of the linked resource."
        },
        "href":{
            "type":"string",
            "description":"URL of the linked resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type of the linked resource."
        },
        "method":{
            "type":"string",
            "description":"HTTP method for the link."
        }
    },
    "description":"A link to a related REST resource, including its HTTP method when supplied."
}

Nested Schema : MCP2610_AdapterVendorInfo

Type: object

Vendor and documentation details for an adapter.

Show Source

• contactUS: string
  Contact US.
• description: string
  Resource description.
• documentationURL: string
  Documentation URL.
• name: string
  Resource display name.
• releaseNotes: string
  Release Notes.
• supportURL: string
  Support URL.

{
    "type":"object",
    "properties":{
        "supportURL":{
            "type":"string",
            "description":"Support URL."
        },
        "name":{
            "type":"string",
            "description":"Resource display name."
        },
        "description":{
            "type":"string",
            "description":"Resource description."
        },
        "contactUS":{
            "type":"string",
            "description":"Contact US."
        },
        "documentationURL":{
            "type":"string",
            "description":"Documentation URL."
        },
        "releaseNotes":{
            "type":"string",
            "description":"Release Notes."
        }
    },
    "description":"Vendor and documentation details for an adapter."
}

Nested Schema : MCP2610_AdapterTypeBaseRs

Type: object

Adapter identity and display metadata.

Show Source

• displayName: string
  Display Name.
• id: string
  Resource identifier.
• links: array links
  Links to related resources.
• name: string
  Resource display name.
• type: string
  Type.

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MCP2610_SuiteLink"
            },
            "description":"Links to related resources."
        },
        "id":{
            "type":"string",
            "description":"Resource identifier."
        },
        "name":{
            "type":"string",
            "description":"Resource display name."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name."
        },
        "type":{
            "type":"string",
            "description":"Type."
        }
    },
    "description":"Adapter identity and display metadata."
}

Nested Schema : links

Type: array

Links to related resources.

Show Source

• Array of: object MCP2610_SuiteLink
  A link to a related REST resource, including its HTTP method when supplied.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MCP2610_SuiteLink"
    },
    "description":"Links to related resources."
}

Nested Schema : MCP2610_ConnectionPropertyRs

Type: object

A connection or security property, including its value, validation metadata, and optional attachment.

Show Source

• acceptableKeys: array acceptableKeys
  Permitted values for the adapter property.
• attachment: attachment
  Attachment associated with this connection property.
• defaultPropertyValue: string
  Default Property Value.
• displayName: string
  Display Name.
• hasAttachment: boolean
  Has Attachment.
• hiddenFlag: boolean
  Hidden Flag.
• integrationRole: string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]

  Integration Role.
• propertyDescription: string
  Property Description.
• propertyGroup: string
  Allowed Values: [ "CREDENTIALS", "SOURCE_ARTIFACTS", "CONNECTION_PROPS", "CUSTOM", "OTHER" ]

  Property Group.
• propertyName: string
  Property Name.
• propertyShortDesc: string
  Property Short Desc.
• 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" ]

  Property Type.
• propertyValue: string
  Property Value.
• requiredFlag: boolean
  Required Flag.

{
    "type":"object",
    "properties":{
        "propertyName":{
            "type":"string",
            "description":"Property Name."
        },
        "propertyValue":{
            "type":"string",
            "description":"Property Value."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name."
        },
        "requiredFlag":{
            "type":"boolean",
            "description":"Required Flag."
        },
        "hiddenFlag":{
            "type":"boolean",
            "description":"Hidden Flag."
        },
        "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"
            ],
            "description":"Property Type."
        },
        "propertyGroup":{
            "type":"string",
            "enum":[
                "CREDENTIALS",
                "SOURCE_ARTIFACTS",
                "CONNECTION_PROPS",
                "CUSTOM",
                "OTHER"
            ],
            "description":"Property Group."
        },
        "integrationRole":{
            "type":"string",
            "enum":[
                "SOURCE",
                "TARGET",
                "SOURCE_AND_TARGET"
            ],
            "description":"Integration Role."
        },
        "acceptableKeys":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MCP2610_AdapterKey"
            },
            "description":"Permitted values for the adapter property."
        },
        "attachment":{
            "description":"Attachment associated with this connection property.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/MCP2610_ConnectionAttachmentRs"
                }
            ]
        },
        "hasAttachment":{
            "type":"boolean",
            "description":"Has Attachment."
        },
        "propertyDescription":{
            "type":"string",
            "description":"Property Description."
        },
        "propertyShortDesc":{
            "type":"string",
            "description":"Property Short Desc."
        },
        "defaultPropertyValue":{
            "type":"string",
            "description":"Default Property Value."
        }
    },
    "description":"A connection or security property, including its value, validation metadata, and optional attachment."
}

Nested Schema : acceptableKeys

Type: array

Permitted values for the adapter property.

Show Source

• Array of: object MCP2610_AdapterKey
  An acceptable adapter property value and its integration-role scope.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MCP2610_AdapterKey"
    },
    "description":"Permitted values for the adapter property."
}

Nested Schema : attachment

Attachment associated with this connection property.

Match All

Attachment associated with this connection property.

Show Source

• object MCP2610_ConnectionAttachmentRs
  Connection attachment and the property to which it belongs.

{
    "description":"Attachment associated with this connection property.",
    "allOf":[
        {
            "$ref":"#/components/schemas/MCP2610_ConnectionAttachmentRs"
        }
    ]
}

Nested Schema : MCP2610_AdapterKey

Type: object

An acceptable adapter property value and its integration-role scope.

Show Source

• displayName: string
  Display Name.
• keyName: string
  Key Name.
• scope: string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]

  Integration-role scope.

{
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string",
            "description":"Display Name."
        },
        "keyName":{
            "type":"string",
            "description":"Key Name."
        },
        "scope":{
            "type":"string",
            "enum":[
                "SOURCE",
                "TARGET",
                "SOURCE_AND_TARGET"
            ],
            "description":"Integration-role scope."
        }
    },
    "description":"An acceptable adapter property value and its integration-role scope."
}

Nested Schema : MCP2610_ConnectionAttachmentRs

Type: object

Connection attachment and the property to which it belongs.

Show Source

• attachment: attachment
  Attachment associated with this connection property.
• attachmentName: string
  Attachment Name.
• propertyName: string
  Property Name.
• signature: string
  Signature.

{
    "type":"object",
    "properties":{
        "attachment":{
            "description":"Attachment associated with this connection property.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/MCP2610_BaseAttachmentRs"
                }
            ]
        },
        "propertyName":{
            "type":"string",
            "description":"Property Name."
        },
        "attachmentName":{
            "type":"string",
            "description":"Attachment Name."
        },
        "signature":{
            "type":"string",
            "description":"Signature."
        }
    },
    "description":"Connection attachment and the property to which it belongs."
}

Nested Schema : attachment

Attachment associated with this connection property.

Match All

Attachment associated with this connection property.

Show Source

• object MCP2610_BaseAttachmentRs
  Attachment metadata and content associated with a connection property.

{
    "description":"Attachment associated with this connection property.",
    "allOf":[
        {
            "$ref":"#/components/schemas/MCP2610_BaseAttachmentRs"
        }
    ]
}

Nested Schema : MCP2610_BaseAttachmentRs

Type: object

Attachment metadata and content associated with a connection property.

Show Source

• attachmentName: string
  Attachment Name.
• content: string
  Content.
• localFilePath: string
  Local File Path.
• propertyName: string
  Property Name.
• signature: string
  Signature.

{
    "type":"object",
    "properties":{
        "propertyName":{
            "type":"string",
            "description":"Property Name."
        },
        "attachmentName":{
            "type":"string",
            "description":"Attachment Name."
        },
        "content":{
            "type":"string",
            "description":"Content."
        },
        "localFilePath":{
            "type":"string",
            "description":"Local File Path."
        },
        "signature":{
            "type":"string",
            "description":"Signature."
        }
    },
    "description":"Attachment metadata and content associated with a connection property."
}

Nested Schema : MCP2610_Link

Type: object

A link to a related REST resource.

Show Source

• href: string
  URL of the linked resource.
• mediaType: string
  Media type of the linked resource.
• rel: string
  Relationship of the linked resource.

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relationship of the linked resource."
        },
        "href":{
            "type":"string",
            "description":"URL of the linked resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type of the linked resource."
        }
    },
    "description":"A link to a related REST resource."
}

Nested Schema : OverridePropertiesRs

Type: object

Project-specific connection override metadata.

Show Source

• code: string
  Resource code.
• name: string
  Resource display name.
• projectCode: string
  Project Code.
• status: string
  Current resource state.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Resource code."
        },
        "projectCode":{
            "type":"string",
            "description":"Project Code."
        },
        "name":{
            "type":"string",
            "description":"Resource display name."
        },
        "status":{
            "type":"string",
            "description":"Current resource state."
        }
    },
    "description":"Project-specific connection override metadata."
}

Nested Schema : MCP2610_SecurityPolicyInfoRs

Type: object

Connection authentication policy and its security properties.

Show Source

• scope: string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]

  Integration-role scope.
• securityPolicy: string
  Security Policy.
• securityProperties: array securityProperties
  Security Properties.

{
    "type":"object",
    "properties":{
        "securityPolicy":{
            "type":"string",
            "description":"Security Policy."
        },
        "securityProperties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MCP2610_ConnectionPropertyRs"
            },
            "description":"Security Properties."
        },
        "scope":{
            "type":"string",
            "enum":[
                "SOURCE",
                "TARGET",
                "SOURCE_AND_TARGET"
            ],
            "description":"Integration-role scope."
        }
    },
    "description":"Connection authentication policy and its security properties."
}

Nested Schema : securityProperties

Type: array

Security Properties.

Show Source

• Array of: object MCP2610_ConnectionPropertyRs
  A connection or security property, including its value, validation metadata, and optional attachment.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MCP2610_ConnectionPropertyRs"
    },
    "description":"Security Properties."
}

400 Response

Malformed parameters

401 Response

Unauthorized or insufficient design-time permissions

404 Response

Project or resource not found, or the MCP feature is not available

409 Response

Conflict, including an operation blocked because the service is in read-only mode.

412 Response

Precondition failed while updating the underlying connection, including unsupported sharing or override changes, or an invalid agent-group association.

423 Response

The underlying connection is locked and this request does not own its lock.

500 Response

Server error

Back to Top

Examples

The following example shows how to update a project MCP server connection or its stored metadata 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 a Project MCP Server

curl --request POST --include \
  --url "${BASE_URL}/ic/api/integration/v1/projects/${PROJECT_ID}/mcp/servers/${SERVER_ID}?integrationInstance=${INTEGRATION_INSTANCE}" \
  --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/json" \
  --header "X-HTTP-Method-Override: PATCH" \
  --header "Content-Type: application/json; charset=utf-8" \
  --data-raw '{
  "testStatus": true
}'

Back to Top