Jump to

• Request
• Response
• Examples

Retrieve Packages

get

/ic/api/integration/v1/packages

Retrieves information about all packages ordered by the last updated time.

Request

Supported Media Types

• application/json; charset=utf-8

Query Parameters

• limit(optional): integer(int32)
  Use with the offset parameter for paginating through the returned results. The limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list packages starting at the 4th item, and the list will contain 16 items.
• offset(optional): integer(int32)
  Use with the limit parameter for paginating through the returned results. The offset is the starting point from which to return records. For example, offset=3&limit=16 indicates to list packages starting at the 4th item, and the list will contain 16 items.
• q(optional): string

  Returns a filtered list of packages based on the specified parameters.

  Valid parameters:

  • name: Name of the package. Supports exact matches or contains. For example:
    • To retrieve packages that are an exact match in the package name, specify:

      q={name:'PackageName'}

      .
    • To retrieve all packages that contain the specified string in the package name, specify:

      q={name: /pack/}

  • type: type of package. Valid values: PREBUILT, DEVELOPED.

Back to Top

Response

Supported Media Types

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

200 Response

Successful operation

Body ()

Root Schema : PackagesRs

Type: object

Show Source

• hasMore(optional): boolean
  Default Value: false
• items(optional): array items
• limit(optional): integer(int32)
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PackageRs"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "type":"boolean",
            "default":false
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object package

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

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : package

Type: object

Show Source

• bartaBuiltBy(optional): string
• bartaType(optional): string
• countOfIntegrations(optional): integer(int32)
• id(optional): string
• integrations(optional): array integrations
• isCloneAllowed(optional): boolean
  Default Value: false
• isViewAllowed(optional): boolean
  Default Value: false
• links(optional): array links
• name(optional): string
• type(optional): 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(optional): string
• dependencies(optional): object IntegrationDependencyRs
• id(optional): string
• links(optional): array links
• lockedFlag(optional): boolean
  Default Value: false
• name(optional): string
• pattern(optional): string
• patternDescription(optional): string
• scheduleApplicable(optional): boolean
  Default Value: false
• scheduleDefined(optional): boolean
  Default Value: false
• status(optional): string
• style(optional): string
• styleDescription(optional): string
• version(optional): 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(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 : 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(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 : 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 : 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"
        }
    }
}

400 Response

Malformed parameters

500 Response

Server error

Back to Top

Examples

The following examples show how to get details about packages 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 all packages

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://integration.us.oraclecloud.com/ic/api/integration/v1/packages

Example: Get only packages that contain myPack in the package name in any case

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={name: /myPack/}" https://integration.us.oraclecloud.com/ic/api/integration/v1/packages

Example: Paginate through returned packages

Pagination is done with limit and offset. In this example, we list packages starting at the fourth item. The list contains 16 items.

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "offset=3&limit=16" https://integration.us.oraclecloud.com/ic/api/integration/v1/packages 

Example: Combine parameters to retrieve packages that contain a string, and paginate through the results

To combine query parameters, use q with the --data-urlencode option. The other parameters can be added after the -d option.

In this example, we are retrieving packages that contain myPack in uppercase or lowercase, and have the type DEVELOPED.

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={name: /myPack/, type:'DEVELOPED'}" -d "offset=3&limit=16" https://integration.us.oraclecloud.com/ic/api/integration/v1/packages

Back to Top