Partes de trabajo · API PÚBLICA V1

Listar campos personalizados

Definiciones de solo lectura aplicables a partes.

Conectar con un entornoSin token

La petición sale de tu navegador hacia el entorno indicado. La API key y el token permanecen en la memoria de esta página.

Introduce las credenciales del entorno que quieras probar.
GET/api/public/v1/daily-reports/custom-fields
daily-reports:read

Respuesta

200Definiciones.

PublicDailyReportCustomField

Definición de campo personalizado

Definición de solo lectura.

PropiedadTipoDescripción
idobligatoriouuidIdentificador.
nameobligatoriostringNombre.
typeobligatoriotext | numeric | image | signature | geolocationTipo.
activeobligatoriobooleanActivo.
Ejemplo JSON
{
  "id": "6786fafd-0d65-4d87-88cc-f349d7161507",
  "name": "Firma",
  "type": "signature",
  "active": true
}
Ejemplo de respuesta
[
  {
    "id": "6786fafd-0d65-4d87-88cc-f349d7161507",
    "name": "Firma",
    "type": "signature",
    "active": true
  }
]

Errores

400Solicitud incorrectaapplication/json
401Autenticación inválida o no proporcionadaapplication/json
403Permisos insuficientesapplication/json
404Recurso no encontradoapplication/json
409Conflicto con el estado actualapplication/json
410Recurso ya no disponibleapplication/json
422Error de validaciónapplication/json
429Límite de solicitudes excedidoapplication/json
Ver modelo de error

PublicApiError

Error de API

Formato estable de los errores públicos.

PropiedadTipoDescripción
statusobligatoriointegerCódigo HTTP.
codeobligatoriostringCódigo estable para tratamiento automático.
messageobligatoriostringMensaje legible.
correlationIdobligatoriostringIdentificador para soporte y trazabilidad.
currentConcurrencyTokenstring | nullToken actual cuando existe un conflicto.
validationErrorsobject<string,string[]>Errores agrupados por campo.
Ejemplo JSON
{
  "status": 422,
  "code": "validation_error",
  "message": "The request is invalid.",
  "correlationId": "01J9EXAMPLE",
  "validationErrors": {
    "unitCode": [
      "The unit does not exist."
    ]
  }
}
Probar endpointPetición directa desde el navegador

Petición

RespuestaSin ejecutar
Configura la conexión y ejecuta la petición.