Worksheet¶

{
  "$id": "https://open-metadata.org/schema/entity/data/worksheet.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Worksheet",
  "$comment": "@om-entity-type",
  "description": "This schema defines the Worksheet entity. A Worksheet is a tab or sheet within a spreadsheet file (Google Sheets, Excel) that contains structured data.",
  "type": "object",
  "javaType": "org.openmetadata.schema.entity.data.Worksheet",
  "javaInterfaces": [
    "org.openmetadata.schema.EntityInterface"
  ],
  "properties": {
    "id": {
      "description": "Unique identifier of this worksheet instance.",
      "$ref": "../../type/basic.json#/definitions/uuid"
    },
    "name": {
      "description": "Name of the worksheet.",
      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "fullyQualifiedName": {
      "description": "Fully qualified name of the worksheet.",
      "$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
    },
    "displayName": {
      "description": "Display Name that identifies this worksheet.",
      "type": "string"
    },
    "description": {
      "description": "Description of the worksheet.",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "spreadsheet": {
      "description": "Reference to the parent File entity (with fileType=Spreadsheet)",
      "$ref": "../../type/entityReference.json"
    },
    "service": {
      "description": "Link to the drive service",
      "$ref": "../../type/entityReference.json"
    },
    "serviceType": {
      "description": "Type of drive service",
      "$ref": "../../entity/services/driveService.json#/definitions/driveServiceType"
    },
    "worksheetId": {
      "description": "Native worksheet/tab ID",
      "type": "string"
    },
    "index": {
      "description": "Position/index of the worksheet in the spreadsheet",
      "type": "integer"
    },
    "rowCount": {
      "description": "Number of rows in the worksheet",
      "type": "integer"
    },
    "columnCount": {
      "description": "Number of columns in the worksheet",
      "type": "integer"
    },
    "columns": {
      "description": "Column definitions if structured data",
      "type": "array",
      "items": {
        "$ref": "../data/table.json#/definitions/column"
      },
      "default": []
    },
    "sampleData": {
      "description": "Sample data from the worksheet",
      "$ref": "../data/table.json#/definitions/tableData"
    },
    "isHidden": {
      "description": "Whether the worksheet is hidden",
      "type": "boolean",
      "default": false
    },
    "sourceUrl": {
      "description": "Link to this worksheet in the source system.",
      "$ref": "../../type/basic.json#/definitions/sourceUrl"
    },
    "href": {
      "description": "Link to the resource corresponding to this worksheet.",
      "$ref": "../../type/basic.json#/definitions/href"
    },
    "owners": {
      "description": "Owners of this worksheet.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "followers": {
      "description": "Followers of this entity.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "tags": {
      "description": "Tags associated with this worksheet.",
      "type": "array",
      "items": {
        "$ref": "../../type/tagLabel.json"
      },
      "default": null
    },
    "version": {
      "description": "Metadata version of the entity.",
      "$ref": "../../type/entityHistory.json#/definitions/entityVersion"
    },
    "updatedAt": {
      "description": "Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.",
      "$ref": "../../type/basic.json#/definitions/timestamp"
    },
    "updatedBy": {
      "description": "User who made the update.",
      "type": "string"
    },
    "impersonatedBy": {
      "description": "Bot user that performed the action on behalf of the actual user.",
      "$ref": "../../type/basic.json#/definitions/impersonatedBy"
    },
    "changeDescription": {
      "description": "Change that lead to this version of the entity.",
      "$ref": "../../type/entityHistory.json#/definitions/changeDescription"
    },
    "incrementalChangeDescription": {
      "description": "Change that lead to this version of the entity.",
      "$ref": "../../type/entityHistory.json#/definitions/changeDescription"
    },
    "deleted": {
      "description": "When `true` indicates the entity has been soft deleted.",
      "type": "boolean",
      "default": false
    },
    "domains": {
      "description": "Domains the Worksheet belongs to.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "dataProducts": {
      "description": "List of data products this entity is part of.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "lifeCycle": {
      "description": "Life Cycle of the entity",
      "$ref": "../../type/lifeCycle.json"
    },
    "sourceHash": {
      "description": "Source hash of the entity",
      "type": "string",
      "minLength": 1,
      "maxLength": 32
    },
    "extension": {
      "description": "Entity extension data with custom attributes added to the entity.",
      "$ref": "../../type/basic.json#/definitions/entityExtension"
    },
    "votes": {
      "description": "Votes on the entity.",
      "$ref": "../../type/votes.json"
    },
    "certification": {
      "$ref": "../../type/assetCertification.json"
    },
    "usageSummary": {
      "description": "Latest usage information for this worksheet.",
      "$ref": "../../type/usageDetails.json",
      "default": null
    },
    "entityStatus": {
      "description": "Status of the Worksheet.",
      "$ref": "../../type/status.json"
    }
  },
  "required": ["id", "name", "spreadsheet", "service"],
  "additionalProperties": false
}

{
  "@context": {
    "@vocab": "https://open-metadata.org/schema/entity/data/",
    "om": "https://open-metadata.org/schema/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
    "rdfs": "http://www.w3.org/2000/01/rdf-schema#",

    "Worksheet": {
      "@id": "Worksheet",
      "@type": "@id"
    },
    "id": {
      "@id": "@id",
      "@type": "@id"
    },
    "name": {
      "@id": "om:name",
      "@type": "xsd:string"
    },
    "fullyQualifiedName": {
      "@id": "om:fullyQualifiedName",
      "@type": "xsd:string"
    },
    "displayName": {
      "@id": "om:displayName",
      "@type": "xsd:string"
    },
    "description": {
      "@id": "om:description",
      "@type": "xsd:string"
    },
    "spreadsheet": {
      "@id": "spreadsheet",
      "@type": "@id"
    },
    "service": {
      "@id": "service",
      "@type": "@id"
    },
    "serviceType": {
      "@id": "om:serviceType",
      "@type": "xsd:string"
    },
    "worksheetId": {
      "@id": "worksheetId",
      "@type": "xsd:string"
    },
    "index": {
      "@id": "index",
      "@type": "xsd:integer"
    },
    "rowCount": {
      "@id": "rowCount",
      "@type": "xsd:integer"
    },
    "columnCount": {
      "@id": "columnCount",
      "@type": "xsd:integer"
    },
    "columns": {
      "@id": "hasColumn",
      "@type": "@id",
      "@container": "@set"
    },
    "sampleData": {
      "@id": "sampleData",
      "@type": "@id"
    },
    "isHidden": {
      "@id": "isHidden",
      "@type": "xsd:boolean"
    },
    "sourceUrl": {
      "@id": "sourceUrl",
      "@type": "xsd:anyURI"
    },
    "href": {
      "@id": "om:href",
      "@type": "xsd:anyURI"
    },
    "owners": {
      "@id": "om:owner",
      "@type": "@id",
      "@container": "@set"
    },
    "followers": {
      "@id": "om:follower",
      "@type": "@id",
      "@container": "@set"
    },
    "tags": {
      "@id": "om:tag",
      "@type": "@id",
      "@container": "@set"
    },
    "domains": {
      "@id": "om:domain",
      "@type": "@id",
      "@container": "@set"
    },
    "dataProducts": {
      "@id": "om:dataProduct",
      "@type": "@id",
      "@container": "@set"
    },
    "version": {
      "@id": "om:version",
      "@type": "xsd:string"
    },
    "updatedAt": {
      "@id": "om:updatedAt",
      "@type": "xsd:dateTime"
    },
    "updatedBy": {
      "@id": "om:updatedBy",
      "@type": "xsd:string"
    },
    "deleted": {
      "@id": "om:deleted",
      "@type": "xsd:boolean"
    },
    "usageSummary": {
      "@id": "usageSummary",
      "@type": "@id"
    },
    "entityStatus": {
      "@id": "om:entityStatus",
      "@type": "xsd:string"
    }
  }
}