Identify What Design a Device is Using

This page assumes that the prerequisites to use have been met, and you have authenticated with Trimble ID. Reference documentation for all of the endpoints used is available here

The designs that are assigned to a device are available at GET /projects/{projectId}/devices/{deviceId}/designs. If you already have the required project and device IDs, skip ahead to the final request.

Finding Relevant IDs

First, identify the project that contains the target device and design. You can find all available projects with GET /projects:

{
    "items": [
        {
            "name": "Example Test Project",
            "id": "trn::profilex:us-west-2:project:829256cc-8518-418d-99bc-466da0caa2db",
            "links": { /* links omitted for brevity */ }
        }
    ],
    "pageIndex": 0,
    "links": { /* links omitted for brevity */ }
}

The id field within each item in the list is the project ID. Use this project ID to list its devices with GET /projects/{projectId}/devices. From the results, you can then get a device ID. For example:

{
    "items": [
        {
            "id": "trn::profilex:us-west-2:device:78074e07-997e-414a-9a3f-cc7113c5d77d",
            "name": "Tablet-TABLET-SITENAV-PHONE",
            "appName": "SiteNavigator",
            "associatedMachineId": "trn::profilex:us-west-2:device:78074e07-997e-414a-9a3f-cc7113c5d77d",
            "links": { /* links omitted for brevity */ }
        }
    ],
    "pageIndex": 0,
    "links": {
        "self": { /* links omitted for brevity */ }
    }
}

As before, you can extract the id from each item.

Get the Designs Assigned to a Device

With all the relevant IDs collected, you can construct the full URL:

GET /projects/{projectId}/devices/{deviceId}/designs.

Example response:

{
    "items": [
        {
            "id": "67ef50045d441d052596e762",
            "name": "Example Surface",
            "version": 2,
            "href": "https://localhost:7024/projects/trn::profilex:us-west-2:project:08606a33-2e3a-4d9e-bacf-50750a51e046/designs/67ef50045d441d052596e762/versions/1"
        }
        // other assigned designs would be listed here
    ],
    "pageIndex": 0,
    "links": { /* links omitted for brevity */ }
}

This response confirms that the device currently has version 2 of the design “Example Surface” assigned. For demonstration purposes, only one design is present in this list. In practice, one device can have many different designs assigned to it.