Jump to

• Request
• Response
• Examples

Retrieve a Package

get

/ic/api/integration/v1/packages/{packagename}

Retrieves detailed information about the package with the specified name.

Request

Path Parameters

• packagename(required): string
  Package name

Query Parameters

• includeDependencies: boolean
  Include integration dependency information in the integration section of the response.
• 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.

There's no request body for this operation.

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 : PackageRs

Type: object

Show Source

• barta-built-by: string
  BA (Business Accelerator) | R (Recipe) | TA (Technical Accelerator) builtBy
• barta-type: string
  Accelerator type BA (Business Accelerator) | R (Recipe) | TA (Technical Accelerator)
• count-of-integrations: integer (int32)
  Number of Integrations
• integrations: array integrations
  Integration List
• is-clone-allowed: boolean
  Flag to Check if Clone Allowed
• is-view-allowed: boolean
  Flag to Check if View Allowed
• name: string
  Package Name
• type: string
  Package type

{
    "type":"object",
    "properties":{
        "integrations":{
            "type":"array",
            "description":"Integration List",
            "items":{
                "$ref":"#/components/schemas/IntegrationBaseResource"
            }
        },
        "name":{
            "type":"string",
            "description":"Package Name"
        },
        "count-of-integrations":{
            "type":"integer",
            "description":"Number of Integrations",
            "format":"int32"
        },
        "type":{
            "type":"string",
            "description":"Package type"
        },
        "barta-built-by":{
            "type":"string",
            "description":"BA (Business Accelerator) | R (Recipe) | TA (Technical Accelerator) builtBy"
        },
        "barta-type":{
            "type":"string",
            "description":"Accelerator type BA (Business Accelerator) | R (Recipe) | TA (Technical Accelerator)"
        },
        "is-view-allowed":{
            "type":"boolean",
            "description":"Flag to Check if View Allowed"
        },
        "is-clone-allowed":{
            "type":"boolean",
            "description":"Flag to Check if Clone Allowed"
        }
    }
}

Nested Schema : integrations

Type: array

Integration List

Show Source

• Array of: IntegrationBaseResource

{
    "type":"array",
    "description":"Integration List",
    "items":{
        "$ref":"#/components/schemas/IntegrationBaseResource"
    }
}

Nested Schema : IntegrationBaseResource

Match All

Show Source

• allOf IdResource
• object GenericRestResource
• object IntegrationBaseResource-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdResource"
        },
        {
            "$ref":"#/components/schemas/GenericRestResource"
        },
        {
            "type":"object",
            "properties":{
                "status":{
                    "type":"string"
                },
                "version":{
                    "type":"string"
                },
                "name":{
                    "type":"string"
                },
                "code":{
                    "type":"string"
                },
                "dependencies":{
                    "$ref":"#/components/schemas/IntegrationDependencyRs"
                },
                "lockedFlag":{
                    "type":"boolean"
                },
                "style":{
                    "type":"string"
                },
                "styleDescription":{
                    "type":"string"
                },
                "pattern":{
                    "type":"string"
                },
                "patternDescription":{
                    "type":"string"
                },
                "scheduleApplicable":{
                    "type":"boolean"
                },
                "scheduleDefined":{
                    "type":"boolean"
                },
                "description":{
                    "type":"string"
                },
                "endPointURI":{
                    "type":"string"
                },
                "createdBy":{
                    "type":"string"
                },
                "created":{
                    "type":"string",
                    "format":"date-time"
                },
                "lockedBy":{
                    "type":"string"
                },
                "lockedDate":{
                    "type":"string",
                    "format":"date-time"
                },
                "lastUpdatedBy":{
                    "type":"string"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time"
                },
                "proxyWSDL":{
                    "type":"string"
                },
                "filmstrip":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FilmstripRs"
                    }
                },
                "keywords":{
                    "type":"string"
                },
                "docUrl":{
                    "type":"string"
                },
                "smartTags":{
                    "type":"string"
                },
                "apipId":{
                    "type":"string"
                },
                "warningMsg":{
                    "type":"string"
                },
                "publishFlag":{
                    "type":"boolean"
                },
                "tracingEnabledFlag":{
                    "type":"boolean"
                },
                "payloadTracingEnabledFlag":{
                    "type":"boolean"
                },
                "eventSubscriptionFlag":{
                    "type":"boolean"
                },
                "tempCopyExists":{
                    "type":"boolean"
                },
                "reactivationStatus":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IdResource

Match All

Show Source

• object GenericRestResource
• object IdResource-allOf[1]

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

Nested Schema : GenericRestResource

Type: object

Show Source

• links: array links
• processing-time: number (float)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "processing-time":{
            "type":"number",
            "format":"float"
        }
    }
}

Nested Schema : IdResource-allOf[1]

Type: object

Show Source

• id: string
• projectId: string
• projectName: string

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

Nested Schema : IntegrationBaseResource-allOf[2]

Type: object

Show Source

• apipId: string
• code: string
• created: string (date-time)
• createdBy: string
• dependencies: object IntegrationDependencyRs
• description: string
• docUrl: string
• endPointURI: string
• eventSubscriptionFlag: boolean
• filmstrip: array filmstrip
• keywords: string
• lastUpdated: string (date-time)
• lastUpdatedBy: string
• lockedBy: string
• lockedDate: string (date-time)
• lockedFlag: boolean
• name: string
• pattern: string
• patternDescription: string
• payloadTracingEnabledFlag: boolean
• proxyWSDL: string
• publishFlag: boolean
• reactivationStatus: string
• scheduleApplicable: boolean
• scheduleDefined: boolean
• smartTags: string
• status: string
• style: string
• styleDescription: string
• tempCopyExists: boolean
• tracingEnabledFlag: boolean
• version: string
• warningMsg: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "dependencies":{
            "$ref":"#/components/schemas/IntegrationDependencyRs"
        },
        "lockedFlag":{
            "type":"boolean"
        },
        "style":{
            "type":"string"
        },
        "styleDescription":{
            "type":"string"
        },
        "pattern":{
            "type":"string"
        },
        "patternDescription":{
            "type":"string"
        },
        "scheduleApplicable":{
            "type":"boolean"
        },
        "scheduleDefined":{
            "type":"boolean"
        },
        "description":{
            "type":"string"
        },
        "endPointURI":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "created":{
            "type":"string",
            "format":"date-time"
        },
        "lockedBy":{
            "type":"string"
        },
        "lockedDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastUpdatedBy":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "proxyWSDL":{
            "type":"string"
        },
        "filmstrip":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FilmstripRs"
            }
        },
        "keywords":{
            "type":"string"
        },
        "docUrl":{
            "type":"string"
        },
        "smartTags":{
            "type":"string"
        },
        "apipId":{
            "type":"string"
        },
        "warningMsg":{
            "type":"string"
        },
        "publishFlag":{
            "type":"boolean"
        },
        "tracingEnabledFlag":{
            "type":"boolean"
        },
        "payloadTracingEnabledFlag":{
            "type":"boolean"
        },
        "eventSubscriptionFlag":{
            "type":"boolean"
        },
        "tempCopyExists":{
            "type":"boolean"
        },
        "reactivationStatus":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

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

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

Nested Schema : IntegrationDependencyRs

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "connections":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationDependencyRs.ConnectionDependencyRs"
            }
        },
        "lookups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationDependencyRs.LookupDependencyRs"
            }
        },
        "libraries":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationDependencyRs.LibraryDependencyRs"
            }
        },
        "certificates":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationDependencyRs.CertificateDependencyRs"
            }
        }
    }
}

Nested Schema : filmstrip

Type: array

Show Source

• Array of: object FilmstripRs

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

Nested Schema : certificates

Type: array

Show Source

• Array of: object IntegrationDependencyRs.CertificateDependencyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IntegrationDependencyRs.CertificateDependencyRs"
    }
}

Nested Schema : connections

Type: array

Show Source

• Array of: object IntegrationDependencyRs.ConnectionDependencyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IntegrationDependencyRs.ConnectionDependencyRs"
    }
}

Nested Schema : libraries

Type: array

Show Source

• Array of: object IntegrationDependencyRs.LibraryDependencyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IntegrationDependencyRs.LibraryDependencyRs"
    }
}

Nested Schema : lookups

Type: array

Show Source

• Array of: object IntegrationDependencyRs.LookupDependencyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IntegrationDependencyRs.LookupDependencyRs"
    }
}

Nested Schema : IntegrationDependencyRs.CertificateDependencyRs

Type: object

Show Source

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

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

Nested Schema : IntegrationDependencyRs.ConnectionDependencyRs

Type: object

Show Source

• display-name: string
• id(required): string
• locked-by: string
• locked-date: string (date-time)
• locked-flag: boolean
• name: string
• role: string
• status: string
• type: string
• usage: integer (int32)

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "display-name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "role":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "locked-flag":{
            "type":"boolean"
        },
        "locked-by":{
            "type":"string"
        },
        "locked-date":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : IntegrationDependencyRs.LibraryDependencyRs

Type: object

Show Source

• code: string
• description: string
• display-name: string
• last-updated-date: string (date-time)
• locked-by: string
• locked-date: string (date-time)
• locked-flag: boolean
• status: string
• usage: integer (int32)
• version: string

{
    "type":"object",
    "properties":{
        "display-name":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "last-updated-date":{
            "type":"string",
            "format":"date-time"
        },
        "status":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "locked-flag":{
            "type":"boolean"
        },
        "locked-by":{
            "type":"string"
        },
        "locked-date":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : IntegrationDependencyRs.LookupDependencyRs

Type: object

Show Source

• description(required): string
• locked-by: string
• locked-date: string (date-time)
• locked-flag: boolean
• name(required): string
• status(required): string
• usage(required): integer (int32)

{
    "required":[
        "description",
        "name",
        "status",
        "usage"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "status":{
            "type":"string"
        },
        "locked-flag":{
            "type":"boolean"
        },
        "locked-by":{
            "type":"string"
        },
        "locked-date":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : FilmstripRs

Type: object

Show Source

• code(required): string
• icon-url: string
• name(required): string
• role(required): string
• status: string

{
    "required":[
        "code",
        "name",
        "role"
    ],
    "type":"object",
    "properties":{
        "icon-url":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "role":{
            "type":"string"
        }
    }
}

404 Response

Package not found

500 Response

Server error

Back to Top

Examples

The following examples show how to get details about a package 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 package samples.oracle.helloworld

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json"
https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/packages/samples.oracle.helloworld?integrationInstance=service-instance

Example: Get details about the package samples.oracle.helloworld and include dependency information in the response

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json"
https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/packages/samples.oracle.helloworld?includeDependencies=true?integrationInstance=service-instance

Example response with dependency information:

{
    "bartaType": "DEVELOPED",
    "countOfIntegrations": 4,
    "id": "samples.oracle.helloworld",
    "integrations": [
        {
            "code": "API_USECASE3",
            "dependencies": {
                "connections": [
                    {
                        "id": "FTP_API_SLC02GAD",
                        "name": "FTP_API_SLC02GAD",
                        "role": "SOURCE_AND_TARGET",
                        "status": "INPROGRESS",
                        "type": "ftp"
                    }
                ]
            },
           ...
}

Back to Top