data.world · Example Payload
Api Examples
Data CatalogData GovernanceMetadata ManagementSPARQLSQLOpen DataCollaboration
Api Examples is an example object payload from data.world, with 3 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
titleversionexamples
Example Payload
{
"title": "data.world API Examples",
"version": "0",
"examples": [
{
"path": "/cancel",
"method": "POST",
"summary": "Cancel a query",
"description": "Cancel a running query.",
"tags": [
"queries"
],
"operationId": "cancel",
"parameters": [
{
"name": "queryruntoken",
"in": "query",
"required": true,
"description": "",
"schema": {
"type": "string",
"minLength": 1
}
}
],
"requestBody": null,
"responses": {
"200": {
"description": "default response",
"contentType": "*/*",
"schema": {},
"example": null
}
}
},
{
"path": "/connections/test",
"method": "POST",
"summary": "Test a connection",
"description": "Test a virtual connection. For increased security, connection endpoints require an Enterprise Admin\nToken. This token can be found under [Advanced Settings](https://data.world/settings/advanced).",
"tags": [
"connections"
],
"operationId": "testConnection",
"parameters": [],
"requestBody": {
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ConnectionDto"
},
"example": null
},
"responses": {
"200": {
"description": "Successful operation",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/PingStatusDto"
},
"example": null
},
"400": {
"description": "Bad Request",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
},
"401": {
"description": "User is unauthorized to perform action",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
},
"403": {
"description": "Access forbidden",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
},
"404": {
"description": "Not found",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
},
"422": {
"description": "Unable to parse request. URLs provided must be fully-formed http or https URLs",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
},
"500": {
"description": "Server error",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
}
}
},
{
"path": "/connections/{owner}",
"method": "GET",
"summary": "Get connections by owner",
"description": "Get a list of configured virtual connections by owner. For increased security, connection\nendpoints require an Enterprise Admin Token. This token can be found under\n[Advanced Settings](https://data.world/settings/advanced).",
"tags": [
"connections"
],
"operationId": "getConnectionsByOwner",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "size",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "from",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
}
],
"requestBody": null,
"responses": {
"200": {
"description": "default response",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/PaginatedConnectionResults"
},
"example": null
}
}
},
{
"path": "/connections/{owner}",
"method": "POST",
"summary": "Create a new connection",
"description": "Create a new virtual connection. For increased security, connection endpoints require an Enterprise Admin\nToken. This token can be found under [Advanced Settings](https://data.world/settings/advanced).",
"tags": [
"connections"
],
"operationId": "createConnection",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "validate",
"in": "query",
"required": false,
"description": "Validate connection before save",
"schema": {
"type": "boolean",
"default": true
}
}
],
"requestBody": {
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ConnectionDto"
},
"example": null
},
"responses": {
"200": {
"description": "Connection created successfully.",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/CreateResponse"
},
"example": null
}
}
},
{
"path": "/connections/{owner}/{id}",
"method": "DELETE",
"summary": "Delete a Connection",
"description": "Delete a Connection. For increased security, connection endpoints require an Enterprise Admin Token. This\ntoken can be found under [Advanced Settings](https://data.world/settings/advanced).",
"tags": [
"connections"
],
"operationId": "deleteConnection",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": null,
"responses": {
"200": {
"description": "default response",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/SuccessMessage"
},
"example": null
}
}
},
{
"path": "/connections/{owner}/{id}",
"method": "GET",
"summary": "Get an individual connection",
"description": "Get details for an individual virtual connection. For increased security, connection endpoints require an\nEnterprise Admin Token. This token can be found under\n[Advanced Settings](https://data.world/settings/advanced).",
"tags": [
"connections"
],
"operationId": "getConnection",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string",
"minLength": 1
}
},
{
"name": "id",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": null,
"responses": {
"200": {
"description": "default response",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ConnectionDto"
},
"example": null
}
}
},
{
"path": "/dataquality/audits/{orgAgentId}",
"method": "GET",
"summary": "Show data quality audits",
"description": "Shows audits that happened during processing of data quality inputs.\nOne of \"requestId\" or \"resourceIri\" needs to be provided.\nOnly errors are tracked. Audits expire 1 day after creation. Returns a maximum of 100 audits.\nIf there are no audits, it is likely the request was executed successfully.\n\nAccess requirement: Requires an admin token. It also requires admin access to the organization.\n\nThis endpoint is in active development. Its definition and behavior may change frequently and without notice.",
"tags": [
"data quality",
"experimental"
],
"operationId": "getAudits",
"parameters": [
{
"name": "orgAgentId",
"in": "path",
"required": true,
"description": "organization agent ID",
"schema": {
"type": "string"
}
},
{
"name": "requestId",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "resourceIri",
"in": "query",
"required": false,
"description": "Internationalized Resource Identifier (IRI) of the resource. You can find the IRI in the Technical Reference section under the Settings tab on the resource\u2019s catalog page.",
"schema": {
"type": "string"
}
}
],
"requestBody": null,
"responses": {
"200": {
"description": "Successful operation",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/DataQualityAuditsDto"
},
"example": null
},
"400": {
"description": "Bad Request",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
},
"401": {
"description": "User is unauthorized to perform action",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
},
"403": {
"description": "Access forbidden",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
},
"500": {
"description": "Server error",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
}
}
},
{
"path": "/dataquality/badges/{orgAgentId}",
"method": "POST",
"summary": "Add Badges",
"description": "Associate a metadata resource with a Badge that describes its overall data quality status.\n\nAccess requirement: Requires an admin token. It also requires admin access to the organization.\n\nThis endpoint is in active development. Its definition and behavior may change frequently and without notice.",
"tags": [
"data quality",
"experimental"
],
"operationId": "addBadges",
"parameters": [
{
"name": "orgAgentId",
"in": "path",
"required": true,
"description": "organization agent ID",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/BadgesDto"
},
"example": null
},
"responses": {
"202": {
"description": "Accepted",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/SuccessMessage"
},
"example": null
},
"400": {
"description": "Bad Request",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
},
"401": {
"description": "User is unauthorized to perform action",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
},
"403": {
"description": "Access forbidden",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
},
"404": {
"description": "Not found",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
},
"500": {
"description": "Server error",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
}
}
},
{
"path": "/dataquality/checkruns/{orgAgentId}",
"method": "POST",
"summary": "Add Check Runs",
"description": "Add executions of a check against a metadata resource.\n\nAccess requirement: Requires an admin token. It also requires admin access to the organization.\n\nThis endpoint is in active development. Its definition and behavior may change frequently and without notice.",
"tags": [
"data quality",
"experimental"
],
"operationId": "addCheckRuns",
"parameters": [
{
"name": "orgAgentId",
"in": "path",
"required": true,
"description": "organization agent ID",
"schema": {
"type": "string"
}
},
{
"name": "collectionIri",
"in": "query",
"required": true,
"description": "The collection to insert resources in. Identified by IRI. You can find the IRI in the Technical Reference section under the Settings tab on the resource\u2019s catalog page.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/CheckRunsDto"
},
"example": null
},
"responses": {
"202": {
"description": "Accepted",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/SuccessMessage"
},
"example": null
},
"400": {
"description": "Bad Request",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
},
"401": {
"description": "User is unauthorized to perform action",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
},
"403": {
"description": "Access forbidden",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
},
"404": {
"description": "Not found",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
},
"500": {
"description": "Server error",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
}
}
},
{
"path": "/dataquality/checks/delete/{orgAgentId}",
"method": "POST",
"summary": "Delete data quality checks",
"description": "Asynchronously delete data quality Checks and all associated Check Versions and Check Runs.\n\nThis operation enqueues delete requests for background processing. The response indicates\nhow many requests were successfully enqueued, not how many deletions have completed.\n\nResponse fields:\n- success: Number of delete requests successfully enqueued\n- failed: Number of delete requests that failed to enqueue\n- requestId: Correlation ID for tracking\n\nAccess requirement: Requires an admin token. It also requires admin access to the organization.\n\nThis endpoint is in active development. Its definition and behavior may change frequently and without notice.",
"tags": [
"data quality",
"experimental"
],
"operationId": "deleteChecks",
"parameters": [
{
"name": "orgAgentId",
"in": "path",
"required": true,
"description": "organization agent ID",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/DeleteChecksDto"
},
"example": null
},
"responses": {
"202": {
"description": "Accepted",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/SuccessMessage"
},
"example": null
},
"400": {
"description": "Bad Request",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
},
"401": {
"description": "User is unauthorized to perform action",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
},
"403": {
"description": "Access forbidden",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
},
"500": {
"description": "Server error",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": null
}
}
},
{
"path": "/datasets/{owner}",
"method": "GET",
"summary": "List datasets for a specified owner",
"description": "List datasets that the currently authenticated user has access to, for the specified owner; when the\ndataset is open, private (but discoverable by the authenticated user) or the authenticated user is a\ncontributor with discover visibility",
"tags": [
"datasets"
],
"operationId": "getDatasetsByOwner",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "owner",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"description": "Number of results to return",
"schema": {
"type": "integer",
"format": "int32",
"default": 10,
"maximum": 100,
"minimum": 1
}
},
{
"name": "next",
"in": "query",
"required": false,
"description": "A token supplied by the previous response to retrieve the next page of results",
"schema": {
"type": "string"
}
}
],
"requestBody": null,
"responses": {
"200": {
"description": "default response",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/PaginatedDatasetResults"
},
"example": null
}
}
},
{
"path": "/datasets/{owner}",
"method": "POST",
"summary": "Create a dataset",
"description": "Create a new dataset.",
"tags": [
"datasets"
],
"operationId": "createDataset",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/DatasetCreateRequest"
},
"example": null
},
"responses": {
"200": {
"description": "Dataset created successfully.",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/CreateDatasetResponse"
},
"example": null
}
}
},
{
"path": "/datasets/{owner}/{id}",
"method": "DELETE",
"summary": "Delete a dataset",
"description": "Delete a dataset and associated data. This operation cannot be undone, but you may recreate the dataset\nusing the same id.",
"tags": [
"datasets"
],
"operationId": "deleteDataset",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": null,
"responses": {
"200": {
"description": "default response",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/SuccessMessage"
},
"example": null
}
}
},
{
"path": "/datasets/{owner}/{id}",
"method": "GET",
"summary": "Retrieve a dataset",
"description": "Retrieve a dataset. The definition of the dataset will be returned, not its data. Use\n`GET:/download/{owner}/{id}` or `GET:/file_download/{owner}/{id}/{file}` to retrieve the original files\ncontent, or `POST:/sql/{owner}/{id}` or `POST:/sparql/{owner}/{id}` to query the data.",
"tags": [
"datasets"
],
"operationId": "getDataset",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": null,
"responses": {
"200": {
"description": "default response",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/DatasetSummaryResponse"
},
"example": null
}
}
},
{
"path": "/datasets/{owner}/{id}",
"method": "PATCH",
"summary": "Update a dataset",
"description": "Update an existing dataset. Only elements included in the request will be updated. All omitted elements\nwill remain untouched. Requesting change in a list replaces the entire list. Requesting an element to be\nnull deletes all values on the element.",
"tags": [
"datasets"
],
"operationId": "patchDataset",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/DatasetPatchRequest"
},
"example": null
},
"responses": {
"200": {
"description": "default response",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/SuccessMessage"
},
"example": null
}
}
},
{
"path": "/datasets/{owner}/{id}",
"method": "PUT",
"summary": "Create / Replace a dataset",
"description": "Create or replace a dataset with a given id. If a dataset exists with the same id, this call will reset\nsuch dataset and all the data contained in it.",
"tags": [
"datasets"
],
"operationId": "replaceDataset",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/DatasetPutRequest"
},
"example": null
},
"responses": {
"200": {
"description": "default response",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/SuccessMessage"
},
"example": null
}
}
},
{
"path": "/datasets/{owner}/{id}/dois/{doi}",
"method": "DELETE",
"summary": "Delete dataset DOI",
"description": "Delete a DOI ([Digital Object Identifier](https://www.doi.org/)) associated with a dataset.",
"tags": [
"DOIs"
],
"operationId": "deleteDoi",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "doi",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": null,
"responses": {
"200": {
"description": "default response",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/SuccessMessage"
},
"example": null
}
}
},
{
"path": "/datasets/{owner}/{id}/dois/{doi}",
"method": "PUT",
"summary": "Create dataset DOI",
"description": "Associate a DOI ([Digital Object Identifier](https://www.doi.org/)) with a dataset.",
"tags": [
"DOIs"
],
"operationId": "addDoi",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "doi",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": null,
"responses": {
"200": {
"description": "default response",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/SuccessMessage"
},
"example": null
}
}
},
{
"path": "/datasets/{owner}/{id}/files",
"method": "DELETE",
"summary": "Delete files",
"description": "Delete one or more files from a dataset.\n\n**Batching**\nNote that the `name` parameter can be include multiple times in the query string, once for each file that is to be deleted together in a single request.",
"tags": [
"files"
],
"operationId": "deleteFilesAndSyncSources",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string",
"minLength": 1
}
},
{
"name": "id",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string",
"minLength": 1
}
},
{
"name": "name",
"in": "query",
"required": true,
"description": "",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"requestBody": null,
"responses": {
"200": {
"description": "default response",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/SuccessMessage"
},
"example": null
}
}
},
{
"path": "/datasets/{owner}/{id}/files",
"method": "POST",
"summary": "Add files from URLs",
"description": "Add files from URLs to a dataset. This method allows files published on the web to be added to a\ndata.world dataset via their URL. This method can also be used to retrieve data via web APIs, with\nadvanced options for http method, request payload and authentication.\n\nThe source URL will be stored so you can easily update your file anytime it changes via the *fetch latest*\nlink on the [data.world](https://data.world/) dataset page or by triggering the `GET:/sync` endpoint.",
"tags": [
"files"
],
"operationId": "addFilesBySource",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string",
"minLength": 1
}
},
{
"name": "id",
"in": "path",
"required": true,
"description": "",
"schema": {
"type": "string",
"minLength": 1
}
}
],
"requestBody": {
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/FileBatchUpdateRequest"
},
"example": null
},
"responses": {
"200": {
"description": "default response",
"contentType": "application/json",
"schema": {
"$ref": "#/components/schemas/SuccessMessage"
},
"example": null
}
}
},
{
"path": "/datasets/{owner}/{id}/files/{file}",
"method": "DELETE",
"summary": "Delete a file",
"description": "Delete a single file from a dataset.",
"tags": [
"files"
],
"operationId": "deleteFileAndSyncSource",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"description": "",
# --- truncated at 32 KB (264 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/data-world/refs/heads/main/examples/api-examples.json