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

Supported Media Types

• application/json; charset=utf-8

Path Parameters

• packagename(required): string
  Package name

Query Parameters

• includeDependencies: boolean
  Include integration dependency information in the integration section of the response.

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

Type: object

Show Source

• bartaBuiltBy: string
• bartaType: string
• countOfIntegrations: integer(int32)
• id: string
• integrations: array integrations
• isCloneAllowed: boolean
  Default Value: false
• isViewAllowed: boolean
  Default Value: false
• links: array links
• name: string
• type: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "countOfIntegrations":{
            "type":"integer",
            "format":"int32"
        },
        "type":{
            "type":"string"
        },
        "integrations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IntegrationBaseResource"
            }
        },
        "bartaBuiltBy":{
            "type":"string"
        },
        "bartaType":{
            "type":"string"
        },
        "isViewAllowed":{
            "type":"boolean",
            "default":false
        },
        "isCloneAllowed":{
            "type":"boolean",
            "default":false
        }
    },
    "xml":{
        "name":"package"
    }
}

Nested Schema : integrations

Type: array

Show Source

• Array of: object IntegrationBaseResource

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : IntegrationBaseResource

Type: object

Show Source

• code: string
• dependencies: object IntegrationDependencyRs
• id: string
• links: array links
• lockedFlag: boolean
  Default Value: false
• name: string
• pattern: string
• patternDescription: string
• scheduleApplicable: boolean
  Default Value: false
• scheduleDefined: boolean
  Default Value: false
• status: string
• style: string
• styleDescription: string
• version: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "style":{
            "type":"string"
        },
        "styleDescription":{
            "type":"string"
        },
        "pattern":{
            "type":"string"
        },
        "patternDescription":{
            "type":"string"
        },
        "dependencies":{
            "$ref":"#/definitions/IntegrationDependencyRs"
        },
        "lockedFlag":{
            "type":"boolean",
            "default":false
        },
        "scheduleApplicable":{
            "type":"boolean",
            "default":false
        },
        "scheduleDefined":{
            "type":"boolean",
            "default":false
        }
    }
}

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

Type: array

Show Source

• Array of: object Link

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

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

Type: object

Show Source

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

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

404 Response

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://integration.us.oraclecloud.com/ic/api/integration/v1/packages/samples.oracle.helloworld

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://integration.us.oraclecloud.com/ic/api/integration/v1/packages/samples.oracle.helloworld?includeDependencies=true

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