JetTime Work Log Metadata

JetTime enhances standard Jira's API work log object by using work log properties. All JetTime-related data is stored as a custom work log property with the key jettime. Below is a complete example of how JetTime stores its metadata:

Full Example of JetTime Work Log Metadata

{

  // Standard Jira work log fields
  // ...

  "properties": [
    {
      "key": "jettime",
      "value": {
        "schemaVersion": 2,
        "timeSpentSeconds": {
          "BILLABLE": 1800,
          "BILLABLE_OVER": 1200
        },
        "fields": {
          "EXPENSE": 1800,
          "INTERNAL": false,
          "INTERNAL_NOTES": "Just between us, pssst...",
          "TAGS": ["Urgent", "2x Rate"],
          "MILEAGE": 208.56,
          "WORK_TYPE": "Construction"
        },
        "account": {
          "name": "Acme Corp",
          "key": "ACME"
        }
      }
    }
  ]
}

Breakdown of the Metadata

Let's go step by step to understand each part of this data structure and what it represents:

1. Schema Version

JetTime uses a schema version field to ensure backward compatibility in case of future changes to the metadata structure. Use schema version 2, the latest version:

"schemaVersion": 2

2. Custom Time Categories

JetTime supports tracking multiple time categories, such as "Billable Time" and "Billable Overtime," recorded in seconds under the timeSpentSeconds object.

Each category key is defined in the app UI when you create and configure that custom time category.

Example:

"timeSpentSeconds": {
    "BILLABLE": 1800,
    "BILLABLE_OVER": 1200
}

3. Custom Work Log Fields

Custom fields defined in JetTime are stored under the fields object. These fields are flexible to accommodate numeric values, strings, tags, or boolean data.

Each field key is defined in the app UI when you create and configure that custom work log field.

Below is a breakdown of the example:

"fields": {
    "EXPENSE": 1800,
    "INTERNAL": false,
    "INTERNAL_NOTES": "Just between us, pssst...",
    "TAGS": ["Urgent", "2x Rate"],
    "MILEAGE": 208.56,
    "WORK_TYPE": "Construction"
}

4. Account Information

JetTime allows associating work logs with specific accounts, clients, or projects. This information is stored in the account object:

"account": {
    "name": "Acme Corp",
    "key": "ACME"
}

Next Steps

For more details on retrieving or creating work logs via the API, refer to the articles on Retrieving Work Logs via API and Logging Work via API.