Jump to

• Request
• Response
• Examples

Retrieve an Integration

get

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

Retrieves detailed information about the integration with the specified ID.

Request

Supported Media Types

• application/json; charset=utf-8

Path Parameters

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

Query Parameters

• expand(optional): string
  Includes additional details in the response about connections in the integration or about the adapters for the connections. Valid values: connection, connection.adapter.

Back to Top

Response

Supported Media Types

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

200 Response

Successful operation

Body ()

Root Schema : integration

Type: object

Show Source

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

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

Nested Schema : LibraryDependencyRs

Type: object

Show Source

• code(optional): string
• description(optional): string
• displayName(optional): string
• lastUpdatedDate(optional): string(date-time)
• lockedFlag(optional): boolean
  Default Value: false
• status(optional): string
• usage(optional): integer(int32)
• version(optional): 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(optional): string
• name(optional): string
• status(optional): string
• usage(optional): 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(optional): object ConnectionBaseRs
• name(optional): string
• role(optional): string

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

Nested Schema : ConnectionBaseRs

Type: object

Show Source

• id(optional): string
• links(optional): 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(optional): string
• mediaType(optional): string
• rel(optional): string

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

Nested Schema : FilmstripRs

Type: object

Show Source

• code(optional): string
• iconUrl(optional): string
• name(optional): string
• role(optional): string
• status(optional): 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(optional): string
• mediaType(optional): string
• rel(optional): string

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

Nested Schema : IntegrationPropRs

Type: object

Show Source

• currentValue(optional): string
• defaultValue(optional): string
• name(optional): 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(optional): string
• id(optional): string
• messageContextRef: object ReferenceType
• name: string
• output: object WirepointType
• primary(optional): boolean
  Default Value: false
• property(optional): array property
• refUri(optional): string
• role(optional): string
• subRole(optional): string
• type(optional): 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: 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(optional): array property
• refUri(optional): string
• role(optional): string
• subRole(optional): 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(optional): object ReferenceType
• name(optional): string
• property(optional): array property
• resourceGroup(optional): array resourceGroup
• role(optional): string
  Allowed Values: [ "REQUEST", "RESPONSE", "FAULT", "VARIABLE" ]
• subRole(optional): 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(optional): string
• value(optional): 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(optional): string
• property(optional): array property
• resource: array resource
• role(optional): string
• subRole(optional): 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(optional): string
• location(optional): string
• name(optional): string
• property(optional): array property
• resourceDescription(optional): string
• resourceName(optional): string
• role(optional): string
• subRole(optional): string
• type(optional): 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"
    }
}

404 Response

Not found

412 Response

Precondition failed

500 Response

Server error

Back to Top

Examples

The following examples show how to get details about an integration by submitting a GET 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: Get details about the integration HELLO_WORLD|01.02.0000

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

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://integration.us.oraclecloud.com/ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000

Example: Get details about the integration HELLO_WORLD|01.02.0000 with additional details about connections

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

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "expand=connection" https://integration.us.oraclecloud.com/ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000

Back to Top