The Trimble Unity Maintain connector allows users to increase efficiency and reduce costs by optimizing asset operation and maintenance.
It is best to familiarize yourself with the connector modules, data objects, and actions, as well as the respective schemas that accompany them.
User access, including any development environment needed, is provided by a customer's administrator. Please contact your administrator for individual access.
Review the following resources if you need additional product training or want to suggest enhancements for the connector.
Book a meeting with Professional Services for SaaS Capital Programs
View Trimble Unity Maintain Training Options
Technical documentation for this product is available to registered users.
The documentation below is an OpenAPI description (OAD) of each module in this connector.
Note: This is provided as a quick view of coverage and capabilities. The API and endpoints documented are used internally by the platform and not directly by end users.
Follow these steps to create an API User account to connect to Trimble Unity Maintain.
In Unity Maintain, select the Admin application.
Under the ADMIN tab, select Employees.
Select the + button to add a new employee.
Create a profile for the API User and select Add.
On the Details panel, assign an email, Domain(s), and Group(s) to provide the API user administrative access.
Caution: Do not use an email already affiliated with a human user.
Under the User section, select Create User.
Enter the email and password.
Enter a Username for the employee, or leave the field blank to use the email as the Username.
Select Create.
Your API User is created.
When setting up the Trimble Unity Maintain connector in App Xchange, enter values in the following fields:
Real-Time Action Processing: This feature should always be enabled for optimal performance. Only disable it if you are advised to do so by support.
Name: Enter a descriptive name for your connection.
API Base URL: Enter the URL for your Unity Maintain environment. For example, https://cloud-app01.cityworks.com/_SALES_KSMMS_CURRENT.
API User: Enter the API User name you created above.
API Key: Enter the API key you created above.
There are no additional configuration parameters for the connector itself.
If you encounter a problem or need support for this connector, please visit Trimble Support or email unityconnectorsupport@trimble.com.
Was this helpful? Give us feedback.