Revision history [back]

Powershell has a built-in cmdlet called 'ConvertFrom-Json' that can be used to convert a JSON response to an object in Powershell. Once the JSON response is converted to an object, it can be manipulated and managed like any other Powershell object.

To use a JSON schema with Powershell, the 'Validate-Json' cmdlet can be used. This cmdlet takes a JSON schema and a JSON object as input and validates the object against the schema. If the object is valid according to the schema, the cmdlet returns true, otherwise it returns false.

Example:

Suppose we have a JSON response that looks like this:

{
    "name": "John Doe",
    "email": "johndoe@example.com",
    "age": 30,
    "address": {
        "street": "123 Main St",
        "city": "Anytown",
        "state": "CA"
    }
}

To convert this response to an object in Powershell, we can use the 'ConvertFrom-Json' cmdlet like this:

$response = '{
    "name": "John Doe",
    "email": "johndoe@example.com",
    "age": 30,
    "address": {
        "street": "123 Main St",
        "city": "Anytown",
        "state": "CA"
    }
}'

$responseObject = ConvertFrom-Json $response

Now we can manipulate the object like this:

$responseObject.name = "Jane Doe"
$responseObject.address.city = "Newtown"

To validate the object against a schema, we can use the 'Validate-Json' cmdlet like this:

$schema = '{
    "type": "object",
    "properties": {
        "name": {"type": "string"},
        "email": {"type": "string", "format": "email"},
        "age": {"type": "number"},
        "address": {
            "type": "object",
            "properties": {
                "street": {"type": "string"},
                "city": {"type": "string"},
                "state": {"type": "string"}
            },
            "required": ["street", "city", "state"]
        }
    },
    "required": ["name", "email", "age", "address"]
}'

$result = $responseObject | Validate-Json -Schema $schema

if ($result) {
    Write-Host "Object is valid according to schema"
} else {
    Write-Host "Object is not valid according to schema"
}