Oracle Occ Demand Signal API

openapi: 3.2.0
info:
  description: Use the OCI Control Center Demand Signal API to manage Demand Signals.
  title: OCI Control Center Demand Signal Occ Demand Signal API
  version: '20240430'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/806148b547773570d1e4ebc94c2e5efa20b751170d4471e0b4f6d0433ca6a7e6.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the OCI Control Center Demand Signal 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/806148b547773570d1e4ebc94c2e5efa20b751170d4471e0b4f6d0433ca6a7e6.yaml
    what: the harvested document for OCI Control Center Demand Signal API
servers:
- url: https://127.0.0.1/20240430
tags:
- name: occDemandSignal
paths:
  /occDemandSignals:
    get:
      description: 'Gets a list of OccDemandSignals.

        '
      operationId: ListOccDemandSignals
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/OccDemandSignalIdentifierQueryParam'
      - $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 OccDemandSignalSummary 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/OccDemandSignalCollection'
        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 OccDemandSignals.
      tags:
      - occDemandSignal
      x-example: "Example 1 Request:\n  GET /20180828/occDemandSignals?compartmentId=string&limit=10&sortBy=timeCreated\n"
      x-related-resource: '#/definitions/OccDemandSignalCollection'
    post:
      description: 'Creates a OccDemandSignal.

        '
      operationId: CreateOccDemandSignal
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Accepted the request. The OccDemandSignal will be created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, 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/OccDemandSignal'
        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 OccDemandSignal.
      tags:
      - occDemandSignal
      x-example: "Example 1 Request:\n  POST /20180828/occDemandSignals\n  {\n    \"displayName\": \"string\",\n    \"occDemandSignalDetails\": [\n      {\n        \"resourceType\": \"string\",\n        \"units\": \"string\",\n        \"values\": [\n          {\n            \"timeValueExpected\": \"2024-02-13T12:12:49.508Z\",\n            \"value\": 0,\n            \"comments\": \"string\"\n          },\n          {\n            \"timeValueExpected\": \"2024-03-13T12:12:49.508Z\",\n            \"value\": 0,\n            \"comments\": \"string\"\n          },\n          {\n            \"timeValueExpected\": \"2024-04-13T12:12:49.508Z\",\n            \"value\": 0,\n            \"comments\": \"string\"\n          },\n          {\n            \"timeValueExpected\": \"2024-05-13T12:12:49.508Z\",\n            \"value\": 0,\n            \"comments\": \"string\"\n          },\n          {\n            \"timeValueExpected\": \"2024-06-13T12:12:49.508Z\",\n            \"value\": 0,\n            \"comments\": \"string\"\n          },\n          {\n            \"timeValueExpected\": \"2024-07-13T12:12:49.508Z\",\n            \"value\": 0,\n            \"comments\": \"string\"\n          },\n          {\n            \"timeValueExpected\": \"2024-08-13T12:12:49.508Z\",\n            \"value\": 0,\n            \"comments\": \"string\"\n          },\n          {\n            \"timeValueExpected\": \"2024-09-13T12:12:49.508Z\",\n            \"value\": 0,\n            \"comments\": \"string\"\n          },\n          {\n            \"timeValueExpected\": \"2024-10-13T12:12:49.508Z\",\n            \"value\": 0,\n            \"comments\": \"string\"\n          },\n          {\n            \"timeValueExpected\": \"2024-11-13T12:12:49.508Z\",\n            \"value\": 0,\n            \"comments\": \"string\"\n          },\n          {\n            \"timeValueExpected\": \"2024-12-13T12:12:49.508Z\",\n            \"value\": 0,\n            \"comments\": \"string\"\n          },\n          {\n            \"timeValueExpected\": \"2025-01-13T12:12:49.508Z\",\n            \"value\": 0,\n            \"comments\": \"string\"\n          }\n        ]\n      }\n    ],\n    \"canShareWithOracle\": false,\n    \"compartmentId\": \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\"\n  }\n"
      x-related-resource: '#/definitions/OccDemandSignal'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOccDemandSignalDetails'
        description: Details for the new OccDemandSignal.
        required: true
  /occDemandSignals/{occDemandSignalId}:
    delete:
      description: Deletes a OccDemandSignal.
      operationId: DeleteOccDemandSignal
      parameters:
      - $ref: '#/components/parameters/OccDemandSignalIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The OccDemandSignal 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: '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'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Deletes a OccDemandSignal.
      tags:
      - occDemandSignal
      x-example: 'Example 1 Request:

        DELETE /20180828/occDemandSignals/ocid1.occdemandsignal.oc1..aaaaaaaaxnbuixpjpcni4kwjal3scy2tm3gmmpmywr6pfomhr4mpexample

        '
      x-related-resource: '#/definitions/OccDemandSignal'
    get:
      description: Gets information about a OccDemandSignal.
      operationId: GetOccDemandSignal
      parameters:
      - $ref: '#/components/parameters/OccDemandSignalIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The OccDemandSignal 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/OccDemandSignal'
        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 OccDemandSignal
      tags:
      - occDemandSignal
      x-example: "Example 1 Request:\n  GET /20180828/occDemandSignals/ocid1.occdemandsignal.oc1..aaaaaaaaxnbuixpjpcni4kwjal3scy2tm3gmmpmywr6pfomhr4mpexample\n"
    patch:
      description: Updates the data of an OccDemandSignal.
      operationId: PatchOccDemandSignal
      parameters:
      - $ref: '#/components/parameters/OccDemandSignalIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Accepted the request. The OccDemandSignal will be patched.
          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/OccDemandSignal'
        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: Patch a OccDemandSignal
      tags:
      - occDemandSignal
      x-example: "Example 1 Request:\n  PATCH /20180828/occDemandSignals/ocid1.occdemandsignal.oc1..aaaaaaaaxnbuixpjpcni4kwjal3scy2tm3gmmpmywr6pfomhr4mpexample\n  {\n    \"items\":\n    [{\n        \"operation\":\"REQUIRE\",\n        \"selection\": \"details\",\n        \"value\": {\n            \"resourceType\": \"string\",\n            \"units\": \"test\",\n            \"values\": [\n                {\n                    \"timeExpected\": \"13-02-2024\",\n                    \"value\": 0.0,\n                    \"comments\": \"test\"\n                },\n                {\n                    \"timeExpected\": \"13-03-2024\",\n                    \"value\": 0.0,\n                    \"comments\": \"test\"\n                }\n            ]\n        }\n    }]\n  }\n"
      x-related-resource: '#/definitions/OccDemandSignal'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchOccDemandSignalDetails'
        description: The information to be updated.
        required: true
    put:
      description: Updates a OccDemandSignal.
      operationId: UpdateOccDemandSignal
      parameters:
      - $ref: '#/components/parameters/OccDemandSignalIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Accepted the request. The OccDemandSignal will be updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            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/OccDemandSignal'
        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 OccDemandSignal.
      tags:
      - occDemandSignal
      x-example: "Example 1 Request:\n  PUT /20180828/occDemandSignals/ocid1.occdemandsignal.oc1..aaaaaaaaxnbuixpjpcni4kwjal3scy2tm3gmmpmywr6pfomhr4mpexample\n  {\n    \"displayName\": \"example\",\n    \"isActive\": false\n  }\n"
      x-related-resource: '#/definitions/OccDemandSignal'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOccDemandSignalDetails'
        description: The information to be updated.
        required: true
  /occDemandSignals/{occDemandSignalId}/actions/changeCompartment:
    post:
      description: 'Moves a OccDemandSignal 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: ChangeOccDemandSignalCompartment
      parameters:
      - $ref: '#/components/parameters/OccDemandSignalIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The OccDemandSignal 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: '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
        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 OccDemandSignal into a different compartment.
      tags:
      - occDemandSignal
      x-example: "Example 1 Request:\nPOST /20180828/occDemandSignals/ocid1.occdemandsignal.oc1..aaaaaaaaxnbuixpjpcni4kwjal3scy2tm3gmmpmywr6pfomhr4mpexample/actions/changeCompartment\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\"\n}\n"
      x-related-resource: '#/definitions/OccDemandSignal'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeOccDemandSignalCompartmentDetails'
        description: The information to be updated.
        required: true
components:
  schemas:
    UpdateOccDemandSignalDetails:
      description: The data to update a OccDemandSignal.
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        isActive:
          description: Indicator of whether to share the data with Oracle.
          type: boolean
      type: object
      x-example: "{\n  \"displayName\": \"exampleName\",\n  \"isActive\": false\n}\n"
    OccDemandSignalValue:
      description: The Value of Demand Signal for particular month.
      properties:
        comments:
          description: Space provided for users to make comments regarding the value.
          type: string
        timeExpected:
          description: The date of the Demand Signal Value.
          format: date-time
          type: string
        value:
          description: The Demand Signal Value.
          format: float
          type: number
      required:
      - timeExpected
      - value
      type: object
      x-example: "{\n  \"timeExpected\": \"2024-02-22T09:52:00.094Z\",\n  \"value\": 0,\n  \"comments\": \"exampleComment\"\n}\n"
    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
    ChangeOccDemandSignalCompartmentDetails:
      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 OccDemandSignal to.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
      x-example: "{\n  \"compartmentId\": \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\"\n}\n"
    OccDemandSignal:
      description: 'An OccDemandSignal is a forecast created for different Resource Types.


        To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to

        an administrator. If you''re an administrator who needs to write policies to give users access, see

        [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).

        '
      properties:
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: A user-friendly name. Does not have to be unique, and it's changeable.
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the OccDemandSignal.
          type: string
        isActive:
          description: Indicator of whether to share the data with Oracle.
          type: boolean
        lifecycleDetails:
          description: 'A message that describes the current state of the OccDemandSignal in more detail. For example,

            can be used to provide actionable information for a resource in the Failed state.

            '
          type: string
        lifecycleState:
          description: The current state of the OccDemandSignal.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
        occDemandSignals:
          description: The OccDemandSignal data.
          items:
            $ref: '#/components/schemas/OccDemandSignalData'
          maxItems: 100
          minItems: 1
          type: array
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a system tag key and value, scoped to a namespace.


              Example: `{"free-tier-retained": "true"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the OccDemandSignal 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 OccDemandSignal 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
      - compartmentId
      - displayName
      - occDemandSignals
      - isActive
      - lifecycleState
      - timeCreated
      - freeformTags
      - definedTags
      type: object
      x-example: "{\n  \"id\": \"ocid1.occdemandsignal.oc1..aaaaaaaaxnbuixpjpcni4kwjal3scy2tm3gmmpmywr6pfomhr4mpexample\",\n  \"displayName\": \"exampleName\",\n  \"compartmentId\": \"ocid1.compartment.oc1..aaaaaaaaxnbuixpjpcni4kwjal3scy2tm3gmmpmywr6pfomhr4mpexample\",\n  \"occDemandSignals\": [\n    {\n      \"resourceType\": \"resourceExample\",\n      \"units\": \"unitExample\",\n      \"values\": [\n        {\n          \"timeExpected\": \"2024-02-22T09:52:00.094Z\",\n          \"value\": 0,\n          \"comments\": \"example Comment\"\n        }\n      ]\n    }\n  ],\n  \"isActive\": true,\n  \"timeCreated\": \"2024-02-22T09:52:00.094Z\",\n  \"timeUpdated\": \"2024-02-22T09:52:00.094Z\",\n  \"lifecycleState\": \"ACTIVE\",\n  \"lifecycleDetails\": \"example details\",\n  \"freeformTags\": null,\n  \"definedTags\": null,\n  \"systemTags\": null\n}\n"
    OccDemandSignalCollection:
      description: Results of a occDemandSignal search. Contains both OccDemandSignalSummary items and other information, such as metadata.
      properties:
        items:
          description: List of occDemandSignals.
          items:
            $ref: '#/components/schemas/OccDemandSignalSummary'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  \"items\": [\n    {\n      \"id\": \"ocid1.occdemandsignal.oc1..aaaaaaaaxnbuixpjpcni4kwjal3scy2tm3gmmpmywr6pfomhr4mpexample\",\n      \"displayName\": \"exampleName\",\n      \"compartmentId\": \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\",\n      \"isActive\": false,\n      \"timeCreated\": \"2024-02-22T09:43:45.420Z\",\n      \"timeUpdated\": \"2024-02-22T09:43:45.420Z\",\n      \"lifecycleState\": \"ACTIVE\",\n      \"lifecycleDetails\": null,\n      \"freeformTags\": null,\n      \"definedTags\": null,\n      \"systemTags\": null\n    }\n  ]\n}\n"
    CreateOccDemandSignalDetails:
      description: The data to create a OccDemandSignal.
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the OccDemandSignal in.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        isActive:
          description: Indicator of whether to share the data with Oracle.
          type: boolean
        occDemandSignals:
          description: The OccDemandSignal data.
          items:
            $ref: '#/components/schemas/OccDemandSignalData'
          maxItems: 100
          minItems: 1
          type: array
      required:
      - occDemandSignals
      - compartmentId
      - isActive
      type: object
      x-example: "{\n  \"displayName\": \"exampleName\",\n  \"occDemandSignals\": [\n    {\n      \"resourceType\": \"resourceExample\",\n      \"units\": \"exampleUnits\",\n      \"values\": [\n        {\n          \"timeExpected\": \"2024-02-13T12:12:49.508Z\",\n          \"value\": 0,\n          \"comments\": \"example Comment\"\n        },\n        {\n          \"timeExpected\": \"2024-03-13T12:12:49.508Z\",\n          \"value\": 0,\n          \"comments\": \"example Comment\"\n        },\n        {\n          \"timeExpected\": \"2024-04-13T12:12:49.508Z\",\n          \"value\": 0,\n          \"comments\": \"example Comment\"\n        },\n        {\n          \"timeExpected\": \"2024-05-13T12:12:49.508Z\",\n          \"value\": 0,\n          \"comments\": \"example Comment\"\n        },\n        {\n          \"timeExpected\": \"2024-06-13T12:12:49.508Z\",\n          \"value\": 0,\n          \"comments\": \"example Comment\"\n        },\n        {\n          \"timeExpected\": \"2024-07-13T12:12:49.508Z\",\n          \"value\": 0,\n          \"comments\": \"example Comment\"\n        },\n        {\n          \"timeExpected\": \"2024-08-13T12:12:49.508Z\",\n          \"value\": 0,\n          \"comments\": \"example Comment\"\n        },\n        {\n          \"timeExpected\": \"2024-09-13T12:12:49.508Z\",\n          \"value\": 0,\n          \"comments\": \"example Comment\"\n        },\n        {\n          \"timeExpected\": \"2024-10-13T12:12:49.508Z\",\n          \"value\": 0,\n          \"comments\": \"example Comment\"\n        },\n        {\n          \"timeExpected\": \"2024-11-13T12:12:49.508Z\",\n          \"value\": 0,\n          \"comments\": \"example Comment\"\n        },\n        {\n          \"timeExpected\": \"2024-12-13T12:12:49.508Z\",\n          \"value\": 0,\n          \"comments\": \"example Comment\"\n        },\n        {\n          \"timeExpected\": \"2025-01-13T12:12:49.508Z\",\n          \"value\": 0,\n          \"comments\": \"example Comment\"\n        }\n      ]\n    }\n  ],\n  \"isActive\": false,\n  \"compartmentId\": \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca4\"\n  \n}\n"
    PatchInstruction:
      description: A single instruction to be included as part of Patch request content.
      discriminator:
        propertyName: operation
      properties:
        operation:
          description: The type of this patch instruction.
          enum:
          - REQUIRE
          - PROHIBIT
          - REPLACE
          - INSERT
          - REMOVE
          - MOVE
          - MERGE
          ty

# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-occdemandsignal-api-openapi.yml