Skip to main content

Read the activities of a task

GET 
/partners/v1/tasks/:taskId/activities
StarterPremiumUltimate
❌✔️✔️

Returns what the technicians did on a task: the description of each activity, when it was carried out, the time spent, who reported it, the meter readings submitted, the spare parts consumed and the additional costs.

Typical use: correlate an alarm raised by a machine with the task that fixed it, and read how it was fixed.

Identifying the task​

taskId is the full task identifier: the one GET /partners/v1/tasks/search returns in taskId, or the one you stored when you created the task. Store it on your side.

The short id displayed in the CMMS (8 characters, e.g. 4086a9a6) is refused with a 400 (code 400045): it is not unique within a network, so it cannot designate a single task.

The task is looked up in the network of the API key only. A task of another network answers 404 (code 404028), exactly like a task that does not exist.

Amounts​

Amounts are decimal strings carrying the number of decimals of their currency ("12.50" in EUR, "1250" in JPY), so that you never round a float. A spare part is priced at the unit price frozen when it was consumed, or at its current unit price when none was frozen: the same price the CMMS displays on the task. An additional cost stored with more decimals than its currency carries is rounded half up ("12.345" in EUR reads "12.35").

Reporter​

When the technician who reported an activity deleted their account, reporter is null.

Meter readings​

Each reading carries the unit it was read in: unitCode, a stable identifier to map the unit on your side (the units provided by Mobility Work start with $, e.g. $hours), unitSymbol (h) and unitName (Hours). The name of a unit provided by Mobility Work is in English; a unit created by your network keeps the name it was created with.

Each activity and its associatedTask carry a canonical link, which identifies them in the API, and a web link, which opens the task in the CMMS. The CMMS displays an activity inside its task: an activity's web link opens its task.

Pagination​

Pagination works as in the tasks search. next and prev are always present and point to the current page when there is no page after or before it. Two activities completed at the same time are ordered by activityId, so that browsing the pages never repeats nor skips an activity.

Unknown query parameters are ignored.

Errors​

HTTPCodeWhen
400400045taskId is a short id, or is not a task identifier
400400008A query parameter is out of its bounds: it is named in extended_message.property_errors
401401001The API key is missing, revoked or unknown
403403008The subscription plan does not include this API
404404028No task of the network of the API key carries this taskId

Request​

Responses​

The activities of the task, for the requested page