openapi: 3.2.0 info: description: 'Fleet Application Management provides a centralized platform to help you automate resource management tasks, validate patch compliance, and enhance operational efficiency across an enterprise. ' title: Fleet Application Management Service Fleet Apps Management Operations API version: '20250228' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/df204aad719edd6386b3f6458501f6b29625fcd70779d4c9febf12d041946740.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Fleet Application Management Service 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/df204aad719edd6386b3f6458501f6b29625fcd70779d4c9febf12d041946740.yaml what: the harvested document for Fleet Application Management Service API servers: - url: http://127.0.0.1/20250228 - url: https://127.0.0.1/20250228 tags: - name: fleetAppsManagementOperations paths: /complianceRecordCounts: get: description: 'Retrieve aggregated summary information of ComplianceRecords within a Compartment. ' operationId: SummarizeComplianceRecordCounts parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: An aaggregated summary of ComplianceRecords in a Compartment. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/ComplianceRecordAggregationCollection' 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 aggregated summary information of ComplianceRecords within a Compartment tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/ComplianceRecordAggregationCollection' /complianceRecords: get: description: 'Gets a list of complianceDetails. ' operationId: ListComplianceRecords parameters: - $ref: '#/components/parameters/MandatoryCompartmentIdQueryParam' - $ref: '#/components/parameters/ComplianceResourceIdQueryParam' - $ref: '#/components/parameters/ComplianceEntityIdQueryParam' - $ref: '#/components/parameters/ComplianceProductNameQueryParam' - $ref: '#/components/parameters/ComplianceProductStackQueryParam' - $ref: '#/components/parameters/ComplianceTargetNameQueryParam' - $ref: '#/components/parameters/TargetComplianceStateQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ComplianceRecordSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ComplianceSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/ComplianceRecordCollection' 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 complianceDetails. tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/ComplianceRecordCollection' /complianceRecords/actions/exportComplianceReport: post: description: 'Generate Compliance Report ' operationId: ExportComplianceReport parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Compliance Report. headers: content-length: description: The content size of the body in bytes. schema: type: integer format: int64 content-type: description: The content type of the body. schema: type: string 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: format: binary 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: Generate Compliance Report tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/ComplianceRecord' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportComplianceReportDetails' description: Details for generating compliance report required: true /installedPatches: get: description: 'Gets a list of installed patches. CompartmentId should be the compartmentId of resource(Containing the target). ' operationId: ListInstalledPatches parameters: - $ref: '#/components/parameters/MandatoryCompartmentIdQueryParam' - $ref: '#/components/parameters/InventoryTargetIdentifierQueryParam' - $ref: '#/components/parameters/InventoryTargetNameQueryParam' - $ref: '#/components/parameters/InventorySeverityQueryParam' - $ref: '#/components/parameters/InventoryPatchLevelQueryParam' - $ref: '#/components/parameters/InventoryPatchTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - description: 'The field to sort by. Only one sort order may be provided. ' in: query name: sortBy schema: type: string enum: - patchName default: patchName responses: 200: description: A page of InstalledPatchSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/InstalledPatchCollection' 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 installed patches. tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/InstalledPatchCollection' /inventoryRecords: get: description: 'Gets a list of inventoryDetails. ' operationId: ListInventoryRecords parameters: - $ref: '#/components/parameters/MandatoryCompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AssociatedFleetIdentifierQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IsDetailsRequiredQueryParam' - description: 'The field to sort by. Only one sort order may be provided. ' in: query name: sortBy schema: type: string enum: - targetName - targetProductName - targetResourceId - osType - architecture default: targetName responses: 200: description: A page of InventoryRecordSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/InventoryRecordCollection' 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 inventoryDetails. tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/InventoryRecordCollection' /managedEntityCounts: get: description: 'Retrieve aggregated summary information of Managed entities within a Compartment. ' operationId: SummarizeManagedEntityCounts parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: An aaggregated summary of ComplianceRecords in a Compartment. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/ManagedEntityAggregationCollection' 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 aggregated summary information of Managed entities within a Compartment tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/ManagedEntityAggregationCollection' /patches: get: description: 'Returns a list of all the Patches in the specified compartment. The query parameter `compartmentId` is required unless the query parameter `id` is specified. ' operationId: ListPatches parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PatchProductIdQueryParam' - $ref: '#/components/parameters/PatchProductVersionQueryParam' - $ref: '#/components/parameters/DefinedByTypeQueryParam' - $ref: '#/components/parameters/PatchTypeIdQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/PatchIdentifierQueryParam' - $ref: '#/components/parameters/TimeReleasedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeReleasedLessThanQueryParam' - $ref: '#/components/parameters/shouldCompliancePolicyRulesBeAppliedQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PatchLifecycleStateQueryParam' - $ref: '#/components/parameters/PatchSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of PatchSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/PatchCollection' 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 Patches in a compartment tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/PatchCollection' post: description: 'Creates a new Patch. ' operationId: CreatePatch parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Patch created successfully. 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/Patch' 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 Patch tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/Patch' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePatchDetails' description: Details for the new Patch. required: true /patches/{patchId}: delete: description: Deletes the patch specified by identifier. operationId: DeletePatch parameters: - $ref: '#/components/parameters/PatchIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Patch 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, please 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' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete an existing Patch tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/Patch' get: description: Gets a Patch by identifier. operationId: GetPatch parameters: - $ref: '#/components/parameters/PatchIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Patch 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, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Patch' 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 Patch tags: - fleetAppsManagementOperations put: description: Updates the patch specified by the identifier. operationId: UpdatePatch parameters: - $ref: '#/components/parameters/PatchIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Patch 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, please 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' 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: Update the Patch specified by the identifier tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/Patch' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePatchDetails' description: The information to be updated. required: true /patches/{patchId}/actions/changeCompartment: post: description: 'Moves a Patch into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangePatchCompartment parameters: - $ref: '#/components/parameters/PatchIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The Patch will be moved into a different compartment. 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: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 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' summary: Moves a Patch into a different compartment. tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/Patch' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangePatchCompartmentDetails' description: Details of the target compartment. required: true /recommendedPatches: get: description: 'Gets a list of recommended patches. ' operationId: ListRecommendedPatches parameters: - $ref: '#/components/parameters/MandatoryCompartmentIdQueryParam' - $ref: '#/components/parameters/ComplianceTargetIdentifierQueryParam' - $ref: '#/components/parameters/ComplianceTargetNameQueryParam' - $ref: '#/components/parameters/CompliancePatchLevelQueryParam' - $ref: '#/components/parameters/ComplianceSeverityQueryParam' - $ref: '#/components/parameters/CompliancePatchTypeQueryParam' - $ref: '#/components/parameters/CompliancePatchIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - description: 'The field to sort by. Only one sort order may be provided. ' in: query name: sortBy schema: type: string enum: - patchName default: patchName responses: 200: description: A page of RecommendedPatchSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/RecommendedPatchCollection' 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 recommended patches. tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/RecommendedPatchCollection' /reports/actions/summarize: post: description: 'Report ' operationId: Report parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/MandatoryCompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' responses: 200: description: A page of ReportsSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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 opc-total-items: description: A number representing the the total number of results available. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ReportCollection' 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: Report tags: - fleetAppsManagementOperations x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ReportCollection' requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportDetails' description: Details for generating report required: true /reports/metadata: get: description: 'Returns a list of all the report metadata. ' operationId: ListReportMetadata parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/MandatoryCompartmentIdQueryParam' - $ref: '#/components/parameters/ReportNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: A page of ReportMetadataCollection objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/ReportMetadataCollection' 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 Report Metadata tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/ReportMetadataCollection' /schedulerDefinitions: get: description: 'Returns a list of all the Schedule Definitions in the specified compartment. The query parameter `compartmentId` is required unless the query parameter `id` is specified. ' operationId: ListSchedulerDefinitions parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/SchedulerDefinitionLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/productDisplayNameQueryParam' - $ref: '#/components/parameters/SchedulerDefinitionIdentifierQueryParam' - $ref: '#/components/parameters/AssociatedMaintenanceWindowIdentifierQueryParam' - $ref: '#/components/parameters/AssociatedRunbookIdentifierQueryParam' - $ref: '#/components/parameters/AssociatedRunbookVersionNameQueryParam' - $ref: '#/components/parameters/TimeScheduledGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeScheduledLessThanQueryParam' - $ref: '#/components/parameters/AssociatedFleetIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SchedulerDefinitionSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of SchedulerDefinitionSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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 opc-total-items: description: A number representing the the total number of results available. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/SchedulerDefinitionCollection' 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 SchedulerDefinitions in a compartment tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/SchedulerDefinitionCollection' post: description: 'Create a SchedulerDefinition to perform lifecycle operations. ' operationId: CreateSchedulerDefinition parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The SchedulerDefinition will be created. headers: content-location: description: Same as location schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URL for the created schedulerDefinition, the schedulerDefinition id will be generated after this request is sent. schema: type: string format: uri-reference 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: '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/SchedulerDefinition' 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 SchedulerDefinition tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/SchedulerDefinition' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSchedulerDefinitionDetails' description: Details for the new SchedulerDefinition. required: true /schedulerDefinitions/{schedulerDefinitionId}: delete: description: Deletes a SchedulerDefinition resource by identifier operationId: DeleteSchedulerDefinition parameters: - $ref: '#/components/parameters/SchedulerDefinitionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: SchedulerDefinition 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' 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: Delete a provisioned SchedulerDefinition tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/SchedulerDefinition' get: description: Get the details of a SchedulerDefinition that performs lifecycle management operations. operationId: GetSchedulerDefinition parameters: - $ref: '#/components/parameters/SchedulerDefinitionIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the SchedulerDefinition with the given id 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/SchedulerDefinition' 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 SchedulerDefinition tags: - fleetAppsManagementOperations put: description: Update the details of a SchedulerDefinition that performs lifecycle management operations. operationId: UpdateSchedulerDefinition parameters: - $ref: '#/components/parameters/SchedulerDefinitionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The SchedulerDefinition 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, please 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 the SchedulerDefinition identified by the id tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/SchedulerDefinition' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSchedulerDefinitionDetails' description: The information to be updated. required: true /schedulerDefinitions/{schedulerDefinitionId}/scheduledFleets: get: description: 'Returns a list of ScheduledFleets. ' operationId: ListScheduledFleets parameters: - $ref: '#/components/parameters/SchedulerDefinitionIdentifierPathParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ScheduledFleetSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ScheduledFleet objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/ScheduledFleetCollection' 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 Fleets for a Schedule Definition tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/ScheduledFleetCollection' /schedulerExecutions: get: description: 'Returns a list of all executions that are scheduled. ' operationId: ListSchedulerExecutions parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/TimeScheduledGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeScheduledLessThanQueryParam' - $ref: '#/components/parameters/AssociatedSchedulerDefinitionIdentifierQueryParam' - $ref: '#/components/parameters/AssociatedSchedulerJobIdentifierQueryParam' - $ref: '#/components/parameters/AssociatedResourceIdentifierQueryParam' - $ref: '#/components/parameters/AssociatedRunbookIdentifierQueryParam' - $ref: '#/components/parameters/AssociatedRunbookVersionNameQueryParam' - $ref: '#/components/parameters/SchedulerExecutionSubstateQueryParam' - $ref: '#/components/parameters/LifecycleOperationQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ScheduledExecutionSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of SchedulerExecution objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/SchedulerExecutionCollection' 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 executions that are scheduled tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/SchedulerExecutionCollection' /schedulerJobCounts: get: description: 'Retrieve aggregated summary information of Scheduler Jobs within a Compartment. ' operationId: SummarizeSchedulerJobCounts parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: An aggregated summary of SchedulerJobs in a Compartment. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/SchedulerJobAggregationCollection' 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 aggregated summary information of Scheduler Jobs within a Compartment tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/SchedulerJobAggregationCollection' /schedulerJobs: get: description: 'Returns a list of all schedule jobs in the specified compartment. The query parameter `compartmentId` is required unless the query parameter `id` is specified. ' operationId: ListSchedulerJobs parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/SchedulerJobLifecycleStateQueryParam' - $ref: '#/components/parameters/AssociatedFleetIdentifierQueryParam' - $ref: '#/components/parameters/TimeScheduledGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeScheduledLessThanQueryParam' - $ref: '#/components/parameters/IsRemediationJobNeededQueryParam' - $ref: '#/components/parameters/SchedulerJobLifecycleSubstateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SchedulerJobIdentifierQueryParam' - $ref: '#/components/parameters/AssociatedSchedulerDefinitionIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SchedulerJobSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of SchedulerJobSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/SchedulerJobCollection' 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 schedule jobs in a compartment. tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/SchedulerJobCollection' /schedulerJobs/{schedulerJobId}: delete: description: Deletes the schedule job specified by an identifier. operationId: DeleteSchedulerJob parameters: - $ref: '#/components/parameters/SchedulerJobIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Schedule Job 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' 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: Deletes the schedule job specified by an identifier. tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/SchedulerJob' get: description: Get the details of a lifecycle management operations job in Fleet Application Management. operationId: GetSchedulerJob parameters: - $ref: '#/components/parameters/SchedulerJobIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The schedule job's information has been 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/SchedulerJob' 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 Schedule Job. tags: - fleetAppsManagementOperations put: description: Updates certain attributes for the specified schedule job. operationId: UpdateSchedulerJob parameters: - $ref: '#/components/parameters/SchedulerJobIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Schedule Job updated successfully. 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/SchedulerJob' 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: Updates certain attributes for the specified schedule job. tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/SchedulerJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSchedulerJobDetails' description: Attributes to update a schedule job. required: true /schedulerJobs/{schedulerJobId}/actions/manageJobExecution: post: description: 'Manage execution actions for a Job like retrying or pausing a task. ' operationId: ManageJobExecution parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SchedulerJobIdentifierPathParam' responses: 202: description: Accepted the request. 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: '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' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Manage execution actions for a Job tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/SchedulerJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/ManageJobExecutionDetails' description: Details for confirming Targets. required: true /schedulerJobs/{schedulerJobId}/jobActivities/{jobActivityId}: get: description: Gets activity details by identifier for a job. operationId: GetJobActivity parameters: - $ref: '#/components/parameters/SchedulerJobIdentifierPathParam' - $ref: '#/components/parameters/JobActivityIdentifierPathParam' - $ref: '#/components/parameters/IsDetailsRequiredQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the JobActivity with the given id 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/JobActivity' 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 JobActivity tags: - fleetAppsManagementOperations /schedulerJobs/{schedulerJobId}/jobActivities/{jobActivityId}/resources: get: description: Returns a list of resources for an Activity Execution. operationId: ListResources parameters: - $ref: '#/components/parameters/SchedulerJobIdentifierPathParam' - $ref: '#/components/parameters/JobActivityIdentifierPathParam' - $ref: '#/components/parameters/ActivityTaskIdentifierQueryParam' - $ref: '#/components/parameters/ActivityStepNameQueryParam' - $ref: '#/components/parameters/ActivityTargetNameQueryParam' - $ref: '#/components/parameters/ActivityTaskOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ResourceTaskSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns a list of resources for an Activity Execution. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/ResourceCollection' 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 Resources for JobActivity tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/ResourceCollection' /schedulerJobs/{schedulerJobId}/jobActivities/{jobActivityId}/resources/{resourceId}/executions: get: description: Returns a list of Task Executions for a Resource. operationId: ListExecutions parameters: - $ref: '#/components/parameters/SchedulerJobIdentifierPathParam' - $ref: '#/components/parameters/JobActivityIdentifierPathParam' - $ref: '#/components/parameters/ActivityResourceIdentifierPathParam' - $ref: '#/components/parameters/ActivityTaskIdentifierQueryParam' - $ref: '#/components/parameters/ActivityStepNameQueryParam' - $ref: '#/components/parameters/ActivityTargetNameQueryParam' - $ref: '#/components/parameters/ActivityTaskOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ResourceTaskSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the list of resource level executions headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/ExecutionCollection' 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 Task Executions for a Resource tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/ExecutionCollection' /schedulerJobs/{schedulerJobId}/jobActivities/{jobActivityId}/resources/{resourceId}/executions/{executionId}: get: description: Get Task Execution by Identifier for a Resource within an action group. operationId: GetExecution parameters: - $ref: '#/components/parameters/SchedulerJobIdentifierPathParam' - $ref: '#/components/parameters/JobActivityIdentifierPathParam' - $ref: '#/components/parameters/ActivityResourceIdentifierPathParam' - $ref: '#/components/parameters/ActivityExecutionIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Execution with the given id 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/Execution' 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 Task Execution Details tags: - fleetAppsManagementOperations /schedulerJobs/{schedulerJobId}/jobActivities/{jobActivityId}/steps: get: description: Returns a list of Steps for an Activity Execution. operationId: ListSteps parameters: - $ref: '#/components/parameters/SchedulerJobIdentifierPathParam' - $ref: '#/components/parameters/JobActivityIdentifierPathParam' - $ref: '#/components/parameters/ActivityTaskIdentifierQueryParam' - $ref: '#/components/parameters/ActivityStepNameQueryParam' - $ref: '#/components/parameters/ActivityTargetNameQueryParam' - $ref: '#/components/parameters/ActivityTaskOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ResourceTaskSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns a list of Steps for an Activity Execution. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/StepCollection' 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 Steps for JobActivity tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/StepCollection' /targetComponents: get: description: 'Gets a list of target component. ' operationId: ListTargetComponents parameters: - $ref: '#/components/parameters/MandatoryCompartmentIdQueryParam' - $ref: '#/components/parameters/InventoryTargetIdentifierQueryParam' - $ref: '#/components/parameters/InventoryTargetNameQueryParam' - $ref: '#/components/parameters/InventorySeverityQueryParam' - $ref: '#/components/parameters/TargetComponentNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - description: 'The field to sort by. Only one sort order may be provided. ' in: query name: sortBy schema: type: string enum: - componentName default: componentName responses: 200: description: A page of TargetComponentSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/TargetComponentCollection' 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 target component. tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/TargetComponentCollection' /targetProperties: get: description: 'Gets a list of target properties. ' operationId: ListTargetProperties parameters: - $ref: '#/components/parameters/MandatoryCompartmentIdQueryParam' - $ref: '#/components/parameters/InventoryTargetIdentifierQueryParam' - $ref: '#/components/parameters/InventoryTargetNameQueryParam' - $ref: '#/components/parameters/InventorySeverityQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - description: 'The field to sort by. Only one sort order may be provided. ' in: query name: sortBy schema: type: string enum: - propertyName default: propertyName responses: 200: description: A page of TargetPropertySummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/TargetPropertyCollection' 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 target properties. tags: - fleetAppsManagementOperations x-related-resource: '#/definitions/TargetPropertyCollection' components: parameters: PatchProductIdQueryParam: description: Product platformConfigurationId associated with the Patch. in: query name: productId x-default-description: 'null' schema: type: string AssociatedSchedulerJobIdentifierQueryParam: description: SchedulerJob identifier filter in: query name: schedulerJobId x-default-description: 'null' schema: type: string NameQueryParam: description: A filter to return only resources that match the entire name given. in: query name: name x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 InventoryTargetNameQueryParam: description: Target name. in: query name: targetName x-default-description: 'null' schema: type: string IsRemediationJobNeededQueryParam: description: Fetch next remediation Job in: query name: isRemediationJobNeeded x-default-description: 'null' schema: type: boolean PatchProductVersionQueryParam: description: Product version. in: query name: version x-default-description: 'null' schema: type: string ActivityTaskOrderQueryParam: description: Task Order Sequence in: query name: sequence 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 TimeReleasedGreaterThanOrEqualToQueryParam: description: A filter to return patches whose release date is greater than or equal to the given date. in: query name: timeReleasedGreaterThanOrEqualTo x-default-description: 'null' schema: type: string format: date-time PatchTypeIdQueryParam: description: Patch Type platformConfigurationId associated with the Patch. in: query name: patchTypeId x-default-description: 'null' schema: type: string SortOrderQueryParam: description: The sort order to use, either 'ASC' or '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 AssociatedMaintenanceWindowIdentifierQueryParam: description: A filter to return only schedule definitions whose associated maintenanceWindowId matches the given maintenanceWindowId. in: query name: maintenanceWindowId x-default-description: 'null' schema: type: string ComplianceTargetNameQueryParam: description: Unique target name in: query name: targetName x-default-description: 'null' schema: type: string PatchSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. ' in: query name: sortBy x-default-description: timeCreated x-obmcs-top-level-enum: '#/definitions/PatchSortBy' schema: type: string enum: - timeCreated - name AssociatedResourceIdentifierQueryParam: description: ResourceId filter (Example FleetId) in: query name: resourceId x-default-description: 'null' schema: type: string ComplianceProductNameQueryParam: description: Product Name. in: query name: productName x-default-description: 'null' schema: type: string RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string TimeReleasedLessThanQueryParam: description: A filter to return patches whose release date is less than the given date. in: query name: timeReleasedLessThan x-default-description: 'null' schema: type: string format: date-time SchedulerDefinitionSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated and timeOfNextRun is descending. Default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName - timeOfNextRun default: displayName SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. ' in: query name: sortBy x-default-description: timeCreated x-obmcs-top-level-enum: '#/definitions/SortBy' schema: type: string enum: - timeCreated - displayName AssociatedRunbookVersionNameQueryParam: description: RunbookVersion Name filter in: query name: runbookVersionName x-default-description: 'null' schema: type: string ResourceIdentifierQueryParam: description: Resource Identifier in: query name: resourceId x-default-description: 'null' schema: type: string CompliancePatchTypeQueryParam: description: Patch Type. in: query name: patchType x-default-description: 'null' schema: type: string TargetComplianceStateQueryParam: description: Target Compliance State. in: query name: complianceState x-default-description: 'null' schema: type: string MandatoryCompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId required: true x-default-description: 'null' schema: type: string ComplianceSeverityQueryParam: description: Patch severity. in: query name: severity x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/PatchSeverity' schema: type: string enum: - CRITICAL - HIGH - MEDIUM - LOW SchedulerJobSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated and timeScheduled is descending. Default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - timeScheduled - displayName default: timeCreated AssociatedSchedulerDefinitionIdentifierQueryParam: description: SchedulerDefinition identifier in: query name: schedulerDefintionId x-default-description: 'null' schema: type: string PatchIdentifierQueryParam: description: 'Unique identifier or OCID for listing a single Patch by id. Either compartmentId or id must be provided. ' in: query name: id x-default-description: 'null' schema: type: string TargetComponentNameQueryParam: description: Target Component Name. in: query name: name x-default-description: 'null' schema: type: string ScheduledFleetSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - displayName default: displayName SchedulerJobLifecycleStateQueryParam: description: A filter to return only resources whose lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/SchedulerJob/lifecycleState' schema: type: string InventoryPatchTypeQueryParam: description: Patch Type. in: query name: patchType x-default-description: 'null' schema: type: string ActivityTaskIdentifierQueryParam: description: Task Id in: query name: resourceTaskId x-default-description: 'null' schema: type: string InventoryPatchLevelQueryParam: description: Patch level. in: query name: patchLevel x-default-description: 'null' schema: type: string SchedulerJobIdentifierPathParam: description: unique SchedulerJob identifier in: path name: schedulerJobId required: true schema: type: string TimeScheduledGreaterThanOrEqualToQueryParam: description: Scheduled Time in: query name: timeScheduledGreaterThanOrEqualTo x-default-description: 'null' schema: type: string format: date-time ReportNameQueryParam: description: A filter to return data for given report name. in: query name: reportName x-default-description: 'null' 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: 255 minLength: 1 DefinedByTypeQueryParam: description: DefinedBy type. in: query name: type x-default-description: USER_DEFINED x-obmcs-enumref: '#/definitions/Patch/type' schema: type: string PaginationTokenQueryParam: description: A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. in: query name: page x-default-description: page schema: type: string minLength: 1 ActivityStepNameQueryParam: description: Unique step name in: query name: stepName x-default-description: 'null' schema: type: string CompliancePatchLevelQueryParam: description: Patch level. in: query name: patchLevel x-default-description: 'null' schema: type: string enum: - LATEST - LATEST_MINUS_ONE - LATEST_MINUS_TWO PatchIdentifierPathParam: description: Unique Patch identifier. in: path name: patchId required: true schema: type: string SchedulerJobLifecycleSubstateQueryParam: description: A filter to return only resources their subState matches the given subState. in: query name: substate required: false x-default-description: 'null' schema: type: string ComplianceEntityIdQueryParam: description: Entity identifier.Ex:FleetId in: query name: entityId x-default-description: 'null' schema: type: string ActivityTargetNameQueryParam: description: Unique target name in: query name: targetName x-default-description: 'null' schema: type: string IsDetailsRequiredQueryParam: description: 'If set to true, inventory details will be returned. ' in: query name: isDetailsRequired required: false schema: type: boolean default: false AssociatedRunbookIdentifierQueryParam: description: A filter to return only schedule definitions whose associated runbookId matches the given runbookId. in: query name: runbookId x-default-description: 'null' schema: type: string SchedulerJobIdentifierQueryParam: description: 'Unique identifier or OCID for listing a single Schedule Job by id. Either compartmentId or id must be provided. ' in: query name: id x-default-description: 'null' schema: type: string ActivityExecutionIdentifierPathParam: description: Execution Id in: path name: executionId required: true schema: type: string CompliancePatchIdentifierQueryParam: description: Patch identifier. in: query name: patchId 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 ComplianceResourceIdQueryParam: description: Resource identifier. in: query name: resourceId x-default-description: 'null' schema: type: string ActivityResourceIdentifierPathParam: description: unique Resource identifier in: path name: resourceId required: true schema: type: string TimeScheduledLessThanQueryParam: description: Scheduled Time in: query name: timeScheduledLessThan x-default-description: 'null' schema: type: string format: date-time productDisplayNameQueryParam: description: A filter to return only dchedule definitions whose assocaited product matches the given product in: query name: product x-default-description: 'null' schema: type: string InventoryTargetIdentifierQueryParam: description: Target Id. in: query name: targetId x-default-description: 'null' schema: type: string ResourceTaskSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeStarted is descending. ' in: query name: sortBy schema: type: string enum: - timeStarted default: timeStarted CompartmentIdInSubtreeQueryParam: description: 'If set to true, resources will be returned for not only the provided compartment, but all compartments which descend from it. Which resources are returned and their field contents depends on the value of accessLevel. ' in: query name: compartmentIdInSubtree required: false schema: type: boolean default: false shouldCompliancePolicyRulesBeAppliedQueryParam: description: Filter patch based on compliance policy rules for the Product. in: query name: shouldCompliancePolicyRulesBeApplied x-default-description: 'null' schema: type: boolean ComplianceProductStackQueryParam: description: ProductStack name. in: query name: productStack x-default-description: 'null' schema: type: string LifecycleOperationQueryParam: description: A filter to return only resources their lifecycleOperation matches the given lifecycleOperation. in: query name: lifecycleOperation required: false x-default-description: 'null' schema: type: string PatchLifecycleStateQueryParam: description: The current state of the Patch. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/Patch/lifecycleState' schema: type: string InventorySeverityQueryParam: description: Patch severity. in: query name: severity x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/PatchSeverity' schema: type: string enum: - CRITICAL - HIGH - MEDIUM - LOW SchedulerDefinitionIdentifierQueryParam: description: 'Unique identifier or OCID for listing a single Schedule Definition by id. Either compartmentId or id must be provided. ' in: query name: id x-default-description: 'null' schema: type: string CompartmentIdQueryParam: description: 'The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. ' in: query name: compartmentId 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 ScheduledExecutionSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated and timeScheduled is descending. ' in: query name: sortBy schema: type: string enum: - timeCreated - timeScheduled default: timeScheduled SchedulerDefinitionLifecycleStateQueryParam: description: A filter to return only scheduleDefinitions whose lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/SchedulerDefinition/lifecycleState' schema: type: string AssociatedFleetIdentifierQueryParam: description: unique Fleet identifier in: query name: fleetId x-default-description: 'null' schema: type: string JobActivityIdentifierPathParam: description: unique jobActivity identifier in: path name: jobActivityId required: true schema: type: string ComplianceRecordSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. ' in: query name: sortBy x-default-description: timeCreated x-obmcs-top-level-enum: '#/definitions/ComplianceRecordSortBy' schema: type: string enum: - timeCreated - displayName SchedulerDefinitionIdentifierPathParam: description: unique SchedulerDefinition identifier in: path name: schedulerDefinitionId required: true schema: type: string ComplianceTargetIdentifierQueryParam: description: Target identifier. in: query name: targetId x-default-description: 'null' schema: type: string SchedulerExecutionSubstateQueryParam: description: A filter to return only resources their subState matches the given subState. in: query name: substate required: false x-default-description: 'null' schema: type: string schemas: 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 string. type: string required: - code - message Outcome: description: Execution Outcome. properties: error: description: Errors if any, associated with the execution. type: string exitCode: description: Exit Code. type: string output: description: A shortened version of Execution output. type: string required: - output type: object ChangePatchCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the patch to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ComplianceDetailPolicy: description: Details of the Policy associated properties: compliancePolicyDisplayName: description: Compliane Policy DisplayName maxLength: 255 minLength: 1 type: string compliancePolicyId: description: Compliance Policy Id maxLength: 255 minLength: 1 type: string compliancePolicyRuleDisplayName: description: Product Name maxLength: 255 minLength: 1 type: string compliancePolicyRuleId: description: Compliane Policy Rule Id maxLength: 255 minLength: 1 type: string gracePeriod: description: Grace period in days,weeks,months or years the exemption is applicable for the rule. format: x-obmcs-duration type: string patchSelection: $ref: '#/components/schemas/PatchSelectionDetails' required: - compliancePolicyId ReportMetadataSummary: description: Summary information about a ReportMetadata. properties: columnMetadata: description: Column Metadata. items: $ref: '#/components/schemas/ColumnMetadata' maxItems: 500 type: array defaultOrderClause: description: default order clause for reports. items: $ref: '#/components/schemas/OrderClause' maxItems: 20 type: array description: description: Description of report. maxLength: 255 minLength: 1 type: string filters: description: metricMetadata. items: $ref: '#/components/schemas/ReportFilter' maxItems: 500 type: array metric: description: Metric Name. maxLength: 255 minLength: 1 type: string name: description: Name of Report. maxLength: 255 minLength: 1 type: string required: - name type: object ComplianceRecordSummary: description: Summary information about a ComplianceDetail. properties: compartmentId: description: The OCID of the compartment. type: string complianceState: description: Last known compliance state of target. enum: - UNKNOWN - COMPLIANT - NON_COMPLIANT - WARNING type: string x-obmcs-top-level-enum: '#/definitions/ComplianceState' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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"}}` ' type: object entityDisplayName: description: The displayName of the entity for which the compliance is calculated.Ex.DisplayName for the Fleet type: string entityId: description: The OCID of the entity for which the compliance is calculated.Ex.FleetId 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"}` ' type: object id: description: The OCID of the ComplianceRecord. type: string lifecycleState: description: The current state of the ComplianceRecord. type: string x-obmcs-enumref: '#/definitions/ComplianceRecord/lifecycleState' patch: $ref: '#/components/schemas/CompliancePatchDetail' policy: $ref: '#/components/schemas/ComplianceDetailPolicy' resource: $ref: '#/components/schemas/ComplianceDetailResource' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' 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 target: $ref: '#/components/schemas/ComplianceDetailTarget' timeCreated: description: 'The date and time the ComplianceRecord 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 timeUpdated: description: 'The date and time the ComplianceRecord was updated, 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 required: - id - entityId - entityDisplayName - resource - target type: object PatchSummary: description: Summary of the Patch. properties: artifactDetails: $ref: '#/components/schemas/ArtifactDetails' compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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"}}` ' type: object description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 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"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Patch. type: string x-obmcs-enumref: '#/definitions/Patch/lifecycleState' name: description: "A user-friendly name. Should be unique within the tenancy, and cannot be changed after creation. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string patchType: $ref: '#/components/schemas/PatchType' product: $ref: '#/components/schemas/PatchProduct' resourceRegion: description: Associated region maxLength: 255 type: string x-default-description: 'null' severity: description: Patch Severity. enum: - CRITICAL - HIGH - MEDIUM - LOW type: string x-obmcs-top-level-enum: '#/definitions/PatchSeverity' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' 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 timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeReleased: description: Date when the patch was released. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string type: description: 'Provide information on who defined the patch. Example: For Custom Patches the value will be USER_DEFINED For Oracle Defined Patches the value will be ORACLE_DEFINED ' type: string x-obmcs-enumref: '#/definitions/Patch/type' required: - id - name - patchType - severity - timeReleased - product - lifecycleState - timeCreated - timeUpdated - compartmentId type: object SchedulerJob: description: A SchedulerJob resource. properties: actionGroups: description: Action Groups associated with the Schedule. items: $ref: '#/components/schemas/ActionGroupDetails' type: array compartmentId: description: Compartment OCID maxLength: 255 minLength: 1 type: string countOfAffectedActionGroups: description: 'Count of Action Groups affected by the Schedule. An action group is a group of entities grouped for a lifecycle activity. Example - A Fleet will be considered an Action Group for any lifecycle activity. ' type: integer countOfAffectedResources: description: Count of resources affected by the schedule. type: integer countOfAffectedTargets: description: Count of targets affected by the schedule. type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 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"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleOperations: description: All LifeCycle Operations that are part of the schedule. items: type: string maxItems: 10 type: array lifecycleState: description: The current state of the SchedulerJob. enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELED - NEEDS_ATTENTION type: string products: description: All products that are part of the schedule for a PRODUCT action group type. items: type: string maxItems: 30 type: array schedulerDefinition: $ref: '#/components/schemas/AssociatedSchedulerDefinition' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' 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 timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeEnded: description: Actual end date and time for the Job. format: date-time type: string timeScheduled: description: The scheduled date and time for the Job. format: date-time type: string timeStarted: description: Actual start date and time for the Job. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - freeformTags - definedTags type: object Filter: description: An array of Managed Entity objects discriminator: propertyName: filterType properties: fieldName: description: Name of report. maxLength: 255 minLength: 1 type: string filterType: description: 'Content Source type details. ' enum: - SINGLE_VALUE - MULTI_VALUE type: string required: - fieldName - filterType type: object InstalledPatchCollection: description: Results of an installed patches search. properties: items: description: List of installed patches items: $ref: '#/components/schemas/InstalledPatchSummary' maxItems: 1000 type: array required: - items type: object PatchCollection: description: Results of a patch search. Contains both PatchSummary items and other information, such as metadata. properties: items: description: List of patches. items: $ref: '#/components/schemas/PatchSummary' type: array required: - items type: object TargetPropertySummary: description: Summary information about an target property. properties: name: description: Name of the property type: string value: description: Value of the property type: string required: - name - value type: object ComplianceRecordCollection: description: Results of a compliancePolicy search. Contains both CompliancePolicySummary items and other information, such as metadata. properties: items: description: List of compliancePolicys. items: $ref: '#/components/schemas/ComplianceRecordSummary' type: array required: - items type: object DependentPatchDetails: description: Dependent Patch Details. properties: id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string required: - id type: object ComplianceDetailTarget: description: Details of the Target. properties: targetId: description: Target Identifier. maxLength: 255 minLength: 1 type: string targetName: description: Target Name. maxLength: 255 minLength: 1 type: string version: description: Current version. type: string required: - targetId - targetName SchedulerDefinition: description: Definition of a Schedule. properties: actionGroups: description: Action Groups associated with the Schedule. items: $ref: '#/components/schemas/ActionGroup' maxItems: 100 type: array compartmentId: description: Compartment OCID maxLength: 255 minLength: 1 type: string countOfAffectedActionGroups: description: Count of Action Groups affected by the Schedule. type: integer countOfAffectedResources: description: Count of Resources affected by the Schedule. type: integer countOfAffectedTargets: description: Count of Targets affected by the Schedule. type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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"}}` ' type: object description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 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"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleOperations: description: All LifeCycle Operations that are part of the schedule. items: type: string maxItems: 10 type: array lifecycleState: description: The current state of the SchedulerDefinition. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - INACTIVE type: string products: description: All products that are part of the schedule for PRODUCT ActionGroup Type. items: type: string maxItems: 30 type: array resourceRegion: description: Associated region maxLength: 255 type: string x-default-description: 'null' runBooks: description: Runbooks. items: $ref: '#/components/schemas/OperationRunbook' maxItems: 50 type: array schedule: $ref: '#/components/schemas/Schedule' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' 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 timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeOfNextRun: description: The scheduled date for the next run of the Job. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName type: object ExportComplianceReportDetails: description: Details for generating Compliance Report. properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string complianceState: description: Last known compliance state of target. enum: - UNKNOWN - COMPLIANT - NON_COMPLIANT - WARNING type: string x-obmcs-top-level-enum: '#/definitions/ComplianceState' entityId: description: The OCID of the entity for which the compliance is calculated.Ex.FleetId maxLength: 255 minLength: 1 type: string productName: description: Product Name. maxLength: 255 minLength: 1 type: string productStack: description: Product Stack. maxLength: 255 minLength: 1 type: string resourceId: description: The OCID to identify the resource. maxLength: 255 minLength: 1 type: string required: - compartmentId ReportDetails: description: 'fetch reports for FAM based on filter. ' properties: condition: description: 'Condition. ' enum: - ALL - ANY type: string filters: description: Filters for reports. items: $ref: '#/components/schemas/Filter' maxItems: 500 type: array granularity: description: 'Granularity. ' enum: - DAY - WEEK - MONTH - QUARTER - YEAR type: string name: description: Name of report. maxLength: 255 minLength: 1 type: string orderClause: description: order clauses for reports. items: $ref: '#/components/schemas/OrderClause' maxItems: 500 type: array reportTimeRange: $ref: '#/components/schemas/ReportTimeRange' required: - name type: object SchedulerJobDimension: description: Aggregated summary information for a SchedulerJob. properties: lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string required: - lifecycleDetails type: object ActionGroupDetails: description: Action Group details. discriminator: propertyName: kind properties: activityId: description: Unique producer Id at Action Group Level maxLength: 255 minLength: 1 type: string displayName: description: Name of the ActionGroup. maxLength: 255 minLength: 1 type: string kind: description: Action Group kind enum: - FLEET_USING_RUNBOOK type: string lifecycleOperation: description: LifeCycle Operation. maxLength: 255 type: string product: description: 'Product associated. Only applicable if actionGroup type is PRODUCT. ' maxLength: 255 type: string status: description: Status of the Job at Action Group Level. enum: - ACCEPTED - WAITING - IN_PROGRESS - FAILED - SUCCEEDED - CANCELED - SKIPPED - IGNORED - NOT_APPLICABLE - ABORTED - TIMED_OUT - PAUSED type: string x-obmcs-top-level-enum: '#/definitions/JobStatus' timeEnded: description: The time the Scheduler Job ended. An RFC3339 formatted datetime string. format: date-time type: string timeStarted: description: The time the Scheduler Job started. An RFC3339 formatted datetime string. format: date-time type: string required: - kind Schedule: description: Schedule Information. discriminator: propertyName: type properties: executionStartdate: description: Start Date for the schedule. An RFC3339 formatted datetime string format: date-time type: string type: description: Schedule Type enum: - CUSTOM - MAINTENANCE_WINDOW type: string required: - type - executionStartdate Patch: description: Patch metadata for Custom and Oracle patches. properties: artifactDetails: $ref: '#/components/schemas/ArtifactDetails' compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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"}}` ' type: object dependentPatches: description: 'Dependent Patches for this patch. ' items: $ref: '#/components/schemas/DependentPatchDetails' maxItems: 30 type: array description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 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"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Patch. enum: - ACTIVE - INACTIVE - DELETED - DELETING - FAILED - UPDATING type: string name: description: "A user-friendly name. Should be unique within the tenancy, and cannot be changed after creation. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string patchType: $ref: '#/components/schemas/PatchType' product: $ref: '#/components/schemas/PatchProduct' resourceRegion: description: Associated region maxLength: 255 type: string x-default-description: 'null' severity: description: Patch Severity. enum: - CRITICAL - HIGH - MEDIUM - LOW type: string x-obmcs-top-level-enum: '#/definitions/PatchSeverity' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' 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 timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeReleased: description: Date when the patch was released. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string type: description: 'Provide information on who defined the patch. Example: For Custom Patches the value will be USER_DEFINED For Oracle Defined Patches the value will be ORACLE_DEFINED ' enum: - USER_DEFINED - ORACLE_DEFINED type: string required: - id - name - patchType - severity - timeReleased - artifactDetails - product - lifecycleState - timeCreated - timeUpdated - compartmentId type: object ArtifactDetails: description: Patch artifact description and content details. discriminator: propertyName: category properties: category: description: Artifact category details. enum: - GENERIC - PLATFORM_SPECIFIC type: string required: - category type: object SchedulerExecutionCollection: description: Results of a schedulerExecution search. Contains SchedulerExecutionSummary items. properties: items: description: List of schedulerExecutions. items: $ref: '#/components/schemas/SchedulerExecutionSummary' type: array required: - items type: object UserActionDetails: description: 'User action details. This can be performed on a failed/paused task or action group. ' discriminator: propertyName: level properties: action: description: 'Action to be Performed. ' enum: - RETRY - RESUME - IGNORE - ABORT type: string level: description: 'User action based On. ' enum: - ACTION_GROUP - STEP_NAME type: string required: - level - action ComplianceRecordDimension: description: Aggregated summary information for ComplianceRecord properties: complianceLevel: description: Level at which the compliance is calculated. enum: - FLEET - TARGET type: string x-obmcs-top-level-enum: '#/definitions/ComplianceLevel' complianceState: description: Last known compliance state. enum: - UNKNOWN - COMPLIANT - NON_COMPLIANT - WARNING type: string x-obmcs-top-level-enum: '#/definitions/ComplianceState' required: - complianceState - complianceLevel type: object InventoryRecordSummary: description: Summary information about an inventory target. properties: architecture: description: Architecture of the resource associated with the target type: string compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string components: description: List of target components items: $ref: '#/components/schemas/InventoryRecordComponent' type: array installedPatches: description: List of details on the patches currently installed on the target items: $ref: '#/components/schemas/InventoryRecordPatchDetails' type: array lifecycleState: description: The current state of the Inventory target. type: string x-obmcs-enumref: '#/definitions/InventoryRecord/lifecycleState' osType: description: OS installed on the resource associated with the target type: string parentTargetName: description: Name of the parent target. type: string properties: description: List of target properties items: $ref: '#/components/schemas/InventoryRecordProperty' type: array targetId: description: The id of the Inventory target. type: string targetName: description: Name of the target type: string targetProductId: description: OCID of the product installed at the target path type: string targetProductName: description: Name of the product installed at the target path type: string targetResourceId: description: OCID of the resource associated with the target type: string targetResourceName: description: Name of the resource associated with the target type: string timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string version: description: Version of the product on the target type: string required: - targetId - targetName - version - targetResourceId - compartmentId - targetProductName - osType - architecture - properties - components - installedPatches type: object InventoryRecordProperty: description: Details about a inventory target properties: name: description: Name of the inventory target property. type: string value: description: Value of the inventory target property. type: string required: - name - value type: object ResourceSummary: allOf: - $ref: '#/components/schemas/EntityExecutionDetails' description: Execution Resource Summary ReportFilter: description: report filters. properties: description: description: Filter description. maxLength: 255 minLength: 1 type: string name: description: Filter Name. maxLength: 255 minLength: 1 type: string valueSource: description: Filter value source. maxLength: 1000 minLength: 1 type: string required: - name type: object AssociatedSchedulerDefinition: description: SchedulerDefinition associated with the job. properties: displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string isRecurring: default: false description: Is this a recurring schedule? type: boolean required: - id - displayName - isRecurring type: object ExecutionCollection: description: A collection of ExecutionSummary. properties: items: description: List of Resource Level Executions. items: $ref: '#/components/schemas/ExecutionSummary' type: array required: - items type: object ManagedEntityAggregation: description: Aggregated summary information for ManagedEntity properties: count: description: Count of managed entities in a compartment. format: int32 type: integer dimensions: $ref: '#/components/schemas/ManagedEntityDimension' required: - count - dimensions type: object SchedulerJobAggregationCollection: description: An array of SchedulerJob objects. properties: items: description: List of SchedulerJobAggregation objects. items: $ref: '#/components/schemas/SchedulerJobAggregation' type: array required: - items type: object PatchSelectionDetails: description: Patch Selection Details discriminator: propertyName: selectionType properties: selectionType: description: 'Selection type for the Patch. ' enum: - PATCH_LEVEL - PATCH_NAME - PATCH_RELEASE_DATE type: string required: - selectionType ReportSummary: description: Summary information about a Report. properties: item: description: Data points. items: type: string maxItems: 1000 type: array required: - item type: object ReportMetadataCollection: description: Results of a run report . properties: items: description: List of ReportMetadata. items: $ref: '#/components/schemas/ReportMetadataSummary' maxItems: 1000 type: array required: - items type: object ManageJobExecutionDetails: description: 'Details of the Job Execution actions. ' properties: actionDetails: $ref: '#/components/schemas/UserActionDetails' required: - actionDetails ComplianceDetailProduct: description: Details of the Product. properties: productName: description: Product Name. maxLength: 255 minLength: 1 type: string productStack: description: Product Stack. maxLength: 255 minLength: 1 type: string productVersion: description: Product Version. maxLength: 255 minLength: 1 type: string required: - productName TargetComponentSummary: description: Summary information about an target component. properties: name: description: Name of the component type: string path: description: Path of the component type: string properties: description: List of properties. items: $ref: '#/components/schemas/TargetPropertySummary' type: array version: description: Version of the component type: string required: - name - version - path type: object OperationRunbook: description: Runbook properties: inputParameters: description: Input Parameters for the Task items: $ref: '#/components/schemas/InputParameter' maxItems: 100 type: array runbookId: description: The ID of the Runbook maxLength: 255 minLength: 1 type: string runbookVersionName: description: The runbook version name maxLength: 255 minLength: 1 type: string required: - runbookId - runbookVersionName ComplianceRecordAggregation: description: Aggregated summary information for ComplianceRecord properties: count: description: Count of compliance records in a compartment. format: int32 type: integer dimensions: $ref: '#/components/schemas/ComplianceRecordDimension' required: - count - dimensions type: object ActivityResourceTarget: description: Activity Resource Target. properties: description: description: "Description of the Execution status.\nIf there are any errors, this can also include a short error message. \n" maxLength: 400 type: string status: description: Status of the Job at target Level. enum: - ACCEPTED - WAITING - IN_PROGRESS - FAILED - SUCCEEDED - CANCELED - SKIPPED - IGNORED - NOT_APPLICABLE - ABORTED - TIMED_OUT - PAUSED type: string x-obmcs-top-level-enum: '#/definitions/JobStatus' targetName: description: Target Name. type: string required: - targetName type: object SchedulerDefinitionCollection: description: Results of a schedulerDefinition search. Contains boh SchedulerDefinitionSummary items and other information, such as metadata. properties: items: description: List of schedulerDefinitions. items: $ref: '#/components/schemas/SchedulerDefinitionSummary' type: array required: - items type: object SchedulerJobSummary: description: Summary of the SchedulerJob. properties: actionGroups: description: Action Groups associated with the Schedule. items: $ref: '#/components/schemas/ActionGroupDetails' type: array compartmentId: description: Compartment OCID maxLength: 255 minLength: 1 type: string countOfAffectedActionGroups: description: 'Count of Action Groups affected by the Schedule. An action group is a group of entities grouped for a lifecycle activity. Example - A Fleet will be considered an Action Group for any lifecycle activity. ' type: integer countOfAffectedResources: description: Count of resources affected by the schedule. type: integer countOfAffectedTargets: description: Count of targets affected by the schedule. type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 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"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleOperations: description: All LifeCycle Operations that are part of the schedule. items: type: string maxItems: 10 type: array lifecycleState: description: The current state of the SchedulerJob. type: string x-obmcs-enumref: '#/definitions/SchedulerJob/lifecycleState' products: description: All products that are part of the schedule for a PRODUCT action group type. items: type: string maxItems: 30 type: array schedulerDefinition: $ref: '#/components/schemas/AssociatedSchedulerDefinition' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' 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 timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeScheduled: description: The scheduled date and time for the Job. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - freeformTags - definedTags type: object EntityExecutionDetails: description: Resource level execution status and target associations. properties: description: description: 'Description of the Resource Execution status. If there are any errors, this can also include a short error message. ' maxLength: 400 type: string resourceDisplayName: description: Resource Display Name. maxLength: 255 minLength: 1 type: string resourceId: description: Resource Identifier associated with the Work Request. maxLength: 255 minLength: 1 type: string sequence: description: The sequence of the Resource. maxLength: 10 minLength: 1 type: string status: description: Status of the Job at Resource Level. enum: - ACCEPTED - WAITING - IN_PROGRESS - FAILED - SUCCEEDED - CANCELED - SKIPPED - IGNORED - NOT_APPLICABLE - ABORTED - TIMED_OUT - PAUSED type: string x-obmcs-top-level-enum: '#/definitions/JobStatus' targets: description: Targets associated with the resource. items: $ref: '#/components/schemas/ActivityResourceTarget' maxItems: 30 type: array timeEnded: description: The time the task ended for the resource. An RFC3339 formatted datetime string format: date-time type: string timeStarted: description: The time the task started for the resource. An RFC3339 formatted datetime string format: date-time type: string required: - status - resourceId type: object SchedulerJobCollection: description: Results of a schedulerJob search. Contains SchedulerJobSummary items and other information, such as metadata. properties: items: description: List of schedulerJobs. items: $ref: '#/components/schemas/SchedulerJobSummary' type: array required: - items type: object PatchType: description: Patch Type properties: platformConfigurationId: description: PlatformConfiguration Id corresponding to the Patch Type maxLength: 255 minLength: 1 type: string required: - platformConfigurationId type: object InventoryRecordCollection: description: Results of an inventory search. properties: items: description: List of inventory targets items: $ref: '#/components/schemas/InventoryRecordSummary' type: array required: - items type: object UpdatePatchDetails: description: The patch information to be updated. properties: artifactDetails: $ref: '#/components/schemas/ArtifactDetails' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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"}}` ' type: object dependentPatches: description: 'Dependent Patches. ' items: $ref: '#/components/schemas/DependentPatchDetails' maxItems: 30 type: array description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 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"}` ' type: object patchType: $ref: '#/components/schemas/PatchType' product: $ref: '#/components/schemas/PatchProduct' severity: description: Patch Severity. enum: - CRITICAL - HIGH - MEDIUM - LOW type: string x-obmcs-top-level-enum: '#/definitions/PatchSeverity' timeReleased: description: Date when the patch was released. format: date-time type: string type: object TargetComponentCollection: description: Results of an target component search. properties: items: description: List of target components. items: $ref: '#/components/schemas/TargetComponentSummary' type: array required: - items type: object ActionGroup: description: Action Group. discriminator: propertyName: kind properties: displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string kind: description: Action Group kind enum: - FLEET_USING_RUNBOOK type: string required: - kind ComplianceRecordAggregationCollection: description: An array of ComplianceRecord objects properties: items: description: List of ComplianceRecordAggregation objects. items: $ref: '#/components/schemas/ComplianceRecordAggregation' type: array required: - items type: object TargetPropertyCollection: description: Results of an target property search. properties: items: description: List of target properties. items: $ref: '#/components/schemas/TargetPropertySummary' type: array required: - items type: object ScheduledFleetSummary: description: Summary of Fleet part of the Schedule. properties: compartmentId: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string countOfAffectedResources: description: Count of Resources affected by the Schedule type: integer countOfAffectedTargets: description: Count of Targets affected by the Schedule type: integer displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string products: description: All products part of the schedule. items: type: string maxItems: 30 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' 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 required: - id - displayName - compartmentId type: object RecommendedPatchCollection: description: Results of an recommended patches search. properties: items: description: List of recommended patches items: $ref: '#/components/schemas/RecommendedPatchSummary' type: array required: - items type: object InventoryRecordComponent: description: Details about a target component properties: componentName: description: Name of the target component type: string componentPath: description: Path of the component type: string componentVersion: description: Version of the target component type: string properties: description: List of component properties items: $ref: '#/components/schemas/InventoryRecordProperty' type: array required: - componentName - componentVersion - componentPath - properties type: object SchedulerJobAggregation: description: Aggregated summary information for SchedulerJob. properties: count: description: Count of jobs in a Compartment. format: int32 type: integer dimensions: $ref: '#/components/schemas/SchedulerJobDimension' required: - count - dimensions type: object ColumnMetadata: description: Column metadata. properties: description: description: Column description maxLength: 255 minLength: 1 type: string name: description: Column name. maxLength: 255 minLength: 1 type: string type: description: 'Column value type. ' enum: - STRING - NUMBER - DATE_TIME type: string required: - name - description - type type: object ScheduledFleetCollection: description: Results of a Scheduled ActionGroup search. properties: items: description: List of ScheduledFleets. items: $ref: '#/components/schemas/ScheduledFleetSummary' type: array required: - items type: object ReportCollection: description: Results of a summarize report . properties: items: description: List of ReportsSummary. items: $ref: '#/components/schemas/ReportSummary' maxItems: 1000 type: array required: - items type: object ManagedEntityAggregationCollection: description: An array of Managed Entity objects properties: items: description: List of ManagedEntityAggregation objects. items: $ref: '#/components/schemas/ManagedEntityAggregation' type: array required: - items type: object CreatePatchDetails: description: The information about new Patch. properties: artifactDetails: $ref: '#/components/schemas/ArtifactDetails' compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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"}}` ' type: object dependentPatches: description: 'Dependent Patches for this patch. ' items: $ref: '#/components/schemas/DependentPatchDetails' maxItems: 30 type: array description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 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"}` ' type: object name: description: "A user-friendly name. Should be unique within the tenancy, and cannot be changed after creation. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string patchType: $ref: '#/components/schemas/PatchType' product: $ref: '#/components/schemas/PatchProduct' severity: description: Patch Severity. enum: - CRITICAL - HIGH - MEDIUM - LOW type: string x-obmcs-top-level-enum: '#/definitions/PatchSeverity' timeReleased: description: Date when the patch was released. format: date-time type: string required: - compartmentId - name - patchType - severity - timeReleased - product - artifactDetails type: object ReportTimeRange: description: TimeRange Object properties: timeFrom: description: Start Date for the report. An RFC3339 formatted datetime string format: date-time type: string timeUntil: description: End Date for the report. An RFC3339 formatted datetime string format: date-time type: string required: - timeFrom - timeUntil type: object PatchProduct: description: Product properties: platformConfigurationId: description: PlatformConfiguration Id corresponding to the Product maxLength: 255 minLength: 1 type: string version: description: product version. maxLength: 100 minLength: 1 type: string required: - platformConfigurationId - version type: object CreateSchedulerDefinitionDetails: description: The information about new SchedulerDefinition. properties: actionGroups: description: Action Groups associated with the Schedule. items: $ref: '#/components/schemas/ActionGroup' maxItems: 100 type: array compartmentId: description: Compartment OCID maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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"}}` ' type: object description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 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"}` ' type: object runBooks: description: Runbooks. items: $ref: '#/components/schemas/OperationRunbook' maxItems: 50 type: array x-default-description: 'null' schedule: $ref: '#/components/schemas/Schedule' required: - compartmentId - schedule - actionGroups type: object Execution: description: Task Execution associated with the Job. properties: description: description: 'Description of the Execution status. If there are any errors, this can also include a short error message. ' maxLength: 400 type: string id: description: Unique Id associated with the task execution. maxLength: 255 minLength: 1 type: string isRetryExceeded: default: false description: An attribute which tells if further retries are allowed for the task on failure. type: boolean isRollbackTask: description: Is this a rollback task? type: boolean outcome: $ref: '#/components/schemas/Outcome' processReferenceId: description: 'Unique process-reference identifier returned by the execution client. In some cases, this can be a runcommand OCID. ' maxLength: 255 minLength: 1 type: string resourceId: description: Resource Identifier associated with the Work Request. maxLength: 255 minLength: 1 type: string sequence: description: The sequence of the task. maxLength: 10 minLength: 1 type: string status: description: Status of the Task enum: - ACCEPTED - WAITING - IN_PROGRESS - FAILED - SUCCEEDED - CANCELED - SKIPPED - IGNORED - NOT_APPLICABLE - ABORTED - TIMED_OUT - PAUSED type: string x-obmcs-top-level-enum: '#/definitions/JobStatus' stepName: description: Name of the step. type: string subjects: description: Subjects that are tied to the task. items: maxLength: 255 minLength: 1 type: string maxItems: 100 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' 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 targetId: description: Target associated with the execution. maxLength: 255 minLength: 1 type: string taskRecordId: description: The OCID of taskRecord. maxLength: 255 minLength: 1 type: string timeEnded: description: The time the task ended. An RFC3339 formatted datetime string. format: date-time type: string timeStarted: description: The time the task started. An RFC3339 formatted datetime string. format: date-time type: string required: - id - status type: object ComplianceDetailResource: description: Details of the Resource properties: compartment: description: Compartment the resource belongs to. maxLength: 255 minLength: 1 type: string compartmentId: description: Compartment OCID of the resource. maxLength: 255 minLength: 1 type: string resourceId: description: The OCID to identify the resource. maxLength: 255 minLength: 1 type: string resourceName: description: Name of the resource. maxLength: 255 minLength: 1 type: string resourceRegion: description: Region the resource belongs to. maxLength: 255 minLength: 1 type: string required: - resourceId - resourceName RecommendedPatchSummary: description: Summary information about an recommended patches. properties: patchDescription: description: Description of the patch type: string patchId: description: The OCID of the patch. type: string patchLevel: description: Patch Level. enum: - LATEST - LATEST_MINUS_ONE - LATEST_MINUS_TWO type: string patchName: description: Name of the patch type: string patchType: description: Description of the patch type: string severity: description: Patch Severity. enum: - CRITICAL - HIGH - MEDIUM - LOW type: string x-obmcs-top-level-enum: '#/definitions/PatchSeverity' timeReleased: description: Date on which the patch was released format: date-time type: string required: - patchId - patchName - patchDescription type: object JobActivity: description: Activity details including status corresponding to an Action Group. properties: description: description: 'A description of the Job Activity status. If there are any errors, this can also include a short error message. ' maxLength: 400 type: string id: description: 'Unique activity id at the action group level. In most cases, this would be a generated ActionGroupId. ' maxLength: 255 minLength: 1 type: string resourceLevelExecutions: description: List of Resource executions associated with the Action Group. items: $ref: '#/components/schemas/EntityExecutionDetails' maxItems: 500 type: array runbookId: description: OCID of the runbook associated with the Action Group. maxLength: 255 minLength: 1 type: string runbookName: description: Name of the runbook associated with the Action Group. maxLength: 200 type: string runbookVersionName: description: Name of the RunbookVersion associated with the Action Group. maxLength: 255 minLength: 1 type: string status: description: Status of the Job at Action Group Level. enum: - ACCEPTED - WAITING - IN_PROGRESS - FAILED - SUCCEEDED - CANCELED - SKIPPED - IGNORED - NOT_APPLICABLE - ABORTED - TIMED_OUT - PAUSED type: string x-obmcs-top-level-enum: '#/definitions/JobStatus' timeEnded: description: The time the execution for the Action Group ended. An RFC3339 formatted datetime string format: date-time type: string timeStarted: description: The time the execution for the Action Group started. An RFC3339 formatted datetime string. format: date-time type: string required: - id - status type: object InstalledPatchSummary: description: Summary information about an installed patches. properties: patchDescription: description: Description of the patch type: string patchId: description: The OCID of the patch. type: string patchLevel: description: Patch Name. type: string patchName: description: Name of the patch type: string patchType: description: Description of the patch type: string severity: description: Patch Severity. enum: - CRITICAL - HIGH - MEDIUM - LOW type: string x-obmcs-top-level-enum: '#/definitions/PatchSeverity' timeApplied: description: Date on which the patch was applied to the target format: date-time type: string timeReleased: description: Date on which the patch was released format: date-time type: string required: - patchId - patchName - patchDescription type: object OrderClause: description: report filters. properties: sortBy: description: Sort By. maxLength: 100 minLength: 1 type: string sortOrder: description: 'Sort Order. ' enum: - ASC - DESC type: string required: - sortBy type: object StepCollection: description: Results of a StepSummary search. properties: items: description: List of Execution steps. items: $ref: '#/components/schemas/StepSummary' type: array required: - items type: object UpdateSchedulerJobDetails: description: The information to be updated for the job. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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"}}` ' 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"}` ' type: object timeScheduled: description: The scheduled date and time for the Job. format: date-time type: string type: object ManagedEntityDimension: description: Aggregated summary information for ComplianceRecord properties: entity: description: Level at which the compliance is calculated. enum: - RESOURCE - TARGET type: string x-obmcs-top-level-enum: '#/definitions/ManagedEntity' required: - entity type: object TaskArgument: description: A Task argument that holds a value. discriminator: propertyName: kind properties: kind: description: Task argument kind enum: - STRING - FILE type: string name: description: Name of the input variable maxLength: 255 type: string required: - kind - name type: object SchedulerExecutionSummary: description: Summary of the Scheduler Executions. properties: activityId: description: Action Group associated with the Schedule. type: string compartmentId: description: Compartment OCID maxLength: 255 minLength: 1 type: string compartmentName: description: Name of the compartment in which resource exist. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 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"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string latestRunbookVersionName: description: Latest Runbook version available. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Scheduler Execution. enum: - ACTIVE - DELETED - FAILED - INACTIVE type: string resourceDisplayName: description: Display Name of the Fleet associated with the Schedule. type: string resourceId: description: FleetId associated with the Schedule. type: string runbookDisplayName: description: Display name of Runbook associated with the Schedule. type: string runbookId: description: RunbookId associated with the Schedule. type: string runbookVersionName: description: Name of the Runbook version associated with the Schedule. type: string schedulerDefinition: $ref: '#/components/schemas/AssociatedSchedulerDefinition' schedulerJobId: description: SchedulerJobId associated with the Schedule. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' 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 timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeEnded: description: Actual end date and time for the Execution. format: date-time type: string timeScheduled: description: The scheduled date and time for the Job. format: date-time type: string timeStarted: description: Actual start date and time for the Execution. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - freeformTags type: object ExecutionSummary: description: A task associated with the Job. properties: description: description: 'Description of the Execution status. If there are any errors, this can also include a short error message. ' maxLength: 400 type: string id: description: Unique Id associated with the task execution. maxLength: 255 minLength: 1 type: string isRetryExceeded: default: false description: An attribute which tells if further retries are allowed for the task on failure. type: boolean isRollbackTask: description: Is this a rollback task? type: boolean processReferenceId: description: 'Unique process-reference identifier returned by the execution client. In some cases, this can be a runcommand OCID. ' maxLength: 255 minLength: 1 type: string resourceId: description: Resource Identifier associated with the Work Request. maxLength: 255 minLength: 1 type: string sequence: description: The sequence of the task. maxLength: 10 minLength: 1 type: string status: description: Status of the Task. enum: - ACCEPTED - WAITING - IN_PROGRESS - FAILED - SUCCEEDED - CANCELED - SKIPPED - IGNORED - NOT_APPLICABLE - ABORTED - TIMED_OUT - PAUSED type: string x-obmcs-top-level-enum: '#/definitions/JobStatus' stepName: description: Name of the Step. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' 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 targetId: description: Target associated with the execution. maxLength: 255 minLength: 1 type: string taskRecordId: description: The OCID of taskRecord. maxLength: 255 minLength: 1 type: string timeEnded: description: The time the task ended. An RFC3339 formatted datetime string. format: date-time type: string timeStarted: description: The time the task started. An RFC3339 formatted datetime string. format: date-time type: string required: - id - status type: object InventoryRecordPatchDetails: description: Details about an installed patch on the target properties: patchDescription: description: Description for the installed patch type: string patchId: description: OCID of the installed patch type: string patchLevel: description: Patch Level. type: string patchName: description: Name of the installed patch type: string patchType: description: Type of patch applied type: string timeApplied: description: Date on which the patch was applied to the target format: date-time type: string timeReleased: description: The date on which patch was released. format: date-time type: string required: - patchName - patchDescription - timeApplied - patchType type: object StepSummary: description: Task associated with the Job. properties: description: description: Description of the step Execution. maxLength: 400 type: string isRollbackTask: description: Is this a rollback task? type: boolean sequence: description: The sequence of the step. maxLength: 10 minLength: 1 type: string status: description: Status of the Task. enum: - ACCEPTED - WAITING - IN_PROGRESS - FAILED - SUCCEEDED - CANCELED - SKIPPED - IGNORED - NOT_APPLICABLE - ABORTED - TIMED_OUT - PAUSED type: string x-obmcs-top-level-enum: '#/definitions/JobStatus' stepName: description: Name of the Step. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' 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 taskRecordId: description: The OCID of taskRecord assocaited with the step. maxLength: 255 minLength: 1 type: string timeEnded: description: The time the task ended. An RFC3339 formatted datetime string format: date-time type: string timeStarted: description: The time the task started. An RFC3339 formatted datetime string format: date-time type: string required: - stepName - status type: object ResourceCollection: description: Results of a ResourceSummary Search. properties: items: description: List of Execution Resources. items: $ref: '#/components/schemas/ResourceSummary' type: array required: - items type: object CompliancePatchDetail: description: Details of the Patch. properties: patchDescription: description: Patch Description. maxLength: 255 minLength: 1 type: string patchId: description: patch OCID. maxLength: 255 minLength: 1 type: string patchName: description: patch Name. maxLength: 255 minLength: 1 type: string patchType: description: Type of patch. maxLength: 255 minLength: 1 type: string product: $ref: '#/components/schemas/ComplianceDetailProduct' severity: description: Patch Severity. enum: - CRITICAL - HIGH - MEDIUM - LOW type: string x-obmcs-top-level-enum: '#/definitions/PatchSeverity' timeReleased: description: Date on which patch was released format: date-time type: string required: - patchName - patchType UpdateSchedulerDefinitionDetails: description: The information to be updated. properties: actionGroups: description: Action Groups associated with the Schedule. items: $ref: '#/components/schemas/ActionGroup' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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"}}` ' type: object description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 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"}` ' type: object runBooks: description: Runbooks. items: $ref: '#/components/schemas/OperationRunbook' type: array schedule: $ref: '#/components/schemas/Schedule' type: object InputParameter: description: Input Parameters for the Task properties: arguments: description: Arguments for the Task items: $ref: '#/components/schemas/TaskArgument' maxItems: 100 type: array stepName: description: stepName for which the input parameters are provided maxLength: 255 minLength: 1 type: string required: - stepName SchedulerDefinitionSummary: description: Summary of the SchedulerDefinition. properties: compartmentId: description: Compartment OCID maxLength: 255 minLength: 1 type: string countOfAffectedActionGroups: description: Count of Action Groups affected by the Schedule. type: integer countOfAffectedResources: description: Count of Resources affected by the Schedule type: integer countOfAffectedTargets: description: Count of Targets affected by the Schedule type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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"}}` ' type: object description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 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"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleOperations: description: All LifeCycle Operations part of the schedule items: type: string maxItems: 10 type: array lifecycleState: description: The current state of the SchedulerDefinition. type: string x-obmcs-enumref: '#/definitions/SchedulerDefinition/lifecycleState' products: description: All products part of the schedule items: type: string maxItems: 30 type: array resourceRegion: description: Associated region maxLength: 255 type: string x-default-description: 'null' schedule: $ref: '#/components/schemas/Schedule' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' 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 timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeOfNextRun: description: Scheduled date for the next run of the Job. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - timeCreated - displayName type: object 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: 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 opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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-total-items: description: A number representing the the total number of results available. type: integer 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 decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is 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"}}` ' type: object description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 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"}` ' type: object name: description: "A user-friendly name. Should be unique within the tenancy, and cannot be changed after creation. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string ocid: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string region: description: Associated region maxLength: 255 type: string x-default-description: 'null' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' 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 tenancyId: description: OCID of the tenancy to which the resource belongs to. maxLength: 255 minLength: 1 type: string timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string uniqueId: description: The unique id of the resource. maxLength: 255 minLength: 1 type: string x-tag-groups: adminWorkRequest: - fleetAppsManagementAdmin announcement: - fleetAppsManagement catalogItem: - fleetAppsManagementCatalog category: - fleetAppsManagementAdmin compliance: - fleetAppsManagementOperations compliancePolicy: - fleetAppsManagementAdmin compliancePolicyRule: - fleetAppsManagementAdmin famProvision: - fleetAppsManagementProvision famReport: - fleetAppsManagementOperations fleet: - fleetAppsManagement fleetCredential: - fleetAppsManagement fleetProperty: - fleetAppsManagement fleetResource: - fleetAppsManagement fleetWorkRequest: - fleetAppsManagementWorkRequest inventory: - fleetAppsManagementOperations inventoryResource: - fleetAppsManagement maintenanceWindow: - fleetAppsManagementMaintenanceWindow onboard: - fleetAppsManagementAdmin patch: - fleetAppsManagementOperations platformConfiguration: - fleetAppsManagementAdmin property: - fleetAppsManagementAdmin runbook: - fleetAppsManagementRunbooks schedulerDefinition: - fleetAppsManagementOperations schedulerJob: - fleetAppsManagementOperations taskRecord: - fleetAppsManagementRunbooks x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.oci.fams