How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenMetadata Worksheets API

A `Worksheet` is an individual sheet or tab within a Spreadsheet.

OpenMetadata Worksheets API is one of 88 APIs that OpenMetadata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Worksheets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 18 operations across 12 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 1.13.

Requests are made against 2 base URLs: /api, http://localhost:8585/api.

18 operations 12 paths 34 schemas 4 DELETE6 GET2 PATCH1 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.13
Base URL
https://{your-host}/api/v1
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

OpenMetadata Worksheets API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 18

Across 12 paths, the API surfaces 18 operations — 4 DELETE, 6 GET, 2 PATCH, 1 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Worksheets 18

A Worksheet is an individual sheet or tab within a Spreadsheet.

PUT
/v1/drives/worksheets/{id}/followers
Add a follower
addFollowerToWorksheet 1 param body → 200404
PUT
/v1/drives/worksheets/bulk
Bulk create or update worksheets
bulkCreateOrUpdateWorksheets 1 param body → 200202400
GET
/v1/drives/worksheets
List worksheets
listWorksheets 7 params → 200
PUT
/v1/drives/worksheets
Create or update a worksheet
createOrUpdateWorksheet body → 200400
POST
/v1/drives/worksheets
Create a worksheet
createWorksheet body → 200400
GET
/v1/drives/worksheets/name/{fqn}
Get a worksheet by fully qualified name
getWorksheetByFQN 4 params → 200404
DELETE
/v1/drives/worksheets/name/{fqn}
Delete a worksheet by fully qualified name
deleteWorksheetByFQN 2 params → 200404
PATCH
/v1/drives/worksheets/name/{fqn}
Update a worksheet by name
patchWorksheet 1 param body → default
GET
/v1/drives/worksheets/{id}
Get a worksheet by Id
getWorksheetByID 4 params → 200404
DELETE
/v1/drives/worksheets/{id}
Delete a worksheet by Id
deleteWorksheet 2 params → 200404
PATCH
/v1/drives/worksheets/{id}
Update a worksheet
patchWorksheet_1 1 param body → default
DELETE
/v1/drives/worksheets/async/{id}
Asynchronously delete a worksheet by Id
deleteWorksheetAsync 3 params → 200404
DELETE
/v1/drives/worksheets/{id}/followers/{userId}
Remove a follower
removeFollowerFromWorksheet 2 params → 200
GET
/v1/drives/worksheets/{id}/versions/{version}
Get a specific version of the worksheet
getSpecificWorksheetVersion 2 params → 200404
GET
/v1/drives/worksheets/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_27 5 params → 200
GET
/v1/drives/worksheets/{id}/versions
List worksheet versions
listAllWorksheetVersion 1 param → 200
PUT
/v1/drives/worksheets/restore
Restore a soft deleted worksheet by id
restoreWorksheetById body → 200
PUT
/v1/drives/worksheets/{id}/vote
Update Vote for a worksheet
updateVoteForWorksheet 1 param body → 200404

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are Worksheet (42 properties), ColumnProfile (30 properties), CreateWorksheet (20 properties), Column (18 properties). Each schema is shown below with its type and property counts.

AssetCertification
object
3 properties 3 required
EntityHistory
object
2 properties 2 required
UsageDetails
object
4 properties 2 required
Paging
object
5 properties 1 required
CustomMetric
object
8 properties 2 required
Style
object
3 properties
Votes
object
4 properties
VoteRequest
object
1 property
ChangeSummaryMap
object
ResultList
object
5 properties 1 required
LifeCycle
object
3 properties
RestoreEntity
object
1 property 1 required
TagLabelMetadata
object
2 properties
TagLabelRecognizerMetadata
object
5 properties 3 required
CardinalityDistribution
object
4 properties
UsageStats
object
2 properties 1 required
Column
object
18 properties 2 required
CoverImage
object
2 properties
TagLabel
object
13 properties 4 required
WorksheetList
object
5 properties 1 required
ChangeDescription
object
5 properties
JsonPatch
object
ChangeEvent
object
14 properties 5 required
EntityError
object
2 properties
Histogram
object
2 properties
TableData
object
2 properties
Worksheet
object
42 properties 4 required
CreateWorksheet
object
20 properties 2 required
FieldChange
object
3 properties
ColumnProfile
object
30 properties 2 required
AccessDetails
object
3 properties 1 required
EntityReference
object
9 properties 2 required
CustomMetricProfile
object
2 properties
PatternMatch
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-worksheets-api-openapi.yml Raw ↑

Other APIs OpenMetadata publishes across the network.

OpenMetadata Agent Executions API
OpenMetadata AI Applications API
OpenMetadata AI Governance Policies API
OpenMetadata API Collections API
OpenMetadata API Endpoint API
OpenMetadata API Services API
OpenMetadata Apps API
OpenMetadata Audit Logs API
OpenMetadata Bots API
OpenMetadata ChangeSummary API
OpenMetadata Charts API
OpenMetadata Classifications API
Where this information came from

This is an independent, third-party profile of OpenMetadata Worksheets API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.