Skip to main content

How to create a maintenance plan triggered via API?

Nina BENDERAC
Updated

Available for

  • Roles: Administrator
  • Plans: Starter, Premium, On demand

A maintenance plan can be created from the maintenance plans search page or directly from the equipment for which you wish to create the plan.

Creating a maintenance plan involves three steps:

  • Filling out general information,
  • Scheduling, and
  • Validation.

General Information

These details must be filled in before moving to the scheduling step.

  • Equipment (required): Choose the equipment or spare part for which the maintenance plan is being created.
  • Description (required): Define the description of the interventions that will be performed. Please click here to see how to format the description using markdown.
  • Specify if the maintenance plan is regulatory.
  • Assignees (required): This allows you to assign people or teams to a maintenance plan.
  • Observers (optional): Users who need to be notified upon completion of each task in this maintenance plan.
  • Labels (optional): Simplify task classification. Labels can be pre-defined to describe work orders, indicating information such as urgency levels, possibility of intervention without machine stoppage, etc. To learn more about using labels, click here.
  • Planned Maintenance Time (optional): The scheduled duration for preventive or corrective maintenance tasks, minimizing production downtime.
  • Planned Stopped Time (optional): Refers to periods during which equipment is intentionally stopped for maintenance, inspections, or repairs.
  • Spare Parts to Provide (optional): Helps plan the intervention effectively by anticipating required parts.
  • Checklist (optional): Represents check points or procedures to follow during the intervention.

Planning

Trigger

We choose the external trigger (via API). With this option, the next task is triggered through the API.

For the plan with an API trigger, the frequency, task duration, and start date are not defined here. Instead, the plan is triggered dynamically via the API according to the needs.

Validation

Once all parameters are chosen, you can proceed to the validation step. This consists of checking that the schedule and information are correctly filled in, and that the plan can be created.

If everything is correct, simply click the button to create the plan at the bottom of the page. A confirmation message will appear.

Creating a Maintenance Plan via API

Creating a maintenance plan via the API follows the same process as for fixed date or task closure plans. You use the regular interface to create your maintenance plan, but instead of specifying a date or closure event to trigger the task, you simply send the maintenance plan ID via the API. The ID is at the end of the URL of the plan page in question.

To create a task with a specific maintenance plan via the API, you simply make a POST call.

Here is an example using CURL:

jsx
Copy code
curl --request POST \\
  --url <https://app.mobility-work.com/partners/maintenance-plans/trigger/>{maintenance plan Id} \\
  --header 'Api-Key: {API Key}' \\
  --header 'Content-Type: application/json' \\
  --data '{}'

If the payload is valid and your API Key and Maintenance Plan ID are correct, the response will be an HTTP 200 code.

Each API call creates a maintenance task. Therefore, you can create multiple tasks per day if needed.

For more information, please refer to our API documentation here.

The network administrator can request the API key by emailing support at help@mobility-work.com or via the Help button in the app.

Key elements of the plan

  • Maintenance plan link

This is actually the endpoint used to call this maintenance plan. The number at the end of the link corresponds to the plan ID.

Related to

Related articles