Developer Documentation

Links

Using Links to Access Related Data

Links are Trimble Ag’s implementation of HATEOAS. These links are useful in discovering additional actions and endpoints that are associated with a particular call. If you do not wish to include links in the response, these can be disabled by using the query parameter includeLinks=false in the request.

The following is an example of links being returned for the Clients GET endpoint:

"links": [
    {
        "href": "https://cloud.dev.api.trimblecloud.com/Trimble-Ag-Software/externalApi/
        rogue/3.0/resources/e540056a-8f68-4c4f-ba96-8d88e9ecaea8/clients/ebb17f5c-5b06-4e89-8174-125c4fc463f9",
        "rel": "GetClient",
        "method": "GET"
    },
    {
        "href": "https://cloud.dev.api.trimblecloud.com/Trimble-Ag-Software/externalApi/
        rogue/3.0/resources/e540056a-8f68-4c4f-ba96-8d88e9ecaea8/clients",
        "rel": "CreateClient",
        "method": "POST"
    },
    {
        "href": "https://cloud.dev.api.trimblecloud.com/Trimble-Ag-Software/externalApi/
        rogue/3.0/resources/e540056a-8f68-4c4f-ba96-8d88e9ecaea8/clients/ebb17f5c-5b06-4e89-8174-125c4fc463f9",
        "rel": "UpdateClient",
        "method": "PUT"
    },
    {
        "href": "https://cloud.dev.api.trimblecloud.com/Trimble-Ag-Software/externalApi/
        rogue/3.0/resources/e540056a-8f68-4c4f-ba96-8d88e9ecaea8/clients/ebb17f5c-5b06-4e89-8174-125c4fc463f9/retire",
        "rel": "RetireClient",
        "method": "PATCH"
    },
    {
        "href": "https://cloud.dev.api.trimblecloud.com/Trimble-Ag-Software/externalApi/
        rogue/3.0/resources/e540056a-8f68-4c4f-ba96-8d88e9ecaea8/clients/ebb17f5c-5b06-4e89-8174-125c4fc463f9/unretire",
        "rel": "UnretireClient",
        "method": "PATCH"
    },
    {
        "href": "https://cloud.dev.api.trimblecloud.com/Trimble-Ag-Software/externalApi/
        rogue/3.0/resources/e540056a-8f68-4c4f-ba96-8d88e9ecaea8/farms",
        "rel": "GetFarms",
        "method": "GET"
    }
]

Copyright © 2024, Trimble Inc.