API Version Management

API Version Management

This document outlines the rules and procedures for creating and managing API versions within the Trimble Cloud Console.

Creating a New API Version

When creating a new API version, all new versions must adhere to the Trimble API Standard for versioning and can be created based on the Permission Matrix.

• Trimble API Standard: New versions must be a whole number prefixed with a lowercase ‘v’ (e.g., v1, v2, v3).
• Existing Versions: Any existing versions that do not follow this standard (e.g., 1.0, 2.1) will be allowed to remain. However, any new versions created for that API must comply with the Trimble API Standard.
• No Duplicates: Duplicate versions cannot exist for the same API.

Removing an API Version

To remove an existing API version, the following two conditions must be met:

1. Delete All Deployments: All deployments associated with that specific version must be deleted.
2. Remove Product Mappings: If the version is mapped against any Product, that mapping must be removed.

Once these conditions are satisfied, the version can be successfully removed. Note: This action can be done by users having necessary permission. Please refer to the Permission Matrix