Jump to

• Request
• Response
• Examples

Clone an Integration

post

/ic/api/integration/v1/integrations/{id}/clone

Creates a new copy of an integration with identical connections and data mappings. The request body must contain at least the code, version, and name fields.

Request

Supported Media Types

• application/json; charset=utf-8

Path Parameters

• id(required): string
  Integration composite identifier. The ID consists of the code and the version separated by the | (vertical line) character. Format: code%7Cversion. Example: SC2RN%7C01.00.0000. When using cURL, substitute the %7C code for the vertical line.

Body ()

Integration resource

Root Schema : integration

Type: object

Show Source

• apipId: string
• bartaBuiltBy: string
• code: string
• compatible: boolean
  Default Value: false
• created: string(date-time)
• createdBy: string
• dependencies: object IntegrationDependencyRs
• description: string
• docUrl: string
• endPoints: array endPoints
• endPointURI: string
• eventSubscriptionFlag: boolean
  Default Value: false
• filmstrip: array filmstrip
• id: string
• isCloneAllowed: boolean
  Default Value: false
• isViewAllowed: boolean
  Default Value: false
• keywords: string
• lastUpdated: string(date-time)
• lastUpdatedBy: string
• links: array links
• lockedBy: string
• lockedDate: string(date-time)
• lockedFlag: boolean
  Default Value: false
• mepType: string
• name: string
• originalIntegrationCode: string
• packageName: string
• pattern: string
• patternDescription: string
• payloadTracingEnabledFlag: boolean
  Default Value: false
• percentageComplete: number
• projectModelVersion: string
• projectType: string
• properties: array properties
• proxyWSDL: string
• publishFlag: boolean
  Default Value: false
• recordEnabledFlag: boolean
  Default Value: false
• scheduleApplicableFlag: boolean
  Default Value: false
• scheduleDefinedFlag: boolean
  Default Value: false
• scheduleParams: object scheduleParams
  Additional Properties Allowed: additionalProperties
• securityPolicy: string
• smartTags: string
• status: string
• stopScheduleForDeactivation: boolean
  Default Value: false
• style: string
• styleDescription: string
• submitNowURI: string
• totalEndPoints: integer(int32)
• tracingEnabledFlag: boolean
  Default Value: false
• trackingInstanceName: string
• trackingVariables: array trackingVariables
• version: string
• warningMsg: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "mepType":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "endPointURI":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "created":{
            "type":"string",
            "format":"date-time"
        },
        "lastUpdatedBy":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "pattern":{
            "type":"string"
        },
        "patternDescription":{
            "type":"string"
        },
        "projectType":{
            "type":"string"
        },
        "compatible":{
            "type":"boolean",
            "default":false
        },
        "packageName":{
            "type":"string"
        },
        "lockedFlag":{
            "type":"boolean",
            "default":false
        },
        "tracingEnabledFlag":{
            "type":"boolean",
            "default":false
        },
        "payloadTracingEnabledFlag":{
            "type":"boolean",
            "default":false
        },
        "scheduleApplicableFlag":{
            "type":"boolean",
            "default":false
        },
        "scheduleDefinedFlag":{
            "type":"boolean",
            "default":false
        },
        "percentageComplete":{
            "type":"number"
        },
        "recordEnabledFlag":{
            "type":"boolean",
            "default":false
        },
        "proxyWSDL":{
            "type":"string"
        },
        "style":{
            "type":"string"
        },
        "styleDescription":{
            "type":"string"
        },
        "endPoints":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EndPointRs"
            }
        },
        "filmstrip":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FilmstripRs"
            }
        },
        "trackingVariables":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TrackingVariableType"
            }
        },
        "lockedBy":{
            "type":"string"
        },
        "lockedDate":{
            "type":"string",
            "format":"date-time"
        },
        "dependencies":{
            "$ref":"#/definitions/IntegrationDependencyRs"
        },
        "properties":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IntegrationPropRs"
            }
        },
        "keywords":{
            "type":"string"
        },
        "docUrl":{
            "type":"string"
        },
        "smartTags":{
            "type":"string"
        },
        "bartaBuiltBy":{
            "type":"string"
        },
        "isViewAllowed":{
            "type":"boolean",
            "default":false
        },
        "isCloneAllowed":{
            "type":"boolean",
            "default":false
        },
        "originalIntegrationCode":{
            "type":"string"
        },
        "submitNowURI":{
            "type":"string"
        },
        "trackingInstanceName":{
            "type":"string"
        },
        "projectModelVersion":{
            "type":"string"
        },
        "scheduleParams":{
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "securityPolicy":{
            "type":"string"
        },
        "apipId":{
            "type":"string"
        },
        "warningMsg":{
            "type":"string"
        },
        "publishFlag":{
            "type":"boolean",
            "default":false
        },
        "eventSubscriptionFlag":{
            "type":"boolean",
            "default":false
        },
        "stopScheduleForDeactivation":{
            "type":"boolean",
            "default":false
        },
        "totalEndPoints":{
            "type":"integer",
            "format":"int32"
        }
    },
    "xml":{
        "name":"integration"
    }
}

Nested Schema : IntegrationDependencyRs

Type: object

Show Source

• certificates: array certificates
• connections: array connections
• integrations: array integrations
• libraries: array libraries
• lookups: array lookups

{
    "type":"object",
    "properties":{
        "connections":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ConnectionDependencyRs"
            }
        },
        "lookups":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LookupDependencyRs"
            }
        },
        "libraries":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LibraryDependencyRs"
            }
        },
        "certificates":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CertificateDependencyRs"
            }
        },
        "integrations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LocalIntegrationDependencyRs"
            }
        }
    }
}

Nested Schema : endPoints

Type: array

Show Source

• Array of: object EndPointRs

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

Nested Schema : filmstrip

Type: array

Show Source

• Array of: object FilmstripRs

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

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : properties

Type: array

Show Source

• Array of: object IntegrationPropRs

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

Nested Schema : scheduleParams

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : trackingVariables

Type: array

Show Source

• Array of: object TrackingVariableType

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

Nested Schema : certificates

Type: array

Show Source

• Array of: object CertificateDependencyRs

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

Nested Schema : connections

Type: array

Show Source

• Array of: object ConnectionDependencyRs

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

Nested Schema : integrations

Type: array

Show Source

• Array of: object LocalIntegrationDependencyRs

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

Nested Schema : libraries

Type: array

Show Source

• Array of: object LibraryDependencyRs

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

Nested Schema : lookups

Type: array

Show Source

• Array of: object LookupDependencyRs

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

Nested Schema : CertificateDependencyRs

Type: object

Show Source

• id: string
• name: string
• status: string
• usage: integer(int32)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "status":{
            "type":"string"
        }
    }
}

Nested Schema : ConnectionDependencyRs

Type: object

Show Source

• id: string
• name: string
• role: string
• status: string
• type: string
• usage: integer(int32)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "role":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : LocalIntegrationDependencyRs

Type: object

Show Source

• code: string
• version: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "version":{
            "type":"string"
        }
    }
}

Nested Schema : LibraryDependencyRs

Type: object

Show Source

• code: string
• description: string
• displayName: string
• lastUpdatedDate: string(date-time)
• lockedFlag: boolean
  Default Value: false
• status: string
• usage: integer(int32)
• version: string

{
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "lastUpdatedDate":{
            "type":"string",
            "format":"date-time"
        },
        "status":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "lockedFlag":{
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : LookupDependencyRs

Type: object

Show Source

• description: string
• name: string
• status: string
• usage: integer(int32)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "status":{
            "type":"string"
        }
    }
}

Nested Schema : EndPointRs

Type: object

Show Source

• connection: object ConnectionBaseRs
• name: string
• role: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "role":{
            "type":"string"
        },
        "connection":{
            "$ref":"#/definitions/ConnectionBaseRs"
        }
    }
}

Nested Schema : ConnectionBaseRs

Type: object

Show Source

• id: string
• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

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

Nested Schema : FilmstripRs

Type: object

Show Source

• code: string
• iconUrl: string
• name: string
• role: string
• status: string

{
    "type":"object",
    "properties":{
        "iconUrl":{
            "type":"string"
        },
        "role":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

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

Nested Schema : IntegrationPropRs

Type: object

Show Source

• currentValue: string
• defaultValue: string
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "defaultValue":{
            "type":"string"
        },
        "currentValue":{
            "type":"string"
        }
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : TrackingVariableType

Type: object

Show Source

• description: string
• id: string
• messageContextRef(required): object ReferenceType
• name(required): string
• output(required): object WirepointType
• primary: boolean
  Default Value: false
• property: array property
• refUri: string
• role: string
• subRole: string
• type: string
  Allowed Values: [ "ORCHESTRATION", "RECEIVE", "ROUTER", "ROUTER_ROUTE", "TRANSFORMER", "TRY", "TRY_CATCH", "INVOKE", "REPLY", "LABEL", "ASSIGNMENT", "FOR", "STOP", "SCHEDULERECEIVE", "STAGEFILE", "FAULTREPLY", "CALLOUT", "WHILE", "WAIT", "NOTE", "GLOBAL_VARIABLE", "GLOBAL_TRY", "GLOBAL_CATCH_ALL", "CATCH_ALL", "EHSTOP", "NOTIFICATION", "ACTIVITY_STREAM_LOGGER", "STITCH", "THROW", "PICK", "PICKRECEIVE", "TRACKING_VARIABLE", "REJECT", "INTEGRATION_METADATA", "INTEGRATION_PROPERTIES" ]
• xpath(required): string

{
    "type":"object",
    "required":[
        "messageContextRef",
        "name",
        "output",
        "xpath"
    ],
    "properties":{
        "role":{
            "type":"string"
        },
        "subRole":{
            "type":"string"
        },
        "primary":{
            "type":"boolean",
            "default":false
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "xpath":{
            "type":"string"
        },
        "messageContextRef":{
            "$ref":"#/definitions/ReferenceType"
        },
        "property":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PropertyType"
            }
        },
        "output":{
            "$ref":"#/definitions/WirepointType"
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "ORCHESTRATION",
                "RECEIVE",
                "ROUTER",
                "ROUTER_ROUTE",
                "TRANSFORMER",
                "TRY",
                "TRY_CATCH",
                "INVOKE",
                "REPLY",
                "LABEL",
                "ASSIGNMENT",
                "FOR",
                "STOP",
                "SCHEDULERECEIVE",
                "STAGEFILE",
                "FAULTREPLY",
                "CALLOUT",
                "WHILE",
                "WAIT",
                "NOTE",
                "GLOBAL_VARIABLE",
                "GLOBAL_TRY",
                "GLOBAL_CATCH_ALL",
                "CATCH_ALL",
                "EHSTOP",
                "NOTIFICATION",
                "ACTIVITY_STREAM_LOGGER",
                "STITCH",
                "THROW",
                "PICK",
                "PICKRECEIVE",
                "TRACKING_VARIABLE",
                "REJECT",
                "INTEGRATION_METADATA",
                "INTEGRATION_PROPERTIES"
            ]
        },
        "refUri":{
            "type":"string"
        }
    }
}

Nested Schema : ReferenceType

Type: object

Show Source

• property: array property
• refUri: string
• role: string
• subRole: string

{
    "type":"object",
    "properties":{
        "role":{
            "type":"string"
        },
        "subRole":{
            "type":"string"
        },
        "property":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PropertyType"
            }
        },
        "refUri":{
            "type":"string"
        }
    }
}

Nested Schema : WirepointType

Type: object

Show Source

• messageContextRef: object ReferenceType
• name: string
• property: array property
• resourceGroup: array resourceGroup
• role: string
  Allowed Values: [ "REQUEST", "RESPONSE", "FAULT", "VARIABLE" ]
• subRole: string

{
    "type":"object",
    "properties":{
        "role":{
            "type":"string",
            "enum":[
                "REQUEST",
                "RESPONSE",
                "FAULT",
                "VARIABLE"
            ]
        },
        "subRole":{
            "type":"string"
        },
        "messageContextRef":{
            "$ref":"#/definitions/ReferenceType"
        },
        "property":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PropertyType"
            }
        },
        "resourceGroup":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResourceGroupType"
            }
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : property

Type: array

Show Source

• Array of: object PropertyType

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

Nested Schema : property

Type: array

Show Source

• Array of: object PropertyType

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

Nested Schema : PropertyType

Type: object

Show Source

• name: string
• value: string

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

Nested Schema : property

Type: array

Show Source

• Array of: object PropertyType

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

Nested Schema : resourceGroup

Type: array

Show Source

• Array of: object ResourceGroupType

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

Nested Schema : ResourceGroupType

Type: object

Show Source

• name: string
• property: array property
• resource(required): array resource
• role: string
• subRole: string

{
    "type":"object",
    "required":[
        "resource"
    ],
    "properties":{
        "role":{
            "type":"string"
        },
        "subRole":{
            "type":"string"
        },
        "resource":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResourceType"
            }
        },
        "property":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PropertyType"
            }
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : property

Type: array

Show Source

• Array of: object PropertyType

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

Nested Schema : resource

Type: array

Show Source

• Array of: object ResourceType

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

Nested Schema : ResourceType

Type: object

Show Source

• externalLocation: string
• location: string
• name: string
• property: array property
• resourceDescription: string
• resourceName: string
• role: string
• subRole: string
• type: string
  Allowed Values: [ "XSD", "XSLT", "JCA", "WSDL", "WADL", "PROPERTIES", "UNDEFINED" ]

{
    "type":"object",
    "properties":{
        "role":{
            "type":"string"
        },
        "subRole":{
            "type":"string"
        },
        "property":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PropertyType"
            }
        },
        "resourceName":{
            "type":"string"
        },
        "resourceDescription":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "location":{
            "type":"string"
        },
        "externalLocation":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "XSD",
                "XSLT",
                "JCA",
                "WSDL",
                "WADL",
                "PROPERTIES",
                "UNDEFINED"
            ]
        }
    }
}

Nested Schema : property

Type: array

Show Source

• Array of: object PropertyType

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

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

Successful operation

400 Response

Bad request, missing required data

404 Response

Integration not found

500 Response

Server error

Back to Top

Examples

The following example shows how to clone an integration 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: Clone the Integration with the Specified ID

Request:

The id is in the form: code%7Cversion. The %7C is the encoded | (vertical line).

curl -X POST -H 'Authorization: Bearer access_token' -H "Content-Type:application/json" -d @integration.json https://integration.us.oraclecloud.com/ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000/clone

Request Body:

The following example shows the contents of the request body in JSON format. This is the contents of the integration.json file listed in the cURL command. The file must contain three attributes: name, code, and version. The description attribute is optional.

{"code":"CLONEDINTEGRATION","version":"01.00.0000","name":"ClonedIntegration","description":"The description of the cloned integration"}

Back to Top