Add a dictionary table to a zone

POST/api/public/v1/zones/{zone_id}/dictionary/tables beta

A name is defined once per zone chain: 409 DICTIONARY_TABLE_EXISTS when it is already defined above, here or below. 422 INVALID_OBSERVATION for an observation or a kind outside the toolbox.

cURL

curl --fail-with-body -X POST 'https://app.openlatch.ai/api/public/v1/zones/<zone_id>/dictionary/tables' \
  -H "Authorization: Bearer $OPENLATCH_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"name":"<table_name>","observation":"name","kinds":["branch"]}'

Python

import json
import os
import urllib.request

body = '{"name":"<table_name>","observation":"name","kinds":["branch"]}'
request = urllib.request.Request(
    'https://app.openlatch.ai/api/public/v1/zones/<zone_id>/dictionary/tables',
    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/zones/<zone_id>/dictionary/tables' \
  -H "Authorization: Bearer $OPENLATCH_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"name":"<table_name>","observation":"name","kinds":["branch"]}' | jq .

PowerShell

$headers = @{
  Authorization = "Bearer $env:OPENLATCH_API_KEY"
}
$body = '{"name":"<table_name>","observation":"name","kinds":["branch"]}'
Invoke-RestMethod -Method POST -Uri 'https://app.openlatch.ai/api/public/v1/zones/<zone_id>/dictionary/tables' -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 : zones:write

Paramètres de chemin

Paramètre	Type	Description
zone_id	string (uuid)	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
case_sensitive	boolean
kinds	array of string
name	string	Obligatoire.
observation	string	Obligatoire.
question	string or null

Réponse

• 201 Created — 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 — DICTIONARY_TABLE_EXISTS, IDEMPOTENCY_IN_PROGRESS
• 422 Unprocessable Content — IDEMPOTENCY_KEY_REUSED, INVALID_ID, INVALID_NAME, INVALID_OBSERVATION, VALIDATION_ERROR
• 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. One dictionary table of the zone's chain, with its origin zone and its values.
data.case_sensitive	boolean	Obligatoire.
data.in_use	boolean	Obligatoire. True when deleting the table would answer DICTIONARY_TABLE_IN_USE.
data.kinds	array of string	Obligatoire.
data.name	string	Obligatoire.
data.observation	string	Obligatoire.
data.origin_zone_id	string	Obligatoire.
data.question	string or null
data.values	array of object	Obligatoire.
data.values[].origin_zone_id	string	Obligatoire.
data.values[].value	string	Obligatoire.

Exemple de réponse

{
  "data": {
    "case_sensitive": false,
    "in_use": false,
    "kinds": [
      "string"
    ],
    "name": "release-bot",
    "observation": "string",
    "origin_zone_id": "3f6c1a2e-8b4d-4c1f-9a7e-0d5b2c8e4f10",
    "question": "string",
    "values": [
      {
        "origin_zone_id": "3f6c1a2e-8b4d-4c1f-9a7e-0d5b2c8e4f10",
        "value": "string"
      }
    ]
  }
}

Voir aussi

• DELETE Rétablir l’affectation automatique de zone d’un agent
• GET Ce qui s’applique à cet agent
• PUT Affecter un agent à une zone à la main