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

Autorización

Rol en la organización	Este punto de conexión
owner	Permitido
admin	Permitido
editor	Permitido
viewer	No permitido

Una clave tiene el rol que su propietario ocupa en la organización. Consulte Autenticación.

Ámbito de la clave de API: zones:write

Parámetros de ruta

Parámetro	Tipo	Descripción
zone_id	string (uuid)	Obligatorio.

Parámetros de encabezado

Parámetro	Tipo	Descripción
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.

Cuerpo de la solicitud

Campo	Tipo	Descripción
case_sensitive	boolean
kinds	array of string
name	string	Obligatorio.
observation	string	Obligatorio.
question	string or null

Respuesta

• 201 Created — la llamada se completó correctamente.
• 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

Campos de la respuesta

Campo	Tipo	Descripción
data	object	Obligatorio. One dictionary table of the zone's chain, with its origin zone and its values.
data.case_sensitive	boolean	Obligatorio.
data.in_use	boolean	Obligatorio. True when deleting the table would answer DICTIONARY_TABLE_IN_USE.
data.kinds	array of string	Obligatorio.
data.name	string	Obligatorio.
data.observation	string	Obligatorio.
data.origin_zone_id	string	Obligatorio.
data.question	string or null
data.values	array of object	Obligatorio.
data.values[].origin_zone_id	string	Obligatorio.
data.values[].value	string	Obligatorio.

Ejemplo de respuesta

{
  "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"
      }
    ]
  }
}

Véase también

• DELETE Restablecer la asignación automática de zona de un agente
• GET Lo que se aplica a este agente
• PUT Asignar un agente a una zona a mano