Oracle Attributes API

openapi: 3.2.0
info:
  description: 'Use the Application Performance Monitoring Trace Explorer API to query traces and associated spans in Trace Explorer. For more information, see [Application Performance Monitoring](https://docs.oracle.com/iaas/application-performance-monitoring/index.html).

    '
  license:
    name: Oracle Corporation
  title: Application Performance Monitoring Trace Explorer Attributes API
  version: '20200630'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/d1cc8021a03784e751fe54c779074681c153f47a8bd2975f098d6c8988748126.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Application Performance Monitoring Trace Explorer 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/d1cc8021a03784e751fe54c779074681c153f47a8bd2975f098d6c8988748126.yaml
    what: the harvested document for Application Performance Monitoring Trace Explorer API
servers:
- url: http://apm-trace.{region}.oci.{secondLevelDomain}/20200630
- url: https://apm-trace.{region}.oci.{secondLevelDomain}/20200630
tags:
- name: attributes
paths:
  /attributes/actions/activateAttributes:
    post:
      description: 'Activates a set of attributes for the given APM Domain.  Attribute names are not case-sensitive.  Any duplicates present in the bulk activation

        request are deduplicated and only unique attributes are activated.  A maximum number of 700 string attributes and 100 numeric attributes

        can be activated in an APM Domain subject to the available string and numeric slots.  Once an attribute has been activated, it may take some time

        for it to be appear in searches as ingest might not have picked up the changes or any associated caches might not have refreshed.  The

        bulk activation operation is atomic, and the operation succeeds only if all the attributes in the request have been processed successfully and they

        get a success status back.  If the processing of any attribute results in a processing or validation error, then none of the attributes in the bulk

        request are activated.  Attributes that are activated are unpinned by default if they are pinned.

        '
      operationId: BulkActivateAttribute
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      responses:
        200:
          description: 'A response indicating the bulk activation status is returned.

            '
          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/BulkActivationStatus'
        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/DefaultError'
      summary: Activate a set of attributes for the given APM Domain.
      tags:
      - attributes
      x-related-resource: '#/definitions/BulkActivationStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkActivateAttributeDetails'
        description: 'Request body containing the details about the set of attributes to be activated.

          '
        required: true
  /attributes/actions/autoActivate:
    post:
      description: 'Turn on or off autoactivate for private data key or public data key traffic a given APM Domain.

        '
      operationId: PutToggleAutoActivate
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      - $ref: '#/components/parameters/AutoActivateToggleOperationQueryParam'
      - $ref: '#/components/parameters/DataKeyTypeQueryParam'
      responses:
        200:
          description: 'A response indicating the status of the toggle autoactivation is returned.

            '
          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/AutoActivateToggleStatus'
        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/DefaultError'
      summary: Turn on or off autoactivation for private data key or public data key traffic in the APM Domain.
      tags:
      - attributes
      x-related-resource: '#/definitions/AutoActivateToggleStatus'
  /attributes/actions/deActivateAttributes:
    post:
      description: 'Deactivates a set of attributes for the given APM Domain.  Attribute names are not case-sensitive.  Any duplicates present in the bulk deactivation

        request are deduplicated and only unique attributes are deactivated.  A maximum number of 700 string attributes and 100 numeric attributes

        can be deactivated in an APM Domain subject to the available string and numeric slots.  Out of box attributes (Trace and Span) cannot be

        deactivated, and will result in a processing error.  Once an attribute has been deactivated, it may take some time for it to disappear in

        searches as ingest might not have picked up the changes or any associated caches might not have refreshed.  The bulk deactivation

        operation is atomic, and the operation succeeds only if all the attributes in the request have been processed successfully and they get a success

        status back.  If the processing of any attribute results in a processing or validation error, then none of the attributes in the bulk request

        are deactivated.

        '
      operationId: BulkDeActivateAttribute
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      responses:
        200:
          description: 'A response indicating the bulk deactivation status is returned.

            '
          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/BulkDeActivationStatus'
        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/DefaultError'
      summary: DeActivate a set of attributes for the given APM Domain.
      tags:
      - attributes
      x-related-resource: '#/definitions/BulkDeActivationStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkDeActivateAttributeDetails'
        description: 'Request body containing the details about the set of attributes to be deactivated.

          '
        required: true
  /attributes/actions/pinAttributes:
    post:
      description: 'Pin a set of attributes in the APM Domain.  Attributes that are marked pinned are not autoactivated by ingest.

        Attributes that are deactivated are pinned by default.

        '
      operationId: BulkPinAttribute
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      responses:
        200:
          description: 'A response indicating the bulk pin status is returned.

            '
          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/BulkPinStatus'
        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/DefaultError'
      summary: Pin a set of attributes in the APM Domain.
      tags:
      - attributes
      x-related-resource: '#/definitions/BulkPinStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkPinAttributeDetails'
        description: 'Request body containing the details about the set of attributes to be pinned.

          '
        required: true
  /attributes/actions/unPinAttributes:
    post:
      description: 'Unpin a set of attributes in the APM Domain.

        '
      operationId: BulkUnpinAttribute
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      responses:
        200:
          description: 'A response indicating the bulk unpin status is returned.

            '
          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/BulkUnpinStatus'
        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/DefaultError'
      summary: Unpin a set of attributes in the APM Domain.
      tags:
      - attributes
      x-related-resource: '#/definitions/BulkUnpinStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUnpinAttributeDetails'
        description: 'Request body containing the details about the set of attributes to be unpinned.

          '
        required: true
  /attributes/actions/updateAttributes:
    post:
      description: 'Update a set of attribute properties in the APM Domain.

        '
      operationId: BulkUpdateAttribute
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      responses:
        200:
          description: 'A response indicating the bulk update attribute status is returned.

            '
          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/BulkUpdateAttributeStatus'
        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/DefaultError'
      summary: Update a set of attribute properties in the APM Domain.
      tags:
      - attributes
      x-related-resource: '#/definitions/BulkUpdateAttributeStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpdateAttributeDetails'
        description: 'Request body containing the details about the set of attributes for which properties are to be updated.

          '
        required: true
  /attributes/actions/updateNotes:
    post:
      description: 'Add or edit notes to a set of attributes in the APM Domain.  Notes can be added to either an active or an inactive attribute.  The

        notes will be preserved even if the attribute changes state (when an active attribute is deactivated or when an inactive attribute

        is activated).

        '
      operationId: BulkUpdateAttributeNotes
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      responses:
        200:
          description: 'A response indicating the bulk update notes status is returned.

            '
          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/BulkUpdateNotesStatus'
        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/DefaultError'
      summary: Update notes to a set of attributes in the APM Domain.
      tags:
      - attributes
      x-related-resource: '#/definitions/BulkUpdateNotesStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpdateAttributeNotesDetails'
        description: 'Request body containing the details about the set of attributes for which notes are to be updated.

          '
        required: true
  /attributes/autoActivateStatus:
    get:
      description: 'Get autoactivation status for a private data key or public data key in the APM Domain.

        '
      operationId: GetStatusAutoActivate
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      - $ref: '#/components/parameters/DataKeyTypeQueryParam'
      responses:
        200:
          description: 'A response indicating the status of autoactivate for the data key is returned.

            '
          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/AutoActivateStatus'
        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/DefaultError'
      summary: Get autoactivate status for a private data key or public data key in the APM Domain.
      tags:
      - attributes
      x-related-resource: '#/definitions/AutoActivateStatus'
components:
  schemas:
    BulkUpdateAttributeMetadata:
      description: 'Metadata about the bulk attribute update operation.  The bulk attribute update operation is atomic and binary.  If the processing of any of the attributes

        in the bulk attribute update request results in a processing or validation error, then none of the attributes updated.

        '
      properties:
        attributesUpdated:
          description: 'Total number attributes (both string and numeric) in TRACES namespace for which properties were updated.

            '
          type: integer
        operationStatus:
          description: 'Operation status of the bulk update attribute operation.

            SUCCESS - The bulk attribute update request has succeeded and all the attributes in the request have been updated.

            The following are error statuses for the bulk update attributes operation.

            EMPTY_ATTRIBUTE_LIST - The bulk update attributes request object was empty and did not contain any attributes for which properties had to be updated.

            INVALID_BULK_REQUEST - The bulk request contains invalid attribute(s), or attribute(s) that resulted in a validation error, or an attribute that resulted

            in a processing error.

            '
          enum:
          - SUCCESS
          - EMPTY_ATTRIBUTE_LIST
          - INVALID_BULK_REQUEST
          type: string
        operationType:
          description: 'Type of operation.

            '
          enum:
          - UPDATE_ATTRIBUTE_PROPERTIES
          type: string
        syntheticAttributesUpdated:
          description: 'Total number attributes (both string and numeric) in SYNTHETIC namespace for which properties were updated.

            '
          type: integer
      required:
      - operationType
      - operationStatus
      - attributesUpdated
      type: object
    BulkPinStatus:
      description: 'Response of a bulk attribute pin operation.

        '
      properties:
        attributeStatuses:
          description: 'We preserve the order of the attribute items from the bulk pin request in this collection.  The ith object in this collection represents the

            bulk pin operation status of the ith object in the BulkPinAttributeDetails object in the Bulk pin request.  If the

            bulk pin operation results in a processing error or a validation error, the operationStatus property in the  BulkPinMetadata object will

            contain the appropriate bulk error status for the bulk operation.

            '
          items:
            $ref: '#/components/schemas/AttributePinResponse'
          type: array
        bulkPinMetadata:
          $ref: '#/components/schemas/BulkPinMetadata'
      required:
      - attributeStatuses
      - bulkPinMetadata
      type: object
    BulkUpdateAttributeDetails:
      description: 'Bulk request object containing the details of the attributes for which properties are to be updated.

        '
      properties:
        attributeDetails:
          description: 'Collection of objects containing the details about individual attribute for which properties are to be updated.

            '
          items:
            $ref: '#/components/schemas/BulkUpdateAttributeDetail'
          type: array
      type: object
    BulkDeActivationMetadata:
      description: 'Metadata about the bulk deactivation operation.  The bulk deactivation operation is atomic and binary.  If the processing of any of the attributes

        in the bulk deactivation request results in a processing or validation error, then none of the attributes in the request are deactivated.

        The bulk deactivation request succeeds only when all the attributes in the bulk deactivation request are processed and they get a successful

        attributeStatus back.

        '
      properties:
        attributesDeActivated:
          description: 'Total number attributes (both string and numeric) in TRACES namespace that were deactivated.

            '
          type: integer
        availableNumericAttributes:
          description: 'Total number of free slots available for activation of additional numeric attributes in TRACES namespace in the APM Domain.

            '
          type: integer
        availableStringAttributes:
          description: 'Total number of free slots available for activation of additional string attributes in TRACES namespace in the APM Domain.

            '
          type: integer
        availableSyntheticNumericAttributes:
          description: 'Total number of free slots available for activation of additional numeric attributes in SYNTHETIC namespace in the APM Domain.

            '
          type: integer
        availableSyntheticStringAttributes:
          description: 'Total number of free slots available for activation of additional string attributes in SYNTHETIC namespace in the APM Domain.

            '
          type: integer
        operationStatus:
          description: 'Operation status of the bulk deactivation operation.  The bulk deactivation operation could have either a success or an error status as defined below.  Note that

            if a bulk operation has not succeeded, we do not deactivate any tags in the request set.

            SUCCESS - The bulk deactivation operation has succeeded and all the attributes in the bulk deactivation request have been deactivated by this operation or deactivated earlier.

            The following are error statuses for the bulk deactivation operation.  Note that none of the attributes (string or numeric) in the bulk request have been deactivated by this bulk

            deactivation operation if any of the below statuses are returned.

            EMPTY_ATTRIBUTE_LIST - The bulk deactivation request object was empty and did not contain any attributes to be deactivated.

            NUMERIC_ATTRIBUTE_LIMIT_EXCEEDED - The number of numeric attributes in the bulk request exceeded the maximum limit (100) of numeric attributes that could be present in the APM Domain.

            STRING_ATTRIBUTE_LIMIT_EXCEEDED - The number of string attributes in the bulk request exceeded the maximum limit (700) of string attributes that could be present in the APM Domain.

            INVALID_BULK_REQUEST - The bulk request contains invalid attribute(s), or attribute(s) that resulted in a validation error, or an attribute that resulted

            in a processing error.

            '
          enum:
          - SUCCESS
          - EMPTY_ATTRIBUTE_LIST
          - NUMERIC_ATTRIBUTE_LIMIT_EXCEEDED
          - STRING_ATTRIBUTE_LIMIT_EXCEEDED
          - INVALID_BULK_REQUEST
          type: string
        operationType:
          description: 'Type of operation.

            '
          enum:
          - DEACTIVATE
          type: string
        syntheticAttributesDeActivated:
          description: 'Total number attributes (both string and numeric) in SYNTHETIC namespace that were deactivated.

            '
          type: integer
      required:
      - operationType
      - operationStatus
      type: object
    Error:
      description: 'Details of an error that occurred.

        '
      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
      type: object
    AttributeResponse:
      description: 'Response of an individual attribute item in the bulk activate or deactivate operation.

        '
      properties:
        attributeName:
          description: 'Attribute that was activated or deactivated by this bulk operation.

            '
          maxLength: 255
          minLength: 1
          type: string
        attributeNameSpace:
          default: TRACES
          description: "Namespace of the attribute whose properties were updated.  The attributeNamespace will default to TRACES if it is \nnot passed in.\n"
          enum:
          - TRACES
          - SYNTHETIC
          type: string
        attributeStatus:
          description: 'Status of the attribute after this operation.  The attribute can have one of the following statuses after the activate or deactivate operation.  The attribute

            can have either a success status or an error status.  The status of the attribute must be correlated with the operation status property in the bulk operation metadata

            object.  The bulk operation will be successful only when all attributes in the bulk request are processed successful and they get a success status back.

            The following are successful status values of individual attribute items in a bulk attribute activation operation.

            ATTRIBUTE_ACTIVATED - The attribute is activated and is available to be queried.  Note that ingest might still have not picked up the changes, and the

            associated caches would not have refreshed yet to pick up the changes.

            ATTRIBUTE_ALREADY_ACTIVE - The caller is trying to activate an attribute that is already active or in the process of getting activated.

            ATTRIBUTE_DEACTIVATED - The attribute is deactivated and will not appear in searches.  Ingest might not have picked up the new changes and the associated caches

            might not have refreshed yet.

            ATTRIBUTE_ALREADY_DEACTIVATED - The caller is trying to deactivate an attribute that has already been deactivated or in the process of deactivation.

            DUPLICATE_ATTRIBUTE - The attribute is a duplicate of an attribute that was present in this bulk request.  Note that we deduplicate the attribute collection, process only unique attributes,

            and call out duplicates.  A duplicate attribute in a bulk request will not prevent the processing of further attributes in the bulk operation.

            The following values are error statuses and the bulk processing is stopped when the first error is encountered.  None of the attributes in the bulk request would have been activated or

            deactivated by this bulk operation.

            DEACTIVATION_NOT_ALLOWED - The caller has asked for the deactivation of an out of box tag which is not permitted.

            ATTRIBUTE_DOES_NOT_EXIST - The caller tries to deactivate an attribute that doesn''t exist in the APM Domain.

            INVALID_ATTRIBUTE - The attribute is invalid.

            INVALID_ATTRIBUTE_TYPE_CONFLICT - The attribute is invalid.  There were two attributes with same name but different type in the bulk request.

            ATTRIBUTE_NOT_PROCESSED - The attribute was not processed, as there was another attribute in this bulk request collection that resulted in a processing error.

            ATTRIBUTE_UPDATE_NOT_ALLOWED - The unit of the attribute cannot be updated as it is an in-built system attribute.

            '
          enum:
          - ATTRIBUTE_ALREADY_ACTIVE
          - ATTRIBUTE_ACTIVATED
          - ATTRIBUTE_DEACTIVATED
          - DEACTIVATION_NOT_ALLOWED
          - ATTRIBUTE_DOES_NOT_EXIST
          - ATTRIBUTE_ALREADY_DEACTIVATED
          - DUPLICATE_ATTRIBUTE
          - INVALID_ATTRIBUTE
          - INVALID_ATTRIBUTE_TYPE_CONFLICT
          - ATTRIBUTE_NOT_PROCESSED
          - ATTRIBUTE_UPDATE_NOT_ALLOWED
          type: string
        attributeType:
          description: 'Type of the attribute.

            '
          enum:
          - NUMERIC
          - STRING
          type: string
        notes:
          description: 'Notes for the activated attribute.

            '
          type: string
        operationType:
          description: 'Type of operation - activate or deactivate.

            '
          enum:
          - ACTIVATE
          - DEACTIVATE
          type: string
        timeUpdated:
          description: 'Time when the attribute was activated or deactivated.  Note that ingest might not have picked up the changes even if this time has elapsed.

            '
          format: date-time
          type: string
        unit:
          description: 'Unit of the attribute.   If unit is not specified, it defaults to NONE.

            '
          enum:
          - NONE
          - EPOCH_TIME_MS
          - BYTES
          - COUNT
          - DURATION_MS
          - TRACE_STATUS
          - PERCENTAGE
          type: string
      required:
      - attributeName
      - attributeType
      - operationType
      - attributeStatus
      - timeUpdated
      - attributeNameSpace
      type: object
    BulkUpdateAttributeNotesDetails:
      description: 'Bulk request object containing the details of the attributes for which notes are to be updated.

        '
      properties:
        attributeDetails:
          description: 'Collection of objects containing the details about individual attribute for which notes are to be updated.

            '
          items:
            $ref: '#/components/schemas/BulkUpdateAttributeNotesDetail'
          type: array
      type: object
    AttributeUpdateNotesResponse:
      description: 'Response of an individual attribute item in the bulk update notes operation.

        '
      properties:
        attributeName:
          description: 'Attribute for which notes were added to or edited in this bulk operation.

            '
          maxLength: 255
          minLength: 1
          type: string
        attributeNameSpace:
          default: TRACES
          description: "Namespace of the attribute whose notes were updated.  The attributeNameSpace will default to TRACES if it is \nnot passed in.\n"
          enum:
          - TRACES
          - SYNTHETIC
          type: string
        attributeStatus:
          description: 'Status of the attribute after this operation.  The attribute can have one of the following statuses after the update notes operation.  The attribute

            can have either a success status or an error status.  The status of the attribute must be correlated with the operation status property in the bulk operation metadata

            object.  The bulk operation will be successful only when all attributes in the bulk request are processed successfully and they get a success status back.

            The following are successful status values of individual attribute items in a bulk update notes operation.

            ATTRIBUTE_NOTES_UPDATED - The attribute''s notes have been updated with the given notes.

            DUPLICATE_ATTRIBUTE - The attribute is a duplicate of an attribute that was present in this bulk request.  Note that we deduplicate the attribute collection, process only unique attributes,

            and call out duplicates.  A duplicate attribute in a bulk request will not prevent the processing of further attributes in the bulk operation.

            The following values are error statuses and the bulk processing is stopped when the first error is encountered.

            INVALID_ATTRIBUTE - The attribute is invalid.  The length of the notes is more than a 1000 characters.

            ATTRIBUTE_NOT_PROCESSED - The attribute was not processed, as there was another attribute in this bulk request collection that resulted in a processing error.

            ATTRIBUTE_DOES_NOT_EXIST - Attribute was neither active nor pinned inactive.

            NOTES_TOO_LONG - Attribute notes were too long (more than 1000 chars).

            '
          enum:
          - ATTRIBUTE_NOTES_UPDATED
          - DUPLICATE_ATTRIBUTE
          - INVALID_ATTRIBUTE
 

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