lexicon

Id: eco.wonderland.workcell.asset.file.defs
Type: lexicon

Objects

• abstractFile: Abstract asset that contains the common properties of the file and fileArchetype types.
• destination: Reference to the target device for this file.
• fileArchetype: AbstractFile type that provides information common to all versions of a file.
• file: AbstractFile type that provides information about the file instance and its URL.
• fileComment: Remark or interpretation for human interpretation associated with a file or fileArchetype.
• fileLocation: URL reference to the file location.
• fileProperty: Key-value pair providing additional metadata about a file.

Schema

{
  "id": "eco.wonderland.workcell.asset.file.defs",
  "lexicon": 1,
  "defs": {
    "abstractFile": {
      "type": "object",
      "required": [
        "assetId",
        "timestamp",
        "name",
        "mediaType",
        "applicationCategory",
        "applicationType"
      ],
      "properties": {
        "assetId": {
          "type": "string"
        },
        "deviceUuid": {
          "type": "string"
        },
        "removed": {
          "type": "boolean"
        },
        "timestamp": {
          "type": "string",
          "format": "datetime"
        },
        "configuration": {
          "type": "ref",
          "ref": "lex:eco.wonderland.workcell.device.configuration.defs#configuration"
        },
        "hash": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "mediaType": {
          "type": "string"
        },
        "applicationCategory": {
          "type": "ref",
          "ref": "lex:eco.wonderland.workcell.asset.data.defs#applicationCategory"
        },
        "applicationType": {
          "type": "ref",
          "ref": "lex:eco.wonderland.workcell.asset.data.defs#applicationType"
        },
        "fileProperties": {
          "type": "array",
          "items": {
            "type": "ref",
            "ref": "#fileProperty"
          }
        },
        "fileComments": {
          "type": "array",
          "items": {
            "type": "ref",
            "ref": "#fileComment"
          }
        }
      }
    },
    "destination": {
      "type": "object",
      "required": [
        "deviceUuid"
      ],
      "properties": {
        "deviceUuid": {
          "type": "string"
        }
      }
    },
    "fileArchetype": {
      "type": "object",
      "required": [
        "assetId",
        "timestamp",
        "name",
        "mediaType",
        "applicationCategory",
        "applicationType"
      ],
      "properties": {
        "assetId": {
          "type": "string"
        },
        "deviceUuid": {
          "type": "string"
        },
        "removed": {
          "type": "boolean"
        },
        "timestamp": {
          "type": "string",
          "format": "datetime"
        },
        "configuration": {
          "type": "ref",
          "ref": "lex:eco.wonderland.workcell.device.configuration.defs#configuration"
        },
        "hash": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "mediaType": {
          "type": "string"
        },
        "applicationCategory": {
          "type": "ref",
          "ref": "lex:eco.wonderland.workcell.asset.data.defs#applicationCategory"
        },
        "applicationType": {
          "type": "ref",
          "ref": "lex:eco.wonderland.workcell.asset.data.defs#applicationType"
        },
        "fileProperties": {
          "type": "array",
          "items": {
            "type": "ref",
            "ref": "#fileProperty"
          }
        },
        "fileComments": {
          "type": "array",
          "items": {
            "type": "ref",
            "ref": "#fileComment"
          }
        }
      }
    },
    "file": {
      "type": "object",
      "required": [
        "assetId",
        "timestamp",
        "name",
        "mediaType",
        "applicationCategory",
        "applicationType",
        "size",
        "versionId",
        "state",
        "creationTime",
        "fileLocation"
      ],
      "properties": {
        "assetId": {
          "type": "string"
        },
        "deviceUuid": {
          "type": "string"
        },
        "removed": {
          "type": "boolean"
        },
        "timestamp": {
          "type": "string",
          "format": "datetime"
        },
        "configuration": {
          "type": "ref",
          "ref": "lex:eco.wonderland.workcell.device.configuration.defs#configuration"
        },
        "hash": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "mediaType": {
          "type": "string"
        },
        "applicationCategory": {
          "type": "ref",
          "ref": "lex:eco.wonderland.workcell.asset.data.defs#applicationCategory"
        },
        "applicationType": {
          "type": "ref",
          "ref": "lex:eco.wonderland.workcell.asset.data.defs#applicationType"
        },
        "fileProperties": {
          "type": "array",
          "items": {
            "type": "ref",
            "ref": "#fileProperty"
          }
        },
        "fileComments": {
          "type": "array",
          "items": {
            "type": "ref",
            "ref": "#fileComment"
          }
        },
        "size": {
          "type": "integer"
        },
        "versionId": {
          "type": "string"
        },
        "state": {
          "type": "ref",
          "ref": "lex:eco.wonderland.workcell.asset.data.defs#fileState"
        },
        "signature": {
          "type": "string"
        },
        "publicKey": {
          "type": "string"
        },
        "creationTime": {
          "type": "string",
          "format": "datetime"
        },
        "modificationTime": {
          "type": "string",
          "format": "datetime"
        },
        "fileLocation": {
          "type": "ref",
          "ref": "#fileLocation"
        },
        "destinations": {
          "type": "array",
          "items": {
            "type": "ref",
            "ref": "#destination"
          }
        }
      }
    },
    "fileComment": {
      "type": "object",
      "required": [
        "timestamp",
        "value"
      ],
      "properties": {
        "timestamp": {
          "type": "string",
          "format": "datetime"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "fileLocation": {
      "type": "object",
      "required": [
        "href"
      ],
      "properties": {
        "href": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      }
    },
    "fileProperty": {
      "type": "object",
      "required": [
        "name",
        "value"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    }
  }
}