openapi: 3.2.0 info: description: Use the OCI Managed Services for Mac API to create and manage orders for dedicated, partially-managed Mac servers hosted in an OCI Data Center. To learn more about the service, see the [OCI Managed Services for Mac documentation](https://docs.oracle.com/en-us/iaas/Content/managed-mac/home.htm). title: OCI Managed Services for Mac Mac Order API version: '20250320' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/9ddea3093fd3564bac7128a88f62ab50750d17916eb1a9c18fb85144868ac15d.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the OCI Managed Services for Mac 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/9ddea3093fd3564bac7128a88f62ab50750d17916eb1a9c18fb85144868ac15d.yaml what: the harvested document for OCI Managed Services for Mac API servers: - url: http://127.0.0.1/20250320 - url: https://127.0.0.1/20250320 tags: - name: macOrder paths: /macOrders: get: description: 'Gets a list of MacOrders. ' operationId: ListMacOrders parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/MacOrderIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of MacOrderSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MacOrderCollection' 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 MacOrders. tags: - macOrder x-related-resource: '#/definitions/MacOrderCollection' post: description: 'Creates a MacOrder. ' operationId: CreateMacOrder parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The MacOrder 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 MacOrder. The MacOrder OCID is 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: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MacOrder' 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 MacOrder. tags: - macOrder x-related-resource: '#/definitions/MacOrder' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMacOrderDetails' description: Details for the new MacOrder. required: true /macOrders/{macOrderId}: get: description: Gets information about a MacOrder. operationId: GetMacOrder parameters: - $ref: '#/components/parameters/MacOrderIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The MacOrder was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MacOrder' 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 MacOrder tags: - macOrder put: description: Updates a MacOrder. operationId: UpdateMacOrder parameters: - $ref: '#/components/parameters/MacOrderIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The MacOrder 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: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a MacOrder. tags: - macOrder x-related-resource: '#/definitions/MacOrder' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMacOrderDetails' description: The information to be updated. required: true /macOrders/{macOrderId}/actions/cancel: post: description: Cancels a MacOrder. operationId: CancelMacOrder parameters: - $ref: '#/components/parameters/MacOrderIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The MacOrder will be cancelled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 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: Cancels a MacOrder. tags: - macOrder x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/MacOrder' requestBody: content: application/json: schema: $ref: '#/components/schemas/CancelMacOrderDetails' description: The information to cancel a MacOrder. /workRequests: get: description: 'Lists the work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - $ref: '#/components/parameters/WorkRequestStatusQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' responses: 200: description: The list of work requests was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List work requests tags: - macOrder x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: delete: description: Cancels a work request. operationId: CancelWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The work request will be canceled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancel work request tags: - macOrder x-related-resource: '#/definitions/WorkRequest' get: description: Gets the details of a work request. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The work request was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get work request status tags: - macOrder x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Lists the errors for a work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The list of work request errors was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List work request errors tags: - macOrder x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Lists the logs for a work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The list of work request logs. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List work request logs tags: - macOrder x-related-resource: '#/definitions/WorkRequestLogEntry' components: parameters: PaginationTokenQueryParam: description: 'For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: page schema: type: string minLength: 1 SortByQueryParam: description: 'The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated MacOrderIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the MacOrder. in: query name: id x-default-description: 'null' schema: type: string ResourceIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request. in: query name: resourceId x-default-description: 'null' schema: type: string CompartmentIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. in: query name: compartmentId x-default-description: 'null' schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string WorkRequestStatusQueryParam: description: A filter to return only the resources that match the given lifecycle state. in: query name: status required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OperationStatus' schema: type: string enum: - ACCEPTED - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELING - CANCELED PaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 LifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/MacOrder/lifecycleState' schema: type: string SortOrderQueryParam: description: The sort order to use, either ascending (`ASC`) or descending (`DESC`). in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is `DESC` when sorting by time and `ASC` otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC WorkRequestIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. in: query name: workRequestId x-default-description: 'null' schema: type: string WorkRequestIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. in: path name: workRequestId required: true schema: type: string WorkRequestLogAndErrorSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending. ' in: query name: sortBy schema: type: string enum: - timestamp default: timestamp RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 DisplayNameQueryParam: description: A filter to return only resources that match the given display name exactly. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 WorkRequestSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending. ' in: query name: sortBy schema: type: string enum: - timeAccepted default: timeAccepted RequestIdHeader: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash. ' in: header name: opc-request-id schema: type: string MacOrderIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the MacOrder. in: path name: macOrderId required: true schema: type: string schemas: MacOrderCollection: description: Results of a MacOrder search. Contains both MacOrderSummary items and other information, such as metadata. properties: items: description: List of MacOrders. items: $ref: '#/components/schemas/MacOrderSummary' type: array required: - items type: object Error: description: Error information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error message. type: string required: - code - message MacOrder: description: 'A description of a MacOrder resource. ' properties: cancelReason: description: The reason for the MacOrder cancellation. type: string commitmentTerm: description: Enum indicating the agreed commitment term for the requested MacDevices. enum: - YEARS_3 type: string compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 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 id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string ipRange: description: The IP Range specified by the customer for this order. type: string isDocusigned: default: false description: Checkbox value that indicates whether the customer completed docusign process. type: boolean lifecycleDetails: description: 'A message that describes the current state of the MacOrder in more detail. ' type: string lifecycleState: description: The current state of the MacOrder. enum: - CREATING - UPDATING - ACTIVE - NEEDS_ATTENTION - DELETING - DELETED - FAILED type: string orderDescription: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string orderSize: description: Number of macs requested in this MacOrder. type: integer orderStatus: description: The current status of the MacOrder. enum: - SUBMITTED - PENDING_DOCUSIGN - ORDER_REVIEW - CUSTOMER_REVIEW - CUSTOMER_APPROVED - FUNDING_APPROVED - PROVISIONING - CUSTOMER_ACCEPTED - COMPLETED - CANCELED type: string shape: description: Enum indicating the requested shape for the MacDevices. enum: - M2_PRO_MAC_MINI_32GB_1TB - M3_ULTRA_MAC_STUDIO_256GB_4TB - M4_PRO_MAC_MINI_64GB_4TB type: string timeBillingEnded: description: An RFC3339-formatted datetime string containing the date and time that billing for this MacOrder ends. format: date-time type: string timeBillingStarted: description: An RFC3339-formatted datetime string containing the date and time that billing for this MacOrder begins. format: date-time type: string timeCanceled: description: An RFC3339-formatted datetime string containing the time this MacOrder was cancelled. format: date-time 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 required: - id - compartmentId - orderDescription - orderStatus - orderSize - commitmentTerm - isDocusigned - shape - timeCreated - lifecycleState type: object UpdateMacOrderDetails: description: The data to update a MacOrder. 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 ipRange: description: The IP Range specified by the customer for this order. type: string orderDescription: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string orderSize: description: Number of macs requested in this MacOrder. type: integer shape: description: The shape of the Mac. type: string x-obmcs-enumref: '#/definitions/MacOrder/shape' type: object WorkRequestSummaryCollection: description: A list of work requests. Can contain both work requests and other information, such as metadata. properties: items: description: A list of work requests. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object WorkRequestResource: description: A resource created or operated on by a work request. properties: actionType: description: 'The way in which this resource is affected by the operation tracked in the work request. A resource being created, updated, or deleted remains in the IN_PROGRESS state until work is complete for that resource, at which point it transitions to CREATED, UPDATED, or DELETED, respectively. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The resource type that the work request affects. type: string entityUri: description: The URI path that you can use for a GET request to access the resource metadata. type: string identifier: description: An [OCID](/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource. type: string metadata: additionalProperties: type: string description: Additional information that helps to explain the resource. enum: - IS_DRY_RUN type: object x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceMetadataKey' required: - actionType - entityType - identifier MacOrderSummary: description: Summary information about a MacOrder. properties: commitmentTerm: description: Enum indicating the agreed commitment term on the MacOrder. type: string x-obmcs-enumref: '#/definitions/MacOrder/commitmentTerm' compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 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 id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string ipRange: description: The IP Range specified by the customer for this order. type: string isDocusigned: default: false description: Checkbox value that indicates whether the customer completed docusign process. type: boolean lifecycleDetails: description: 'A message that describes the current state of the MacOrder in more detail. ' type: string lifecycleState: description: The current state of the MacOrder. type: string x-obmcs-enumref: '#/definitions/MacOrder/lifecycleState' orderDescription: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string orderSize: description: Number of macs requested in this MacOrder. type: integer orderStatus: description: The current status of the MacOrder. type: string x-obmcs-enumref: '#/definitions/MacOrder/orderStatus' shape: description: The requested shape for Macs in this MacOrder. type: string x-obmcs-enumref: '#/definitions/MacOrder/shape' timeBillingEnded: description: An RFC3339-formatted datetime string containing the date and time this MacOrder begins. format: date-time type: string timeBillingStarted: description: An RFC3339-formatted datetime string containing the date and time this MacOrder begins. format: date-time 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 required: - id - compartmentId - displayName - orderDescription - orderStatus - orderSize - commitmentTerm - isDocusigned - shape - timeCreated - lifecycleState type: object WorkRequestErrorCollection: description: A list of work request errors. Can contain both errors and other information, such as metadata. properties: items: description: A list of work request errors. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object CreateMacOrderDetails: description: The data to create a new MacOrder. properties: commitmentTerm: default: YEARS_3 description: Enum that indicates the agreed commitment term for the MacDevices. type: string x-obmcs-enumref: '#/definitions/MacOrder/commitmentTerm' compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 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 ipRange: description: The IP Range specified by the customer for this order. type: string orderDescription: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string orderSize: description: Number of macs requested in this MacOrder. type: integer shape: description: The requested shape of the MacDevices in the MacOrder. type: string x-obmcs-enumref: '#/definitions/MacOrder/shape' required: - compartmentId - orderDescription - orderSize - commitmentTerm - shape type: object WorkRequestSummary: description: Summary information about an asynchronous work request. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. ' type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. type: string operationType: description: The asynchronous operation tracked by this work request. enum: - CREATE_MAC_ORDER - UPDATE_MAC_ORDER - CANCEL_MAC_ORDER - DELETE_MAC_ORDER - DELETE_MAC_DEVICE type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: 'Shows the progress of the operation tracked by the work request, as a percentage of the total work that must be performed. ' format: float type: number resources: description: The resources that are affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of the work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the work request was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeFinished: description: 'The date and time the work request was finished, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the work request was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeUpdated: description: 'The date and time the work request was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted WorkRequestError: description: An error encountered while performing an operation that is tracked by a work request. properties: code: description: 'A machine-usable code for the error that occurred. For a list of error codes, see [API Errors](/iaas/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable error message. type: string timestamp: description: 'The date and time the error occurred, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string required: - code - message - timestamp WorkRequestLogEntry: description: A log message from performing an operation that is tracked by a work request. properties: message: description: A human-readable log message. type: string timestamp: description: 'The date and time the log message was written, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string required: - message - timestamp CancelMacOrderDetails: description: The data to cancel a MacOrder. properties: cancelReason: description: The reason for the MacOrder cancellation. type: string type: object WorkRequestLogEntryCollection: description: A list of work request logs. Can contain both logs and other information, such as metadata. properties: items: description: A list of work request log entries. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object WorkRequest: description: 'An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work request. A work request is an activity log that lets you track each step in the operation''s progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. ' type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. type: string operationType: description: The asynchronous operation tracked by this work request. enum: - CREATE_MAC_ORDER - UPDATE_MAC_ORDER - CANCEL_MAC_ORDER - DELETE_MAC_ORDER - DELETE_MAC_DEVICE type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: 'Shows the progress of the operation tracked by the work request, as a percentage of the total work that must be performed. ' format: float type: number resources: description: The resources that are affected by the work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of the work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the work request was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeFinished: description: 'The date and time the work request was finished, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the work request was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeUpdated: description: 'The date and time the work request was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 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 ipRange: description: The IP Range specified by the customer for this order. type: string isDocusigned: default: false description: Checkbox value that indicates whether the customer completed docusign process. type: boolean ocid: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string orderDescription: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string orderSize: description: Number of macs requested in this MacOrder. type: integer region: description: Associated region maxLength: 255 type: string x-default-description: 'null' 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 x-obmcs-client-retries-enabled: true x-oracle-package: com.oci.mngdmac.dev