openapi: 3.2.0 info: description: The APIs for Analyze Applications and other utilities of Java Management Service. title: Java Management Service Utilities Jms Utils API version: '20250521' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/fa4258099975c15660254dbd2ba6c584173b6610144b9157d5731fc976e2eb89.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Java Management Service Utilities 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/fa4258099975c15660254dbd2ba6c584173b6610144b9157d5731fc976e2eb89.yaml what: the harvested document for Java Management Service Utilities API servers: - url: http://127.0.0.1/20250521 - url: https://127.0.0.1/20250521 tags: - name: jmsUtils paths: /analyzeApplicationsConfiguration: get: description: 'Returns the configuration for analyzing applications. ' operationId: GetAnalyzeApplicationsConfiguration parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The analyze application configuration. 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, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AnalyzeApplicationsConfiguration' 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: Returns the configuration for analyzing applications. tags: - jmsUtils x-related-resource: '#/definitions/AnalyzeApplicationsConfiguration' put: description: Updates the configuration for analyze application. operationId: UpdateAnalyzeApplicationsConfiguration parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Analyze applications configuration has been updated. 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, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AnalyzeApplicationsConfiguration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the Analyze application configuration. tags: - jmsUtils x-related-resource: '#/definitions/AnalyzeApplicationsConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAnalyzeApplicationsConfigurationDetails' description: The information to be updated. required: true /javaMigrationAnalysis: get: description: 'Gets a list of Java Migration Analysis. ' operationId: ListJavaMigrationAnalysis parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/JavaMigrationAnalysisIdentifierQueryParam' - $ref: '#/components/parameters/AnalysisProjectNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/JavaMigrationAnalysisSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of JavaMigrationAnalysisSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/JavaMigrationAnalysisCollection' 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 Java Migration Analysis. tags: - jmsUtils x-related-resource: '#/definitions/JavaMigrationAnalysis' /javaMigrationAnalysis/actions/requestJavaMigrationAnalysis: post: description: 'Requests Java Migration Analysis. ' operationId: RequestJavaMigrationAnalysis parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The JavaMigrationAnalysis will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' 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: Requests Java Migration Analysis. tags: - jmsUtils x-related-resource: '#/definitions/JavaMigrationAnalysis' requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestJavaMigrationAnalysisDetails' description: Details for the new JavaMigrationAnalysis. required: true /javaMigrationAnalysis/{javaMigrationAnalysisId}: delete: description: Deletes a Java Migration Analysis. operationId: DeleteJavaMigrationAnalysis parameters: - $ref: '#/components/parameters/JavaMigrationAnalysisIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The Java Migration Analysis has been DELETED. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please 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 Java Migration Analysis. tags: - jmsUtils x-related-resource: '#/definitions/JavaMigrationAnalysis' get: description: Gets information about a Java Migration Analysis. operationId: GetJavaMigrationAnalysis parameters: - $ref: '#/components/parameters/JavaMigrationAnalysisIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The JavaMigrationAnalysis was retrieved. 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, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/JavaMigrationAnalysis' 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 Java Migration Analysis tags: - jmsUtils /performanceTuningAnalysis: get: description: 'Gets a list of Performance tuning Analysis. ' operationId: ListPerformanceTuningAnalysis parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PerformanceTuningAnalysisIdentifierQueryParam' - $ref: '#/components/parameters/AnalysisProjectNameQueryParam' - $ref: '#/components/parameters/PerformanceTuningAnalysisResultQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PerformanceTuningAnalysisSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of PerformanceTuningAnalysisSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PerformanceTuningAnalysisCollection' 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 Performance tuning analysis. tags: - jmsUtils x-related-resource: '#/definitions/PerformanceTuningAnalysis' /performanceTuningAnalysis/actions/requestPerformanceTuningAnalysis: post: description: 'Requests Performance Tuning Analysis. ' operationId: RequestPerformanceTuningAnalysis parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The PerformanceTuningAnalysis will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 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: Requests a Performance Tuning Analysis. tags: - jmsUtils x-related-resource: '#/definitions/PerformanceTuningAnalysis' requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestPerformanceTuningAnalysisDetails' description: Details for the new PerformanceTuningAnalysis. required: true /performanceTuningAnalysis/{performanceTuningAnalysisId}: delete: description: Deletes a Performance Tuning Analysis. operationId: DeletePerformanceTuningAnalysis parameters: - $ref: '#/components/parameters/PerformanceTuningAnalysisIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The Performance Tuning Analysis has been DELETED. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please 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 Performance Tuning Analysis. tags: - jmsUtils x-related-resource: '#/definitions/PerformanceTuningAnalysis' get: description: Gets information about a Performance Tuning Analysis. operationId: GetPerformanceTuningAnalysis parameters: - $ref: '#/components/parameters/PerformanceTuningAnalysisIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The PerformanceTuningAnalysis was retrieved. 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, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PerformanceTuningAnalysis' 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 Performance Tuning Analysis tags: - jmsUtils /subscriptionAcknowledgmentConfiguration: get: description: 'Returns the configuration for subscription acknowledgment. ' operationId: GetSubscriptionAcknowledgmentConfiguration parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The subscription acknowledgment configuration. 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, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SubscriptionAcknowledgmentConfiguration' 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: Returns the configuration for subscription acknowledgment. tags: - jmsUtils x-related-resource: '#/definitions/SubscriptionAcknowledgmentConfiguration' put: description: Updates the configuration for subscription acknowledgment. operationId: UpdateSubscriptionAcknowledgmentConfiguration parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Subscription acknowledgment configuration has been updated. 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, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SubscriptionAcknowledgmentConfiguration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the Subscription acknowledgment configuration. tags: - jmsUtils x-related-resource: '#/definitions/SubscriptionAcknowledgmentConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSubscriptionAcknowledgmentConfigurationDetails' description: The configuration to be updated. required: true /workRequests: get: description: 'Lists the work requests in a compartment. ' 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 requests was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please 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: - jmsUtils x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: delete: description: Cancels a work request. operationId: CancelWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The work request will be canceled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please 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: - jmsUtils x-related-resource: '#/definitions/WorkRequest' get: description: Gets the details of a work request. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The work request was retrieved. 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, please provide the request ID. ' schema: type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer 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: - jmsUtils x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Lists the errors for a work request. ' 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 was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please 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: - jmsUtils x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Lists the logs for a work request. ' 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. 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, please 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: - jmsUtils x-related-resource: '#/definitions/WorkRequestLogEntry' /workRequests/{workRequestId}/workItems: get: description: 'Retrieve a paginated list of work items for a specified work request. ' operationId: ListWorkItems parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: A list of work items. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkItemCollection' 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 items of a work request. tags: - jmsUtils x-related-resource: '#/definitions/WorkItemSummary' components: schemas: UpdateAnalyzeApplicationsConfigurationDetails: description: Attributes to update an Analyze Applications Configuration. properties: bucketName: description: The name of the bucket used for analyzing applications. maxLength: 255 minLength: 1 type: string namespaceName: description: The Object Storage namespace used for analyzing applications. maxLength: 255 minLength: 1 type: string type: object x-example: "{\n \"namespaceName\": \"oardccsi\",\n \"bucketName\": \"jmsutils-java-migration\"\n}\n" PerformanceTuningAnalysisSummary: description: Summary information about a Performance Tuning Analysis. properties: analysisProjectName: description: Name of the analysis project. maxLength: 255 minLength: 1 type: string artifactObjectStoragePath: description: Object storage path to the artifact. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string createdBy: $ref: '#/components/schemas/Principal' id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Performance Tuning Analysis. maxLength: 255 minLength: 1 type: string result: description: Possible Performance Tuning Result statuses. type: string x-obmcs-enumref: '#/definitions/PerformanceTuningAnalysis/result' resultObjectStoragePath: description: Object storage path to the analysis. type: string timeCreated: description: 'The date and time the Performance Tuning Analysis was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeFinished: description: 'The date and time the Performance Tuning Analysis was finished, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeStarted: description: 'The date and time the Performance Tuning Analysis was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string warningCount: default: 0 description: Number of warnings in the Performance Tuning Analysis. minimum: 0 type: integer workRequestId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Work Request. maxLength: 255 minLength: 1 type: string required: - id - workRequestId - compartmentId - analysisProjectName - warningCount - result - resultObjectStoragePath - artifactObjectStoragePath - timeCreated - timeStarted - timeFinished - createdBy type: object x-example: "{\n \"id\": \"ocid1.jfrreport\",\n \"workRequestId\": \"ocid1.jmsworkrequest.aaaaaaaamh2kjcjdka2dwakgsfutru4ml4mswwnm6zdcowoqxhbv6qvkrcea\",\n \"compartmentId\": \"ocid1.tenancy.oc1..aaaaaaaawgbzspd6cjovpmic7dahwbalg4opcbixgguo6z2s7t335m6labcd\",\n \"analysisProjectName\": \"my-project\",\n \"warningCount\": 3,\n \"result\": \"ACTION_RECOMMENDED\",\n \"resultObjectStoragePath\": \"/JMS/utils/results/performanceTuning/performanceTuningResult.json\",\n \"artifactObjectStoragePath\": \"/JMS/utils/myartifacts2.jfr\",\n \"timeCreated\": \"2024-11-07T09:14:20.300Z\",\n \"timeStarted\": \"2024-11-07T09:14:20.300Z\",\n \"timeFinished\": \"2024-11-07T09:14:20.300Z\",\n \"createdBy\": {\n \"id\": \"ocid1.user.oc1..aaaaaaaamh2kjcjdka2dwakgsfutru4ml4mswwnm6zdcowoqxhbv6qvkrcea\",\n \"displayName\": \"userName\" \n }\n}\n" RequestJavaMigrationAnalysisDetails: description: The data to bulk create Java Migration Analysis. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the Java Migration Analysis will be created. maxLength: 255 minLength: 1 type: string definedTags: 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: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object targets: description: The list of targets for the Java Migration Analysis. items: $ref: '#/components/schemas/JavaMigrationAnalysisTarget' maxItems: 1000 type: array required: - compartmentId - targets type: object Error: description: Error information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error message. type: string required: - code - message JavaMigrationAnalysisCollection: description: Results of a Java Migration Analysis search. Contains JavaMigrationAnalysisSummary items. properties: items: description: List of Java Migration Analysis. items: $ref: '#/components/schemas/JavaMigrationAnalysisSummary' type: array required: - items type: object AnalyzeApplicationsConfiguration: description: The configuration for analyzing applications. properties: bucketName: description: The name of the bucket used for analyzing applications. maxLength: 255 minLength: 1 type: string namespaceName: description: The Object Storage namespace used for analyzing applications. maxLength: 255 minLength: 1 type: string required: - namespaceName - bucketName type: object x-example: "{\n \"namespaceName\": \"oardccsi\",\n \"bucketName\": \"jmsutils-java-migration\"\n}\n" WorkItemSummary: description: Work item to complete a work request. properties: details: $ref: '#/components/schemas/WorkItemDetails' id: description: The unique ID of ths work item. type: string retryCount: description: Number of times this work item is retried. type: integer status: description: The status of the work item. enum: - ACCEPTED - IN_PROGRESS - CANCELING - CANCELED - SUCCEEDED - NEEDS_ATTENTION - RETRYING - SKIPPED type: string x-obmcs-top-level-enum: '#/definitions/WorkItemStatus' timeLastUpdated: description: 'The date and time the work item was last updated. (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). ' format: date-time type: string workRequestId: description: The OCID of the work request created this work item. type: string required: - id - workRequestId - status - details - retryCount type: object WorkItemCollection: description: A list of WorkItem. properties: items: description: A list of work request items. items: $ref: '#/components/schemas/WorkItemSummary' type: array required: - items type: object PerformanceTuningAnalysis: description: 'To use any of the API operations, you must be authorized by an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm). ' properties: analysisProjectName: description: Name of the analysis project. maxLength: 255 minLength: 1 type: string artifactObjectStoragePath: description: Object storage path to the artifact. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string createdBy: $ref: '#/components/schemas/Principal' id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Performance Tuning Analysis. maxLength: 255 minLength: 1 type: string result: description: Possible Performance Tuning Result statuses. enum: - ACTION_RECOMMENDED - NO_WARNINGS type: string resultObjectStoragePath: description: Object storage path to the analysis. type: string timeCreated: description: 'The date and time the Performance Tuning Analysis was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeFinished: description: 'The date and time the Performance Tuning Analysis was finished, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeStarted: description: 'The date and time the Performance Tuning Analysis was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string warningCount: default: 0 description: Number of warnings in the Performance Tuning Analysis. minimum: 0 type: integer workRequestId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Work Request. maxLength: 255 minLength: 1 type: string required: - id - workRequestId - compartmentId - analysisProjectName - warningCount - result - resultObjectStoragePath - artifactObjectStoragePath - timeCreated - timeStarted - timeFinished - createdBy type: object x-example: "{\n \"id\": \"ocid1.jfrreport\",\n \"workRequestId\": \"ocid1.jmsworkrequest.aaaaaaaamh2kjcjdka2dwakgsfutru4ml4mswwnm6zdcowoqxhbv6qvkrcea\",\n \"compartmentId\": \"ocid1.tenancy.oc1..aaaaaaaawgbzspd6cjovpmic7dahwbalg4opcbixgguo6z2s7t335m6labcd\",\n \"analysisProjectName\": \"my-project\",\n \"warningCount\": 3,\n \"result\": \"ACTION_RECOMMENDED\",\n \"resultObjectStoragePath\": \"/JMS/utils/results/performanceTuning/performanceTuningResult.json\",\n \"artifactObjectStoragePath\": \"/JMS/utils/myartifacts2.jfr\",\n \"timeCreated\": \"2024-11-07T09:14:20.300Z\",\n \"timeStarted\": \"2024-11-07T09:14:20.300Z\",\n \"timeFinished\": \"2024-11-07T09:14:20.300Z\",\n \"createdBy\": {\n \"id\": \"ocid1.user.oc1..aaaaaaaamh2kjcjdka2dwakgsfutru4ml4mswwnm6zdcowoqxhbv6qvkrcea\",\n \"displayName\": \"userName\" \n }\n}\n" JavaMigrationAnalysisSummary: description: Summary information about a Java Migration Analysis. properties: analysisProjectName: description: Name of the analysis project. maxLength: 255 minLength: 1 type: string analysisResultFiles: description: The analysis application file names result in the Object Storage. items: type: string type: array analysisResultObjectStoragePath: description: Path to the Object Storage analysis application result. maxLength: 8192 minLength: 1 type: string bucketName: description: Object storage bucket name. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string createdBy: $ref: '#/components/schemas/Principal' id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Java Migration Analysis. maxLength: 255 minLength: 1 type: string inputApplicationsObjectStoragePaths: description: Object storage paths to the input files applications to be analysed. items: maxLength: 8192 minLength: 1 type: string type: array metadata: description: Additional info reserved for future use. type: string namespaceName: description: Object storage namespace. maxLength: 255 minLength: 1 type: string targetJdkVersion: description: Jdk Version of the Java Migration Analysis target. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the Java Migration Analysis was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeFinished: description: 'The date and time the Java Migration Analysis was finished, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeStarted: description: 'The date and time the Java Migration Analysis was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string workRequestId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Work Request. maxLength: 255 minLength: 1 type: string required: - id - workRequestId - compartmentId - analysisProjectName - inputApplicationsObjectStoragePaths - targetJdkVersion - namespaceName - bucketName - analysisResultObjectStoragePath - analysisResultFiles - timeCreated - timeStarted - timeFinished - createdBy type: object x-example: "{\n \"id\": \"ocid1.jmsreport....\",\n \"workRequestId\": \"ocid1.jmsworkrequest.aaaaaaaamh2kjcjdka2dwakgsfutru4ml4mswwnm6zdcowoqxhbv6qvkrcea\",\n \"compartmentId\": \"ocid1.tenancy.oc1..aaaaaaaawgbzspd6cjovpmic7dahwbalg4opcbixgguo6z2s7t335m6labcd\",\n \"analysisProjectName\": \"my-project\",\n \"inputApplicationsObjectStoragePaths\": [\n \"/JMS/Utils/myartifacts1.jar\",\n \"/JMS/Utils/myartifacts2.war\",\n \"/JMS/Utils/myartifacts3.ear\"\n ],\n \"targetJdkVersion\": \"17\",\n \"namespaceName\": \"oardccsi\",\n \"bucketName\": \"jmsutils-java-migration\",\n \"analysisResultObjectStoragePath\": \"JMS/utils/results/javaMigration/ocid1.jmsworkrequest.dev.dev.aaaaaaaamh2kjcjdka2dwakgsfutru4ml4mswwnm6zdcowoqxhbv6qvkrcea/045225cc-d174-4694-8053-8033de48e23a/my-project/targetJdkVersion-17/\",\n \"analysisResultFiles\": [\n \"diagsbyapi-p3.json\",\n \"my-project.zip\",\n \"diagsbyclass-p4.json\",\n \"diagsbyapi-p3-summary.json\",\n \"diagsbyclass-mandatory.json\",\n \"diagsbyapi-p4-summary.json\",\n \"diagsbyclass-p2.json\",\n \"diagsbyapi-p2.json\",\n \"diagsbyclass-recommended.json\",\n \"jarsummaries-without-classsummaries.json\",\n \"diagsbyapi-p1.json\",\n \"diagsbyapi-p4.json\",\n \"diagsbyapi-summary-counts.json\",\n \"diagsbyclass-p1.json\",\n \"diagsbyapi-p2-summary.json\",\n \"diagsbyapi-p1-summary.json\",\n \"execsummary.json\",\n \"diagsbyclass-p3.json\",\n \"analysis.json\"\n ],\n \"timeCreated\": \"2024-11-07T09:14:20.300Z\",\n \"timeStarted\": \"2024-11-07T09:14:20.300Z\",\n \"timeFinished\": \"2024-11-07T09:14:20.300Z\",\n \"createdBy\": {\n \"id\": \"ocid1.principal.aaaaaaaamh2kjcjdka2dwakgsfutru4ml4mswwnm6zdcowoqxhbv6qvkrcea\",\n \"displayName\": \"userName\" \n }\n}\n" SubscriptionAcknowledgmentConfiguration: description: The configuration for subscription acknowledgment. properties: acknowledgedBy: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the principal that ackwnoledged the subscription. type: string isAcknowledged: default: false description: Flag to determine whether the subscription was acknowledged or not. type: boolean timeAcknowledged: description: 'The date and time the subscription was acknowledged (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). ' format: date-time type: string required: - isAcknowledged type: object x-example: "{\n \"isAcknowledged\": true,\n \"acknowledgedBy\": \"ocid1.principal.aaaaaaaamh2kjcjdka2dwakgsfutru4ml4mswwnm6zdcowoqxhbv6qvkrcea\",\n \"timeAcknowledged\": \"2024-11-07T09:14:20.300Z\"\n}\n" RequestPerformanceTuningAnalysisDetails: description: The data to create Performance Tuning Analysis. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the Performance Tuning Analysis will be created. maxLength: 255 minLength: 1 type: string definedTags: 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: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object targets: description: The list of targets for the Performance Tuning Analysis. items: $ref: '#/components/schemas/PerformanceTuningAnalysisTarget' maxItems: 10 type: array required: - compartmentId - targets type: object 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 operation tracked in the work request. A resource being created, updated, or deleted remains in the IN_PROGRESS state until work is complete for that resource, at which point it transitions 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 that the work request affects. type: string entityUri: description: The URI path that you can use for a GET request to access the resource metadata. type: string identifier: description: An [OCID](/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource. type: string metadata: additionalProperties: type: string description: Additional information that helps to explain the resource. enum: - IS_DRY_RUN type: object x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceMetadataKey' required: - actionType - entityType - identifier WorkRequestSummaryCollection: description: A list of work requests. Can contain both work requests and other information, such as metadata. properties: items: description: A list of work requests. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object UpdateSubscriptionAcknowledgmentConfigurationDetails: description: Attributes to update a Subscription Acknowledgment Configuration. properties: isAcknowledged: default: false description: Flag to determine whether the subscription was acknowledged or not. type: boolean type: object x-example: "{\n \"isAcknowledged\": true\n}\n" JavaMigrationAnalysis: description: 'To use any of the API operations, you must be authorized by an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm). ' properties: analysisProjectName: description: Name of the analysis project. maxLength: 255 minLength: 1 type: string analysisResultFiles: description: The analysis application file names result in the Object Storage. items: type: string type: array analysisResultObjectStoragePath: description: Path to the Object Storage analysis application result. maxLength: 8192 minLength: 1 type: string bucketName: description: Object storage bucket name. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string createdBy: $ref: '#/components/schemas/Principal' id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Java Migration Analysis. maxLength: 255 minLength: 1 type: string inputApplicationsObjectStoragePaths: description: Object storage paths to the input files applications to be analysed. items: maxLength: 8192 minLength: 1 type: string type: array metadata: description: Additional info reserved for future use. type: string namespaceName: description: Object storage namespace. maxLength: 255 minLength: 1 type: string targetJdkVersion: description: Jdk Version of the Java Migration Analysis target. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the Java Migration Analysis was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeFinished: description: 'The date and time the Java Migration Analysis was finished, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeStarted: description: 'The date and time the Java Migration Analysis was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string workRequestId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Work Request. maxLength: 255 minLength: 1 type: string required: - id - workRequestId - compartmentId - analysisProjectName - inputApplicationsObjectStoragePaths - targetJdkVersion - namespaceName - bucketName - analysisResultObjectStoragePath - analysisResultFiles - timeCreated - timeStarted - timeFinished - createdBy type: object x-example: "{\n \"id\": \"ocid1.jmsreport....\",\n \"workRequestId\": \"ocid1.jmsworkrequest.aaaaaaaamh2kjcjdka2dwakgsfutru4ml4mswwnm6zdcowoqxhbv6qvkrcea\",\n \"compartmentId\": \"ocid1.tenancy.oc1..aaaaaaaawgbzspd6cjovpmic7dahwbalg4opcbixgguo6z2s7t335m6labcd\",\n \"analysisProjectName\": \"my-project\",\n \"inputApplicationsObjectStoragePaths\": [\n \"/JMS/Utils/myartifacts1.jar\",\n \"/JMS/Utils/myartifacts2.war\",\n \"/JMS/Utils/myartifacts3.ear\"\n ],\n \"targetJdkVersion\": \"17\",\n \"namespaceName\": \"oardccsi\",\n \"bucketName\": \"jmsutils-java-migration\",\n \"analysisResultObjectStoragePath\": \"JMS/utils/results/javaMigration/ocid1.jmsworkrequest.dev.dev.aaaaaaaamh2kjcjdka2dwakgsfutru4ml4mswwnm6zdcowoqxhbv6qvkrcea/045225cc-d174-4694-8053-8033de48e23a/my-project/targetJdkVersion-17/\",\n \"analysisResultFiles\": [\n \"diagsbyapi-p3.json\",\n \"my-project.zip\",\n \"diagsbyclass-p4.json\",\n \"diagsbyapi-p3-summary.json\",\n \"diagsbyclass-mandatory.json\",\n \"diagsbyapi-p4-summary.json\",\n \"diagsbyclass-p2.json\",\n \"diagsbyapi-p2.json\",\n \"diagsbyclass-recommended.json\",\n \"jarsummaries-without-classsummaries.json\",\n \"diagsbyapi-p1.json\",\n \"diagsbyapi-p4.json\",\n \"diagsbyapi-summary-counts.json\",\n \"diagsbyclass-p1.json\",\n \"diagsbyapi-p2-summary.json\",\n \"diagsbyapi-p1-summary.json\",\n \"execsummary.json\",\n \"diagsbyclass-p3.json\",\n \"analysis.json\"\n ],\n \"timeCreated\": \"2024-11-07T09:14:20.300Z\",\n \"timeStarted\": \"2024-11-07T09:14:20.300Z\",\n \"timeFinished\": \"2024-11-07T09:14:20.300Z\",\n \"createdBy\": {\n \"id\": \"ocid1.user.oc1..aaaaaaaamh2kjcjdka2dwakgsfutru4ml4mswwnm6zdcowoqxhbv6qvkrcea\",\n \"displayName\": \"userName\" \n }\n}\n" PerformanceTuningAnalysisCollection: description: Results of a Performance Tuning Analysis search. Contains PerformanceTuningAnalysisSummary items. properties: items: description: List of Performance Tuning Analysis. items: $ref: '#/components/schemas/PerformanceTuningAnalysisSummary' type: array required: - items type: object WorkRequestErrorCollection: description: A list of work request errors. Can contain both errors and other information, such as metadata. properties: items: description: A list of work request errors. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object JavaMigrationAnalysisTarget: description: The target for the Java Migration Analysis properties: analysisProjectName: description: Name of the analysis project. maxLength: 255 minLength: 1 type: string excludePackagePrefixes: description: 'Package prefixes to be excluded from the migration analysis. Either this or includePackagePrefixes can be specified. ' items: maxLength: 255 minLength: 1 type: string type: array includePackagePrefixes: description: 'Package prefixes to be included from the migration analysis. Either this or excludePackagePrefixes can be specified. ' items: maxLength: 255 minLength: 1 type: string type: array inputApplicationsObjectStoragePaths: description: Object storage paths to the input files applications to be analysed. items: maxLength: 8192 minLength: 1 type: string maxItems: 10 type: array targetJdkVersions: description: Version of the target JDKs. items: type: string type: array required: - analysisProjectName - inputApplicationsObjectStoragePaths - targetJdkVersions type: object x-example: "{\n \"analysisProjectName\": \"my-project1\",\n \"applicationsObjectStoragePaths\": [\n \"/JMS/Utils/myartifacts1.jar\",\n \"/JMS/Utils/myartifacts2.war\"\n ],\n \"targetJdkVersion\": \"11\",\n \"includePackagePrefixes\": [\n \"lombok\",\n \"junit.test\"\n ],\n \"excludePackagePrefixes\": [\n \"lombok\",\n \"junit.test\"\n ]\n}\n" Principal: description: An authorized principal. properties: displayName: description: The name of the principal. type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the principal. maxLength: 255 minLength: 1 type: string required: - id - displayName type: object x-example: "{\n \"createdBy\": {\n \"id\": \"ocid1.principal.aaaaaaaamh2kjcjdka2dwakgsfutru4ml4mswwnm6zdcowoqxhbv6qvkrcea\",\n \"displayName\": \"userName\"\n }\n}\n" WorkRequestSummary: description: Summary information about an asynchronous work request. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. ' type: string createdBy: $ref: '#/components/schemas/Principal' id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. type: string operationType: description: The asynchronous operation tracked by this work request. enum: - REQUEST_JAVA_MIGRATION_SA_ANALYSIS - REQUEST_PERFORMANCE_TUNING_SA_ANALYSIS type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: 'Shows the progress of the operation tracked by the work request, as a percentage of the total work that must be performed. ' format: float type: number resources: description: The resources that are affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of the work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELLING - CANCELLED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the work request was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeFinished: description: 'The date and time the work request was finished, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the work request was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeUpdated: description: 'The date and time the work request was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted WorkRequestError: description: An error encountered while performing an operation that is tracked by a work request. properties: code: description: 'A machine-usable code for the error that occurred. For a list of error codes, see [API Errors](/iaas/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable error message. type: string timestamp: description: 'The date and time the error occurred, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string required: - code - message - timestamp WorkItemDetails: description: The minimum details of a work item. discriminator: propertyName: kind properties: kind: description: The kind of work item details. enum: - BASIC - JAVA_MIGRATION - PERFORMANCE_TUNING type: string workItemType: description: The work item type. enum: - PERFORMANCE_TUNING - JAVA_MIGRATION type: string x-obmcs-top-level-enum: '#/definitions/WorkItemType' required: - kind type: object WorkRequestLogEntry: description: A log message from performing an operation that is tracked by a work request. properties: message: description: A human-readable log message. type: string timestamp: description: 'The date and time the log message was written, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string required: - message - timestamp PerformanceTuningAnalysisTarget: description: The target for the Performance Tuning Analysis properties: analysisProjectName: description: Name of the analysis project. maxLength: 255 minLength: 1 type: string artifactObjectStoragePath: description: Object storage path to the artifact. maxLength: 255 minLength: 1 type: string required: - analysisProjectName - artifactObjectStoragePath type: object x-example: "{\n \"analysisProjectName\": \"my-project1\",\n \"artifactObjectStoragePath\": \"/JMS/Utils/myartifacts1.jfr\",\n}\n" WorkRequestLogEntryCollection: description: A list of work request logs. Can contain both logs and other information, such as metadata. properties: items: description: A list of work request log entries. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object WorkRequest: description: 'An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work request. A work request is an activity log that lets you track each step in the operation''s progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. ' type: string completedTaskCount: description: The number of tasks had been executed to a terminal state. type: integer createdBy: $ref: '#/components/schemas/Principal' id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. type: string operationType: description: The asynchronous operation tracked by this work request. enum: - REQUEST_JAVA_MIGRATION_SA_ANALYSIS - REQUEST_PERFORMANCE_TUNING_SA_ANALYSIS type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: 'Shows the progress of the operation tracked by the work request, as a percentage of the total work that must be performed. ' format: float type: number resources: description: The resources that are affected by the work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of the work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELLING - CANCELLED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the work request was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeFinished: description: 'The date and time the work request was finished, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the work request was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeUpdated: description: 'The date and time the work request was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string totalTaskCount: description: The total number of tasks to be executed for this work request. type: integer required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted parameters: 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 ResourceIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request. in: query name: resourceId x-default-description: 'null' schema: type: string PerformanceTuningAnalysisResultQueryParam: description: The result of the Performance Tuning Analysis to query for. in: query name: performanceTuningAnalysisResult x-default-description: 'null' x-obmcs-enumref: '#/definitions/PerformanceTuningAnalysis/result' schema: type: string JavaMigrationAnalysisIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Java Migration Analysis. in: path name: javaMigrationAnalysisId required: true schema: type: string CompartmentIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. in: query name: compartmentId x-default-description: 'null' schema: type: string 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 WorkRequestStatusQueryParam: description: A filter to return only the resources that match the given lifecycle state. 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 - CANCELLING - CANCELLED PerformanceTuningAnalysisIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Performance Tuning Analysis. in: query name: id x-default-description: 'null' schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 WorkRequestIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. in: path name: workRequestId required: true schema: type: string SortOrderQueryParam: description: The sort order to use, either ascending (`ASC`) or descending (`DESC`). in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is `DESC` when sorting by time and `ASC` otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC WorkRequestIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. in: query name: workRequestId x-default-description: 'null' schema: type: string WorkRequestLogAndErrorSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for `timeCreated` is descending. ' in: query name: sortBy schema: type: string enum: - timeCreated default: timeCreated 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 running 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 removed 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 JavaMigrationAnalysisIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Java Migration Analysis. in: query name: id x-default-description: 'null' schema: type: string PerformanceTuningAnalysisIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Performance Tuning Analysis. in: path name: performanceTuningAnalysisId required: true schema: type: string JavaMigrationAnalysisSortByQueryParam: description: 'The field to sort Java Migration Analysis. Only one sort order may be provided. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/JavaMigrationAnalysisSortBy' schema: type: string enum: - TIME_CREATED - TIME_STARTED - TIME_FINISHED default: timeCreated 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 RequestIdHeader: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash. ' in: header name: opc-request-id schema: type: string AnalysisProjectNameQueryParam: description: The project name of the Performance Tuning Analysis to query for. in: query name: analysisProjectName x-default-description: 'null' schema: type: string PerformanceTuningAnalysisSortByQueryParam: description: 'The field to sort Performance Tuning Analysis. Only one sort order may be provided. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/PerformanceTuningAnalysisSortBy' schema: type: string enum: - TIME_CREATED - TIME_STARTED - TIME_FINISHED default: timeCreated 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, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: 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: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' 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 system 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. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.oci.jms.sa