Jump to

• Request
• Response

Search Maven packages

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/mavenPackages

Searches Maven packages available for cluster library installation.

Request

Path Parameters

• aiDataPlatformId(required): string
  Minimum Length: 1

  Maximum Length: 500

  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• clusterKey(required): string
  Minimum Length: 1

  Maximum Length: 200

  Cluster key.
• workspaceKey(required): string
  Minimum Length: 1

  Maximum Length: 200

  The key of the Workspace

Query Parameters

• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

  Default Value: 100
• mavenSearchQuery(required): string
  Minimum Length: 1

  Maximum Length: 512

  Search text matched against Maven package metadata, including group and artifact identifiers. For example, `commons-csv` can return `org.apache.commons:commons-csv`.
• page: string
  Maximum Length: 1024

  For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

Header Parameters

• opc-request-id: string
  Maximum Length: 255

  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. Maven package search results are retrieved.

Headers

• opc-next-page: string
  For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• opc-prev-page: string
  For list pagination. When this header appears in the response, previous pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : MavenSearchSummaryCollection

Type: object

List of Maven package search results.

Show Source

• items(required): array items
  Maven package search results.

{
    "type":"object",
    "description":"List of Maven package search results.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"Maven package search results.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/MavenSearchSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

Maven package search results.

Show Source

• Array of: object MavenSearchSummary
  Maven package search result.

{
    "description":"Maven package search results.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/MavenSearchSummary"
    }
}

Nested Schema : MavenSearchSummary

Type: object

Maven package search result.

Show Source

• allVersions: array allVersions
  Available versions reported for the Maven package.
• artifactId: string
  Maven artifact identifier.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this Maven package search result.
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this Maven package search result.
• groupId: string
  Maven group identifier.
• latestVersion: string
  Latest version reported for the Maven package.
• systemTags: object systemTags
  Additional Properties Allowed: additionalProperties

  System tags for this Maven package search result.

{
    "description":"Maven package search result.",
    "type":"object",
    "properties":{
        "groupId":{
            "description":"Maven group identifier.",
            "type":"string"
        },
        "artifactId":{
            "description":"Maven artifact identifier.",
            "type":"string"
        },
        "latestVersion":{
            "description":"Latest version reported for the Maven package.",
            "type":"string"
        },
        "allVersions":{
            "description":"Available versions reported for the Maven package.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "freeformTags":{
            "description":"Free-form tags for this Maven package search result.",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "description":"Defined tags for this Maven package search result.",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "additionalProperties":{
                    "type":"object"
                }
            }
        },
        "systemTags":{
            "description":"System tags for this Maven package search result.",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "additionalProperties":{
                    "type":"object"
                }
            }
        }
    }
}

Nested Schema : allVersions

Type: array

Available versions reported for the Maven package.

Show Source

• Array of: string

{
    "description":"Available versions reported for the Maven package.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

{
    "description":"Defined tags for this Maven package search result.",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "additionalProperties":{
            "type":"object"
        }
    }
}

Defined tags for this Maven package search result.

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Free-form tags for this Maven package search result.",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Free-form tags for this Maven package search result.

Nested Schema : systemTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

{
    "description":"System tags for this Maven package search result.",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "additionalProperties":{
            "type":"object"
        }
    }
}

System tags for this Maven package search result.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : additionalProperties

Type: object

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : additionalProperties

Type: object

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top