Bühler Maintenance API Documentation¶
Welcome to the documentation home for the Bühler Maintenance API.
This public REST API enables customers to exchange maintenance-related information with Bühler over a standardized API layer. It provides structured access to maintenance data including completed jobs, planned jobs, assets, tasks, and inventory levels.
Quick Start¶
- Getting Started – set up your first API call step by step
- Authentication – learn how to obtain and use API keys
- API Reference v1 – full endpoint specifications
- Error Handling – response codes and error formats
- Rate Limits – throttling and quota information
- Lookup Values – enumeration values used across the API
Jobs Done¶
This endpoint allows you to retrieve completed job records for Bühler equipment.
Job data includes job details, parts used, assigned personnel, work orders, and asset identification. Results can be filtered by date range, plant, asset tag number, asset serial number, or asset external reference.
Jobs Planned¶
This endpoint allows you to retrieve planned maintenance jobs for Bühler equipment.
Planned job data includes job scheduling, due dates, required parts, assigned users, and activity kinds. Results can be filtered by plant, due date range, asset tag number, asset serial number, or asset external reference.
Assets¶
This endpoint allows you to retrieve registered assets at a given plant.
Asset data includes product identification, serial numbers, tag numbers, plant assignment, location, and process line information. Results can be filtered by plant.
Tasks¶
This endpoint allows you to retrieve maintenance tasks for Bühler equipment.
Task data includes task descriptions, statuses, assigned users, incident details, root causes, required parts, parts used, and asset references. Results can be filtered by date range, task status, plant, asset tag number, asset serial number, or asset external reference.
Inventory¶
This endpoint allows you to apply stock level updates for spare parts or materials.
Inventory data includes the part identifier, quantity, unit of measurement, and an optional remark. The request requires a plant identifier and a part identifier in the path, and returns a status indicating the result of the operation.
Task Creation¶
This endpoint allows you to create new maintenance tasks.
Task creation data includes task title, description, activity kind, assigned role, priority, dates, and an asset reference (tag number, serial number, or external reference). The request requires a plant identifier and returns a status indicating the result of the operation.
Support¶
If you need assistance or have any questions regarding the Bühler Maintenance API, please feel free to reach out to our support team: Send an email to Support.
{"environments":[],"pdf-download":true}