Skip to content
HALOWERK

File Formats and Conversion

snapshot key type migration candidates

JSON key migration returns unmatched keys that differ only by a string versus integer representation. Use it when an agent needs to distinguish a key type migration from true deletion and insertion.

POST https://format.halowerk.com/v1/snapshot-key-type-migration-candidates

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
keystringYes
beforearrayYes
afterarrayYes
Show full input schema
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "maxLength": 65,
      "minLength": 1
    },
    "before": {
      "type": "array",
      "items": {
        "type": "object",
        "maxProperties": 32
      },
      "maxItems": 180,
      "minItems": 0
    },
    "after": {
      "type": "array",
      "items": {
        "type": "object",
        "maxProperties": 32
      },
      "maxItems": 180,
      "minItems": 0
    }
  },
  "required": [
    "key",
    "before",
    "after"
  ],
  "additionalProperties": false
}

Open original schema

Published input example

{
  "key": "position",
  "before": [
    {
      "position": 1,
      "agency": "SEC"
    },
    {
      "position": 2,
      "agency": "SBA"
    }
  ],
  "after": [
    {
      "position": "1",
      "agency": "SEC"
    },
    {
      "position": "2",
      "agency": "SBA"
    }
  ]
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-19 UTC.

More endpoints in this hub

All endpoints in this hub โ†’