API reference
Every operation of the Fluenta API, generated from its OpenAPI document: path, parameters, permissions and responses.
These pages are generated from the API’s OpenAPI document, so they cannot drift from it: one page per operation, with its path, its parameters, the permission it needs and its responses. The whole document is at /openapi.json.
Account
| Operation | Method and path | What it does |
|---|---|---|
getMe | GET /v1/external/me | The user the credential acts as, the credential itself, its «Permisos», its rate limit and the organizations it reaches. |
getMyUsage | GET /v1/external/me/usage | What this credential has asked of the API: totals, by route and by day. Only its own requests, in every organization. |
listOrganizations | GET /v1/external/organizations | The organizations the credential reaches, by name, 50 per page. A credential of an account with platform-wide access searches every organization. |
Organization
| Operation | Method and path | What it does |
|---|---|---|
getOrganization | GET /v1/external/organizations/{organizationId} | The organization: «país», «zona horaria» and today in its clock, «moneda», «jornada», the módulos’ «descansos», «categorías» and the plan features it has. |
getOrganizationAccess | GET /v1/external/organizations/{organizationId}/access | The user’s roles and the credential’s «Permisos» in one organization. |
listCategories | GET /v1/external/organizations/{organizationId}/categories | The «Categorías» an OC takes its garment from: the plant’s own, for «Otros clientes», and those of each brand it works for in the «Red de talleres». |
getPlan | GET /v1/external/organizations/{organizationId}/plan | The organization’s plan: Light or Pro, its plan version, what it allows (reports, «Facturación», «Pausas», «Conectar con IA»…) and the rate limits this API counts a credential against. |
getSettings | GET /v1/external/organizations/{organizationId}/settings | The plant’s «jornada»: its «zona horaria» and today in its clock, when the shift starts and ends on each weekday, the «jornada continua» and «jornada especial» days, the days off, and its switches. The «descansos» of a «módulo» are listModuleRestTimes. |
Plant
| Operation | Method and path | What it does |
|---|---|---|
getFloor | GET /v1/external/organizations/{organizationId}/floor | The whole floor in one answer: every «módulo» in the floor’s order, each with its «puestos» (stations) as the live board reads them now. Counted against the heavy rate limit. |
listModules | GET /v1/external/organizations/{organizationId}/modules | The organization’s módulos (production lines), in the floor’s order, with how many puestos each has. |
getModule | GET /v1/external/organizations/{organizationId}/modules/{moduleId} | One «módulo» (production line): its name, its place on the floor, how many «puestos» it has and its colour. |
listModuleRestTimes | GET /v1/external/organizations/{organizationId}/modules/{moduleId}/rest-times | One «módulo»’s «descansos» (breaks), every weekday alike, by start: no goal is owed inside one. On a «jornada continua» weekday (getSettings) none applies. |
listStations | GET /v1/external/organizations/{organizationId}/modules/{moduleId}/stations | The puestos (stations) of one módulo as the live board reads them now: operación, seated operario, current referencia, units this hour and today. |
listOperators | GET /v1/external/organizations/{organizationId}/operators | The organization’s operarios by name, «Activo» or «Inactivo», and the puesto each is seated at. |
getOperatorPresence | GET /v1/external/organizations/{organizationId}/operators/presence | Which «operarios» have a tablet connected right now, and whether the app is open on it. An «operario» missing from the answer is offline. |
getOperator | GET /v1/external/organizations/{organizationId}/operators/{operatorId} | One «operario» by id: name, «Activo» or «Inactivo», and the «puesto» the «operario» is seated at. |
listOrganizationStations | GET /v1/external/organizations/{organizationId}/stations | The organization’s «puestos» (stations) across its «módulos», optionally of one «módulo», as the live board reads them now. 50 per page, by «módulo» in the floor’s order, then in the board’s. |
getStation | GET /v1/external/organizations/{organizationId}/stations/{stationId} | One «puesto» (station) as the live board reads it now: «operación», seated «operario», current «referencia», units this hour and today. |
Boards
| Operation | Method and path | What it does |
|---|---|---|
getLiveBoard | GET /v1/external/organizations/{organizationId}/board | The live board of the whole floor for a day: each módulo’s «eficiencia», units and goal so far, and the plant’s. |
getHoursBoard | GET /v1/external/organizations/{organizationId}/modules/{moduleId}/days/{day}/board | One módulo’s «Tablero de producción» for a day, hour by hour: goal, units typed and tapped, running totals, «eficiencia» and where each referencia stands. |
Program
| Operation | Method and path | What it does |
|---|---|---|
setDayGoals | PUT /v1/external/organizations/{organizationId}/modules/{moduleId}/days/{day}/references/{referenceId}/goal | «Metas del día»: one referencia’s hourly goal for one day of a módulo, one rate all day or rates by minute. Answers the módulo’s day as getHoursBoard does. |
clearDayGoals | DELETE /v1/external/organizations/{organizationId}/modules/{moduleId}/days/{day}/references/{referenceId}/goal | «↺ Meta base»: the day reads the referencia’s own «Meta por hora» again. Answers the módulo’s day as getHoursBoard does. |
getProgram | GET /v1/external/organizations/{organizationId}/modules/{moduleId}/program | One módulo’s «Programa»: its referencias in queue order, with units produced, «saldo», dates and today’s «Metas del día». A finished cut stays listed a few days. |
reorderProgram | PATCH /v1/external/organizations/{organizationId}/modules/{moduleId}/program/order | Rewrite a módulo’s «Programa» order (the FILA): every referencia of the queue, each once, in the new order. Answers the queue as getProgram does. |
searchReferences | GET /v1/external/organizations/{organizationId}/references | Search the organization’s referencias by «Corte (OC)», «Referencia» or «Categoría», optionally in one módulo or one state (in the «Programa», on hold, finished). 50 per page, newest first. |
createReference | POST /v1/external/organizations/{organizationId}/references | Create an OC (a referencia, a cut of a garment) at the end of a módulo’s «Programa», as «Nueva referencia» does. |
addReferencesFromCatalogue | POST /v1/external/organizations/{organizationId}/references/from-catalogue | Add several OCs to a módulo’s «Programa» from the «Catálogo de referencias», one per template, as «Agregar del catálogo» does. A refused OC never stops the rest: failed lists them; when none lands, the first refusal is the answer. |
listOnHold | GET /v1/external/organizations/{organizationId}/references/on-hold | The «banco de espera»: every paused referencia of the organization, newest pause first, with why, since when and from which módulo. |
getReference | GET /v1/external/organizations/{organizationId}/references/{referenceId} | One referencia (cut, OC): its módulo, state, units, produced and «saldo», goals, price, dates, «Subprocesos» and «Red» marks. |
updateReference | PATCH /v1/external/organizations/{organizationId}/references/{referenceId} | Edit an OC, as «Editar» does: only the fields sent change. A new «Meta por hora» keeps the past days’ goals; a new price re-prices today. |
deleteReference | DELETE /v1/external/organizations/{organizationId}/references/{referenceId} | Delete an OC, as «Borrar» does, only with the confirmationToken its preview returned once the usuario said yes: 422 CONFIRMATION_REQUIRED without it, 409 PREVIEW_STALE when it ran out or the OC changed since. |
markReferenceArrived | POST /v1/external/organizations/{organizationId}/references/{referenceId}/arrive | «Llegó»: the taller marks a brand’s OC («OC anticipada») as physically arrived, with the «Meta por hora» and the units its «ficha técnica» says. |
previewDeleteReference | POST /v1/external/organizations/{organizationId}/references/{referenceId}/delete-preview | What deleting an OC would do, writing nothing: the OC, whether its módulo empties (every puesto cleared), the puestos sewing it, and the confirmationToken deleteReference needs. Show it to the usuario and wait for a yes. |
holdReference | PATCH /v1/external/organizations/{organizationId}/references/{referenceId}/hold | Pause an OC into the «banco de espera» (⏸): it leaves its módulo’s queue with its counts, and the puestos sewing it move to the next OC. |
reactivateReference | PATCH /v1/external/organizations/{organizationId}/references/{referenceId}/reactivate | Bring an OC back from the «banco de espera» (▶) into a módulo, at the end of its queue, with its counts. |
recordSacrifice | PATCH /v1/external/organizations/{organizationId}/references/{referenceId}/sacrifice | Set the «descuento por sacrificio» of an OC: units written off its «saldo» without being production. Absolute; 0 removes it. |
splitReference | POST /v1/external/organizations/{organizationId}/references/{referenceId}/split | Split an OC between two módulos (✂): units go to a new «-B» portion at the end of another módulo’s queue; the original keeps the rest. |
Catalogue
| Operation | Method and path | What it does |
|---|---|---|
listCatalogue | GET /v1/external/organizations/{organizationId}/catalogue | The «Catálogo de referencias»: the organization’s reusable styles by name, with the goal, price, category and «Subprocesos» a new OC from each starts with. |
createCatalogueEntry | POST /v1/external/organizations/{organizationId}/catalogue | Add a reusable style to the «Catálogo de referencias», as its «Nueva referencia» does: the name is unique in the catálogo (409 REFERENCE_TEMPLATE_EXISTS). |
updateCatalogueEntry | PATCH /v1/external/organizations/{organizationId}/catalogue/{templateId} | Edit a template of the «Catálogo de referencias»: only the fields sent change; null clears an optional one. No OC changes. |
deleteCatalogueEntry | DELETE /v1/external/organizations/{organizationId}/catalogue/{templateId} | Delete a template of the «Catálogo de referencias» (no OC changes), only with the confirmationToken its preview returned once the usuario said yes: 422 CONFIRMATION_REQUIRED without it, 409 PREVIEW_STALE when it ran out or the template changed since. |
previewDeleteCatalogueEntry | POST /v1/external/organizations/{organizationId}/catalogue/{templateId}/delete-preview | What deleting a template of the «Catálogo de referencias» would do, writing nothing, and the confirmationToken deleteCatalogueEntry needs. Show it to the usuario and wait for a yes. |
Analytics
| Operation | Method and path | What it does |
|---|---|---|
getStationActivity | GET /v1/external/organizations/{organizationId}/analytics/activity | Analítica for one plant day, from the marcas log: one puesto’s marcas summarised, the day hour by hour, each operario’s pace, or the log against the hourly buckets. |
getBilling | GET /v1/external/organizations/{organizationId}/analytics/billing | «Facturación» over a range of plant days, per day, or per day and módulo, operario or puesto. |
getBillingByModule | GET /v1/external/organizations/{organizationId}/analytics/billing/modules | «Facturación por módulo» for one plant day: each módulo’s billed units and amount, in the plant’s currency. |
getConsistency | GET /v1/external/organizations/{organizationId}/analytics/consistency | The marcas log against the hourly buckets for one plant day: which puesto-hours agree, which differ, and by how many units. |
getDayReport | GET /v1/external/organizations/{organizationId}/analytics/day-report | Reportes › Eficiencia for one plant day: every módulo hour by hour, each puesto’s units, meta and efficiency. |
getEfficiency | GET /v1/external/organizations/{organizationId}/analytics/efficiency | «Eficiencia» over a range of plant days: units made against the meta, per day, or per day and módulo, operario or puesto. |
getEfficiencyByModule | GET /v1/external/organizations/{organizationId}/analytics/efficiency/modules | Reportes › Eficiencia for one plant day, módulo by módulo: units, meta, efficiency and pausas. |
getHourlyActivity | GET /v1/external/organizations/{organizationId}/analytics/hourly | Analítica hour by hour for one plant day, from the marcas log: units, meta, efficiency, billing and pace per hour, for the plant, one módulo or one operario. |
getLeaderboard | GET /v1/external/organizations/{organizationId}/analytics/leaderboard | The «Clasificación» of one plant day: every operario’s units, meta, efficiency and «Facturado», best first. |
getMonth | GET /v1/external/organizations/{organizationId}/analytics/month | The plant’s last 30 days, up to its today: units, meta, efficiency and «Facturación» per day. The 30-day chart of Reportes. |
getOperatorsActivity | GET /v1/external/organizations/{organizationId}/analytics/operators | Analítica by operario for one plant day: each one’s units, pace, active hours, channels, efficiency and billing, with the totals. |
getOperatorReport | GET /v1/external/organizations/{organizationId}/analytics/operators/{operatorId} | One operario’s report: units, meta and efficiency per day over a range of up to 92 days, and hour by hour for a single day. |
getPauses | GET /v1/external/organizations/{organizationId}/analytics/pauses | The «Pausas» report over a range of up to 31 plant days: every pausa, newest first (at most 2000), and the figures over the whole range. |
getProduction | GET /v1/external/organizations/{organizationId}/analytics/production | «Producido» over a range of plant days, per day, or per day and módulo, referencia or categoría. |
getModuleEfficiency | GET /v1/external/organizations/{organizationId}/modules/{moduleId}/analytics/efficiency | One módulo’s «Eficiencia» per day over a range of up to 92 plant days: units made against the meta, every puesto counted. The chart of «Reportes por módulo». |
getModuleDayHistory | GET /v1/external/organizations/{organizationId}/modules/{moduleId}/days/{day}/history | One módulo’s day, hour by hour and puesto by puesto: units, meta, efficiency, «Facturación» and pausas. The table of «Reportes por módulo». |
getOperatorEfficiency | GET /v1/external/organizations/{organizationId}/operators/{operatorId}/analytics/efficiency | One operario’s «Eficiencia» per day over a range of up to 92 plant days: their own marcas against their share of each puesto-hour’s meta. |
getStationEvents | GET /v1/external/organizations/{organizationId}/stations/{stationId}/analytics/events | One puesto’s marcas of a day, summarised from the marcas log: units, billing, online and offline marcas, pace and «pausas sin registro». |
getStationDayReport | GET /v1/external/organizations/{organizationId}/stations/{stationId}/days/{day}/report | One puesto’s «reporte por operación» for a day: hour by hour, each referencia’s units, meta, efficiency and price, the hour’s «Facturación» and its pausas; by «Subproceso» with «El operario escoge la referencia» on. |
Activity
| Operation | Method and path | What it does |
|---|---|---|
listActivity | GET /v1/external/organizations/{organizationId}/activity | «Actividad de conexiones»: the changes conexiones made in this organization, newest first, each as a Spanish sentence, refused attempts included. An ADMIN, or an account with platform-wide access, sees every conexión’s; any other role, only their own. |