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 TopResponse
Supported Media Types
- application/json; charset=utf-8, application/vnd.oracle.resource+json;type=singular
200 Response
Successful operation
Root Schema : PackageRs
Type:
Show Source
object
-
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
Nested Schema : IntegrationBaseResource-allOf[2]
Type:
Show Source
object
-
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
404 Response
Package not found
500 Response
Server error
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"
}
]
},
...
}