Request Anatomy

See the breakdown of the API URL for a sample GET and POST endpoint.

Sample GET Endpoint

https://api.xchange.trimble.com/connect/v1/direct/subscribers/123456/Viewpoint/Jc/1/data/job_phase/cache?limit=1000&offset=0
ValueVariableDescription
https://api.xchange.trimble.com/connect/v1/direct/Base URLBase URL for making requests to Vista Direct API endpoints
SubscribersTenant TypeThe type of tenant you are trying to request.
123456Subscriber UIDThe unique value that determines which customers data you are requesting.
ViewpointSystem InterfaceThe specific Interface you are requesting data from.
JCVista ModuleThe Vista Module, as defined by Vista, that you are requesting data from.
1API VersionThe versioning of the API.
DataData
Job PhaseData ObjectThe specific data table you are trying to pull data back from.
Cache
LimitQuery ParameterLimits the number of records returned by the API, up to a maximum of 1,000.
OffsetQuery ParameterOffsets 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
ValueVariable
https://api.xchange.trimble.com/connect/v1/direct/Base URL
subscribersTenant Type
123456Subscriber UID
viewpointSystem Interfac
jcModule
1API Version
dataData
contract masterData Object
actionsAction Reference
create{Action}