openapi: 3.2.0
info:
description: The APIs for the [Java Download](https://docs.oracle.com/en-us/iaas/jms/doc/java-download.html) feature of Java Management Service.
title: Java Management Service Java Download API
version: '20230601'
x-provenance:
method: harvested
first_party: true
publisher: Oracle
source: https://docs.oracle.com/en-us/iaas/api/specs/262828676ddc987c55151766aa2127c9c73d8a81ad9625e1214e80e7cba22d26.yaml
harvested: '2026-08-04'
note: Published by Oracle as the contract for the Java Management Service Java Download API OCI service and stored verbatim; API Evangelist added only this provenance block.
x-evidence:
- url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
what: Oracle's own index of every OCI service specification
- url: https://docs.oracle.com/en-us/iaas/api/specs/262828676ddc987c55151766aa2127c9c73d8a81ad9625e1214e80e7cba22d26.yaml
what: the harvested document for Java Management Service Java Download API
servers:
- url: /
tags:
- description: 'Endpoints related to the Java Management Service Download feature
'
name: javaDownload
paths:
/20230601/actions/generateArtifactDownloadUrl:
post:
description: 'Generates a download URL and returns it in the response payload.
The URL in the response can then be used for downloading the specific Java runtime artifact.
Use the [GetJavaRelease](#/en/jms/20210610/JavaRelease/GetJavaRelease) API
to get information about available artifacts for a specific release. Each artifact is uniquely identified by an `artifactId`.
Refer [JavaArtifact](#/en/jms/20210610/datatypes/JavaArtifact) for more details.
'
operationId: GenerateArtifactDownloadUrl
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Return the Download URL object.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DownloadUrl'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Generate download URL for an artifact.
tags:
- javaDownload
x-example: "POST /20230601/actions/generateArtifactDownloadUrl\nHost: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.tenancy.oc1..<unique_id>\",\n \"artifactId\": 1001\n}\n"
x-obmcs-authz-declarations:
authorizationRequired: false
x-related-resource: '#/definitions/DownloadUrl'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateArtifactDownloadUrlDetails'
description: Details for generating download URL for a Java artifact.
required: true
/20230601/actions/requestSummarizedJavaDownloadCounts:
post:
description: 'Returns list of download counts grouped by the specified property.
'
operationId: RequestSummarizedJavaDownloadCounts
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Aggregated report of the Java download counts.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaDownloadCountAggregationCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Aggregated summary of download counts.
tags:
- javaDownload
x-example: "POST /20230601/actions/requestSummarizedJavaDownloadCounts\nHost: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.tenancy.oc1..<unique_id>\" \n \"groupAs\": \"JAVA_FAMILY\",\n \"timeStart\": \"2022-01-01T05:25:10.082Z\",\n \"timeEnd\": \"2023-06-28T05:25:10.082Z\"\n}\n"
x-related-resource: '#/definitions/JavaDownloadCountAggregation'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestSummarizedJavaDownloadCountsDetails'
description: Details for retreiving the summary of download counts.
required: true
/20230601/javaDownloadRecords:
get:
description: 'Returns a list of Java download records in a tenancy based on specified parameters.
See [JavaReleases API](#/en/jms/20210610/JavaRelease/ListJavaReleases)
for possible values of `javaFamilyVersion` and `javaReleaseVersion` parameters.
'
operationId: ListJavaDownloadRecords
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/JavaFamilyVersionQueryParam'
- $ref: '#/components/parameters/JavaReleaseVersionQueryParam'
- $ref: '#/components/parameters/OsFamilyQueryParam'
- $ref: '#/components/parameters/ArchitectureTypeQueryParam'
- $ref: '#/components/parameters/PackageTypeDetailQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/DownloadRecordSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: List of Java download records.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaDownloadRecordCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List of Java download records.
tags:
- javaDownload
x-example: "GET /20230601/javaDownloadRecords?\n compartmentId=<tenancy OCID>\n &javaReleaseVersion=17.0.2&osFamily=WINDOWS&architecture=x64&packageTypeDetail=Installer\nHost: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n"
x-related-resource: '#/definitions/JavaDownloadRecord'
/20230601/javaDownloadReports:
get:
description: 'Returns a list of JavaDownloadReports.
'
operationId: ListJavaDownloadReports
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/LifecycleStateQueryParam'
- $ref: '#/components/parameters/ReportDisplayNameQueryParam'
- $ref: '#/components/parameters/JavaDownloadReportIdentifierQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/JavaDownloadReportSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A page of JavaDownloadReportSummary objects.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaDownloadReportCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a list of all JavaDownloadReports in a tenancy.
tags:
- javaDownload
x-example: 'GET /20230601/javaDownloadReports
Host: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JavaDownloadReport'
post:
description: 'Create a new report in the specified format containing the download details
for the tenancy.
'
operationId: CreateJavaDownloadReport
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. A download report will be generated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Create a download report.
tags:
- javaDownload
x-example: "POST /20230601/javaDownloadReports\nHost: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.tenancy.oc1..<unique_id>\" \n \"timeStart\": \"2021-11-28T05:25:10.082Z\",\n \"timeEnd\": \"2022-12-28T05:25:10.082Z\",\n \"sortBy\": \"timeDownloaded\",\n \"sortOrder\": \"DESC\",\n \"format\": \"CSV\"\n}\n"
x-related-resource: '#/definitions/JavaDownloadReport'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateJavaDownloadReportDetails'
description: Details for the new report.
required: true
/20230601/javaDownloadReports/{javaDownloadReportId}:
delete:
description: Deletes a JavaDownloadReport resource by identifier.
operationId: DeleteJavaDownloadReport
parameters:
- $ref: '#/components/parameters/JavaDownloadReportIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The JavaDownloadReport will be deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete a JavaDownloadReport.
tags:
- javaDownload
x-example: 'DELETE /20230601/javaDownloadReports/<javadownloadreport_OCID>
Host: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JavaDownloadReport'
get:
description: Gets a JavaDownloadReport by the specified identifier.
operationId: GetJavaDownloadReport
parameters:
- $ref: '#/components/parameters/JavaDownloadReportIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Retrieves the JavaDownloadReport with the given identifier.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaDownloadReport'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get JavaDownloadReport
tags:
- javaDownload
x-example: 'GET /20230601/javaDownloadReports/<javadownloadreport_OCID>
Host: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
/20230601/javaDownloadReports/{javaDownloadReportId}/content:
get:
description: Retrieve a Java download report with the specified identifier.
operationId: GetJavaDownloadReportContent
parameters:
- $ref: '#/components/parameters/JavaDownloadReportIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Downloads the report in the specified format.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
text/csv:
schema:
format: binary
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Retrieve a download report.
tags:
- javaDownload
x-example: 'GET /20230601/javaDownloadReports/<report_OCID>/content
Host: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JavaDownloadReport'
/20230601/javaDownloadTokens:
get:
description: 'Returns a list of JavaDownloadTokens.
'
operationId: ListJavaDownloadTokens
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/LifecycleStateQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/JavaDownloadTokenIdentifierQueryParam'
- $ref: '#/components/parameters/JavaDownloadTokenValueQueryParam'
- $ref: '#/components/parameters/JavaFamilyVersionQueryParam'
- $ref: '#/components/parameters/SearchByUserQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/JavaDownloadTokenSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A page of JavaDownloadTokenSummary objects.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaDownloadTokenCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a list of all JavaDownloadTokens in a tenancy.
tags:
- javaDownload
x-example: 'GET /20230601/javaDownloadTokens
Host: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JavaDownloadToken'
post:
description: 'Creates a new JavaDownloadToken in the tenancy with specified attributes.
Ensure that you review the license terms before token generation. Visit the Oracle Java Downloads page to understand the license terms of the Java version for which you are generating a token. By generating a token, you agree to the associated license terms. See Oracle JDK Licensing - FAQs for detailed information.
'
operationId: CreateJavaDownloadToken
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The JavaDownloadToken will be created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaDownloadToken'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates a new JavaDownloadToken
tags:
- javaDownload
x-example: "POST /20230601/javaDownloadTokens\nHost: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"Trial Token\",\n \"description\": \"Trial token for script friendly download\",\n \"compartmentId\":\"ocid1.tenancy.oc1..<unique_id>\",\n \"javaVersion\": \"11\",\n \"licenseType\": [\"OTN\"],\n \"timeExpires\":\"2024-01-26T15:58:25.748Z\",\n}\n"
x-related-resource: '#/definitions/JavaDownloadToken'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateJavaDownloadTokenDetails'
description: Details for the new JavaDownloadToken.
required: true
/20230601/javaDownloadTokens/{javaDownloadTokenId}:
delete:
description: Deletes a JavaDownloadToken resource by identifier.
operationId: DeleteJavaDownloadToken
parameters:
- $ref: '#/components/parameters/JavaDownloadTokenIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The JavaDownloadToken will be deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete a provisioned JavaDownloadToken
tags:
- javaDownload
x-example: 'DELETE /20230601/javaDownloadTokens/<javadownloadtoken_OCID>
Host: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JavaDownloadToken'
get:
description: Gets a JavaDownloadToken by identifier
operationId: GetJavaDownloadToken
parameters:
- $ref: '#/components/parameters/JavaDownloadTokenIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Retrieves the JavaDownloadToken with the given identifier.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaDownloadToken'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get JavaDownloadToken
tags:
- javaDownload
x-example: 'GET /20230601/javaDownloadTokens/<javadownloadtoken_OCID>
Host: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
put:
description: Updates the JavaDownloadToken specified by the identifier.
operationId: UpdateJavaDownloadToken
parameters:
- $ref: '#/components/parameters/JavaDownloadTokenIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The JavaDownloadToken will be updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update JavaDownloadToken
tags:
- javaDownload
x-example: "PUT /20230601/javaDownloadTokens/<javadownloadtoken_OCID>\nHost: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"Updated display name\",\n \"timeExpires\": \"2024-02-26T15:58:25.748Z\",\n}\n"
x-related-resource: '#/definitions/JavaDownloadToken'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateJavaDownloadTokenDetails'
description: The attributes to be updated.
required: true
/20230601/javaLicenseAcceptanceRecords:
get:
description: 'Returns a list of all the Java license acceptance records in a tenancy.
'
operationId: ListJavaLicenseAcceptanceRecords
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/SearchByUserQueryParam'
- $ref: '#/components/parameters/JavaLicenseAcceptanceRecordIdentifierQueryParam'
- $ref: '#/components/parameters/JavaLicenseTypeQueryParam'
- $ref: '#/components/parameters/LicenseAcceptanceStatusQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/LicenseAcceptanceSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A page of JavaLicenseAcceptanceRecordSummary objects.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaLicenseAcceptanceRecordCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists Java license acceptance records in a tenancy.
tags:
- javaDownload
x-example: 'GET /20230601/javaLicenseAcceptanceRecords
Host: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-authz-declarations:
authorizationRequired: false
x-related-resource: '#/definitions/JavaLicenseAcceptanceRecord'
post:
description: 'Creates a Java license acceptance record for the specified license type in a tenancy.
'
operationId: CreateJavaLicenseAcceptanceRecord
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Returns the license acceptance record.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaLicenseAcceptanceRecord'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates a Java license acceptance record
tags:
- javaDownload
x-example: "POST /20230601/javaLicenseAcceptanceRecords\nHost: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"userId\": \"ocid1.user.oc1..<unique_id>\",\n \"compartmentId\": \"ocid1.tenancy.oc1..<unique_id>\",\n \"licenseType\": \"OTN\",\n \"licenseAcceptanceStatus\": \"ACCEPTED\"\n}\n"
x-obmcs-authz-declarations:
authorizationRequired: false
x-related-resource: '#/definitions/JavaLicenseAcceptanceRecord'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateJavaLicenseAcceptanceRecordDetails'
description: Details for the new JavaLicenseAcceptanceRecord.
required: true
/20230601/javaLicenseAcceptanceRecords/{javaLicenseAcceptanceRecordId}:
delete:
description: 'Deletes a Java license acceptance record with the specified identifier.
'
operationId: DeleteJavaLicenseAcceptanceRecord
parameters:
- $ref: '#/components/parameters/JavaLicenseAcceptanceRecordIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The record was successfully deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes a JavaLicenseAcceptanceRecord
tags:
- javaDownload
x-example: 'DELETE /20230601/javaLicenseAcceptanceRecords/<license_acceptance_record_identifier>
Host: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JavaLicenseAcceptanceRecord'
get:
description: 'Returns a specific Java license acceptance record in a tenancy.
'
operationId: GetJavaLicenseAcceptanceRecord
parameters:
- $ref: '#/components/parameters/JavaLicenseAcceptanceRecordIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Retrieves the Java license acceptance record with the given identifier.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaLicenseAcceptanceRecord'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a GetJavaLicenseAcceptanceRecord by identifier.
tags:
- javaDownload
x-example: 'GET /20230601/javaLicenseAcceptanceRecords/<license_acceptance_record_identifier>
Host: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JavaLicenseAcceptanceRecord'
put:
description: 'Updates a specific Java license acceptance record in a tenancy.
'
operationId: UpdateJavaLicenseAcceptanceRecord
parameters:
- $ref: '#/components/parameters/JavaLicenseAcceptanceRecordIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Returns the updated Java license acceptance record.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaLicenseAcceptanceRecord'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a JavaLicenseAcceptanceRecord
tags:
- javaDownload
x-example: "PUT /20230601/javaLicenseAcceptanceRecords/<license_acceptance_record_identifier>\nHost: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"licenseAcceptanceStatus\": \"REVOKED\"\n}\n"
x-related-resource: '#/definitions/JavaLicenseAcceptanceRecord'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateJavaLicenseAcceptanceRecordDetails'
description: Attributes for updating the JavaLicenseAcceptanceRecord.
required: true
/20230601/javaLicenses:
get:
description: 'Return a list with details of all Java licenses.
'
operationId: ListJavaLicenses
parameters:
- $ref: '#/components/parameters/JavaLicenseTypeQueryParam'
- $ref: '#/components/parameters/JavaLicenseDisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/JavaLicenseSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: List of Java licenses.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaLicenseCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List details of all Java licenses.
tags:
- javaDownload
x-example: 'GET /20230601/javaLicenses?limit=10
Host: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-authz-declarations:
authorizationRequired: false
x-related-resource: '#/definitions/JavaLicense'
/20230601/javaLicenses/{licenseType}:
get:
description: 'Return details of the specified Java license type.
'
operationId: GetJavaLicense
parameters:
- $ref: '#/components/parameters/JavaLicenseTypePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Details of a Java license.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaLicense'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get details of a Java license.
tags:
- javaDownload
x-example: 'GET /20230601/javaLicenses/<license_type>
Host: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-authz-declarations:
authorizationRequired: false
x-related-resource: '#/definitions/JavaLicense'
/20230601/workRequests:
get:
description: 'Lists the work requests in a tenancy.
'
operationId: ListWorkRequests
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/WorkRequestIdQueryParam'
- $ref: '#/components/parameters/WorkRequestStatusQueryParam'
- $ref: '#/components/parameters/ResourceIdentifierQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/WorkRequestSortByQueryParam'
responses:
200:
description: The list of work request summaries.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequestSummaryCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List work requests
tags:
- javaDownload
x-related-resource: '#/definitions/WorkRequest'
/20230601/workRequests/{workRequestId}:
delete:
description: Cancels the work request with the given ID.
operationId: CancelWorkRequest
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: The work request will be cancelled.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Cancel work request
tags:
- javaDownload
x-related-resource: '#/definitions/WorkRequest'
get:
description: Gets details of the work request with the given ID.
operationId: GetWorkRequest
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The details of the work request.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
retry-after:
description: A non-negative integer representing the number of seconds the client should wait before polling this endpoint again.
schema:
type: integer
format: int64
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequest'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get work request status
tags:
- javaDownload
x-related-resource: '#/definitions/WorkRequest'
/20230601/workRequests/{workRequestId}/errors:
get:
description: 'Returns a (paginated) list of errors for the work request with the given ID.
'
operationId: ListWorkRequestErrors
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list of work request errors.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequestErrorCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List work request errors
tags:
- javaDownload
x-related-resource: '#/definitions/WorkRequestError'
/20230601/workRequests/{workRequestId}/logs:
get:
description: 'Returns a (paginated) list of logs for the work request with the given ID.
'
operationId: ListWorkRequestLogs
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list of work request logs.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequestLogEntryCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List work request logs
tags:
- javaDownload
x-related-resource: '#/definitions/WorkRequestLogEntry'
/currentJavaReleases:
get:
description: 'Returns a list of the current Oracle Java releases (i.e. CPU, FEATURE and PATCH_RELEASE) that have the latest security vulnerability fixes.
'
operationId: ListCurrentJavaReleases
parameters:
- $ref: '#/components/parameters/IsLtsQueryParam'
- $ref: '#/components/parameters/ReleaseTypeQueryParam'
- $ref: '#/components/parameters/JdkVersionQueryParam'
- $ref: '#/components/parameters/JavaLicenseTypeQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/JavaReleaseSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: List of the current Oracle Java releases that have the latest security vulnerability fixes.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CurrentJavaReleaseCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Retrieves a list of the current Oracle Java releases (i.e. CPU, FEATURE and PATCH_RELEASE) that have the latest security vulnerability fixes.
tags:
- javaDownload
x-example: 'GET /currentJavaReleases?limit=10
Host: java.oraclecloud.com
'
x-obmcs-authz-declarations:
authorizationRequired: false
x-related-resource: '#/definitions/CurrentJavaRelease'
/currentJavaReleases/{jdkVersion}:
get:
description: Returns all information associated with the release, including artifact information.
operationId: GetCurrentJavaRelease
parameters:
- $ref: '#/components/parameters/JdkVersionPathParam'
- $ref: '#/components/parameters/OsArchitectureQueryParam'
- $ref: '#/components/parameters/ArtifactContentTypeQueryParam'
- $ref: '#/components/parameters/ArtifactPackageTypeQueryParam'
- $ref: '#/components/parameters/ArtifactOsFamilyQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/JavaArtifactSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Details of the current release of a Java version.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CurrentJavaRelease'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Retrieves details of the current release, that have the latest security vulnerability fixes, for a specified Java version.
tags:
- javaDownload
x-example: 'GET /currentJavaReleases/<jdk_version_identifier>
Host: java.oraclecloud.com
'
x-obmcs-authz-declarations:
authorizationRequired: false
x-related-resource: '#/definitions/CurrentJavaRelease'
/java/{javaVersion}/{category}/{identifier}:
get:
description: 'Use this API to either download a Java runtime artifact or get its checksum.
The target artifact is determined from the metadata in the URL.
When used for downloading an artifact, the JavaDownloadToken value should be passed in `token` header for authorization. If the artifact corresponds to a Java release under the NFTC license, the token is optional, but providing it ensures the download details are included in the download report.
The `token` header is not required for fetching the checksum.
On success, the API returns HTTP response code `302` and uses redirects for actual operation.
'
operationId: GetJavaArtifact
parameters:
- $ref: '#/components/parameters/JavaVersionPathParam'
- $ref: '#/components/parameters/ArtifactCategoryPathParam'
- $ref: '#/components/parameters/ArtifactIdentifierPathParam'
- $ref: '#/components/parameters/RequestTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: OK
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
format: binary
type: string
302:
description: The redirect URL for download.
headers:
Location:
description: URL to redirect to on returning a 3XX status code.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Download the Java artifact
tags:
- javaDownload
x-example: 'GET /java/19/latest/jdk-19_linux-x64_bin.tar.gz
Host: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com
<token header>
'
x-related-resource: '#/definitions/JavaArtifact'
head:
description: 'Validates if the request for downloading a Java runtime artifact will be successful.
(Optional for releases under NFTC license) The JavaDownloadToken value should be passed in `token` header for authorization.
On success, the API returns HTTP status code `200` and returns artifact metadata in the response headers.
'
operationId: HeadJavaArtifact
parameters:
- $ref: '#/components/parameters/JavaVersionPathParam'
- $ref: '#/components/parameters/ArtifactCategoryPathParam'
- $ref: '#/components/parameters/ArtifactIdentifierPathParam'
- $ref: '#/components/parameters/RequestTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/IfNoneMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Success
headers:
content-length:
description: The artifact size in bytes.
schema:
type: integer
format: int64
content-type:
description: Content-Type of the Java artifact, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.17).
schema:
type: string
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
last-modified:
description: The artifact modification time, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29).
schema:
type: string
format: date-time
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
304:
$ref: '#/components/responses/304'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Validates the download request for a Java runtime artifact.
tags:
- javaDownload
x-example: 'HEAD /java/19/latest/jdk-19_linux-x64_bin.tar.gz
Host: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com
<token header>
'
x-related-resource: '#/definitions/JavaArtifact'
/java/{javaVersion}/{category}/{identifier}/sha256:
get:
description: 'Use this API to get the SHA256 checksum of a Java runtime artifact. The target artifact is determined from the metadata in the URL.
On success, the API returns HTTP response code `200` and the checksum as a raw string.
'
operationId: GetJavaArtifactShaChecksum
parameters:
- $ref: '#/components/parameters/JavaVersionPathParam'
- $ref: '#/components/parameters/ArtifactCategoryPathParam'
- $ref: '#/components/parameters/ArtifactIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The SHA256 checksum of the Java artifact.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
text/plain:
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get the SHA256 checksum of the Java artifact
tags:
- javaDownload
x-example: 'GET /java/19/latest/jdk-19_linux-x64_bin.tar.gz/sha256
Host: javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com
'
x-obmcs-authz-declarations:
authorizationRequired: false
x-related-resource: '#/definitions/JavaArtifact'
/javaReleases:
get:
description: 'Returns a list of the generally available Oracle Java releases (i.e. CPU, FEATURE and PATCH_RELEASE).
'
operationId: ListJavaReleases
parameters:
- $ref: '#/components/parameters/JdkVersionQueryParam'
- $ref: '#/components/parameters/SupportedVersionQueryParam'
- $ref: '#/components/parameters/IsLtsQueryParam'
- $ref: '#/components/parameters/JavaReleaseVersionQueryParam'
- $ref: '#/components/parameters/ReleaseTypeQueryParam'
- $ref: '#/components/parameters/SecurityStatusQueryParam'
- $ref: '#/components/parameters/JavaLicenseTypeQueryParam'
- $ref: '#/components/parameters/DaysUnderSecurityBaselineQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/JavaReleaseSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: List of the Oracle Java releases.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaReleaseCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Retrieves a list of the generally available Oracle Java releases (i.e. CPU, FEATURE and PATCH_RELEASE).
tags:
- javaDownload
x-example: 'GET /javaReleases?limit=10
Host: java.oraclecloud.com
'
x-obmcs-authz-declarations:
authorizationRequired: false
x-related-resource: '#/definitions/JavaRelease'
/javaReleases/{releaseVersion}:
get:
description: Returns all information associated with the release, including artifact information.
operationId: GetJavaRelease
parameters:
- $ref: '#/components/parameters/JavaReleaseIdentifierPathParam'
- $ref: '#/components/parameters/OsArchitectureQueryParam'
- $ref: '#/components/parameters/ArtifactContentTypeQueryParam'
- $ref: '#/components/parameters/ArtifactPackageTypeQueryParam'
- $ref: '#/components/parameters/ArtifactOsFamilyQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/JavaArtifactSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Details of the specific release of a Java version.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaRelease'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Retrieves details of the specified release of a Java version.
tags:
- javaDownload
x-example: 'GET /javaReleases/<release_version_identifier>
Host: java.oraclecloud.com
'
x-obmcs-authz-declarations:
authorizationRequired: false
x-related-resource: '#/definitions/JavaRelease'
/javaVersions:
get:
description: 'Returns a list of the Oracle Java versions.
An Oracle Java version is typically a major version in the Java version identifier.
'
operationId: ListJavaVersions
parameters:
- $ref: '#/components/parameters/JdkVersionQueryParam'
- $ref: '#/components/parameters/SupportedVersionQueryParam'
- $ref: '#/components/parameters/IsLtsQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/JavaVersionSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of the Java major version information.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaVersionCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Retrieves a list of the Oracle Java versions.
tags:
- javaDownload
x-example: 'GET /javaVersions?limit=10
Host: java.oraclecloud.com
'
x-obmcs-authz-declarations:
authorizationRequired: false
x-related-resource: '#/definitions/JavaVersion'
components:
schemas:
CurrentJavaReleaseCollection:
description: Collection of current Java releases properties.
properties:
items:
description: A list of the current Java release properties.
items:
$ref: '#/components/schemas/CurrentJavaReleaseSummary'
maxItems: 100
minItems: 1
type: array
required:
- items
type: object
x-example: "{\n \"items\": [\n {\n \"artifactContentTypes\": [\n \"JDK\"\n ],\n \"daysUnderSecurityBaseline\": 219,\n \"isScriptDownloadAvailable\": true,\n \"jdkDetails\": {\n \"docUrl\": \"https://docs.oracle.com/en/java/javase/17\",\n \"endOfSupportLifeDate\": \"2029-09-18T23:59:59.000Z\",\n \"jdkVersion\": \"17\",\n \"isSupportedVersion\": true,\n \"latestReleaseVersion\": \"17.0.9\",\n \"isLts\": true\n },\n \"licenseDetails\": {\n \"displayName\": \"Oracle No-Fee Terms and Conditions\",\n \"licenseType\": \"NFTC\",\n \"licenseUrl\": \"https://java.com/freeuselicense\"\n },\n \"releaseDate\": \"2023-01-17T00:00:00.000Z\",\n \"releaseNotesUrl\": \"https://www.oracle.com/java/technologies/javase/17-0-6-relnotes.html\",\n \"releaseType\": \"CPU\",\n \"releaseVersion\": \"17.0.6\",\n \"releaseFullVersion\": \"jdk-17.0.6+9\",\n \"securityStatus\": \"UPDATE_REQUIRED\"\n }\n ]\n}\n"
JavaLicense:
allOf:
- $ref: '#/components/schemas/JavaLicenseSummary'
description: 'Details about a license type for Java.
'
x-example: "{\n \"displayName\": \"Oracle Technology Network\",\n \"licenseType\": \"OTN\",\n \"licenseUrl\": \"https://www.oracle.com/downloads/licenses/javase-license1.html\"\n}\n"
Error:
description: An error code and message from an API request failure.
properties:
code:
description: 'A short error code that describes the error, meant for programmatic parsing. See [API Errors](/Content/API/References/apierrors.htm).
'
type: string
message:
description: A human-readable error string.
type: string
required:
- code
- message
WorkRequestSummaryCollection:
description: Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
properties:
items:
description: List of workRequestSummary objects.
items:
$ref: '#/components/schemas/WorkRequestSummary'
type: array
required:
- items
type: object
GenerateArtifactDownloadUrlDetails:
description: The attributes to generate a DownloadUrl for a Java runtime artifact.
properties:
artifactId:
description: Unique identifier for the Java runtime artifact.
format: int64
type: integer
compartmentId:
description: The tenancy [OCID](/Content/General/Concepts/identifiers.htm) of the user initiating the download.
maxLength: 255
minLength: 1
type: string
required:
- artifactId
type: object
JavaLicenseAcceptanceRecordCollection:
description: 'Contains a list of JavaLicenseAcceptanceRecordSummary objects.
'
properties:
items:
description: List of JavaLicenseAcceptanceRecords.
items:
$ref: '#/components/schemas/JavaLicenseAcceptanceRecordSummary'
type: array
required:
- items
type: object
x-example: "{\n items: [\n {\n \"id\": \"ocid1.javadownloadlicense.oc1.iad.<unique_id>\",\n \"licenseAcceptanceStatus\": \"ACCEPTED\",\n \"userId\" : \"ocid1.user.oc1..<unique_id>\",\n \"compartmentId\" : \"ocid1.tenancy.oc1..<unique_id>\"\n \"licenseType\": \"OTN\",\n \"timeAccepted\": \"2023-01-27T15:58:25.748Z\",\n \"timeLastUpdated\": \"2023-01-27T15:58:25.748Z\"\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\":{},\n \"definedTags\":{},\n \"systemTags\":{}\n },\n {\n \"id\": \"ocid1.javadownloadlicense.oc1.iad.<unique_id>\",\n \"licenseAcceptanceStatus\": \"ACCEPTED\",\n \"userId\" : \"ocid1.user.oc1..<unique_id>\",\n \"compartmentId\" : \"ocid1.tenancy.oc1..<unique_id>\"\n \"licenseType\": \"OTN\",\n \"timeAccepted\": \"2023-01-26T15:58:25.748Z\",\n \"timeLastUpdated\": \"2023-01-26T15:58:25.748Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\":{},\n \"definedTags\":{},\n \"systemTags\":{}\n }\n ]\n}\n"
JavaLicenseAcceptanceRecordSummary:
description: 'User acceptance record summary for a Java license.
'
properties:
compartmentId:
description: The tenancy [OCID](/Content/General/Concepts/identifiers.htm) of the user accepting the license.
type: string
createdBy:
$ref: '#/components/schemas/Principal'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer, and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
id:
description: The unique identifier for the acceptance record.
type: string
lastUpdatedBy:
$ref: '#/components/schemas/Principal'
licenseAcceptanceStatus:
description: Status of license acceptance.
enum:
- ACCEPTED
- REVOKED
type: string
x-obmcs-top-level-enum: '#/definitions/LicenseAcceptanceStatus'
licenseType:
description: License type associated with the acceptance.
enum:
- OTN
- NFTC
- BCL
- RESTRICTED
type: string
x-obmcs-top-level-enum: '#/definitions/LicenseType'
lifecycleState:
description: The current state of the JavaLicenseAcceptanceRecord.
enum:
- ACTIVE
- CREATING
- DELETED
- DELETING
- FAILED
- NEEDS_ATTENTION
- UPDATING
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"free-tier-retained": "true"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
System tags can be viewed by users, but can only be created by the system.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeAccepted:
description: 'The date and time of license acceptance (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
timeLastUpdated:
description: 'The date and time of last update (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
required:
- id
- licenseAcceptanceStatus
- compartmentId
- licenseType
- createdBy
- timeAccepted
type: object
x-example: "{\n \"id\": \"ocid1.javadownloadlicense.oc1.iad.<unique_id>\",\n \"licenseAcceptanceStatus\": \"ACCEPTED\",\n \"userId\" : \"ocid1.user.oc1..<unique_id>\",\n \"compartmentId\" : \"ocid1.tenancy.oc1..<unique_id>\"\n \"licenseType\": \"OTN\",\n \"timeAccepted\": \"2023-01-26T15:58:25.748Z\",\n \"timeLastUpdated\": \"2023-01-26T15:58:25.748Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\":{},\n \"definedTags\":{},\n \"systemTags\":{}\n}\n"
JavaLicenseCollection:
description: 'Collection of the Java license summary objects.
'
properties:
items:
description: A list of JavaLicenseSummary objects.
items:
$ref: '#/components/schemas/JavaLicenseSummary'
maxItems: 25
minItems: 1
type: array
required:
- items
type: object
x-example: "{\n items: [\n {\n \"displayName\": \"Oracle Technology Network\",\n \"licenseType\": \"OTN\",\n \"licenseUrl\": \"https://www.oracle.com/downloads/licenses/javase-license1.html\"\n },\n {\n \"displayName\": \"Oracle No-Fee Terms and Conditions\",\n \"licenseType\": \"NFTC\",\n \"licenseUrl\": \"https://www.oracle.com/downloads/licenses/no-fee-license.html\"\n }\n ]\n}\n"
WorkRequestSummary:
description: A summary of the status of a work request.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the tenancy scoped to the work request.
'
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request.
type: string
operationType:
description: Type of the work request.
enum:
- CREATE_JAVA_DOWNLOAD_TOKEN
- UPDATE_JAVA_DOWNLOAD_TOKEN
- DELETE_JAVA_DOWNLOAD_TOKEN
- CREATE_JAVA_DOWNLOAD_REPORT
- DELETE_JAVA_DOWNLOAD_REPORT
type: string
x-obmcs-top-level-enum: '#/definitions/OperationType'
percentComplete:
description: Percentage of the request completed.
format: float
type: number
resources:
description: The resources affected by this work request.
items:
$ref: '#/components/schemas/WorkRequestResource'
type: array
status:
description: Status of current work request.
enum:
- ACCEPTED
- IN_PROGRESS
- WAITING
- NEEDS_ATTENTION
- FAILED
- SUCCEEDED
- CANCELING
- CANCELED
type: string
x-obmcs-top-level-enum: '#/definitions/OperationStatus'
timeAccepted:
description: 'The date and time the request was created, as described in
[RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.
'
format: date-time
type: string
timeFinished:
description: 'The date and time the request was completed, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
timeStarted:
description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),
section 14.29.
'
format: date-time
type: string
required:
- operationType
- status
- id
- compartmentId
- resources
- percentComplete
- timeAccepted
JavaDownloadRecordSummary:
description: A summary of Java artifact download in a tenancy.
properties:
architecture:
description: The target Operating System architecture for the artifact.
type: string
downloadSourceId:
description: Identifier of the source that downloaded the artifact.
type: string
downloadType:
description: Type of download.
type: string
familyDisplayName:
description: The Java family display name.
type: string
familyVersion:
description: The Java family version identifier.
type: string
osFamily:
description: The target Operating System family for the artifact.
type: string
packageType:
description: The package type (typically the file extension) of the artifact.
type: string
packageTypeDetail:
description: Additional information about the package type.
type: string
releaseVersion:
description: The Java release version identifier.
type: string
timeDownloaded:
description: Timestamp of download.
format: date-time
type: string
required:
- downloadSourceId
- timeDownloaded
- downloadType
type: object
x-example: "{\n \"familyVersion\": \"17\",\n \"familyDisplayName\": \"JDK 17\",\n \"releaseVersion\": \"17.0.2\",\n \"osFamily\": \"windows\",\n \"architecture\": \"x64\",\n \"packageType\": \"exe\",\n \"packageTypeDetail\": \"Installer\",\n \"downloadSourceId\": \"ocid1.user.oc1.iad.<unique_id>\",\n \"timeDownloaded\": \"2023-01-26T15:58:25.748Z\",\n \"downloadType\": \"Download by user\"\n}\n"
JavaDownloadRecordCollection:
description: 'Collection of Java download records.
'
properties:
items:
description: A list of Java download records in a tenancy.
items:
$ref: '#/components/schemas/JavaDownloadRecordSummary'
type: array
required:
- items
type: object
x-example: "{\n items: [\n {\n \"familyVersion\": \"17\",\n \"familyDisplayName\": \"JDK 17\",\n \"releaseVersion\": \"17.0.2\",\n \"osFamily\": \"windows\",\n \"architecture\": \"x64\",\n \"packageType\": \"exe\",\n \"packageTypeDetail\": \"Installer\",\n \"downloadSourceId\": \"ocid1.user.oc1.iad.<unique_id>\",\n \"timeDownloaded\": \"2023-01-26T15:58:25.748Z\",\n \"downloadType\": \"Download by user\"\n }\n {\n \"familyVersion\": \"19\",\n \"familyDisplayName\": \"JDK 19\",\n \"releaseVersion\": \"19.0.1\",\n \"osFamily\": \"windows\",\n \"architecture\": \"x64\",\n \"packageType\": \"exe\",\n \"packageTypeDetail\": \"Installer\",\n \"downloadSourceId\": \"ocid1.managementagent.oc1.iad.<unique_id>\",\n \"timeDownloaded\": \"2023-01-27T15:58:25.748Z\",\n \"downloadType\": \"Download by agent\"\n }\n ]\n}\n"
JavaArtifactInfo:
description: Information about an artifact for a Java release.
properties:
architecture:
description: The target Operating System architecture for the artifact.
type: string
artifactType:
description: Product content type of this artifact.
enum:
- JDK
- JRE
- SERVER_JRE
type: string
x-obmcs-top-level-enum: '#/definitions/ArtifactContentType'
checksumCommand:
description: "The complete curl command for getting the checksum value of the artifact. \n$region is a placeholder and must be replaced with the actual value.\nDepending on the use-case, this checksum curl command can point to the checksum value of the archive or latest release version artifact.\n"
type: string
checksumUrl:
description: "The endpoint for retrieving the checksum for the artifact. \n$region is a placeholder and must be replaced with the actual value.\nDepending on the use-case, this checksum endpoint can point to the checksum value of the archive or latest release version artifact.\n"
type: string
description:
description: Description of the artifact. Typically includes the OS, architecture, and installer type.
type: string
downloadCommand:
description: "The complete curl command for downloading the artifact. \n$token and $region are placeholders and must be replaced with the actual value.\nDepending on the use-case, this download curl command can download the archive or latest release version artifact.\n"
type: string
downloadFileSizeInBytes:
description: Download file size in bytes.
format: int64
type: integer
downloadUrl:
description: "The endpoint for downloading the artifact which can be used to automate Java download in scripts and dockerfiles. \n$token and $region are placeholders and must be replaced with the actual value.\nDepending on the use-case, this download endpoint can point to the archive or latest release version artifact.\n"
type: string
osFamily:
description: The target Operating System platform for the artifact.
type: string
packageType:
description: The package type (typically the file extension) of the artifact.
type: string
required:
- downloadFileSizeInBytes
- artifactType
- description
- osFamily
- architecture
- packageType
- checksumUrl
- checksumCommand
- downloadUrl
- downloadCommand
type: object
x-example: '{
"downloadFileSizeInBytes": 180797351,
"architecture": "x64",
"artifactType": "JDK",
"description": "Windows x64 Compressed Archive",
"osFamily": "windows",
"packageType": "zip",
"checksumCommand": "curl -L https://java.oraclecloud.com/java/17/archive/jdk-17.0.9_windows-x64_bin.zip.sha256",
"checksumUrl": "https://java.oraclecloud.com/java/17/archive/jdk-17.0.9_windows-x64_bin.zip.sha256",
"downloadCommand": "curl -H "token:<$token>" -L -O https://java.oraclecloud.com/java/17/archive/jdk-17.0.9_windows-x64_bin.zip",
"downloadUrl": "https://java.oraclecloud.com/java/17/archive/jdk-17.0.9_windows-x64_bin.zip"
}
'
JavaDownloadCountAggregation:
description: Count of Java downloads aggregated by the specified type.
properties:
architecture:
description: The target Operating System architecture for the artifact. Applicable only to `PLATFORM` aggregationType.
type: string
downloadCount:
description: Count of Java downloads.
format: int64
type: integer
familyDisplayName:
description: The Java family display name.
type: string
familyVersion:
description: The Java family version.
type: string
osFamily:
description: The target Operating System family for the artifact. Applicable only to `PLATFORM` aggregationType.
type: string
packageType:
description: The package type (typically the file extension) of the artifact. Applicable only to `PLATFORM` aggregationType.
type: string
packageTypeDetail:
description: Additional information about the package type. Applicable only to `PLATFORM` aggregationType.
type: string
releaseVersion:
description: The Java release version. Applicable only to `JAVA_RELEASE` aggregationType.
type: string
required:
- downloadCount
x-example: "{\n \"familyVersion\": \"17\",\n \"familyDisplayName\": \"JDK 17\",\n \"releaseVersion\": \"17.0.1\",\n \"downloadCount\": 100\n}\n"
DownloadUrl:
description: Download Url object for the Java artifact.
properties:
downloadUrl:
description: The URL for downloading the artifact.
type: string
downloadUrlType:
description: The type of download URL.
enum:
- OSS
- CDN
type: string
x-obmcs-top-level-enum: '#/definitions/DownloadUrlType'
required:
- downloadUrl
- downloadUrlType
type: object
x-example: "{\n \"downloadUrl\": \"<oss_url>\",\n \"downloadUrlType\": \"OSS\"\n}\n"
JavaDownloadCountAggregationCollection:
description: Collection of download count aggregations.
properties:
aggregationType:
description: Aggregation type
enum:
- JAVA_FAMILY
- JAVA_RELEASE
- PLATFORM
type: string
x-obmcs-top-level-enum: '#/definitions/JavaDownloadCountAggregationType'
items:
description: A list of download count aggregations.
items:
$ref: '#/components/schemas/JavaDownloadCountAggregation'
type: array
required:
- aggregationType
- items
type: object
x-example: "{\n \"aggregationType\": \"JAVA_RELEASE\"\n items: [\n {\n \"familyVersion\": \"17\",\n \"familyDisplayName\": \"JDK 17\",\n \"releaseVersion\": \"17.0.1\",\n \"downloadCount\": 100\n },\n {\n \"familyVersion\": \"17\",\n \"familyDisplayName\": \"JDK 17\",\n \"releaseVersion\": \"17.0.2\",\n \"downloadCount\": 200\n },\n {\n \"familyVersion\": \"17\",\n \"familyDisplayName\": \"JDK 17\",\n \"releaseVersion\": \"17.0.3\",\n \"downloadCount\": 250\n } \n ]\n}\n"
JavaDownloadToken:
description: A JavaDownloadToken is a primary resource for the script friendly URLs. The value of this token serves as the authorization token for the download.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the tenancy scoped to the JavaDownloadToken.
'
type: string
createdBy:
$ref: '#/components/schemas/Principal'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer, and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
description:
description: User provided description of the JavaDownloadToken.
maxLength: 255
minLength: 1
type: string
displayName:
description: User provided display name of the JavaDownloadToken.
maxLength: 64
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
id:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the JavaDownloadToken.
'
type: string
isDefault:
description: A flag to indicate if the token is default.
type: boolean
javaVersion:
description: The associated Java version of the JavaDownloadToken.
type: string
lastUpdatedBy:
$ref: '#/components/schemas/Principal'
licenseType:
description: The license type(s) associated with the JavaDownloadToken.
items:
$ref: '#/components/schemas/LicenseType'
maxItems: 10
type: array
uniqueItems: true
lifecycleDetails:
description: Possible lifecycle substates.
enum:
- EXPIRED
- REVOKING
- REVOKED
type: string
x-obmcs-top-level-enum: '#/definitions/TokenLifecycleDetails'
lifecycleState:
description: The current state of the JavaDownloadToken.
enum:
- ACTIVE
- CREATING
- DELETED
- DELETING
- FAILED
- NEEDS_ATTENTION
- UPDATING
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"free-tier-retained": "true"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
System tags can be viewed by users, but can only be created by the system.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the JavaDownloadToken was created, displayed as an [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
format: date-time
type: string
timeExpires:
description: The expiry time of the JavaDownloadToken, displayed as an [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
format: date-time
type: string
timeLastUsed:
description: The time the JavaDownloadToken was last used for download, displayed as an [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the JavaDownloadToken was updated, displayed as an [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
format: date-time
type: string
value:
description: Uniquely generated value for the JavaDownloadToken.
type: string
required:
- id
- displayName
- compartmentId
- createdBy
- description
- value
- javaVersion
- timeCreated
- timeExpires
- lifecycleState
type: object
x-example: "{\n \"id\": \"ocid1.javadownloadtoken.oc1.iad.<unique_id>\",\n \"displayName\": \"A short name for token\",\n \"description\": \"A description for token\",\n \"compartmentId\": \"ocid1.tenancy.oc1..<unique_id>\",\n \"createdBy\": \n {\n \"id\": \"ocid1.user.oc1.iad.<unique_id>\",\n \"displayName\": \"name\",\n \"email\": \"foo@bar.com\"\n },\n \"value\": \"<token_value>\",\n \"timeCreated\": \"2023-01-26T15:58:25.748Z\",\n \"timeExpires\": \"2024-01-26T15:58:25.748Z\",\n \"javaVersion\": \"11\"\n \"licenseType\": [\"OTN\"],\n \"isDefault\" : true,\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\":{},\n \"definedTags\":{},\n \"systemTags\":{}\n}\n"
JavaRelease:
allOf:
- $ref: '#/components/schemas/JavaReleaseSummary'
- properties:
artifacts:
description: List of artifacts associated with a Java release.
items:
$ref: '#/components/schemas/JavaArtifactInfo'
maxItems: 50
minItems: 1
type: array
type: object
description: 'Metadata associated with a specific release within a Java version. Includes the artifact details.
'
x-example: "{ \n \"artifactContentTypes\": [\n \"JDK\"\n ],\n \"daysUnderSecurityBaseline\": 0,\n \"isScriptDownloadAvailable\": true,\n \"jdkDetails\": {\n \"docUrl\": \"https://docs.oracle.com/en/java/javase/17\",\n \"endOfSupportLifeDate\": \"2029-09-18T23:59:59.000Z\",\n \"jdkVersion\": \"17\",\n \"isSupportedVersion\": true,\n \"latestReleaseVersion\": \"17.0.9\",\n \"isLts\": true\n },\n \"licenseDetails\": {\n \"displayName\": \"Oracle No-Fee Terms and Conditions\",\n \"licenseType\": \"NFTC\",\n \"licenseUrl\": \"https://java.com/freeuselicense\"\n },\n \"releaseDate\": \"2023-10-17T00:00:00.000Z\",\n \"releaseNotesUrl\": \"https://www.oracle.com/java/technologies/javase/17-0-9-relnotes.html\",\n \"releaseType\": \"CPU\",\n \"releaseVersion\": \"17.0.9\",\n \"releaseFullVersion\": \"jdk-17.0.9+11\",\n \"securityStatus\": \"UP_TO_DATE\"\n \"artifacts\": [\n {\n \"downloadFileSizeInBytes\": 159698944,\n \"architecture\": \"x64\",\n \"artifactType\": \"JDK\",\n \"description\": \"Windows x64 MSI Installer\",\n \"osFamily\": \"windows\",\n \"packageType\": \"msi\",\n \"checksumCommand\": \"curl -L https://java.oraclecloud.com/java/17/archive/jdk-17.0.9_windows-x64_bin.msi.sha256\",\n \"checksumUrl\": \"https://java.oraclecloud.com/java/17/archive/jdk-17.0.9_windows-x64_bin.msi.sha256\",\n \"downloadCommand\": \"curl -H \"token:<$token>\" -L -O https://java.oraclecloud.com/java/17/archive/jdk-17.0.9_windows-x64_bin.msi\",\n \"downloadUrl\": \"https://java.oraclecloud.com/java/17/archive/jdk-17.0.9_windows-x64_bin.msi\"\n }\n ]\n }\n"
JavaDownloadTokenCollection:
description: 'Contains a list of JavaDownloadTokenSummary objects.
'
properties:
items:
description: List of JavaDownloadTokens.
items:
$ref: '#/components/schemas/JavaDownloadTokenSummary'
type: array
required:
- items
type: object
x-example: "{\n items: [\n {\n \"id\": \"ocid1.javadownloadtoken.oc1.iad.<unique_id>\",\n \"displayName\": \"A short name for token\",\n \"description\": \"A description for token\",\n \"compartmentId\": \"ocid1.tenancy.oc1..<unique_id>\",\n \"createdBy\": \n {\n \"id\": \"ocid1.user.oc1.iad.<unique_id>\",\n \"displayName\": \"name\",\n \"email\": \"foo@bar.com\"\n },\n \"value\": \"token_value\",\n \"timeCreated\": \"2023-01-26T15:58:25.748Z\",\n \"timeExpires\": \"2024-01-26T15:58:25.748Z\",\n \"javaVersion\": \"11\"\n \"licenseType\": [\"OTN\"],\n \"isDefault\" : true,\n \"lifecycleState\": \"ACTIVE\"\n }\n {\n \"id\": \"ocid1.javadownloadtoken.oc1.iad.<unique_id>\",\n \"displayName\": \"A short name for token\",\n \"description\": \"A description for token\",\n \"compartmentId\": \"ocid1.tenancy.oc1..<unique_id>\",\n \"createdBy\": \n {\n \"id\": \"ocid1.user.oc1.iad.<unique_id>\",\n \"displayName\": \"name2\",\n \"email\": \"foo2@bar.com\"\n },\n \"value\": \"<token_value>\",\n \"timeCreated\": \"2023-01-26T15:58:25.748Z\",\n \"timeExpires\": \"2023-06-26T15:58:25.748Z\",\n \"javaVersion\": \"17\"\n \"licenseType\": [\"NFTC\"]\n \"isDefault\" : true,\n \"lifecycleState\": \"ACTIVE\"\n }\n ]\n}\n"
CreateJavaLicenseAcceptanceRecordDetails:
description: The attributes to create a new JavaLicenseAcceptanceRecord.
properties:
compartmentId:
description: The tenancy [OCID](/Content/General/Concepts/identifiers.htm) of the user accepting the license.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer, and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
licenseAcceptanceStatus:
description: Status of license acceptance.
enum:
- ACCEPTED
- REVOKED
type: string
x-obmcs-top-level-enum: '#/definitions/LicenseAcceptanceStatus'
licenseType:
description: License type for the Java version.
enum:
- OTN
- NFTC
- BCL
- RESTRICTED
type: string
x-obmcs-top-level-enum: '#/definitions/LicenseType'
required:
- compartmentId
- licenseType
- licenseAcceptanceStatus
type: object
Principal:
description: An authorized principal.
properties:
displayName:
description: The name of the principal.
type: string
email:
description: The email of the principal.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the principal.
type: string
required:
- id
type: object
JavaReleaseSummary:
description: A summary of the Java release properties.
properties:
artifactContentTypes:
description: Artifact content types for the Java release.
items:
enum:
- JDK
- JRE
- SERVER_JRE
type: string
x-obmcs-top-level-enum: '#/definitions/ArtifactContentType'
maxItems: 3
minItems: 1
type: array
uniqueItems: true
daysUnderSecurityBaseline:
description: The number of days since this release has been under the security baseline.
type: integer
isScriptDownloadAvailable:
description: 'Whether or not this Java release is available for script download.
Older Java releases that do not support scriptable download are available from the [Oracle archive downloads](https://www.oracle.com/in/java/technologies/downloads/archive/).
'
type: boolean
jdkDetails:
$ref: '#/components/schemas/JavaVersionSummary'
licenseDetails:
$ref: '#/components/schemas/JavaLicenseSummary'
releaseDate:
description: The release date of the Java release version (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
format: date-time
type: string
releaseFullVersion:
description: The full Java release version identifier including build number.
type: string
releaseNotesUrl:
description: Release notes associated with the Java release version.
maxLength: 512
type: string
releaseType:
description: Release category of the Java release version.
enum:
- CPU
- FEATURE
- PATCH_RELEASE
type: string
x-obmcs-top-level-enum: '#/definitions/ReleaseType'
releaseVersion:
description: "A specific release or update within a Java major version (e.g., 17.0.5, 21.0.1). Releases within the same major version typically include bug fixes, \nsecurity patches, and potentially minor enhancements.\n"
type: string
securityStatus:
description: The security status of the Java release version.
enum:
- EARLY_ACCESS
- UNKNOWN
- UP_TO_DATE
- UPDATE_REQUIRED
- UPGRADE_REQUIRED
type: string
x-obmcs-top-level-enum: '#/definitions/SecurityStatus'
required:
- artifactContentTypes
- daysUnderSecurityBaseline
- isScriptDownloadAvailable
- jdkDetails
- licenseDetails
- releaseDate
- releaseNotesUrl
- releaseType
- releaseVersion
- releaseFullVersion
- securityStatus
type: object
x-example: "{\n \"artifactContentTypes\": [\n \"JDK\"\n ],\n \"daysUnderSecurityBaseline\": 0,\n \"isScriptDownloadAvailable\": true,\n \"jdkDetails\": {\n \"docUrl\": \"https://docs.oracle.com/en/java/javase/17\",\n \"endOfSupportLifeDate\": \"2029-09-18T23:59:59.000Z\",\n \"jdkVersion\": \"17\",\n \"isSupportedVersion\": true,\n \"latestReleaseVersion\": \"17.0.9\",\n \"isLts\": true\n },\n \"licenseDetails\": {\n \"displayName\": \"Oracle No-Fee Terms and Conditions\",\n \"licenseType\": \"NFTC\",\n \"licenseUrl\": \"https://java.com/freeuselicense\"\n },\n \"releaseDate\": \"2023-10-17T00:00:00.000Z\",\n \"releaseNotesUrl\": \"https://www.oracle.com/java/technologies/javase/17-0-9-relnotes.html\",\n \"releaseType\": \"CPU\",\n \"releaseVersion\": \"17.0.9\",\n \"releaseFullVersion\": \"jdk-17.0.9+11\",\n \"securityStatus\": \"UP_TO_DATE\"\n}\n"
WorkRequestLogEntry:
description: A log message from the execution of a work request.
properties:
message:
description: Human-readable log message.
type: string
timestamp:
description: The time the log message was written. An RFC3339 formatted datetime string.
format: date-time
type: string
required:
- message
- timestamp
JavaLicenseSummary:
description: Summary of a license type for Java.
properties:
displayName:
description: Commonly used name for the license type.
type: string
licenseType:
description: License Type
enum:
- OTN
- NFTC
- BCL
- RESTRICTED
type: string
x-obmcs-top-level-enum: '#/definitions/LicenseType'
licenseUrl:
description: Publicly accessible license URL containing the detailed terms and conditions.
maxLength: 512
type: string
required:
- displayName
- licenseType
- licenseUrl
type: object
x-example: "{\n \"displayName\": \"Oracle Technology Network\",\n \"licenseType\": \"OTN\",\n \"licenseUrl\": \"https://www.oracle.com/downloads/licenses/javase-license1.html\"\n}\n"
WorkRequest:
description: A description of workrequest status.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the tenancy scoped to the work request.
'
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request.
type: string
operationType:
description: Type of the work request.
enum:
- CREATE_JAVA_DOWNLOAD_TOKEN
- UPDATE_JAVA_DOWNLOAD_TOKEN
- DELETE_JAVA_DOWNLOAD_TOKEN
- CREATE_JAVA_DOWNLOAD_REPORT
- DELETE_JAVA_DOWNLOAD_REPORT
type: string
x-obmcs-top-level-enum: '#/definitions/OperationType'
percentComplete:
description: Percentage of the request completed.
format: float
type: number
resources:
description: The resources affected by this work request.
items:
$ref: '#/components/schemas/WorkRequestResource'
type: array
status:
description: Status of current work request.
enum:
- ACCEPTED
- IN_PROGRESS
- WAITING
- NEEDS_ATTENTION
- FAILED
- SUCCEEDED
- CANCELING
- CANCELED
type: string
x-obmcs-top-level-enum: '#/definitions/OperationStatus'
timeAccepted:
description: 'The date and time the request was created, as described in
[RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.
'
format: date-time
type: string
timeFinished:
description: 'The date and time the request was completed, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
'
format: date-time
type: string
timeStarted:
description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),
section 14.29.
'
format: date-time
type: string
required:
- operationType
- status
- id
- compartmentId
- resources
- percentComplete
- timeAccepted
LicenseType:
description: Type of license associated with the Java version.
enum:
- OTN
- NFTC
- BCL
- RESTRICTED
type: string
JavaVersionCollection:
description: 'Collection of the Java main version summary.
A Java version is typically a major version in the Java version identifier.
'
properties:
items:
description: A list of the Java main version summary.
items:
$ref: '#/components/schemas/JavaVersionSummary'
maxItems: 20
minItems: 1
type: array
required:
- items
type: object
x-example: "{\n items: [\n {\n \"docUrl\": \"https://docs.oracle.com/en/java/javase/21\",\n \"endOfSupportLifeDate\": \"2031-09-19T23:59:59.000Z\",\n \"jdkVersion\": \"21\",\n \"isSupportedVersion\": true,\n \"latestReleaseVersion\": \"21.0.1\",\n \"isLts\": true\n },\n {\n \"docUrl\": \"https://docs.oracle.com/en/java/javase/20\",\n \"endOfSupportLifeDate\": \"2023-09-21T23:59:59.000Z\",\n \"jdkVersion\": \"20\",\n \"isSupportedVersion\": false,\n \"latestReleaseVersion\": \"20.0.2\",\n \"isLts\": false\n }\n ]\n}\n"
WorkRequestResource:
description: A resource created or operated on by a work request.
properties:
actionType:
description: 'The way in which this resource is affected by the work tracked in the work request.
A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
work is complete for that resource at which point it will transition to CREATED, UPDATED,
or DELETED, respectively.
'
enum:
- CREATED
- UPDATED
- DELETED
- IN_PROGRESS
- RELATED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/ActionType'
entityType:
description: The resource type the work request affects.
type: string
entityUri:
description: The URI path that the user can do a GET on to access the resource metadata.
type: string
identifier:
description: The identifier of the resource the work request affects.
type: string
required:
- actionType
- entityType
- identifier
UpdateJavaLicenseAcceptanceRecordDetails:
description: The attributes for updating a Java license acceptance record.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer, and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
licenseAcceptanceStatus:
description: Status of license acceptance.
enum:
- ACCEPTED
- REVOKED
type: string
x-obmcs-top-level-enum: '#/definitions/LicenseAcceptanceStatus'
required:
- licenseAcceptanceStatus
WorkRequestError:
description: An error encountered while executing a work request.
properties:
code:
description: 'A machine-usable code for the error that occured. Error codes are listed on
(https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)
'
type: string
message:
description: A human readable description of the issue encountered.
type: string
timestamp:
description: The time the error occured. An RFC3339 formatted datetime string.
format: date-time
type: string
required:
- code
- message
- timestamp
JavaDownloadTokenSummary:
description: Summary of the JavaDownloadToken.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the tenancy scoped to the JavaDownloadToken.
'
type: string
createdBy:
$ref: '#/components/schemas/Principal'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer, and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
description:
description: User provided description of the JavaDownloadToken.
maxLength: 255
minLength: 1
type: string
displayName:
description: User provided display name of the JavaDownloadToken.
maxLength: 64
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
id:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the JavaDownloadToken.
'
type: string
isDefault:
description: A flag to indicate if the token is default.
type: boolean
javaVersion:
description: The associated Java version of the JavaDownloadToken.
type: string
lastUpdatedBy:
$ref: '#/components/schemas/Principal'
licenseType:
description: The license type(s) associated with the JavaDownloadToken.
items:
$ref: '#/components/schemas/LicenseType'
maxItems: 10
type: array
uniqueItems: true
lifecycleDetails:
description: Possible lifecycle substates.
enum:
- EXPIRED
- REVOKING
- REVOKED
type: string
x-obmcs-top-level-enum: '#/definitions/TokenLifecycleDetails'
lifecycleState:
description: The current state of the JavaDownloadToken.
enum:
- ACTIVE
- CREATING
- DELETED
- DELETING
- FAILED
- NEEDS_ATTENTION
- UPDATING
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"free-tier-retained": "true"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
System tags can be viewed by users, but can only be created by the system.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the JavaDownloadToken was created, displayed as an [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
format: date-time
type: string
timeExpires:
description: The expiry time of the JavaDownloadToken, displayed as an [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
format: date-time
type: string
timeLastUsed:
description: The time the JavaDownloadToken was last used for download, displayed as an [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the JavaDownloadToken was updated, displayed as an [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
format: date-time
type: string
value:
description: Uniquely generated value for the JavaDownloadToken.
type: string
required:
- id
- displayName
- compartmentId
- createdBy
- description
- value
- javaVersion
- timeCreated
- timeExpires
- lifecycleState
type: object
x-example: "{\n \"id\": \"ocid1.javadownloadtoken.oc1.iad.<unique_id>\",\n \"displayName\": \"A short name for token\",\n \"description\": \"A description for token\",\n \"compartmentId\": \"ocid1.tenancy.oc1..<unique_id>\",\n \"createdBy\": \n {\n \"id\": \"ocid1.user.oc1.iad.<unique_id>\",\n \"displayName\": \"name\",\n \"email\": \"foo@bar.com\"\n },\n \"value\": \"<token_value>\",\n \"timeCreated\": \"2023-01-26T15:58:25.748Z\",\n \"timeExpires\": \"2024-01-26T15:58:25.748Z\",\n \"javaVersion\": \"11\"\n \"licenseType\": [\"OTN\"],\n \"isDefault\" : true,\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\":{},\n \"definedTags\":{},\n \"systemTags\":{}\n}\n"
JavaVersionSummary:
description: 'A summary of the Java version properties.
The Java version is typically identified by the main version number in the Java release version identifier.
'
properties:
docUrl:
description: Link to access the JDK documentation for the Java version.
maxLength: 512
type: string
endOfSupportLifeDate:
description: 'The End of Support Life (EOSL) date of the Java version (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
isLts:
description: Whether or not this Java major version is under Long Term Support (LTS).
type: boolean
isSupportedVersion:
description: 'Whether or not this Java major version is currently supported by Oracle.
Refer [Java Support Roadmap](https://www.oracle.com/java/technologies/java-se-support-roadmap.html) for more details.
'
type: boolean
jdkVersion:
description: "The major version number of a Java release (e.g., 8, 11, 17, 21). This number signifies a significant change or addition to the Java platform. \nDifferent Java versions may have different features, APIs, and breaking changes.\n"
type: string
latestReleaseVersion:
description: Latest release in the Java major version.
type: string
required:
- docUrl
- endOfSupportLifeDate
- jdkVersion
- isSupportedVersion
- latestReleaseVersion
- isLts
type: object
x-example: "{\n \"docUrl\": \"https://docs.oracle.com/en/java/javase/21\",\n \"endOfSupportLifeDate\": \"2031-09-19T23:59:59.000Z\",\n \"jdkVersion\": \"21\",\n \"isSupportedVersion\": true,\n \"latestReleaseVersion\": \"21.0.1\",\n \"isLts\": true\n}\n"
UpdateJavaDownloadTokenDetails:
description: The attributes of the JavaDownloadToken to be updated.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer, and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
description:
description: User provided description of the JavaDownloadToken.
maxLength: 255
minLength: 1
type: string
displayName:
description: User provided display name of the JavaDownloadToken.
maxLength: 64
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
isDefault:
description: Update the token default status.
type: boolean
licenseType:
description: The license type(s) associated with the JavaDownloadToken.
items:
$ref: '#/components/schemas/LicenseType'
maxItems: 10
type: array
uniqueItems: true
timeExpires:
description: Expiry time of the token.
format: date-time
type: string
type: object
CurrentJavaReleaseSummary:
description: A summary of the current Java release properties.
properties:
artifactContentTypes:
description: Artifact content types for the Java release version.
items:
enum:
- JDK
- JRE
- SERVER_JRE
type: string
x-obmcs-top-level-enum: '#/definitions/ArtifactContentType'
maxItems: 3
minItems: 1
type: array
uniqueItems: true
daysUnderSecurityBaseline:
description: The number of days since this release has been under the security baseline.
type: integer
isScriptDownloadAvailable:
description: 'Whether or not this Java release version is available for script download.
Older Java releases that do not support scriptable download are available from the [Oracle archive downloads](https://www.oracle.com/in/java/technologies/downloads/archive/).
'
type: boolean
jdkDetails:
$ref: '#/components/schemas/JavaVersionSummary'
licenseDetails:
$ref: '#/components/schemas/JavaLicenseSummary'
releaseDate:
description: The release date of the Java release version (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
format: date-time
type: string
releaseFullVersion:
description: The full Java release version identifier including build number.
type: string
releaseNotesUrl:
description: Release notes associated with the Java release version.
maxLength: 512
type: string
releaseType:
description: Release category of the Java release version.
enum:
- CPU
- FEATURE
- PATCH_RELEASE
type: string
x-obmcs-top-level-enum: '#/definitions/ReleaseType'
releaseVersion:
description: "A specific release or update within a Java major version (e.g., 17.0.5, 21.0.1). Releases within the same major version typically include bug fixes, \nsecurity patches, and potentially minor enhancements.\n"
type: string
securityStatus:
description: The security status of the Java release version.
enum:
- EARLY_ACCESS
- UNKNOWN
- UP_TO_DATE
- UPDATE_REQUIRED
- UPGRADE_REQUIRED
type: string
x-obmcs-top-level-enum: '#/definitions/SecurityStatus'
required:
- artifactContentTypes
- daysUnderSecurityBaseline
- isScriptDownloadAvailable
- jdkDetails
- licenseDetails
- releaseDate
- releaseNotesUrl
- releaseType
- releaseVersion
- releaseFullVersion
- securityStatus
type: object
x-example: "{\n \"artifactContentTypes\": [\n \"JDK\"\n ],\n \"daysUnderSecurityBaseline\": 0,\n \"isScriptDownloadAvailable\": true,\n \"jdkDetails\": {\n \"docUrl\": \"https://docs.oracle.com/en/java/javase/17\",\n \"endOfSupportLifeDate\": \"2029-09-18T23:59:59.000Z\",\n \"jdkVersion\": \"17\",\n \"isSupportedVersion\": true,\n \"latestReleaseVersion\": \"17.0.9\",\n \"isLts\": true\n },\n \"licenseDetails\": {\n \"displayName\": \"Oracle No-Fee Terms and Conditions\",\n \"licenseType\": \"NFTC\",\n \"licenseUrl\": \"https://java.com/freeuselicense\"\n },\n \"releaseDate\": \"2023-10-17T00:00:00.000Z\",\n \"releaseNotesUrl\": \"https://www.oracle.com/java/technologies/javase/17-0-9-relnotes.html\",\n \"releaseType\": \"CPU\",\n \"releaseVersion\": \"17.0.9\",\n \"releaseFullVersion\": \"jdk-17.0.9+11\",\n \"securityStatus\": \"UP_TO_DATE\"\n}\n"
JavaReleaseCollection:
description: Collection of Java releases properties.
properties:
items:
description: A list of the Java release properties.
items:
$ref: '#/components/schemas/JavaReleaseSummary'
maxItems: 100
minItems: 1
type: array
required:
- items
type: object
x-example: "{\n \"items\": [\n {\n \"artifactContentTypes\": [\n \"JDK\"\n ],\n \"daysUnderSecurityBaseline\": 219,\n \"isScriptDownloadAvailable\": true,\n \"jdkDetails\": {\n \"docUrl\": \"https://docs.oracle.com/en/java/javase/17\",\n \"endOfSupportLifeDate\": \"2029-09-18T23:59:59.000Z\",\n \"jdkVersion\": \"17\",\n \"isSupportedVersion\": true,\n \"latestReleaseVersion\": \"17.0.9\",\n \"isLts\": true\n },\n \"licenseDetails\": {\n \"displayName\": \"Oracle No-Fee Terms and Conditions\",\n \"licenseType\": \"NFTC\",\n \"licenseUrl\": \"https://java.com/freeuselicense\"\n },\n \"releaseDate\": \"2023-01-17T00:00:00.000Z\",\n \"releaseNotesUrl\": \"https://www.oracle.com/java/technologies/javase/17-0-6-relnotes.html\",\n \"releaseType\": \"CPU\",\n \"releaseVersion\": \"17.0.6\",\n \"releaseFullVersion\": \"jdk-17.0.6+9\",\n \"securityStatus\": \"UPDATE_REQUIRED\"\n }\n ]\n}\n"
CreateJavaDownloadReportDetails:
description: Attributes to create a Java download report.
properties:
compartmentId:
description: 'The compartment [OCID](/Content/General/Concepts/identifiers.htm) here should be
the tenancy OCID.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer, and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
format:
default: CSV
description: The format of the report that is generated.
enum:
- CSV
type: string
x-obmcs-top-level-enum: '#/definitions/JavaDownloadReportFormat'
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
sortBy:
default: timeDownloaded
description: The property to be used for sorting the records.
enum:
- timeDownloaded
- downloadSourceId
- downloadType
type: string
x-obmcs-top-level-enum: '#/definitions/JavaDownloadRecordSortBy'
sortOrder:
default: DESC
description: The sort order for the records.
enum:
- ASC
- DESC
type: string
x-obmcs-top-level-enum: '#/definitions/SortOrder'
timeEnd:
description: 'The end time until when the download records have to be included (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
timeStart:
description: 'The start time from when download records have to be included (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
required:
- compartmentId
- format
type: object
CreateJavaDownloadTokenDetails:
description: The attributes to create a new JavaDownloadToken.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the tenancy scoped to the JavaDownloadToken.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer, and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
description:
description: User provided description of the JavaDownloadToken.
maxLength: 255
minLength: 1
type: string
displayName:
description: User provided display name of the JavaDownloadToken.
maxLength: 64
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
isDefault:
description: The token default attribute.
type: boolean
javaVersion:
description: The Java version associated with the token.
type: string
licenseType:
description: The license type(s) associated with the JavaDownloadToken.
items:
$ref: '#/components/schemas/LicenseType'
maxItems: 10
type: array
uniqueItems: true
timeExpires:
description: Expiry time of the token.
format: date-time
type: string
required:
- displayName
- description
- compartmentId
- javaVersion
- licenseType
- timeExpires
type: object
CurrentJavaRelease:
allOf:
- $ref: '#/components/schemas/CurrentJavaReleaseSummary'
- properties:
artifacts:
description: List of Java artifacts.
items:
$ref: '#/components/schemas/JavaArtifactInfo'
maxItems: 50
minItems: 1
type: array
type: object
description: 'Metadata associated with a current release of Java. Includes the artifact details.
'
x-example: "{ \n \"artifactContentTypes\": [\n \"JDK\"\n ],\n \"daysUnderSecurityBaseline\": 0,\n \"isScriptDownloadAvailable\": true,\n \"jdkDetails\": {\n \"docUrl\": \"https://docs.oracle.com/en/java/javase/17\",\n \"endOfSupportLifeDate\": \"2029-09-18T23:59:59.000Z\",\n \"jdkVersion\": \"17\",\n \"isSupportedVersion\": true,\n \"latestReleaseVersion\": \"17.0.9\",\n \"isLts\": true\n },\n \"licenseDetails\": {\n \"displayName\": \"Oracle No-Fee Terms and Conditions\",\n \"licenseType\": \"NFTC\",\n \"licenseUrl\": \"https://java.com/freeuselicense\"\n },\n \"releaseDate\": \"2023-10-17T00:00:00.000Z\",\n \"releaseNotesUrl\": \"https://www.oracle.com/java/technologies/javase/17-0-9-relnotes.html\",\n \"releaseType\": \"CPU\",\n \"releaseVersion\": \"17.0.9\",\n \"releaseFullVersion\": \"jdk-17.0.9+11\",\n \"securityStatus\": \"UP_TO_DATE\"\n \"artifacts\": [\n {\n \"downloadFileSizeInBytes\": 74684898,\n \"architecture\": \"aarch64\",\n \"artifactType\": \"JDK\",\n \"description\": \"Linux ARM 64 Compressed Archive\",\n \"osFamily\": \"linux\",\n \"packageType\": \"tar.gz\",\n \"checksumCommand\": \"curl -L https://java.oraclecloud.com/java/8/latest/jdk-8_linux-aarch64_bin.tar.gz.sha256\",\n \"checksumUrl\": \"https://java.oraclecloud.com/java/8/latest/jdk-8_linux-aarch64_bin.tar.gz.sha256\",\n \"downloadCommand\": \"curl -H \"token:<$token>\" -L -O https://java.oraclecloud.com/java/8/latest/jdk-8_linux-aarch64_bin.tar.gz\",\n \"downloadUrl\": \"https://java.oraclecloud.com/java/8/latest/jdk-8_linux-aarch64_bin.tar.gz\"\n }\n ]\n"
JavaDownloadReportSummary:
description: 'A summary of the Java download report in a tenancy.
'
properties:
checksumType:
description: The algorithm used for calculating the checksum.
enum:
- SHA256
type: string
x-obmcs-top-level-enum: '#/definitions/ChecksumType'
checksumValue:
description: The checksum value of the Java download report file.
maxLength: 512
type: string
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the tenancy scoped to the Java download report.
'
type: string
createdBy:
$ref: '#/components/schemas/Principal'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer, and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
displayName:
description: Display name for the Java download report.
maxLength: 255
minLength: 1
type: string
fileSizeInBytes:
description: Approximate size of the Java download report file in bytes.
format: int64
type: integer
format:
description: The file format of the Java download report.
enum:
- CSV
type: string
x-obmcs-top-level-enum: '#/definitions/JavaDownloadReportFormat'
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
id:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Java download report.
'
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the Java download report.
enum:
- ACTIVE
- CREATING
- DELETED
- DELETING
- FAILED
- NEEDS_ATTENTION
- UPDATING
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
sortBy:
description: The property used for sorting the records.
enum:
- timeDownloaded
- downloadSourceId
- downloadType
type: string
x-obmcs-top-level-enum: '#/definitions/JavaDownloadRecordSortBy'
sortOrder:
description: The sort order for the records.
enum:
- ASC
- DESC
type: string
x-obmcs-top-level-enum: '#/definitions/SortOrder'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"free-tier-retained": "true"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
System tags can be viewed by users, but can only be created by the system.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the Java download report was created, displayed as an [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
format: date-time
type: string
timeEnd:
description: 'The end time until when the download records are included (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
timeStart:
description: 'The start time from when the download records are included (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
required:
- id
- displayName
- format
- fileSizeInBytes
- checksumType
- checksumValue
- compartmentId
- createdBy
- timeCreated
- lifecycleState
type: object
x-example: "{\n \"id\": \"ocid1.javadownloadreport.oc1.iad.<unique_id>\",\n \"displayName\": \"Display name for the report\",\n \"format\": \"CSV\",\n \"fileSizeInBytes\": 15445,\n \"checksumType\": \"SHA256\",\n \"checksumValue\": \"db82736369765fd1ba92361ca3d7b30d683f078be44f35b879456b014d599271\",\n \"compartmentId\": \"ocid1.tenancy.oc1..<unique_id>\",\n \"createdBy\": \n {\n \"id\": \"ocid1.user.oc1.iad.<unique_id>\",\n \"displayName\": \"name\",\n \"email\": \"foo@bar.com\"\n },\n \"timeCreated\": \"2023-01-26T15:58:25.748Z\",\n \"timeStart\": \"2021-11-28T05:25:10.082Z\",\n \"timeEnd\": \"2022-12-28T05:25:10.082Z\",\n \"sortBy\": \"timeDownloaded\",\n \"sortOrder\": \"DESC\",\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\":{},\n \"definedTags\":{},\n \"systemTags\":{}\n}\n"
WorkRequestErrorCollection:
description: Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
properties:
items:
description: List of workRequestError objects.
items:
$ref: '#/components/schemas/WorkRequestError'
type: array
required:
- items
type: object
JavaDownloadReport:
description: 'Details about a Java download report in a tenancy.
The report is a file in Object Storage. It contains the download records in a specific format.
'
properties:
checksumType:
description: The algorithm used for calculating the checksum.
enum:
- SHA256
type: string
x-obmcs-top-level-enum: '#/definitions/ChecksumType'
checksumValue:
description: The checksum value of the Java download report file.
maxLength: 512
type: string
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the tenancy scoped to the Java download report.
'
type: string
createdBy:
$ref: '#/components/schemas/Principal'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer, and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
displayName:
description: Display name for the Java download report.
maxLength: 255
minLength: 1
type: string
fileSizeInBytes:
description: Approximate size of the Java download report file in bytes.
format: int64
type: integer
format:
description: The file format of the Java download report.
enum:
- CSV
type: string
x-obmcs-top-level-enum: '#/definitions/JavaDownloadReportFormat'
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
id:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Java download report.
'
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the Java download report.
enum:
- ACTIVE
- CREATING
- DELETED
- DELETING
- FAILED
- NEEDS_ATTENTION
- UPDATING
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
sortBy:
description: The property used for sorting the records.
enum:
- timeDownloaded
- downloadSourceId
- downloadType
type: string
x-obmcs-top-level-enum: '#/definitions/JavaDownloadRecordSortBy'
sortOrder:
description: The sort order for the records.
enum:
- ASC
- DESC
type: string
x-obmcs-top-level-enum: '#/definitions/SortOrder'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"free-tier-retained": "true"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
System tags can be viewed by users, but can only be created by the system.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the Java download report was created, displayed as an [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
format: date-time
type: string
timeEnd:
description: 'The end time until when the download records are included (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
timeStart:
description: 'The start time from when the download records are included (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
required:
- id
- displayName
- format
- fileSizeInBytes
- checksumType
- checksumValue
- compartmentId
- createdBy
- timeCreated
- lifecycleState
type: object
x-example: "{\n \"id\": \"ocid1.javadownloadreport.oc1.iad.<unique_id>\",\n \"displayName\": \"Unique name for the report\",\n \"format\": \"CSV\",\n \"fileSizeInBytes\": 15445,\n \"checksumType\": \"SHA256\",\n \"checksumValue\": \"db82736369765fd1ba92361ca3d7b30d683f078be44f35b879456b014d599271\",\n \"compartmentId\": \"ocid1.tenancy.oc1..<unique_id>\",\n \"createdBy\": \n {\n \"id\": \"ocid1.user.oc1.iad.<unique_id>\",\n \"displayName\": \"name\",\n \"email\": \"foo@bar.com\"\n },\n \"timeCreated\": \"2023-01-26T15:58:25.748Z\",\n \"timeStart\": \"2021-11-28T05:25:10.082Z\",\n \"timeEnd\": \"2022-12-28T05:25:10.082Z\",\n \"sortBy\": \"timeDownloaded\",\n \"sortOrder\": \"DESC\",\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\":{},\n \"definedTags\":{},\n \"systemTags\":{}\n}\n"
RequestSummarizedJavaDownloadCountsDetails:
description: Attributes to summarize the Java download counts in a tenancy.
properties:
compartmentId:
description: 'The compartment [OCID](/Content/General/Concepts/identifiers.htm) here should be the tenancy OCID.
'
maxLength: 255
minLength: 1
type: string
familyVersion:
description: Unique Java family version identifier.
type: string
groupAs:
description: The property that specifies the aggregation type for the download counts.
enum:
- JAVA_FAMILY
- JAVA_RELEASE
- PLATFORM
type: string
x-obmcs-top-level-enum: '#/definitions/JavaDownloadCountAggregationType'
limit:
default: 10
description: The maximum number of items to return.
maximum: 1000
minimum: 1
type: integer
page:
description: 'The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous call.
'
maxLength: 4096
minLength: 1
type: string
releaseVersion:
description: Unique Java release version identifier.
type: string
sortBy:
default: FAMILY_VERSION
description: The property to be used for sorting the aggregated report.
enum:
- FAMILY_VERSION
- DOWNLOAD_COUNT
type: string
x-obmcs-top-level-enum: '#/definitions/AggregationSortBy'
sortOrder:
default: DESC
description: The sort order for the aggregated report.
enum:
- ASC
- DESC
type: string
x-obmcs-top-level-enum: '#/definitions/SortOrder'
timeEnd:
description: 'The end time until when the download data has to be included (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
timeStart:
description: 'The start time from when download data has to be included (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
required:
- compartmentId
- groupAs
type: object
JavaDownloadReportCollection:
description: 'Collection of JavaDownloadReportSummary objects.
'
properties:
items:
description: A list of JavaDownloadReportSummary objects in a tenancy.
items:
$ref: '#/components/schemas/JavaDownloadReportSummary'
type: array
required:
- items
type: object
x-example: "{\n items: [\n {\n \"id\": \"ocid1.javadownloadreport.oc1.iad.<unique_id>\",\n \"displayName\": \"Report1\",\n \"format\": \"CSV\",\n \"fileSizeInBytes\": 15445,\n \"checksumType\": \"SHA256\",\n \"checksumValue\": \"db82736369765fd1ba92361ca3d7b30d683f078be44f35b879456b014d599271\",\n \"compartmentId\": \"ocid1.tenancy.oc1..<unique_id>\",\n \"createdBy\": \n {\n \"id\": \"ocid1.user.oc1.iad.<unique_id>\",\n \"displayName\": \"name\",\n \"email\": \"foo@bar.com\"\n },\n \"timeCreated\": \"2023-01-26T15:58:25.748Z\",\n \"timeStart\": \"2021-11-28T05:25:10.082Z\",\n \"timeEnd\": \"2022-12-28T05:25:10.082Z\",\n \"sortBy\": \"timeDownloaded\",\n \"sortOrder\": \"DESC\", \n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\":{},\n \"definedTags\":{},\n \"systemTags\":{}\n },\n {\n \"id\": \"ocid1.javadownloadreport.oc1.iad.<unique_id>\",\n \"displayName\": \"Report2\",\n \"format\": \"CSV\",\n \"fileSizeInBytes\": 15446,\n \"checksumType\": \"SHA256\",\n \"checksumValue\": \"db82736369765fd1ba92361ca3d7b30d683f078be44f35b879456b014d599272\",\n \"compartmentId\": \"ocid1.tenancy.oc1..<unique_id>\",\n \"createdBy\": \n {\n \"id\": \"ocid1.user.oc1.iad.<unique_id>\",\n \"displayName\": \"name\",\n \"email\": \"foo@bar.com\"\n },\n \"timeCreated\": \"2023-01-28T15:58:25.748Z\",\n \"timeStart\": \"2021-11-28T05:25:10.082Z\",\n \"timeEnd\": \"2022-12-01T05:25:10.082Z\",\n \"sortBy\": \"downloadType\",\n \"sortOrder\": \"DESC\", \n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\":{},\n \"definedTags\":{},\n \"systemTags\":{}\n }\n ]\n}\n"
JavaLicenseAcceptanceRecord:
description: User acceptance record for a Java license.
properties:
compartmentId:
description: The tenancy [OCID](/Content/General/Concepts/identifiers.htm) of the user accepting the license.
type: string
createdBy:
$ref: '#/components/schemas/Principal'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer, and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
id:
description: The unique identifier for the acceptance record.
type: string
lastUpdatedBy:
$ref: '#/components/schemas/Principal'
licenseAcceptanceStatus:
description: Status of license acceptance.
enum:
- ACCEPTED
- REVOKED
type: string
x-obmcs-top-level-enum: '#/definitions/LicenseAcceptanceStatus'
licenseType:
description: License type associated with the acceptance.
enum:
- OTN
- NFTC
- BCL
- RESTRICTED
type: string
x-obmcs-top-level-enum: '#/definitions/LicenseType'
lifecycleState:
description: The current state of the JavaLicenseAcceptanceRecord.
enum:
- ACTIVE
- CREATING
- DELETED
- DELETING
- FAILED
- NEEDS_ATTENTION
- UPDATING
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"free-tier-retained": "true"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
System tags can be viewed by users, but can only be created by the system.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeAccepted:
description: 'The date and time of license acceptance (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
timeLastUpdated:
description: 'The date and time of last update (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
required:
- id
- licenseAcceptanceStatus
- compartmentId
- licenseType
- createdBy
- timeAccepted
type: object
x-example: "{\n \"id\": \"ocid1.javadownloadlicense.oc1.iad.<unique_id>\",\n \"licenseAcceptanceStatus\": \"ACCEPTED\",\n \"userId\" : \"ocid1.user.oc1..<unique_id>\",\n \"compartmentId\" : \"ocid1.tenancy.oc1..<unique_id>\"\n \"licenseType\": \"OTN\",\n \"timeAccepted\": \"2023-01-26T15:58:25.748Z\",\n \"timeLastUpdated\": \"2023-01-26T15:58:25.748Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\":{},\n \"definedTags\":{},\n \"systemTags\":{}\n}\n"
WorkRequestLogEntryCollection:
description: Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
properties:
items:
description: List of workRequestLogEntries.
items:
$ref: '#/components/schemas/WorkRequestLogEntry'
type: array
required:
- items
type: object
parameters:
JdkVersionQueryParam:
description: The Java major version.
in: query
name: jdkVersion
required: false
x-default-description: 'null'
schema:
type: string
OsFamilyQueryParam:
description: Target Operating System family of the artifact.
in: query
name: osFamily
required: false
x-default-description: 'null'
schema:
type: string
JavaDownloadTokenIdentifierQueryParam:
description: Unique JavaDownloadToken identifier.
in: query
name: id
x-default-description: 'null'
schema:
type: string
IfNoneMatchHeader:
description: 'For conditional requests. In the GET or HEAD call for a resource, set the
`If-None-Match` header to the value of the ETag from a previous response for that resource.
The server will return with either a 304 Not Modified response if the resource has not changed, or a
200 OK response with the updated representation.
'
in: header
name: if-none-match
required: false
x-default-description: 'null'
schema:
type: string
JavaLicenseAcceptanceRecordIdentifierQueryParam:
description: Unique Java license acceptance record identifier.
in: query
name: id
x-default-description: 'null'
schema:
type: string
JavaReleaseSortByQueryParam:
description: 'If no value is specified _releaseDate_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/JavaReleaseSortBy'
schema:
type: string
enum:
- releaseDate
- releaseVersion
- jdkVersion
- licenseType
default: releaseDate
IfMatchHeader:
description: 'For optimistic concurrency control. In the PUT or DELETE call
for a resource, set the `if-match` parameter to the value of the
ETag from a previous GET or POST response for that resource.
The resource will be updated or deleted only if the ETag you
provide matches the resource''s current ETag value.
'
in: header
name: if-match
required: false
schema:
type: string
ReportDisplayNameQueryParam:
description: A filter to return only resources that match the display name.
in: query
name: displayName
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
SortOrderQueryParam:
description: The sort order, either 'asc' or 'desc'.
in: query
name: sortOrder
x-obmcs-top-level-enum: '#/definitions/SortOrder'
schema:
type: string
enum:
- ASC
- DESC
default: ASC
JavaLicenseDisplayNameQueryParam:
description: A filter to return only resources that match the display name.
in: query
name: displayName
required: false
x-default-description: 'null'
schema:
type: string
LicenseAcceptanceStatusQueryParam:
description: The status of license acceptance.
in: query
name: status
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/LicenseAcceptanceStatus'
schema:
type: string
enum:
- ACCEPTED
- REVOKED
JavaDownloadTokenIdentifierPathParam:
description: Unique JavaDownloadToken identifier.
in: path
name: javaDownloadTokenId
required: true
schema:
type: string
ArchitectureTypeQueryParam:
description: Target Operating System architecture of the artifact.
in: query
name: architecture
required: false
x-default-description: 'null'
schema:
type: string
JavaDownloadTokenValueQueryParam:
description: Unique JavaDownloadToken value.
in: query
name: value
x-default-description: 'null'
schema:
type: string
JavaLicenseSortByQueryParam:
description: 'The field to sort by. If no value is specified, _licenseType_ is the default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/LicenseSortBy'
schema:
type: string
enum:
- licenseType
- displayName
default: licenseType
PackageTypeDetailQueryParam:
description: Packaging type detail of the artifact.
in: query
name: packageTypeDetail
required: false
x-default-description: 'null'
schema:
type: string
SearchByUserQueryParam:
description: "A filter to return only resources that match the user principal detail. \nThe search string can be any of the property values from the [Principal](#/en/jms/latest/datatypes/Principal) object.\nThis object is used as a response datatype for the `createdBy` and `lastUpdatedBy` fields in applicable resource.\n"
in: query
name: searchByUser
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
ArtifactPackageTypeQueryParam:
description: Filter the release version artifact by the supported artifact package type.
in: query
name: packageType
required: false
x-default-description: 'null'
schema:
type: string
JavaDownloadReportIdentifierQueryParam:
description: Unique Java download report identifier.
in: query
name: javaDownloadReportId
required: false
x-default-description: 'null'
schema:
type: string
RequestIdHeader:
description: The client request ID for tracing.
in: header
name: opc-request-id
schema:
type: string
JavaDownloadReportSortByQueryParam:
description: 'The field to sort by. If no value is specified, _timeCreated_ is the default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/JavaDownloadReportSortBy'
schema:
type: string
enum:
- timeCreated
- displayName
default: timeCreated
JavaFamilyVersionQueryParam:
description: Unique Java family version identifier.
in: query
name: familyVersion
required: false
x-default-description: 'null'
schema:
type: string
LifecycleStateQueryParam:
description: A filter to return only resources their lifecycleState matches the given lifecycleState.
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
schema:
type: string
enum:
- ACTIVE
- CREATING
- DELETED
- DELETING
- FAILED
- NEEDS_ATTENTION
- UPDATING
ResourceIdentifierQueryParam:
description: The ID of the resource affected by the work request.
in: query
name: resourceId
x-default-description: 'null'
schema:
type: string
DaysUnderSecurityBaselineQueryParam:
description: Filter the Java release versions by the number of days it is under the security baseline.
in: query
name: daysUnderSecurityBaseline
required: false
x-default-description: 'null'
schema:
type: integer
WorkRequestStatusQueryParam:
description: A filter to return only resources their lifecycleState matches the given OperationStatus.
in: query
name: status
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/OperationStatus'
schema:
type: string
enum:
- ACCEPTED
- IN_PROGRESS
- WAITING
- NEEDS_ATTENTION
- FAILED
- SUCCEEDED
- CANCELING
- CANCELED
JavaDownloadReportIdentifierPathParam:
description: Unique Java download report identifier.
in: path
name: javaDownloadReportId
required: true
schema:
type: string
SupportedVersionQueryParam:
description: Filter the Java versions by the Oracle support status.
in: query
name: isSupportedVersion
required: false
x-default-description: 'null'
schema:
type: boolean
WorkRequestIdPathParam:
description: The ID of the asynchronous request.
in: path
name: workRequestId
required: true
schema:
type: string
DisplayNameQueryParam:
description: A filter to return only resources that match the entire display name given.
in: query
name: displayName
x-default-description: 'null'
schema:
type: string
maxLength: 64
minLength: 1
PaginationTokenQueryParam:
description: The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
in: query
name: page
x-default-description: 'null'
schema:
type: string
maxLength: 4096
minLength: 1
ReleaseTypeQueryParam:
description: Filter the Java releases by the release type.
in: query
name: releaseType
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/ReleaseType'
schema:
type: string
enum:
- CPU
- FEATURE
- PATCH_RELEASE
SecurityStatusQueryParam:
description: The security status of the Java release.
in: query
name: securityStatus
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/SecurityStatus'
schema:
type: string
enum:
- EARLY_ACCESS
- UNKNOWN
- UP_TO_DATE
- UPDATE_REQUIRED
- UPGRADE_REQUIRED
JavaLicenseTypePathParam:
description: Unique Java license type.
in: path
name: licenseType
required: true
x-obmcs-top-level-enum: '#/definitions/LicenseType'
schema:
type: string
enum:
- OTN
- NFTC
- BCL
- RESTRICTED
IsLtsQueryParam:
description: Filter the Java versions by the long term support status.
in: query
name: isLts
required: false
x-default-description: 'null'
schema:
type: boolean
WorkRequestIdQueryParam:
description: The ID of an asynchronous work request.
in: query
name: id
x-default-description: 'null'
schema:
type: string
ArtifactIdentifierPathParam:
description: 'The identifier of the artifact to be downloaded. The identifier is a combination of
release version, operating system, architecture, and packaging option. For the checksum,
it additionally includes the checksum type.
'
in: path
name: identifier
required: true
schema:
type: string
maxLength: 255
minLength: 1
WorkRequestLogAndErrorSortByQueryParam:
description: 'The field to sort by. Only one sort order may be provided. Default order for timestamp is descending.
'
in: query
name: sortBy
schema:
type: string
enum:
- timestamp
default: timestamp
JavaReleaseIdentifierPathParam:
description: Unique Java release version identifier
in: path
name: releaseVersion
required: true
schema:
type: string
OsArchitectureQueryParam:
description: Filter the release version artifact by the supported Operating System architecture.
in: query
name: architecture
required: false
x-default-description: 'null'
schema:
type: string
RetryTokenHeader:
description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or
server error without risk of executing that same action again. Retry tokens expire after 24
hours, but can be invalidated before then due to conflicting operations. For example, if a resource
has been deleted and purged from the system, then a retry of the original creation request
might be rejected.
'
in: header
name: opc-retry-token
required: false
schema:
type: string
maxLength: 64
minLength: 1
JavaDownloadTokenSortByQueryParam:
description: 'The field to sort by. If no value is specified, _timeCreated_ is the default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/TokenSortBy'
schema:
type: string
enum:
- timeCreated
- timeExpires
- state
- displayName
- javaVersion
default: timeCreated
ArtifactOsFamilyQueryParam:
description: Filter the release version artifact by the supported Operating System.
in: query
name: osFamily
required: false
x-default-description: 'null'
schema:
type: string
WorkRequestSortByQueryParam:
description: 'The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.
'
in: query
name: sortBy
schema:
type: string
enum:
- timeAccepted
default: timeAccepted
JavaLicenseAcceptanceRecordIdentifierPathParam:
description: Unique Java license acceptance record identifier.
in: path
name: javaLicenseAcceptanceRecordId
required: true
schema:
type: string
TimeEndQueryParam:
description: The end of the time period for which reports are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
in: query
name: timeEnd
required: false
x-default-description: Current time
schema:
type: string
format: date-time
JavaVersionPathParam:
description: The Java family version of the artifact to download.
in: path
name: javaVersion
required: true
schema:
type: string
DownloadRecordSortByQueryParam:
description: 'If no value is specified _timeDownloaded_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/JavaDownloadRecordSortBy'
schema:
type: string
enum:
- timeDownloaded
- downloadSourceId
- downloadType
default: timeDownloaded
CompartmentIdQueryParam:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the tenancy.
'
in: query
name: compartmentId
required: true
schema:
type: string
maxLength: 255
minLength: 1
PaginationLimitQueryParam:
description: The maximum number of items to return.
in: query
name: limit
schema:
type: integer
default: 10
maximum: 1000
minimum: 1
JavaReleaseVersionQueryParam:
description: Unique Java release version identifier.
in: query
name: releaseVersion
required: false
x-default-description: 'null'
schema:
type: string
TimeStartQueryParam:
description: The start of the time period for which reports are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
in: query
name: timeStart
required: false
x-default-description: Current time minus seven days
schema:
type: string
format: date-time
ArtifactCategoryPathParam:
description: The category of Java version that is specified for download.
in: path
name: category
required: true
x-obmcs-top-level-enum: '#/definitions/ArtifactCategory'
schema:
type: string
enum:
- latest
- archive
maxLength: 120
minLength: 1
JavaArtifactSortByQueryParam:
description: 'If no value is specified _osFamily_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/JavaArtifactSortBy'
schema:
type: string
enum:
- osFamily
- architecture
- artifactType
- packageType
default: osFamily
JavaVersionSortByQueryParam:
description: 'If no value is specified _jdkVersion_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/JavaVersionSortBy'
schema:
type: string
enum:
- jdkVersion
- endOfSupportLifeDate
default: jdkVersion
RequestTokenHeader:
description: (Optional for releases under NFTC license) The bearer token for authorizing the download.
in: header
name: token
required: false
x-default-description: 'null'
schema:
type: string
ArtifactContentTypeQueryParam:
description: Filter the release version artifact by the supported artifact content type.
in: query
name: artifactType
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/ArtifactContentType'
schema:
type: string
enum:
- JDK
- JRE
- SERVER_JRE
JavaLicenseTypeQueryParam:
description: Unique Java license type.
in: query
name: licenseType
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/LicenseType'
schema:
type: string
enum:
- OTN
- NFTC
- BCL
- RESTRICTED
LicenseAcceptanceSortByQueryParam:
description: 'The field to sort by. If no value is specified, _timeAccepted_ is the default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/LicenseAcceptanceSortBy'
schema:
type: string
enum:
- timeAccepted
- timeLastUpdated
- licenseAcceptanceStatus
default: timeAccepted
JdkVersionPathParam:
description: Unique Java major version identifier
in: path
name: jdkVersion
required: true
schema:
type: string
responses:
default:
description: Unknown Error
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-anchors:
x-headers:
content-length:
description: The content size of the body in bytes.
format: int64
type: integer
content-type:
description: The content type of the body.
type: string
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
type: string
location:
description: URL to redirect to on returning a 3XX status code.
type: string
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
'
type: string
retry-after:
description: A non-negative integer representing the number of seconds the client should wait before polling this endpoint again.
format: int64
type: integer
x-properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer, and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"free-tier-retained": "true"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
System tags can be viewed by users, but can only be created by the system.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
targetCompartmentId: 'request.body.compartmentId != null ? request.body.compartmentId : ( request.serviceName == ''JavaManagementServiceDownloadDev'' || request.serviceName == ''JavaManagementServiceDownloadDev2'' || request.serviceName == ''JavaManagementServiceDownloadDev3'' || request.serviceName == ''JavaManagementServiceDownloadStage'') ? ''ocid1.tenancy.oc1..aaaaaaaajhbzef3dwuda6nytzggrlvjo6wt7dfcfexgqzguzhvtt2fc3h7ka'' : ( request.serviceName == ''JavaManagementServiceDownloadTest'' || request.serviceName == ''JavaManagementServiceDownloadTest2'' || request.serviceName == ''JavaManagementServiceDownloadTest3'') ? ''ocid1.tenancy.oc1..aaaaaaaauc7w6xwbexltofomotjo6b3lodrzyf3wpdqgkkfuj26i6jrr5duq'' : request.serviceName == ''JavaManagementServiceDownload-rbaastest'' ? ''ocid1.tenancy.oc1..aaaaaaaa4wm4ktqfr2kwrehyw7tchtkptxmhlsh7yanny5wkpvogvkg75fna'' : request.tenancyId
'
userEmail: '(request.getPrincipalType(request.principal)==''user'') ? splat.getUser(request.principalMetadata, request.principal)?.userEmail : ''''
'
userName: '(request.getPrincipalType(request.principal)==''user'') ? splat.getUser(request.principalMetadata, request.principal)?.userName : request.subjectId
'
userOcid: '(request.getPrincipalType(request.principal)==''user'') ? splat.getUser(request.principalMetadata, request.principal)?.userOcid : request.subjectId
'
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.oci.jms.jd