Get floor
getFloorPermission read
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.
/v1/external/organizations/{organizationId}/floorAnswers the «Tablero en tiempo real» in one read: every «módulo» (production line) in the floor’s order, each with its «puestos» in the board’s order. It is listModules and listStations of every «módulo» together, so no id is needed beyond organizationId; the ids it answers feed getModule, listModuleRestTimes, getStation and getOperator.
Each «puesto» is read as the «Tablero en tiempo real» reads it now: unitsThisHour and hourGoal are units of the hour currentHour names, unitsToday units of the plant day today names, color the «semáforo» (GRAY, RED, YELLOW, GREEN), pausedAt an ISO 8601 UTC instant, and currentReference.price money per unit in the organization’s currency (getOrganization.currency).
today (YYYY-MM-DD) and currentHour (0 to 23) are the plant’s clock when it was read; both are null only when that clock could not be read, and the counts are then answered as stored. Every day and hour is on the plant’s own clock, its «zona horaria» (getSettings.timezone, an IANA name), never UTC and never the caller’s.
An organization with no «módulo» answers modules: []; a «módulo» with no «puesto» answers stations: [].
Not paged: the whole answer comes in one response.
Plan: on every plan, Light included. A «token de API» reads it in any organization the user who created it belongs to; a connected AI app (a «conexión») reads it only where the organization has «Conectar con IA» (getPlan.features.aiConnector, a Pro feature), and answers 403 PLAN_LIMIT elsewhere.
Rate limit: a heavy read. Besides the ordinary budget, each request spends one of the heavy budget (getPlan.rateLimits.heavy per window, the same on Light and on Pro, shared with the range reads); once the heavy budget is spent the heavy reads answer 429 RATE_LIMITED with Retry-After in seconds, and every other route keeps answering. To follow one «módulo» or one «puesto», call listStations, listOrganizationStations or getStation, which are not heavy.
Authorization
apiToken An API token created in Configuración › Tokens de API, or a connected app’s access token
In: header
Path Parameters
The organization, from getMe or listOrganizations.
Response Body
application/json
application/json
curl -X GET "https://api.fluenta.io/v1/external/organizations/0/floor" \ -H "Authorization: Bearer fluenta_live_XXXX"{ "today": "2019-08-24", "currentHour": 0, "modules": [ { "id": 0, "name": "string", "position": 0, "stationCount": 0, "colorHue": 1, "stations": [ { "id": 0, "name": "string", "position": 0, "moduleId": 0, "isBilling": true, "isEntry": true, "isRework": true, "operator": { "id": 0, "name": "string", "active": true }, "operatorActive": true, "pausedAt": "2019-08-24T14:15:22Z", "currentReference": { "id": 0, "name": "string", "stationGoal": 0, "price": 0 }, "currentStep": 0, "stepUnitsToday": { "whole": 0, "step1": 0, "step2": 0 }, "goalReference": 0, "hourGoal": 0, "unitsThisHour": 0, "unitsToday": 0, "color": "GRAY", "total": 0, "totalCompleted": 0, "remaining": 0, "reworkCurrent": 0, "reworkTotal": 0 } ] } ]}Get settings GET
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`.
List modules GET
The organization’s módulos (production lines), in the floor’s order, with how many puestos each has.