Campos personalizados
Listar definiciones de campos personalizados
Devuelve las DEFINICIONES de los campos personalizados de la cuenta: qué identificador tiene cada uno, qué tipo admite y, si es un desplegable, qué valores acepta.
Ejemplos de petición
curl https://app.filmo.io/api/v1/custom-fields \
--header "Authorization: Bearer $FILMO_API_KEY"Generado a partir del esquema
Te permite identificar un campo personalizado y los valores que acepta. La v1 solo lee campos personalizados: ningún cuerpo de creación o actualización los admite, así que se establecen en la aplicación de Filmo. No devuelve el valor asignado a ninguna entidad: los valores viajan dentro de cada recurso.
Autorizaciones
Clave de API como Bearer, con el permiso de abajo. custom-fields:read
Parámetros de consulta
Filtra por la entidad a la que se aplica el campo: devuelve solo las definiciones utilizables en ese tipo de recurso.
Opciones disponibles: order, item, space, contact, project, kit, orderTemplate, repairTicket, serializedItem, vehicle, staff, service, purchaseOrder, incident, opportunity, document, all
Respuesta
Respuesta correcta.
Esquema de la respuesta: CustomFieldDefinitionDto
Sobre: CustomFieldDefinitionItems. meta. solo aparece cuando la operación está obsoleta.
Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Mostrar atributos hijosOcultar atributos hijos
Identificador único de la definición. Es el que se usa al escribir un valor.
Nombre visible del campo.
Tipo de dato que acepta el campo.
Opciones disponibles: text, multitext, dropdown, checkbox, radio, date, contact, item, space, staff_member, vehicle
Descripción del campo; null si no tiene.
Valores permitidos cuando el campo es un desplegable. Vacío para los demás tipos.
Entidades en las que se puede usar el campo.
Opciones disponibles: order, item, space, contact, project, kit, orderTemplate, repairTicket, serializedItem, vehicle, staff, service, purchaseOrder, incident, opportunity, document, all
Documentos en los que se imprime el campo.
Opciones disponibles: quote, proforma, invoice, contract, packing_slip, purchase_order, repair_ticket, all
true si la definición está activa y se puede usar.
Fecha de creación en ISO 8601 UTC; null si no consta.
Fecha de la última modificación en ISO 8601 UTC; null si no está registrada.
Información adicional sobre la respuesta.
Mostrar atributos hijosOcultar atributos hijos
Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.
Mostrar atributos hijosOcultar atributos hijos
Código de aviso estable.
Opciones disponibles: deprecated
Para personas: qué está obsoleto, hasta cuándo y qué usar.
Día (YYYY-MM-DD) en que la operación deja de estar disponible.
operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.
Dónde está documentada la deprecación (el changelog).
Petición no válida (validation_error): consulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Fallo de autenticación (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin).
Cabeceras: X-Request-Id · Content-Language
Add-on requerido (addon_required): el plan de la cuenta no incluye el add-on que necesita esta operación; requiredAddon lo nombra.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
No permitido (insufficient_scope: la clave de API no tiene el scope requerido, indicado en requiredScope; forbidden: el propietario de la clave carece del permiso que exige la operación). insufficient_scope se responde antes de que la petición cuente contra el límite de peticiones, así que no lleva cabeceras RateLimit-*; forbidden sí.
Cabeceras: X-Request-Id · Content-Language
Límite de peticiones superado (rate_limited): reintenta tras Retry-After segundos; RateLimit-* indica qué cuota se ha agotado.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Retry-After
Error interno (internal_error).
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Errores
| Estado | Códigos | Significado |
|---|---|---|
| 400 | validation_error | Consulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable. |
| 402 | addon_required | El plan de la cuenta no incluye el add-on que necesita esta operación; requiredAddon lo nombra. |
401, 403, 429, 500 los puede devolver cualquier operación. Errores
Obsolescencia
Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasPlataforma
Definición de campo personalizado
DEFINICIÓN de un campo personalizado de la cuenta: su identificador, el tipo que admite y los valores que acepta.
¿Te ha resultado útil esta página?