See the breakdown of the API URL for a sample GET
and POST
endpoint.
https://api.xchange.trimble.com/connect/v1/direct/subscribers/123456/Viewpoint/Jc/1/data/job_phase/cache?limit=1000&offset=0
Value | Variable | Description |
---|
https://api.xchange.trimble.com/connect/v1/direct/ | Base URL | Base URL for making requests to Vista Direct API endpoints |
Subscribers | Tenant Type | The type of tenant you are trying to request. |
123456 | Subscriber UID | The unique value that determines which customers data you are requesting. |
Viewpoint | System Interface | The specific Interface you are requesting data from. |
JC | Vista Module | The Vista Module, as defined by Vista, that you are requesting data from. |
1 | API Version | The versioning of the API. |
Data | Data | |
Job Phase | Data Object | The specific data table you are trying to pull data back from. |
Cache | | |
Limit | Query Parameter | Limits the number of records returned by the API, up to a maximum of 1,000. |
Offset | Query Parameter | Offsets the number of records returned by the API. |
https://api.xchange.trimble.com/connect/v1/direct/subscribers/123456/Viewpoint/jc/1/data/contractmaster/actions/create