Field Systems Data Services

https://cloud.api.trimble.com/geospatial/jobs-service/1.0/schemas/Core

{
  "jobType": "Core",
  "owner": "Trimble Field Systems - Jobs Service",
  "schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "",
    "title": "Core Jobs Service schema",
    "description": "Defines the core job object used by the Jobs Service.",
    "type": "object",
    "properties": {
      "name": {
        "description": "The name of the job.",
        "type": "string"
      },
      "jobType": {
        "description": "The type of the job.",
        "type": "string"
      },
      "eTag": {
        "description": "Auto generated string that changes with every job change. See If-Match header documentation",
        "type": "string"
      },
      "jobId": {
        "description": "trn uniquely identifing the job with its project.  A JobId will be created if not provided at job creation.",
        "type": "string"
      },
      "projectId": {
        "description": "trn uniquely identifing the project",
        "type": "string"
      },
      "modifiedDateTime": {
        "description": "ISO-8601 UTC date and time for when the job was last updated.",
        "type": "string"
      },
      "modifiedBy": {
        "description": "User details for the user who last modified the job.",
        "type": "object",
        "items": {
          "$ref": "#/$defs/person"
        }
      },
      "createdBy": {
        "description": "User details for the user who created the job.",
        "type": "object",
        "items": {
          "$ref": "#/$defs/person"
        }
      },
      "createdDateTime": {
        "description": "ISO-8601 UTC date and time for when the job was created.",
        "type": "string"
      },
      "rootDataFile": {
        "description": "A copy of the attachment that contains the 'RootDataFile' Tag.  Missing is no such tagged attachment exists.",
        "type": "object",
        "items": {
          "$ref": "#/$defs/attachment"
        }
      },
      "attachments": {
        "description": "Array of attachment objects",
        "type": "array",
        "items": {
          "$ref": "#/$defs/attachment"
        }
      },
      "attributes": {
        "description": "Attributes described by the jobType.",
        "type": "object"
      }
    },
    "required": [
      "name",
      "jobType",
      "attributes"
    ],
    "$defs": {
      "fileTrn": {
        "type": "string",
        "description": "Currently only Connect file TRN's are supported.  trn:jobs:connect-file:{region}:{fileId}[:{version}]"
      },
      "attachmentTags": {
        "type": "string",
        "description": "Application specific tags.  RootDataFile is a Jobs Service tag the causes the rootDataFile attribute to be added to the job object.",
        "enum": [
          "RootDataFile"
        ]
      },
      "person": {
        "type": "object",
        "properties": {
          "connectUserId": {
            "description": "Trimble Connect user Id",
            "type": "string"
          },
          "tidUuid": {
            "description": "Trimble Identity guid",
            "type": "string"
          },
          "id": {
            "description": "Copy of connectUserId. output only",
            "deprecated": true,
            "type": "string"
          },
          "name": {
            "description": "User name",
            "encrypted": true,
            "type": "string"
          },
          "email": {
            "description": "User email",
            "encrypted": true,
            "type": "string"
          }
        }
      },
      "attachment": {
        "type": "object",
        "description": "Not all properties will be available for all file systems.",
        "properties": {
          "attachmentId": {
            "$ref": "#/$defs/fileTrn"
          },
          "filename": {
            "type": "string"
          },
          "modifiedDateTime": {
            "description": "ISO-8601 UTC date and time for when the job was last updated.",
            "type": "string"
          },
          "modifiedBy": {
            "description": "User details for the user who last modified the job.",
            "type": "object",
            "items": {
              "$ref": "#/$defs/person"
            }
          },
          "createdBy": {
            "description": "User details for the user who created the job.",
            "type": "object",
            "items": {
              "$ref": "#/$defs/person"
            }
          },
          "createdDateTime": {
            "description": "ISO-8601 UTC date and time for when the job was created.",
            "type": "string"
          },
          "eTag": {
            "description": "eTag from the source file system",
            "type": "string"
          },
          "Tags": {
            "description": "Application defined tags",
            "type": "array",
            "items": {
              "$ref": "#/$defs/attachmentTags"
            },
            "uniqueItems": true
          },
          "version": {
            "description": "File system version",
            "type": "string"
          },
          "size": {
            "description": "File size in bytes",
            "type": "number"
          },
          "revision": {
            "description": "File system revision",
            "type": "number"
          },
          "hash": {
            "description": "File system hash",
            "type": "string"
          }
        }
      }
    }
  }
}