Standard Metadata

APIs MUST use the names listed below for commonly used metadata fields.

| Name | Description | DataType | Sample Value | |:------------------------|:------------|:---------|:-------------| | id | Globally Unique Resource Identifier | UUID/GUID | c9b0d1db-8123-4849-960e-f8e917ffd6c5 | | createdAtDateTime | Resource Create Timestamp | DateTime | 2019-10-12T07:20:50.52Z | | createdByUserTrn | The TID User that created this resource. | TRN | trn:tid:users:sjXnfsiasj | | createdByApplicationTrn | The TID Application that created this resource. | TRN | trn:tid:applications:sjXnfsiasj | | createdByDeviceTrn | The TID Device that created this resource. | TRN | trn:tid:devices:sjXnfsiasj | | updatedAtDateTime | Resource Update Timestamp | DateTime | 2019-10-12T07:20:50.52Z | | updatedByUserTrn | The TID User that updated this resource. | TRN | trn:tid:users:sjXnfsiasj | | updatedByApplicationTrn | The TID Application that updated this resource | TRN | trn:tid:applications:sjXnfsiasj | | updatedByDeviceTrn | The TID Device that updated this resource | TRN | trn:tid:devices:sjXnfsiasj | | deletedAtDateTime | Resource Delete Timestamp | DateTime | 2019-10-12T07:20:50.52Z | | deletedByUserTrn | The TID User that deleted this resource. | TRN | trn:tid:users:sjXnfsiasj | | deletedByApplicationTrn | The TID Application that deleted this resource. | TRN | trn:tid:applications:sjXnfsiasj | | deletedByDeviceTrn | The TID Device that deleted this resource. | TRN | trn:tid:devices:sjXnfsiasj |

The following restrictions apply to all standard metadata fields above:

JSON encoded date-times conforming to this requirement can be validated using JSON Schema, e.g.:

{
    "description": "A valid timestamp",
    "type": "object",
    "properties": {
        "createdAtDateTime": {
            "type": "string",
            "format":"date-time"
        }
    },
    "required":["createdAtDateTime"]
}

All change attribution (e.g., created, updated, or deleted attributes) MUST be identified by a URI. In the case of attribution by a Trimble user, attribution MUST NOT include: given name, family name, or email address. It is recommended that change attribution be identified by a Trimble Identity TRN.