BulkPinStatus

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-bulk-pin-status-schema.json",
  "title": "BulkPinStatus",
  "description": "Response of a bulk attribute pin operation.\n",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-attributes-api-openapi.yml#/components/schemas/BulkPinStatus",
  "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\nbulk pin operation status of the ith object in the BulkPinAttributeDetails object in the Bulk pin request.  If the\nbulk pin operation results in a processing error or a validation error, the operationStatus property in the  BulkPinMetadata object will\ncontain the appropriate bulk error status for the bulk operation.\n",
      "items": {
        "$ref": "#/$defs/AttributePinResponse"
      },
      "type": "array"
    },
    "bulkPinMetadata": {
      "$ref": "#/$defs/BulkPinMetadata"
    }
  },
  "required": [
    "attributeStatuses",
    "bulkPinMetadata"
  ],
  "type": "object",
  "$defs": {
    "AttributePinResponse": {
      "description": "Response of an individual attribute item in the bulk pin operation.\n",
      "properties": {
        "attributeName": {
          "description": "Attribute that was pinned by this bulk operation.\n",
          "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 pin operation.  The attribute\ncan 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\nobject.  The bulk operation will be successful only when all attributes in the bulk request are processed successfully and they get a success status back.\nThe following are successful status values of individual attribute items in a bulk attribute pin operation.\nATTRIBUTE_PINNED - The attribute is marked pinned and associated notes have been added.\nATTRIBUTE_ALREADY_PINNED - The caller is trying to pin an attribute that has already been pinned.\nDUPLICATE_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,\nand call out duplicates.  A duplicate attribute in a bulk request will not prevent the processing of further attributes in the bulk operation.\nThe following values are error statuses and the bulk processing is stopped when the first error is encountered.\nPIN_NOT_ALLOWED - The caller has asked to pin an active attribute which is not allowed.\nINVALID_ATTRIBUTE - The attribute is invalid.\nATTRIBUTE_NOT_PROCESSED - The attribute was not processed, as there was another attribute in this bulk request collection that resulted in a processing error.\n",
          "enum": [
            "ATTRIBUTE_ALREADY_PINNED",
            "ATTRIBUTE_PINNED",
            "PIN_NOT_ALLOWED",
            "DUPLICATE_ATTRIBUTE",
            "INVALID_ATTRIBUTE",
            "ATTRIBUTE_NOT_PROCESSED"
          ],
          "type": "string"
        },
        "notes": {
          "description": "Notes added to this attribute.\n",
          "type": "string"
        },
        "operationType": {
          "description": "Type of operation - pin.\n",
          "enum": [
            "PIN"
          ],
          "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.\n",
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "attributeName",
        "notes",
        "operationType",
        "attributeStatus",
        "timeUpdated",
        "attributeNameSpace"
      ],
      "type": "object"
    },
    "BulkPinMetadata": {
      "description": "Metadata about the bulk pin operation.  The bulk pin operation is atomic and binary.  If the processing of any of the attributes\nin the bulk pin request results in a processing or validation error, then none of the attributes in the request are pinned.\n",
      "properties": {
        "attributesPinned": {
          "description": "Total number attributes (both string and numeric) in TRACES namespace that were pinned.\n",
          "type": "integer"
        },
        "operationStatus": {
          "description": "Operation status of the bulk pin operation.\nSUCCESS - The bulk pin operation has succeeded and all the attributes in the bulk pin request have been pinned by this operation or pinned earlier.\nThe following are error statuses for the bulk pin operation.\nEMPTY_ATTRIBUTE_LIST - The bulk pin request object was empty and did not contain any attributes to be pinned.\nINVALID_BULK_REQUEST - The bulk request contains invalid attribute(s), or attribute(s) that resulted in a validation error, or an attribute that resulted\nin a processing error.\n",
          "enum": [
            "SUCCESS",
            "EMPTY_ATTRIBUTE_LIST",
            "INVALID_BULK_REQUEST"
          ],
          "type": "string"
        },
        "operationType": {
          "description": "Type of operation.\n",
          "enum": [
            "PIN"
          ],
          "type": "string"
        },
        "syntheticAttributesPinned": {
          "description": "Total number attributes (both string and numeric) in SYNTHETIC namespace that were pinned.\n",
          "type": "integer"
        }
      },
      "required": [
        "operationType",
        "operationStatus",
        "attributesPinned"
      ],
      "type": "object"
    }
  }
}