FilteredResponseWithLinksOfComputer

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/snow-software/json-schema/snow-software-filtered-response-with-links-of-computer-schema.json",
  "title": "FilteredResponseWithLinksOfComputer",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/snow-software-computers-api-openapi.yml#/components/schemas/FilteredResponseWithLinksOfComputer",
  "allOf": [
    {
      "$ref": "#/$defs/BaseResponse"
    },
    {
      "type": "object",
      "description": "Generic response class supporting filtering and including links.",
      "additionalProperties": false,
      "required": [
        "items",
        "pagination"
      ],
      "properties": {
        "items": {
          "type": "array",
          "description": "A collection of items returned in the response.",
          "items": {
            "$ref": "#/$defs/Computer"
          }
        },
        "pagination": {
          "description": "The pagination details.",
          "oneOf": [
            {
              "$ref": "#/$defs/PaginationResponse"
            }
          ]
        }
      }
    }
  ],
  "$defs": {
    "BaseResponse": {
      "type": "object",
      "description": "Base response class.",
      "additionalProperties": false,
      "required": [
        "_links"
      ],
      "properties": {
        "_links": {
          "type": "array",
          "description": "A collection of links to related resources.",
          "items": {
            "$ref": "#/$defs/Link"
          }
        }
      }
    },
    "Computer": {
      "allOf": [
        {
          "$ref": "#/$defs/BaseResponse"
        },
        {
          "type": "object",
          "description": "Response representing a computer.",
          "additionalProperties": false,
          "required": [
            "id",
            "hostName",
            "lastScanDate",
            "status"
          ],
          "properties": {
            "id": {
              "type": "string",
              "description": "The unique ID of the computer.",
              "format": "guid",
              "minLength": 1
            },
            "hostName": {
              "type": "string",
              "description": "The host name of the computer.",
              "minLength": 1
            },
            "hostComputerId": {
              "type": [
                "string",
                "null"
              ],
              "description": "The unique ID of the host computer.",
              "format": "guid"
            },
            "mostFrequentUser": {
              "type": [
                "string",
                "null"
              ],
              "description": "The unique ID of the most frequent user of the computer.",
              "format": "guid"
            },
            "mostRecentUser": {
              "type": [
                "string",
                "null"
              ],
              "description": "The unique ID of the most recent user of the computer.",
              "format": "guid"
            },
            "manufacturer": {
              "type": [
                "string",
                "null"
              ],
              "description": "The manufacturer of the computer."
            },
            "isPortable": {
              "type": [
                "boolean",
                "null"
              ],
              "description": "```true``` if the computer is portable; otherwise, ```false```."
            },
            "isVirtual": {
              "type": [
                "boolean",
                "null"
              ],
              "description": "```true``` if the computer is virtual; otherwise, ```false```."
            },
            "isServer": {
              "type": [
                "boolean",
                "null"
              ],
              "description": "```true``` if the computer is a server; otherwise, ```false```."
            },
            "model": {
              "type": [
                "string",
                "null"
              ],
              "description": "The model of the computer."
            },
            "operatingSystem": {
              "type": [
                "string",
                "null"
              ],
              "description": "The operating system of the computer."
            },
            "vendor": {
              "type": [
                "string",
                "null"
              ],
              "description": "The vendor of the computer."
            },
            "domain": {
              "type": [
                "string",
                "null"
              ],
              "description": "The domain of the computer."
            },
            "ipAddress": {
              "type": [
                "string",
                "null"
              ],
              "description": "The IP address of the computer."
            },
            "isVDI": {
              "type": [
                "boolean",
                "null"
              ],
              "description": "```true``` if the computer uses virtual desktop infrastructure; otherwise, ```false```."
            },
            "lastScanDate": {
              "type": "string",
              "description": "The date and time that the computer was last scanned.",
              "format": "date-time",
              "minLength": 1
            },
            "status": {
              "type": "string",
              "description": "The status of the computer.",
              "minLength": 1
            },
            "organizationId": {
              "type": [
                "string",
                "null"
              ],
              "description": "The unique ID of the organization to which the computer belongs.",
              "format": "guid"
            },
            "processorCount": {
              "type": [
                "integer",
                "null"
              ],
              "description": "The number of processors in the computer.",
              "format": "int32"
            },
            "coreCount": {
              "type": [
                "integer",
                "null"
              ],
              "description": "The number of cores in the computer.",
              "format": "int32"
            }
          }
        }
      ]
    },
    "Link": {
      "type": "object",
      "required": [
        "href",
        "rel",
        "method"
      ],
      "properties": {
        "href": {
          "type": "string",
          "description": "The associated relative URL."
        },
        "rel": {
          "type": "string",
          "description": "Specifies the relationship between the current document and the linked document/resource."
        },
        "method": {
          "type": "string",
          "description": "The method to access related resources."
        }
      }
    },
    "PaginationResponse": {
      "type": "object",
      "description": "Generic response class for the pagination part. Properties are annotated using DataMemberAttribute so that we're aligned with REST style guide regarding the json payload.",
      "additionalProperties": false,
      "required": [
        "page_size",
        "page_number"
      ],
      "properties": {
        "page_size": {
          "type": "integer",
          "description": "The page size you requested.",
          "format": "int32"
        },
        "page_number": {
          "type": "integer",
          "description": "The page number you requested.",
          "format": "int32"
        },
        "total_pages": {
          "type": [
            "integer",
            "null"
          ],
          "description": "The total number of pages.",
          "format": "int32"
        },
        "total_items": {
          "type": [
            "integer",
            "null"
          ],
          "description": "The total number of items.",
          "format": "int32"
        }
      }
    }
  }
}