Apply an earlier version of a policy

POST/api/public/v1/policies/{public_id}/versions/{version}/apply

Ratifies a new version whose intent policies are copies of version version's: every sentence with its rules, cases, fallback, answers and answered exceptions. The earlier versions and their history stay; the AIP's zones and their modes are kept, and their bundles carry the new version. One audit entry names both versions. 202 with a job already succeeded (GET /aip/jobs/{job_id}), whose result is {version, applied_version, previous_version}. An open edit draft keeps its rows and answers 409 EDIT_DRAFT_STALE at ratify. 409 NOT_RATIFIED also answers a version ratified before the engine swap (details[] reason pre_swap_version). An agent (OAuth) caller must send sentences, the version's ratified sentences: 428 SENTENCES_REQUIRED without them, 409 SENTENCES_MISMATCH unless they match.

cURL

curl --fail-with-body -X POST 'https://app.openlatch.ai/api/public/v1/policies/<policy_public_id>/versions/<version>/apply' \
  -H "Authorization: Bearer $OPENLATCH_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"sentences":<sentences>}'

Python

import json
import os
import urllib.request

body = '{"sentences":<sentences>}'
request = urllib.request.Request(
    'https://app.openlatch.ai/api/public/v1/policies/<policy_public_id>/versions/<version>/apply',
    method='POST',
    data=body.encode(),
    headers={
        'Authorization': 'Bearer ' + os.environ['OPENLATCH_API_KEY'],
        'Content-Type': 'application/json',
    },
)
with urllib.request.urlopen(request) as response:
    text = response.read().decode()
    print(json.dumps(json.loads(text), indent=2) if text else response.status)

Bash

#!/usr/bin/env bash
set -euo pipefail

curl -sS --fail-with-body -X POST 'https://app.openlatch.ai/api/public/v1/policies/<policy_public_id>/versions/<version>/apply' \
  -H "Authorization: Bearer $OPENLATCH_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"sentences":<sentences>}' | jq .

PowerShell

$headers = @{
  Authorization = "Bearer $env:OPENLATCH_API_KEY"
}
$body = '{"sentences":<sentences>}'
Invoke-RestMethod -Method POST -Uri 'https://app.openlatch.ai/api/public/v1/policies/<policy_public_id>/versions/<version>/apply' -Headers $headers -ContentType 'application/json; charset=utf-8' -Body $body | ConvertTo-Json -Depth 20

Autorisation

Rôle dans l’organisation	Ce point de terminaison
owner	Autorisé
admin	Autorisé
editor	Autorisé
viewer	Non autorisé

Une clé porte le rôle que son propriétaire détient dans l’organisation. Voir Authentification.

Portée de clé d’API : policies:write

Paramètres de chemin

Paramètre	Type	Description
public_id	string	Obligatoire.
version	integer	Obligatoire.

Paramètres d’en-tête

Paramètre	Type	Description
Idempotency-Key	string or null	Optional. Makes the request safe to retry: the same key and the same request, within 24 hours, returns the stored response with Idempotent-Replayed: true and runs once.

Corps de la requête

Champ	Type	Description
sentences	array of string or null	The exact sentences this call puts in force, as shown to the user. Required of an agent (OAuth) caller: 428 SENTENCES_REQUIRED without them, 409 SENTENCES_MISMATCH unless they match the sentences put in force (the same sentences, order ignored, each as many times as it appears, after Unicode NFC and whitespace normalisation).

Réponse

• 202 Accepted — l’appel a réussi.
• 400 Bad Request — BAD_REQUEST
• 401 Unauthorized — UNAUTHORIZED
• 402 Payment Required — license_expired
• 403 Forbidden — FEATURE_DISABLED, FORBIDDEN, INSUFFICIENT_SCOPE
• 404 Not Found — NOT_FOUND
• 409 Conflict — ALREADY_CURRENT, DICTIONARY_TABLE_EXISTS, IDEMPOTENCY_IN_PROGRESS, NOT_RATIFIED, SENTENCES_MISMATCH
• 422 Unprocessable Content — IDEMPOTENCY_KEY_REUSED, INVALID_ID, INVALID_PATTERN, VALIDATION_ERROR
• 428 Precondition Required — SENTENCES_REQUIRED
• 429 Too Many Requests — TOO_MANY_REQUESTS
• 500 Internal Server Error — INTERNAL_SERVER_ERROR, tenant_isolation_violation
• 503 Service Unavailable — FEATURE_STATE_UNAVAILABLE, SERVICE_UNAVAILABLE

Champs de la réponse

Champ	Type	Description
data	object	Obligatoire. `202 for a job-starting operation: poll GET /aip/jobs/{job_id}`.
data.job_id	string	Obligatoire.

Exemple de réponse

{
  "data": {
    "job_id": "3f6c1a2e-8b4d-4c1f-9a7e-0d5b2c8e4f10"
  }
}

Voir aussi

• POST State sentences as a policy
• DELETE Delete a policy
• GET Lire une politique ratifiée