Documentación API pública V1 — Trowel Developers

GET/api/public/v1/numbering-lines/{id}

numbering-lines:read

Parámetros

iduuidobligatorioruta

Identificador de la serie.

scopestringopcionalquery

Ámbito.

projectdaily-report

Respuesta

200Serie encontrada.

PublicNumberingLine

Serie de numeración

Definición de una serie disponible para proyectos o partes. Consultarla no reserva ningún número.

PropiedadTipoDescripción

idobligatoriouuidIdentificador de la serie.

nameobligatoriostringNombre.

formatobligatoriostringFormato usado al generar códigos.

lastNumberobligatoriointegerÚltimo número confirmado.

scopeobligatorioproject | daily-reportÁmbito solicitado.

defaultobligatoriobooleanIndica si se usa cuando la creación no envía código ni serie.

activeobligatoriobooleanIndica si puede usarse para generar códigos.

createdAtobligatoriodate-timeFecha de creación.

modifiedAtobligatoriodate-timeÚltima modificación.

Ejemplo JSON

{
  "id": "89f378ce-b1fc-49ef-97f9-0806f32b8438",
  "name": "Proyectos 2026",
  "format": "OBR-2026-%%%%",
  "lastNumber": 41,
  "scope": "project",
  "default": true,
  "active": true,
  "createdAt": "2026-10-10T12:00:00",
  "modifiedAt": "2026-10-10T12:00:00"
}

Ejemplo de respuesta

{
  "id": "89f378ce-b1fc-49ef-97f9-0806f32b8438",
  "name": "Proyectos 2026",
  "format": "OBR-2026-%%%%",
  "lastNumber": 41,
  "scope": "project",
  "default": true,
  "active": true,
  "createdAt": "2026-10-10T12:00:00",
  "modifiedAt": "2026-10-10T12:00:00"
}

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