OpenMetadata Spreadsheets API
A `Spreadsheet` is a file format for organizing data in a tabular format, like Google Sheets or Excel files.
A `Spreadsheet` is a file format for organizing data in a tabular format, like Google Sheets or Excel files.
openapi: 3.0.1
info:
title: OpenMetadata APIs Agent Executions Spreadsheets API
description: Common types and API definition for OpenMetadata
contact:
name: OpenMetadata
url: https://open-metadata.org
email: openmetadata-dev@googlegroups.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: '1.13'
servers:
- url: /api
description: Current Host
- url: http://localhost:8585/api
description: Endpoint URL
security:
- BearerAuth: []
tags:
- name: Spreadsheets
description: A `Spreadsheet` is a file format for organizing data in a tabular format, like Google Sheets or Excel files.
paths:
/v1/drives/spreadsheets/{id}/followers:
put:
tags:
- Spreadsheets
summary: Add a follower
description: Add a user identified by `userId` as follower of this spreadsheet
operationId: addFollowerToSpreadsheet
parameters:
- name: id
in: path
description: Id of the spreadsheet
required: true
schema:
type: string
format: uuid
requestBody:
description: Id of the user to be added as follower
content:
application/json:
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeEvent'
'404':
description: Spreadsheet for instance {id} is not found
/v1/drives/spreadsheets/bulk:
put:
tags:
- Spreadsheets
summary: Bulk create or update spreadsheets
description: Create or update multiple spreadsheets in a single operation.
operationId: bulkCreateOrUpdateSpreadsheets
parameters:
- name: async
in: query
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateSpreadsheet'
responses:
'200':
description: Bulk operation results
'202':
description: Bulk operation accepted for async processing
'400':
description: Bad request
/v1/drives/spreadsheets:
get:
tags:
- Spreadsheets
summary: List spreadsheets
description: Get a list of spreadsheets, optionally filtered by `service` or `directory` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.
operationId: listSpreadsheets
parameters:
- name: fields
in: query
description: Fields requested in the returned resource
schema:
type: string
example: owners,directory,worksheets,usageSummary,tags,extension,domains,sourceHash,lifeCycle,votes,followers,mimeType,createdTime,modifiedTime
- name: service
in: query
description: Filter spreadsheets by service name
schema:
type: string
example: googleDrive
- name: directory
in: query
description: Filter spreadsheets by directory fully qualified name
schema:
type: string
- name: root
in: query
description: List spreadsheets at the root level (without parent) when `true`
schema:
type: boolean
default: false
- name: limit
in: query
description: Limit the number spreadsheets returned. (1 to 1000000, default = 10)
schema:
maximum: 1000000
minimum: 0
type: integer
format: int32
default: 10
- name: before
in: query
description: Returns list of spreadsheets before this cursor
schema:
type: string
- name: after
in: query
description: Returns list of spreadsheets after this cursor
schema:
type: string
- name: include
in: query
description: Include all, deleted, or non-deleted entities.
schema:
type: string
default: non-deleted
enum:
- all
- deleted
- non-deleted
responses:
'200':
description: List of spreadsheets
content:
application/json:
schema:
$ref: '#/components/schemas/SpreadsheetList'
put:
tags:
- Spreadsheets
summary: Create or update a spreadsheet
description: Create a new spreadsheet, if it does not exist or update an existing spreadsheet.
operationId: createOrUpdateSpreadsheet
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSpreadsheet'
responses:
'200':
description: The spreadsheet
content:
application/json:
schema:
$ref: '#/components/schemas/Spreadsheet'
'400':
description: Bad request
post:
tags:
- Spreadsheets
summary: Create a spreadsheet
description: Create a new spreadsheet under an existing `directory`.
operationId: createSpreadsheet
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSpreadsheet'
responses:
'200':
description: The spreadsheet
content:
application/json:
schema:
$ref: '#/components/schemas/Spreadsheet'
'400':
description: Bad request
/v1/drives/spreadsheets/name/{fqn}:
get:
tags:
- Spreadsheets
summary: Get a spreadsheet by fully qualified name
description: Get a spreadsheet by fully qualified name.
operationId: getSpreadsheetByFQN
parameters:
- name: fqn
in: path
description: Fully qualified name of the spreadsheet
required: true
schema:
type: string
- name: fields
in: query
description: Fields requested in the returned resource
schema:
type: string
example: owners,directory,worksheets,usageSummary,tags,extension,domains,sourceHash,lifeCycle,votes,followers,mimeType,createdTime,modifiedTime
- name: include
in: query
description: Include all, deleted, or non-deleted entities.
schema:
type: string
default: non-deleted
enum:
- all
- deleted
- non-deleted
- name: includeRelations
in: query
description: 'Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity''s include value.'
schema:
type: string
example: owners:non-deleted,followers:all
responses:
'200':
description: The spreadsheet
content:
application/json:
schema:
$ref: '#/components/schemas/Spreadsheet'
'404':
description: Spreadsheet for instance {fqn} is not found
delete:
tags:
- Spreadsheets
summary: Delete a spreadsheet by fully qualified name
description: Delete a spreadsheet by `fullyQualifiedName`.
operationId: deleteSpreadsheetByFQN
parameters:
- name: hardDelete
in: query
description: Hard delete the entity. (Default = `false`)
schema:
type: boolean
default: false
- name: recursive
in: query
description: Recursively delete this entity and it's children. (Default `false`)
schema:
type: boolean
default: false
- name: fqn
in: path
description: Fully qualified name of the spreadsheet
required: true
schema:
type: string
responses:
'200':
description: OK
'404':
description: Spreadsheet for instance {fqn} is not found
patch:
tags:
- Spreadsheets
summary: Update a spreadsheet by name.
description: Update an existing spreadsheet using JsonPatch.
externalDocs:
description: JsonPatch RFC
url: https://tools.ietf.org/html/rfc6902
operationId: patchSpreadsheet
parameters:
- name: fqn
in: path
description: Name of the spreadsheet
required: true
schema:
type: string
requestBody:
description: JsonPatch with array of operations
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/JsonPatch'
example: '[{op:remove, path:/a},{op:add, path: /b, value: val}]'
responses:
default:
description: default response
content:
application/json: {}
/v1/drives/spreadsheets/{id}:
get:
tags:
- Spreadsheets
summary: Get a spreadsheet by Id
description: Get a spreadsheet by `Id`.
operationId: getSpreadsheetByID
parameters:
- name: id
in: path
description: Id of the spreadsheet
required: true
schema:
type: string
format: uuid
- name: fields
in: query
description: Fields requested in the returned resource
schema:
type: string
example: owners,directory,worksheets,usageSummary,tags,extension,domains,sourceHash,lifeCycle,votes,followers,mimeType,createdTime,modifiedTime
- name: include
in: query
description: Include all, deleted, or non-deleted entities.
schema:
type: string
default: non-deleted
enum:
- all
- deleted
- non-deleted
- name: includeRelations
in: query
description: 'Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity''s include value.'
schema:
type: string
example: owners:non-deleted,followers:all
responses:
'200':
description: The spreadsheet
content:
application/json:
schema:
$ref: '#/components/schemas/Spreadsheet'
'404':
description: Spreadsheet for instance {id} is not found
delete:
tags:
- Spreadsheets
summary: Delete a spreadsheet by Id
description: Delete a spreadsheet by `Id`.
operationId: deleteSpreadsheet
parameters:
- name: hardDelete
in: query
description: Hard delete the entity. (Default = `false`)
schema:
type: boolean
default: false
- name: recursive
in: query
description: Recursively delete this entity and it's children. (Default `false`)
schema:
type: boolean
default: false
- name: id
in: path
description: Id of the spreadsheet
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
'404':
description: Spreadsheet for instance {id} is not found
patch:
tags:
- Spreadsheets
summary: Update a spreadsheet
description: Update an existing spreadsheet using JsonPatch.
externalDocs:
description: JsonPatch RFC
url: https://tools.ietf.org/html/rfc6902
operationId: patchSpreadsheet_1
parameters:
- name: id
in: path
description: Id of the spreadsheet
required: true
schema:
type: string
format: uuid
requestBody:
description: JsonPatch with array of operations
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/JsonPatch'
example: '[{op:remove, path:/a},{op:add, path: /b, value: val}]'
responses:
default:
description: default response
content:
application/json: {}
/v1/drives/spreadsheets/async/{id}:
delete:
tags:
- Spreadsheets
summary: Asynchronously delete a spreadsheet by Id
description: Asynchronously delete a spreadsheet by `Id`.
operationId: deleteSpreadsheetAsync
parameters:
- name: hardDelete
in: query
description: Hard delete the entity. (Default = `false`)
schema:
type: boolean
default: false
- name: recursive
in: query
description: Recursively delete related entities. (Default = `false`)
schema:
type: boolean
default: false
- name: id
in: path
description: Id of the spreadsheet
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
'404':
description: Spreadsheet for instance {id} is not found
/v1/drives/spreadsheets/{id}/followers/{userId}:
delete:
tags:
- Spreadsheets
summary: Remove a follower
description: Remove the user identified `userId` as a follower of the spreadsheet.
operationId: removeFollowerFromSpreadsheet
parameters:
- name: id
in: path
description: Id of the spreadsheet
required: true
schema:
type: string
format: uuid
- name: userId
in: path
description: Id of the user being removed as follower
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeEvent'
/v1/drives/spreadsheets/{id}/versions/{version}:
get:
tags:
- Spreadsheets
summary: Get a specific version of the spreadsheet
description: Get a specific version of the spreadsheet identified by `Id`
operationId: getSpecificSpreadsheetVersion
parameters:
- name: id
in: path
description: Id of the spreadsheet
required: true
schema:
type: string
format: uuid
- name: version
in: path
description: Spreadsheet version number in the form `major`.`minor`
required: true
schema:
type: string
example: 0.1 or 1.1
responses:
'200':
description: Spreadsheet
content:
application/json:
schema:
$ref: '#/components/schemas/Spreadsheet'
'404':
description: Spreadsheet for instance {id} and version {version} is not found
/v1/drives/spreadsheets/history:
get:
tags:
- Spreadsheets
summary: List all entity versions within a time range
description: 'Get a paginated list of all entity versions within a given time range specified by `startTs` and `endTs` in milliseconds since epoch. '
operationId: listAllEntityVersionsByTimestamp_26
parameters:
- name: startTs
in: query
description: Start timestamp in milliseconds since epoch
required: true
schema:
type: integer
format: int64
- name: endTs
in: query
description: End timestamp in milliseconds since epoch
required: true
schema:
type: integer
format: int64
- name: limit
in: query
description: Limit the number of entity returned (1 to 1000000, default = 10)
schema:
maximum: 500
minimum: 1
type: integer
format: int32
default: 10
- name: before
in: query
description: Returns list of entity versions before this cursor
schema:
type: string
- name: after
in: query
description: Returns list of entity versions after this cursor
schema:
type: string
responses:
'200':
description: List of all versions
content:
application/json:
schema:
$ref: '#/components/schemas/ResultList'
/v1/drives/spreadsheets/{id}/versions:
get:
tags:
- Spreadsheets
summary: List spreadsheet versions
description: Get a list of all the versions of a spreadsheet identified by `Id`
operationId: listAllSpreadsheetVersion
parameters:
- name: id
in: path
description: Id of the spreadsheet
required: true
schema:
type: string
format: uuid
responses:
'200':
description: List of spreadsheet versions
content:
application/json:
schema:
$ref: '#/components/schemas/EntityHistory'
/v1/drives/spreadsheets/restore:
put:
tags:
- Spreadsheets
summary: Restore a soft deleted spreadsheet
description: Restore a soft deleted spreadsheet.
operationId: restoreSpreadsheet
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RestoreEntity'
responses:
'200':
description: 'Successfully restored the spreadsheet '
content:
application/json:
schema:
$ref: '#/components/schemas/Spreadsheet'
/v1/drives/spreadsheets/{id}/vote:
put:
tags:
- Spreadsheets
summary: Update Vote for a spreadsheet
description: Update vote for a spreadsheet
operationId: updateVoteForSpreadsheet
parameters:
- name: id
in: path
description: Id of the spreadsheet
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VoteRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeEvent'
'404':
description: Spreadsheet for instance {id} is not found
components:
schemas:
TagLabelRecognizerMetadata:
required:
- recognizerId
- recognizerName
- score
type: object
properties:
recognizerId:
type: string
format: uuid
recognizerName:
type: string
score:
type: number
format: double
target:
type: string
enum:
- content
- column_name
patterns:
type: array
items:
$ref: '#/components/schemas/PatternMatch'
ChangeSummaryMap:
type: object
AccessDetails:
required:
- timestamp
type: object
properties:
timestamp:
type: integer
format: int64
accessedBy:
$ref: '#/components/schemas/EntityReference'
accessedByAProcess:
type: string
RestoreEntity:
required:
- id
type: object
properties:
id:
type: string
format: uuid
CoverImage:
type: object
properties:
url:
type: string
position:
type: string
FieldChange:
type: object
properties:
name:
type: string
oldValue:
type: object
newValue:
type: object
LifeCycle:
type: object
properties:
created:
$ref: '#/components/schemas/AccessDetails'
updated:
$ref: '#/components/schemas/AccessDetails'
accessed:
$ref: '#/components/schemas/AccessDetails'
EntityHistory:
required:
- entityType
- versions
type: object
properties:
entityType:
type: string
versions:
type: array
items:
type: object
AssetCertification:
required:
- appliedDate
- expiryDate
- tagLabel
type: object
properties:
tagLabel:
$ref: '#/components/schemas/TagLabel'
appliedDate:
type: integer
format: int64
expiryDate:
type: integer
format: int64
VoteRequest:
type: object
properties:
updatedVoteType:
type: string
enum:
- votedUp
- votedDown
- unVoted
ResultList:
required:
- data
type: object
properties:
data:
type: array
items:
type: object
paging:
$ref: '#/components/schemas/Paging'
errors:
type: array
items:
$ref: '#/components/schemas/EntityError'
warningsCount:
type: integer
format: int32
warnings:
type: array
items:
$ref: '#/components/schemas/EntityError'
CreateSpreadsheet:
required:
- name
- service
type: object
properties:
name:
maxLength: 256
minLength: 1
pattern: ^((?!::).)*$
type: string
displayName:
type: string
description:
type: string
service:
maxLength: 3072
minLength: 1
type: string
parent:
$ref: '#/components/schemas/EntityReference'
mimeType:
type: string
enum:
- application/vnd.google-apps.spreadsheet
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
- application/vnd.ms-excel
- application/vnd.oasis.opendocument.spreadsheet
- text/csv
- text/tab-separated-values
- Other
path:
type: string
driveFileId:
type: string
size:
type: integer
format: int32
fileVersion:
type: string
sourceUrl:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/TagLabel'
owners:
type: array
items:
$ref: '#/components/schemas/EntityReference'
dataProducts:
type: array
items:
type: string
domains:
type: array
items:
type: string
lifeCycle:
$ref: '#/components/schemas/LifeCycle'
sourceHash:
maxLength: 32
minLength: 1
type: string
extension:
type: object
createdTime:
type: integer
format: int64
modifiedTime:
type: integer
format: int64
reviewers:
type: array
items:
$ref: '#/components/schemas/EntityReference'
Paging:
required:
- total
type: object
properties:
before:
type: string
after:
type: string
offset:
type: integer
format: int32
limit:
type: integer
format: int32
total:
type: integer
format: int32
JsonPatch:
type: object
ChangeDescription:
type: object
properties:
fieldsAdded:
type: array
items:
$ref: '#/components/schemas/FieldChange'
fieldsUpdated:
type: array
items:
$ref: '#/components/schemas/FieldChange'
fieldsDeleted:
type: array
items:
$ref: '#/components/schemas/FieldChange'
previousVersion:
type: number
format: double
changeSummary:
$ref: '#/components/schemas/ChangeSummaryMap'
SpreadsheetList:
required:
- data
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Spreadsheet'
paging:
$ref: '#/components/schemas/Paging'
errors:
type: array
items:
$ref: '#/components/schemas/EntityError'
warningsCount:
type: integer
format: int32
warnings:
type: array
items:
$ref: '#/components/schemas/EntityError'
ChangeEvent:
required:
- entityId
- entityType
- eventType
- id
- timestamp
type: object
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- entityCreated
- entityUpdated
- entityFieldsChanged
- entityNoChange
- entitySoftDeleted
- entityDeleted
- entityRestored
- threadCreated
- threadUpdated
- postCreated
- postUpdated
- taskResolved
- taskClosed
- logicalTestCaseAdded
- suggestionCreated
- suggestionUpdated
- suggestionAccepted
- suggestionRejected
- suggestionDeleted
- userLogin
- userLogout
entityType:
type: string
entityId:
type: string
format: uuid
domains:
type: array
items:
type: string
format: uuid
entityFullyQualifiedName:
type: string
previousVersion:
type: number
format: double
currentVersion:
type: number
format: double
userName:
type: string
impersonatedBy:
type: string
timestamp:
type: integer
format: int64
changeDescription:
$ref: '#/components/schemas/ChangeDescription'
incrementalChangeDescription:
$ref: '#/components/schemas/ChangeDescription'
entity:
type: object
UsageStats:
required:
- count
type: object
properties:
count:
minimum: 0
exclusiveMinimum: false
type: integer
format: int32
percentileRank:
type: number
format: double
Style:
type: object
properties:
color:
type: string
iconURL:
type: string
coverImage:
$ref: '#/components/schemas/CoverImage'
Votes:
type: object
properties:
upVotes:
type: integer
format: int32
downVotes:
type: integer
format: int32
upVoters:
type: array
items:
$ref: '#/components/schemas/EntityReference'
downVoters:
type: array
items:
$ref: '#/components/schemas/EntityReference'
TagLabel:
required:
- labelType
- source
- state
- tagFQN
type: object
properties:
tagFQN:
type: string
name:
type: string
displayName:
type: string
description:
type: string
style:
$ref: '#/components/schemas/Style'
source:
type: string
enum:
- Classification
- Glossary
labelType:
type: string
enum:
- Manual
- Propagated
- Automated
- Derived
- Generated
state:
type: string
enum:
- Suggested
- Confirmed
href:
type: string
format: uri
reason:
type: string
appliedAt:
type: string
format: date-time
appliedBy:
type: string
metadata:
$ref: '#/components/schemas/TagLabelMetadata'
PatternMatch:
required:
- name
- score
type: object
properties:
name:
type: string
regex:
type: string
score:
type: number
format: double
TagLabelMetadata:
type: object
properties:
recognizer:
$ref: '#/components/schemas/TagLabelRecognizerMetadata'
expiryDate:
type: integer
format: int64
EntityError:
type: object
properties:
message:
type: string
entity:
type: object
Spreadsheet:
required:
- id
- name
- service
type: object
properties:
id:
type: string
format: uuid
name:
maxLength: 256
minLength: 1
pattern: ^((?!::).)*$
type: string
fullyQualifiedName:
maxLength: 3072
minLength: 1
type: string
displayName:
type: string
description:
type: string
service:
$ref: '#/components/schemas/EntityReference'
serviceType:
type: string
enum:
- GoogleDrive
- SharePoint
- Sftp
- CustomDrive
directory:
$ref: '#/components/schemas/EntityReference'
worksheets:
type: array
items:
$ref: '#/components/schemas/EntityReference'
mimeType:
type: string
enum:
- application/vnd.google-apps.spreadsheet
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
- application/vnd.ms-excel
- application/vnd.oasis.opendocument.spreadsheet
- text/csv
- text/tab-separated-values
- Other
path:
type: string
driveFileId:
type: string
size:
type: integer
format: int32
fileVersion:
type: string
createdTime:
type: integer
format: int64
modifiedTime:
type: integer
format: int64
lastModifiedBy:
$ref: '#/components/schemas/EntityReference'
usageSummary:
$ref: '#/components/schemas/UsageDetails'
sourceUrl:
type: string
href:
type: string
format: uri
owners:
type: array
items:
$ref: '#/components/schemas/EntityReference'
followers:
type: array
items:
$ref: '#/components/schemas/EntityReference'
tags:
type: array
items:
$ref: '#/components/schemas/TagLabel'
version:
type: number
format: double
updatedAt:
type: integer
format: int64
updatedBy:
type: string
impersonatedBy:
type: string
changeDescription:
$ref: '#/components/schemas/ChangeDescription'
incrementalChangeDescription:
$ref: '#/components/schemas/ChangeDescription'
deleted:
type: boolean
domains:
type: array
items:
$ref: '#/components/schemas/EntityReference'
dataProducts:
type: array
items:
$ref: '#/components/schemas/EntityReference'
dataContract:
$ref: '#/components/schemas/EntityReference'
lifeCycle:
$ref: '#/components/schemas/LifeCycle'
sourceHash:
maxLength: 32
minLength: 1
type: string
extension:
type: object
votes:
$ref: '#/components/schemas/Votes'
certification:
$ref: '#/components/schemas/AssetCertification'
entityStatus:
type: string
enum:
- Draft
- In Review
- Approved
- Archived
- Deprecated
- Rejected
- Unprocessed
provider:
type: string
enum:
- system
- user
- automation
children:
type: array
items:
$ref: '#/components/schemas/EntityReference'
style:
$ref:
# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openmetadata/refs/heads/main/openapi/openmetadata-spreadsheets-api-openapi.yml