PagedDeidentificationDocumentDetails

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/azure-health/json-schema/azure-health-paged-deidentification-document-details-schema.json",
  "title": "PagedDeidentificationDocumentDetails",
  "description": "Paged collection of DeidentificationDocumentDetails items",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/azure-health-jobs-api-openapi.yml#/components/schemas/PagedDeidentificationDocumentDetails",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "description": "The DeidentificationDocumentDetails items on this page",
      "items": {
        "$ref": "#/$defs/DeidentificationDocumentDetails"
      }
    },
    "nextLink": {
      "type": "string",
      "format": "uri",
      "description": "The link to the next page of items"
    }
  },
  "required": [
    "value"
  ],
  "$defs": {
    "Azure.Core.Foundations.Error": {
      "type": "object",
      "description": "The error object.",
      "properties": {
        "code": {
          "type": "string",
          "description": "One of a server-defined set of error codes."
        },
        "message": {
          "type": "string",
          "description": "A human-readable representation of the error."
        },
        "target": {
          "type": "string",
          "description": "The target of the error."
        },
        "details": {
          "type": "array",
          "description": "An array of details about specific errors that led to this reported error.",
          "items": {
            "$ref": "#/$defs/Azure.Core.Foundations.Error"
          }
        },
        "innererror": {
          "$ref": "#/$defs/Azure.Core.Foundations.InnerError",
          "description": "An object containing more specific information than the current object about the error."
        }
      },
      "required": [
        "code",
        "message"
      ]
    },
    "Azure.Core.Foundations.InnerError": {
      "type": "object",
      "description": "An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.",
      "properties": {
        "code": {
          "type": "string",
          "description": "One of a server-defined set of error codes."
        },
        "innererror": {
          "$ref": "#/$defs/Azure.Core.Foundations.InnerError",
          "description": "Inner error."
        }
      }
    },
    "Azure.Core.Foundations.OperationState": {
      "type": "string",
      "description": "Enum describing allowed operation states.",
      "enum": [
        "NotStarted",
        "Running",
        "Succeeded",
        "Failed",
        "Canceled"
      ],
      "x-ms-enum": {
        "name": "OperationState",
        "modelAsString": true,
        "values": [
          {
            "name": "NotStarted",
            "value": "NotStarted",
            "description": "The operation has not started."
          },
          {
            "name": "Running",
            "value": "Running",
            "description": "The operation is in progress."
          },
          {
            "name": "Succeeded",
            "value": "Succeeded",
            "description": "The operation has completed successfully."
          },
          {
            "name": "Failed",
            "value": "Failed",
            "description": "The operation has failed."
          },
          {
            "name": "Canceled",
            "value": "Canceled",
            "description": "The operation has been canceled by the user."
          }
        ]
      }
    },
    "Azure.Core.eTag": {
      "type": "string",
      "description": "The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource.\nIt lets caches be more efficient and save bandwidth, as a web server does not need to resend a full response if the content was not changed.\n\nIt is a string of ASCII characters placed between double quotes, like \"675af34563dc-tr34\"."
    },
    "DeidentificationDocumentDetails": {
      "type": "object",
      "description": "Details of a single document in a job.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the document details.",
          "readOnly": true
        },
        "input": {
          "$ref": "#/$defs/DeidentificationDocumentLocation",
          "description": "Location for the input."
        },
        "output": {
          "$ref": "#/$defs/DeidentificationDocumentLocation",
          "description": "Location for the output."
        },
        "status": {
          "$ref": "#/$defs/Azure.Core.Foundations.OperationState",
          "description": "Status of the document."
        },
        "error": {
          "$ref": "#/$defs/Azure.Core.Foundations.Error",
          "description": "Error when document fails."
        }
      },
      "required": [
        "id",
        "input",
        "status"
      ]
    },
    "DeidentificationDocumentLocation": {
      "type": "object",
      "description": "Location of a document.",
      "properties": {
        "location": {
          "type": "string",
          "format": "uri",
          "description": "Location of document in storage.",
          "maxLength": 1024
        },
        "etag": {
          "$ref": "#/$defs/Azure.Core.eTag",
          "description": "The entity tag for this resource.",
          "readOnly": true
        }
      },
      "required": [
        "location",
        "etag"
      ]
    }
  }
}