Daon · Schema

ArchiveProcessInstancesRequest

Batch archive submission request.

CompanyDigital IdentityIdentity VerificationAuthenticationBiometricsFraud PreventionMulti-Factor AuthenticationFIDO

Properties

Name Type Description
archivePolicyName string Name of an existing archive policy for the tenant.
archivePolicyVersion integer Version of the archive policy.
filter object Selector describing which process instances to archive.
archiveKey string Key used to derive the unique archive-tmp path passed to the archive policy's cloud function. Applied to every instance in the batch. Required when the archive policy has a cloud function configured;
View JSON Schema on GitHub

JSON Schema

daon-archive-process-instances-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/daon/json-schema/daon-archive-process-instances-request-schema.json",
  "title": "ArchiveProcessInstancesRequest",
  "description": "Batch archive submission request.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/daon-process-instance-archiving-api-openapi.yml#/components/schemas/ArchiveProcessInstancesRequest",
  "type": "object",
  "properties": {
    "archivePolicyName": {
      "type": "string",
      "description": "Name of an existing archive policy for the tenant.",
      "minLength": 1
    },
    "archivePolicyVersion": {
      "type": "integer",
      "format": "int32",
      "description": "Version of the archive policy."
    },
    "filter": {
      "$ref": "#/$defs/ArchiveFilter",
      "description": "Selector describing which process instances to archive."
    },
    "archiveKey": {
      "type": "string",
      "description": "Key used to derive the unique archive-tmp path passed to the archive policy's cloud function. Applied to every instance in the batch. Required when the archive policy has a cloud function configured; ignored otherwise. May only contain letters, digits, '_' and '-' (max 128 chars) so it forms a single, safe S3 path segment.",
      "maxLength": 128,
      "minLength": 0,
      "pattern": "^[A-Za-z0-9_-]+$"
    }
  },
  "required": [
    "archivePolicyName",
    "archivePolicyVersion",
    "filter"
  ],
  "$defs": {
    "ArchiveFilter": {
      "type": "object",
      "description": "Selector describing which process instances to archive.",
      "oneOf": [
        {
          "$ref": "#/$defs/DateFilter"
        },
        {
          "$ref": "#/$defs/IdFilter"
        }
      ],
      "properties": {
        "filterType": {
          "type": "string",
          "description": "Discriminator selecting the concrete filter type.",
          "enum": [
            "date",
            "id"
          ],
          "minLength": 1
        }
      },
      "required": [
        "filterType"
      ]
    },
    "DateFilter": {
      "allOf": [
        {
          "$ref": "#/$defs/ArchiveFilter"
        },
        {
          "type": "object",
          "properties": {
            "createdDtmFrom": {
              "type": "string",
              "format": "date-time",
              "description": "Inclusive lower bound of the process instance createdDtm."
            },
            "createdDtmTo": {
              "type": "string",
              "format": "date-time",
              "description": "Inclusive upper bound of the process instance createdDtm."
            },
            "processDefinitionId": {
              "type": "string",
              "description": "Process definition id. Mutually exclusive with processDefinitionName."
            },
            "processDefinitionName": {
              "type": "string",
              "description": "Process definition name. Mutually exclusive with processDefinitionId."
            },
            "processDefinitionVersion": {
              "type": "integer",
              "format": "int32",
              "description": "Process definition version. Only valid with processDefinitionName; all versions match when omitted."
            }
          }
        }
      ],
      "description": "Selects process instances by created-date range and process definition.",
      "required": [
        "createdDtmFrom",
        "createdDtmTo",
        "filterType"
      ]
    },
    "IdFilter": {
      "allOf": [
        {
          "$ref": "#/$defs/ArchiveFilter"
        },
        {
          "type": "object",
          "properties": {
            "processInstanceIds": {
              "type": "array",
              "description": "Explicit list of process instance ids to archive.",
              "items": {
                "type": "string"
              },
              "minItems": 1
            }
          }
        }
      ],
      "description": "Selects process instances by explicit ids. Documented only ? not yet implemented.",
      "required": [
        "filterType",
        "processInstanceIds"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/daon-archive-process-instances-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.