Common Language

Common language for concepts used inside Geospatial Field Data

Concept	Meaning
Project	One Project contains many Jobs. Field Configuration Service manages Project level metadata and configurations.
Job	A Job is a collection of metadata and attachment metadata and is the main object which the Field Data Service operates with.
Attachment	Can be erroneously refferred to as a File, the File itself is stored in Trimble File Service which is a wrapper around AWS S3. An Attachment is metadata about a file stored in Trimble File Service and stored in an array on the Job object.
TRN / Trimble Resource Name	A TRN is a common unique identifier that Trimble uses to name and identify resources. the Field Data Service uses TRN’s to identify Projects, Jobs and Files. All TRNs start with “trn:” more info can be found here, TRNs are expected to be html encoded when used as part of a URL, so use ‘%3A’ as a the separator in place of the colon ’:‘.
eTag / If-Match	An object lifetime GUID, everytime a record is updated this GUID changes. the idea is to reduce the number of race conditions.
Client Name / Trimble-FieldSystems-ClientName	A lot of the API endpoints have a required field of Trimble-FieldSystems-ClientName. This can be any string, it just lets us identify common clients using the service.