ts_ids_core.schema.time_ module¶

Model RawSampleTime[source]¶

Bases: RawTime

The base model for time associated with a specific sample.

Show JSON schema

{
   "description": "The base model for time associated with a specific sample.",
   "type": "object",
   "properties": {
      "start": {
         "description": "Process/experiment/task start time.",
         "type": [
            "string",
            "null"
         ]
      },
      "created": {
         "description": "Data created time.",
         "type": [
            "string",
            "null"
         ]
      },
      "stop": {
         "description": "Process/experiment/task stop/finish time.",
         "type": [
            "string",
            "null"
         ]
      },
      "duration": {
         "description": "Process/experiment/task duration.",
         "type": [
            "string",
            "null"
         ]
      },
      "last_updated": {
         "description": "Data last updated time of a file/method.",
         "type": [
            "string",
            "null"
         ]
      },
      "acquired": {
         "description": "Data acquired/exported/captured time.",
         "type": [
            "string",
            "null"
         ]
      },
      "modified": {
         "description": "Data last modified/edited time.",
         "type": [
            "string",
            "null"
         ]
      },
      "lookup": {
         "description": "Raw sample data lookup time.",
         "type": [
            "string",
            "null"
         ]
      }
   },
   "additionalProperties": false,
   "required": [
      "lookup"
   ]
}

Validators:

all_abstract_fields_implemented » all fields

field acquired: Nullable[str]¶: Data acquired/exported/captured time.

field created: Nullable[str]¶: Data created time.

field duration: Nullable[str]¶: Process/experiment/task duration.

field last_updated: Nullable[str]¶: Data last updated time of a file/method.

field lookup: Required[Nullable[str]]¶: Raw sample data lookup time.

field modified: Nullable[str]¶: Data last modified/edited time.

field start: Nullable[str]¶: Process/experiment/task start time.

field stop: Nullable[str]¶: Process/experiment/task stop/finish time.

Model RawTime[source]¶

Bases: IdsElement

The base model for capturing common time fields found in primary data.

Show JSON schema

{
   "description": "The base model for capturing common time fields found in primary data.",
   "type": "object",
   "properties": {
      "start": {
         "description": "Process/experiment/task start time.",
         "type": [
            "string",
            "null"
         ]
      },
      "created": {
         "description": "Data created time.",
         "type": [
            "string",
            "null"
         ]
      },
      "stop": {
         "description": "Process/experiment/task stop/finish time.",
         "type": [
            "string",
            "null"
         ]
      },
      "duration": {
         "description": "Process/experiment/task duration.",
         "type": [
            "string",
            "null"
         ]
      },
      "last_updated": {
         "description": "Data last updated time of a file/method.",
         "type": [
            "string",
            "null"
         ]
      },
      "acquired": {
         "description": "Data acquired/exported/captured time.",
         "type": [
            "string",
            "null"
         ]
      },
      "modified": {
         "description": "Data last modified/edited time.",
         "type": [
            "string",
            "null"
         ]
      },
      "lookup": {
         "description": "Data lookup time.",
         "type": [
            "string",
            "null"
         ]
      }
   },
   "additionalProperties": false
}

Validators:

all_abstract_fields_implemented » all fields

field acquired: Nullable[str]¶: Data acquired/exported/captured time.

field created: Nullable[str]¶: Data created time.

field duration: Nullable[str]¶: Process/experiment/task duration.

field last_updated: Nullable[str]¶: Data last updated time of a file/method.

field lookup: Nullable[str]¶: Data lookup time.

field modified: Nullable[str]¶: Data last modified/edited time.

field start: Nullable[str]¶: Process/experiment/task start time.

field stop: Nullable[str]¶: Process/experiment/task stop/finish time.

Model SampleTime[source]¶

Bases: RawSampleTime

A model for experiment sample datetime values converted to a standard ISO format and their respective raw datetime values in the primary data.

Show JSON schema

{
   "description": "A model for experiment sample datetime values converted to a standard ISO format\nand their respective raw datetime values in the primary data.",
   "type": "object",
   "properties": {
      "start": {
         "description": "Process/experiment/task start time.",
         "type": [
            "string",
            "null"
         ]
      },
      "created": {
         "description": "Data created time.",
         "type": [
            "string",
            "null"
         ]
      },
      "stop": {
         "description": "Process/experiment/task stop/finish time.",
         "type": [
            "string",
            "null"
         ]
      },
      "duration": {
         "description": "Process/experiment/task duration.",
         "type": [
            "string",
            "null"
         ]
      },
      "last_updated": {
         "description": "Data last updated time of a file/method.",
         "type": [
            "string",
            "null"
         ]
      },
      "acquired": {
         "description": "Data acquired/exported/captured time.",
         "type": [
            "string",
            "null"
         ]
      },
      "modified": {
         "description": "Data last modified/edited time.",
         "type": [
            "string",
            "null"
         ]
      },
      "lookup": {
         "description": "Raw sample data lookup time.",
         "type": [
            "string",
            "null"
         ]
      },
      "raw": {
         "$ref": "#/definitions/RawSampleTime",
         "description": "Raw sample time values from primary data."
      }
   },
   "additionalProperties": false,
   "required": [
      "lookup"
   ],
   "definitions": {
      "RawSampleTime": {
         "additionalProperties": false,
         "description": "The base model for time associated with a specific sample.",
         "properties": {
            "start": {
               "description": "Process/experiment/task start time.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "created": {
               "description": "Data created time.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "stop": {
               "description": "Process/experiment/task stop/finish time.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "duration": {
               "description": "Process/experiment/task duration.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "last_updated": {
               "description": "Data last updated time of a file/method.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "acquired": {
               "description": "Data acquired/exported/captured time.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "modified": {
               "description": "Data last modified/edited time.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "lookup": {
               "description": "Raw sample data lookup time.",
               "type": [
                  "string",
                  "null"
               ]
            }
         },
         "required": [
            "lookup"
         ],
         "type": "object"
      }
   }
}

Validators:

all_abstract_fields_implemented » all fields

field acquired: Nullable[str]¶: Data acquired/exported/captured time.

field created: Nullable[str]¶: Data created time.

field duration: Nullable[str]¶: Process/experiment/task duration.

field last_updated: Nullable[str]¶: Data last updated time of a file/method.

field lookup: Required[Nullable[str]]¶: Raw sample data lookup time.

field modified: Nullable[str]¶: Data last modified/edited time.

field raw: RawSampleTime¶: Raw sample time values from primary data.

field start: Nullable[str]¶: Process/experiment/task start time.

field stop: Nullable[str]¶: Process/experiment/task stop/finish time.

Model Time[source]¶

Bases: RawTime

A model for datetime values converted to a standard ISO format and their respective raw datetime values in the primary data.

Show JSON schema

{
   "description": "A model for datetime values converted to a standard ISO format and their\nrespective raw datetime values in the primary data.",
   "type": "object",
   "properties": {
      "start": {
         "description": "Process/experiment/task start time.",
         "type": [
            "string",
            "null"
         ]
      },
      "created": {
         "description": "Data created time.",
         "type": [
            "string",
            "null"
         ]
      },
      "stop": {
         "description": "Process/experiment/task stop/finish time.",
         "type": [
            "string",
            "null"
         ]
      },
      "duration": {
         "description": "Process/experiment/task duration.",
         "type": [
            "string",
            "null"
         ]
      },
      "last_updated": {
         "description": "Data last updated time of a file/method.",
         "type": [
            "string",
            "null"
         ]
      },
      "acquired": {
         "description": "Data acquired/exported/captured time.",
         "type": [
            "string",
            "null"
         ]
      },
      "modified": {
         "description": "Data last modified/edited time.",
         "type": [
            "string",
            "null"
         ]
      },
      "lookup": {
         "description": "Data lookup time.",
         "type": [
            "string",
            "null"
         ]
      },
      "raw": {
         "$ref": "#/definitions/RawTime",
         "description": "Raw time values from primary data."
      }
   },
   "additionalProperties": false,
   "definitions": {
      "RawTime": {
         "additionalProperties": false,
         "description": "The base model for capturing common time fields found in primary data.",
         "properties": {
            "start": {
               "description": "Process/experiment/task start time.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "created": {
               "description": "Data created time.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "stop": {
               "description": "Process/experiment/task stop/finish time.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "duration": {
               "description": "Process/experiment/task duration.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "last_updated": {
               "description": "Data last updated time of a file/method.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "acquired": {
               "description": "Data acquired/exported/captured time.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "modified": {
               "description": "Data last modified/edited time.",
               "type": [
                  "string",
                  "null"
               ]
            },
            "lookup": {
               "description": "Data lookup time.",
               "type": [
                  "string",
                  "null"
               ]
            }
         },
         "type": "object"
      }
   }
}

Validators:

all_abstract_fields_implemented » all fields

field acquired: Nullable[str]¶: Data acquired/exported/captured time.

field created: Nullable[str]¶: Data created time.

field duration: Nullable[str]¶: Process/experiment/task duration.

field last_updated: Nullable[str]¶: Data last updated time of a file/method.

field lookup: Nullable[str]¶: Data lookup time.

field modified: Nullable[str]¶: Data last modified/edited time.

field raw: RawTime¶: Raw time values from primary data.

field start: Nullable[str]¶: Process/experiment/task start time.

field stop: Nullable[str]¶: Process/experiment/task stop/finish time.