{ "openapi" : "3.1.0", "info" : { "contact" : { "name" : "Contact Us", "url" : "https://data.world/company/contact-us" }, "termsOfService" : "https://data.world/terms-policies", "title" : "data.world Public API", "version" : "0" }, "servers" : [ { "url" : "/v0" } ], "security" : [ { "bearerAuth" : [ ] } ], "tags" : [ { "description" : "Manage relationships between catalog resources", "name" : "catalog relationships" }, { "name" : "catalog resources" }, { "name" : "connections" }, { "description" : "Manage data quality of metadata resources", "name" : "data quality" }, { "name" : "datasets" }, { "name" : "DOIs" }, { "description" : "This API is in active development. Its definition may change frequently and without notice.", "name" : "experimental" }, { "name" : "download" }, { "name" : "files" }, { "name" : "insights" }, { "name" : "legacy catalog - analysis" }, { "name" : "legacy catalog - collections" }, { "name" : "legacy catalog - data" }, { "name" : "legacy catalog - glossary" }, { "name" : "legacy catalog - properties" }, { "name" : "legacy catalog - relationships" }, { "name" : "organizations" }, { "name" : "projects" }, { "name" : "queries" }, { "description" : "Manage authorization requests", "name" : "requests - authorization" }, { "description" : "Manage resource requests", "name" : "requests - resource" }, { "name" : "search" }, { "name" : "serviceaccount" }, { "name" : "streams" }, { "name" : "tables" }, { "name" : "user" }, { "name" : "users" }, { "name" : "webhooks" }, { "name" : "instance admin" }, { "name" : "telemetry" }, { "name" : "topics and comments - resource" } ], "paths" : { "/cancel" : { "post" : { "description" : "Cancel a running query.", "operationId" : "cancel", "parameters" : [ { "in" : "query", "name" : "queryruntoken", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "*/*" : { } }, "description" : "default response" } }, "summary" : "Cancel a query", "tags" : [ "queries" ] } }, "/connections/test" : { "post" : { "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).", "operationId" : "testConnection", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConnectionDto" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PingStatusDto" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "User is unauthorized to perform action" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Access forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Not found" }, "422" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Unable to parse request. URLs provided must be fully-formed http or https URLs" }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Server error" } }, "summary" : "Test a connection", "tags" : [ "connections" ] } }, "/connections/{owner}" : { "get" : { "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).", "operationId" : "getConnectionsByOwner", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int32", "default" : 10 } }, { "in" : "query", "name" : "from", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedConnectionResults" } } }, "description" : "default response" } }, "summary" : "Get connections by owner", "tags" : [ "connections" ] }, "post" : { "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).", "operationId" : "createConnection", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Validate connection before save", "in" : "query", "name" : "validate", "schema" : { "type" : "boolean", "default" : true } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConnectionDto" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateResponse" } } }, "description" : "Connection created successfully." } }, "summary" : "Create a new connection", "tags" : [ "connections" ] } }, "/connections/{owner}/{id}" : { "delete" : { "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).", "operationId" : "deleteConnection", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Delete a Connection", "tags" : [ "connections" ] }, "get" : { "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).", "operationId" : "getConnection", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConnectionDto" } } }, "description" : "default response" } }, "summary" : "Get an individual connection", "tags" : [ "connections" ] } }, "/dataquality/audits/{orgAgentId}" : { "get" : { "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.", "operationId" : "getAudits", "parameters" : [ { "description" : "organization agent ID", "in" : "path", "name" : "orgAgentId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "requestId", "schema" : { "type" : "string" } }, { "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’s catalog page.", "in" : "query", "name" : "resourceIri", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DataQualityAuditsDto" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "User is unauthorized to perform action" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Access forbidden" }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Server error" } }, "summary" : "Show data quality audits", "tags" : [ "data quality", "experimental" ] } }, "/dataquality/badges/{orgAgentId}" : { "post" : { "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.", "operationId" : "addBadges", "parameters" : [ { "description" : "organization agent ID", "in" : "path", "name" : "orgAgentId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BadgesDto" } } }, "required" : true }, "responses" : { "202" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "Accepted" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "User is unauthorized to perform action" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Access forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Not found" }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Server error" } }, "summary" : "Add Badges", "tags" : [ "data quality", "experimental" ] } }, "/dataquality/checkruns/{orgAgentId}" : { "post" : { "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.", "operationId" : "addCheckRuns", "parameters" : [ { "description" : "organization agent ID", "in" : "path", "name" : "orgAgentId", "required" : true, "schema" : { "type" : "string" } }, { "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’s catalog page.", "in" : "query", "name" : "collectionIri", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CheckRunsDto" } } }, "required" : true }, "responses" : { "202" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "Accepted" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "User is unauthorized to perform action" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Access forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Not found" }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Server error" } }, "summary" : "Add Check Runs", "tags" : [ "data quality", "experimental" ] } }, "/dataquality/checks/delete/{orgAgentId}" : { "post" : { "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.", "operationId" : "deleteChecks", "parameters" : [ { "description" : "organization agent ID", "in" : "path", "name" : "orgAgentId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DeleteChecksDto" } } }, "required" : true }, "responses" : { "202" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "Accepted" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "User is unauthorized to perform action" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Access forbidden" }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Server error" } }, "summary" : "Delete data quality checks", "tags" : [ "data quality", "experimental" ] } }, "/datasets/{owner}" : { "get" : { "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", "operationId" : "getDatasetsByOwner", "parameters" : [ { "in" : "query", "name" : "fields", "schema" : { "type" : "string" } }, { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Number of results to return", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "A token supplied by the previous response to retrieve the next page of results", "in" : "query", "name" : "next", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedDatasetResults" } } }, "description" : "default response" } }, "summary" : "List datasets for a specified owner", "tags" : [ "datasets" ] }, "post" : { "description" : "Create a new dataset.", "operationId" : "createDataset", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatasetCreateRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDatasetResponse" } } }, "description" : "Dataset created successfully." } }, "summary" : "Create a dataset", "tags" : [ "datasets" ] } }, "/datasets/{owner}/{id}" : { "delete" : { "description" : "Delete a dataset and associated data. This operation cannot be undone, but you may recreate the dataset\nusing the same id.", "operationId" : "deleteDataset", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Delete a dataset", "tags" : [ "datasets" ] }, "get" : { "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.", "operationId" : "getDataset", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatasetSummaryResponse" } } }, "description" : "default response" } }, "summary" : "Retrieve a dataset", "tags" : [ "datasets" ] }, "patch" : { "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.", "operationId" : "patchDataset", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatasetPatchRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Update a dataset", "tags" : [ "datasets" ] }, "put" : { "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.", "operationId" : "replaceDataset", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatasetPutRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Create / Replace a dataset", "tags" : [ "datasets" ] } }, "/datasets/{owner}/{id}/dois/{doi}" : { "delete" : { "description" : "Delete a DOI ([Digital Object Identifier](https://www.doi.org/)) associated with a dataset.", "operationId" : "deleteDoi", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "doi", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Delete dataset DOI", "tags" : [ "DOIs" ] }, "put" : { "description" : "Associate a DOI ([Digital Object Identifier](https://www.doi.org/)) with a dataset.", "operationId" : "addDoi", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "doi", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Create dataset DOI", "tags" : [ "DOIs" ] } }, "/datasets/{owner}/{id}/files" : { "delete" : { "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.", "operationId" : "deleteFilesAndSyncSources", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "query", "name" : "name", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Delete files", "tags" : [ "files" ] }, "post" : { "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.", "operationId" : "addFilesBySource", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FileBatchUpdateRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Add files from URLs", "tags" : [ "files" ] } }, "/datasets/{owner}/{id}/files/{file}" : { "delete" : { "description" : "Delete a single file from a dataset.", "operationId" : "deleteFileAndSyncSource", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "description" : "Filename", "in" : "path", "name" : "file", "required" : true, "schema" : { "type" : "string", "maxLength" : 128, "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Delete a file", "tags" : [ "files" ] } }, "/datasets/{owner}/{id}/files/{file}/metadata" : { "get" : { "description" : "Get file description and labels", "operationId" : "getFileMetadata", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "file", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FileMetadataResponse" } } }, "description" : "default response" } }, "summary" : "Get file description and labels", "tags" : [ "files" ] }, "patch" : { "description" : "Update file description and labels. Only elements included in the request will be updated. All omitted\nelements will remain untouched. Requesting change in a list replaces the entire list. Requesting an element\nto be null deletes all values on the element.", "operationId" : "patchFileMetadata", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "file", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FileMetadataUpdateRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Update file description and labels", "tags" : [ "files" ] }, "put" : { "description" : "Replace file description and labels", "operationId" : "putFileMetadata", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "file", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FileMetadataUpdateRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Replace file description and labels", "tags" : [ "files" ] } }, "/datasets/{owner}/{id}/queries" : { "get" : { "description" : "List published saved queries associated with a dataset. Query definitions will be returned, not the query results.\nTo retrieve query results use `GET:/queries/{id}/results`.", "operationId" : "getPublishedDatasetQueries", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Number of results to return", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "A token supplied by the previous response to retrieve the next page of results", "in" : "query", "name" : "next", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedQueryResults" } } }, "description" : "default response" } }, "summary" : "List published queries", "tags" : [ "queries" ] }, "post" : { "description" : "Create a saved query in a specified dataset.", "operationId" : "createSavedQuery", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateQueryRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QuerySummaryResponse" } } }, "description" : "default response" } }, "summary" : "Create a saved query in a specified dataset", "tags" : [ "queries" ] } }, "/datasets/{owner}/{id}/queries/{queryId}" : { "delete" : { "description" : "Delete a saved query in a specified dataset.", "operationId" : "deleteSavedQuery", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "queryId", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Delete a saved query in a specified dataset", "tags" : [ "queries" ] }, "put" : { "description" : "Update a saved query in a specified dataset.", "operationId" : "updateSavedQuery", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "queryId", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QueryPutRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QuerySummaryResponse" } } }, "description" : "default response" } }, "summary" : "Update a saved query in a specified dataset", "tags" : [ "queries" ] } }, "/datasets/{owner}/{id}/sync" : { "get" : { "description" : "Same as `POST:/dataset/{owner}/{id}/sync`. The id parameter can either be a dataset id or project id.", "operationId" : "syncViaGet", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Sync files (via GET)", "tags" : [ "files" ] }, "post" : { "description" : "Sync files within a dataset or project. This method will process the latest data available for files added\nfrom URLs or via streams. The id parameter can either be a dataset id or project id.", "operationId" : "sync", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Sync files", "tags" : [ "files" ] } }, "/datasets/{owner}/{id}/sync/{filename}" : { "get" : { "operationId" : "syncFileViaGet", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "filename", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Fetch latest file from source and update dataset — via GET, for convenience.", "tags" : [ "datasets" ] }, "post" : { "operationId" : "syncFile", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "filename", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Fetch latest file from source and update dataset.", "tags" : [ "datasets" ] } }, "/datasets/{owner}/{id}/tables" : { "post" : { "description" : "Add tables from an established virtual connection. For increased security, endpoints that interact with\nexternal connection sources require an Enterprise Admin Token. This token can be found under\n[Advanced Settings](https://data.world/settings/advanced). To learn more about the virtual connections\ndata.world supports, please visit our\n[help portal](https://help.data.world/hc/en-us/sections/360009504254-Create-and-manage-virtual-connections).", "operationId" : "addTables", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TableBatchUpdateRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Add live tables from a virtual connection", "tags" : [ "tables" ] } }, "/datasets/{owner}/{id}/userQueries" : { "get" : { "description" : "List user saved queries associated with a dataset. Query definitions will be returned, not the query results.\nTo retrieve query results use `GET:/queries/{id}/results`.", "operationId" : "getUserSavedDatasetQueries", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Number of results to return", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "A token supplied by the previous response to retrieve the next page of results", "in" : "query", "name" : "next", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedQueryResults" } } }, "description" : "default response" } }, "summary" : "List user saved queries", "tags" : [ "queries" ] } }, "/datasets/{owner}/{id}/v/{versionId}" : { "get" : { "description" : "Retrieve a version of a dataset. The definition of the dataset will be returned, not its data.", "operationId" : "getDatasetByVersion", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "versionId", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatasetSummaryResponse" } } }, "description" : "default response" } }, "summary" : "Retrieve a dataset version", "tags" : [ "datasets" ] } }, "/datasets/{owner}/{id}/v/{versionId}/dois/{doi}" : { "delete" : { "description" : "Delete a DOI ([Digital Object Identifier](https://www.doi.org/)) associated with a version of a dataset.", "operationId" : "deleteVersionDoi", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "versionId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "doi", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Delete dataset version DOI", "tags" : [ "DOIs" ] }, "put" : { "description" : "Associate a DOI ([Digital Object Identifier](https://www.doi.org/)) with a version of a dataset.", "operationId" : "addVersionDoi", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "versionId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "doi", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Create dataset version DOI", "tags" : [ "DOIs" ] } }, "/download/{owner}/{id}" : { "get" : { "description" : "Download a .zip file containing all files within a dataset as originally uploaded. Prefer `POST:/sql` or\n`POST:/sparql` for retrieving clean and structured data.", "operationId" : "downloadDataset", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/zip" : { } }, "description" : "default response" } }, "summary" : "Download a dataset", "tags" : [ "datasets" ] } }, "/file_download/{owner}/{id}/{file}" : { "get" : { "description" : "Download a file within the dataset as originally uploaded. Prefer `POST:/sql` or `POST:/sparql` for\nretrieving clean and structured data.", "operationId" : "downloadFile", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "file", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { } }, "description" : "default response" } }, "summary" : "Download a file", "tags" : [ "files" ] } }, "/insights/{projectOwner}/{projectId}" : { "get" : { "description" : "List insights associated with a project.", "operationId" : "getInsightsForProject", "parameters" : [ { "in" : "path", "name" : "projectOwner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "projectId", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Number of results to return", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "A token supplied by the previous response to retrieve the next page of results", "in" : "query", "name" : "next", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedInsightResults" } } }, "description" : "default response" } }, "summary" : "List insights", "tags" : [ "insights" ] }, "post" : { "description" : "Create a new insight.", "operationId" : "createInsight", "parameters" : [ { "in" : "path", "name" : "projectOwner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "projectId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InsightCreateRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateInsightResponse" } } }, "description" : "Insight created successfully." } }, "summary" : "Create an insight", "tags" : [ "insights" ] } }, "/insights/{projectOwner}/{projectId}/{id}" : { "delete" : { "description" : "Delete an insight.", "operationId" : "deleteInsight", "parameters" : [ { "in" : "path", "name" : "projectOwner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "projectId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Delete an insight", "tags" : [ "insights" ] }, "get" : { "description" : "Retrieve an insight.", "operationId" : "getInsight", "parameters" : [ { "in" : "path", "name" : "projectOwner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "projectId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InsightSummaryResponse" } } }, "description" : "default response" } }, "summary" : "Retrieve an insight", "tags" : [ "insights" ] }, "patch" : { "description" : "Update an insight. Note that only elements included in the request will be updated. All omitted elements\nwill remain untouched.", "operationId" : "updateInsight", "parameters" : [ { "in" : "path", "name" : "projectOwner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "projectId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InsightPatchRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Update an insight", "tags" : [ "insights" ] }, "put" : { "description" : "Replace an insight.", "operationId" : "replaceInsight", "parameters" : [ { "in" : "path", "name" : "projectOwner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "projectId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InsightPutRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Replace an insight", "tags" : [ "insights" ] } }, "/insights/{projectOwner}/{projectId}/{id}/v/{versionId}" : { "get" : { "description" : "Retrieve an insight version.", "operationId" : "getInsightByVersion", "parameters" : [ { "in" : "path", "name" : "projectOwner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "projectId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "in" : "path", "name" : "versionId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InsightSummaryResponse" } } }, "description" : "default response" } }, "summary" : "Retrieve an insight version", "tags" : [ "insights" ] } }, "/instanceAdmin/agents/{agentid}" : { "put" : { "description" : "This operation is only usable in Private Instances and requires the instance admin role permission. See the\n[Get API Tokens](https://developer.data.world/docs/api-getting-started#/step-2-get-the-tokens) documentation\nfor more information.", "operationId" : "createOrUpdateAgent", "parameters" : [ { "description" : "agent id or username", "in" : "path", "name" : "agentid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateOrUpdateUserRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessageDto" } } }, "description" : "default response" } }, "summary" : "Create a new user or update existing one", "tags" : [ "instance admin" ] } }, "/instanceAdmin/agents/{agentid}/deactivate" : { "post" : { "description" : "This operation is only usable in Private Instances and requires the instance admin role permission. See the\n[Get API Tokens](https://developer.data.world/docs/api-getting-started#/step-2-get-the-tokens) documentation\nfor more information.", "operationId" : "deactivateAgent", "parameters" : [ { "description" : "agent id or username", "in" : "path", "name" : "agentid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessageDto" } } }, "description" : "default response" } }, "summary" : "Deactivate specified agent", "tags" : [ "instance admin" ] } }, "/instanceAdmin/agents/{agentid}/reactivate" : { "post" : { "description" : "This operation is only usable in Private Instances and requires the instance admin role permission. See the\n[Get API Tokens](https://developer.data.world/docs/api-getting-started#/step-2-get-the-tokens) documentation\nfor more information.", "operationId" : "activateAgent", "parameters" : [ { "description" : "agent id or username", "in" : "path", "name" : "agentid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessageDto" } } }, "description" : "default response" } }, "summary" : "Reactivate specified agent", "tags" : [ "instance admin" ] } }, "/metadata/analysis/suggest/{owner}/{id}" : { "patch" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "suggestCatalogAnalysis", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataSuggestRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "suggest for an existing analysis", "tags" : [ "legacy catalog - analysis" ] } }, "/metadata/analysis/{owner}" : { "get" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "getCatalogAnalysesByOwner", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "typelabel", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "typeiri", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int32", "default" : 10 } }, { "in" : "query", "name" : "from", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedGenericResultsMetadataResourceDto" } } }, "description" : "default response" } }, "summary" : "Gets metadata analysis by owner.", "tags" : [ "legacy catalog - analysis" ] }, "post" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "createCatalogAnalysis", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateResponse" } } }, "description" : "Analysis Metadata created successfully." } }, "summary" : "Create a new analysis metadata.", "tags" : [ "legacy catalog - analysis" ] } }, "/metadata/analysis/{owner}/{id}" : { "delete" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "deleteCatalogAnalysis", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Delete an Analysis.", "tags" : [ "legacy catalog - analysis" ] }, "get" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "getCatalogAnalysis", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataResourceDto" } } }, "description" : "default response" } }, "summary" : "Get an individual metadata analysis", "tags" : [ "legacy catalog - analysis" ] }, "patch" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "patchCatalogAnalysis", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Update an existing analysis.", "tags" : [ "legacy catalog - analysis" ] }, "put" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "replaceCatalogAnalysis", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Replace an existing analysis", "tags" : [ "legacy catalog - analysis" ] } }, "/metadata/collections/{owner}" : { "get" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "getCatalogs", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int32", "default" : 10 } }, { "in" : "query", "name" : "from", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedSearchResultsDtoMetadataResourceDto" } } }, "description" : "default response" } }, "summary" : "Gets collections owned by specified owner", "tags" : [ "legacy catalog - collections" ] }, "post" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "createCatalog", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateResponse" } } }, "description" : "Collection created successfully." } }, "summary" : "Creates a new collection", "tags" : [ "legacy catalog - collections" ] } }, "/metadata/collections/{owner}/{id}" : { "delete" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "deleteCatalog", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Deletes a collection", "tags" : [ "legacy catalog - collections" ] }, "get" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "getCatalog", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataResourceDto" } } }, "description" : "default response" } }, "summary" : "Gets a collection by ID", "tags" : [ "legacy catalog - collections" ] }, "patch" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "updateCatalog", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Updates a collection", "tags" : [ "legacy catalog - collections" ] }, "put" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "replaceCatalog", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Replaces a collection", "tags" : [ "legacy catalog - collections" ] } }, "/metadata/data/sources/suggest/{owner}/{sourceid}/tables/{tableid}" : { "patch" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "suggestCatalogTable", "parameters" : [ { "description" : "id of the user or organization", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "description" : "database source id", "in" : "path", "name" : "sourceid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "tableid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogTableSuggestRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "suggest for an existing table.", "tags" : [ "legacy catalog - data" ] } }, "/metadata/data/sources/{owner}" : { "get" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "getDatabases", "parameters" : [ { "description" : "id of the user or organization", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int32", "default" : 10 } }, { "in" : "query", "name" : "from", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedDatabaseResults" } } }, "description" : "default response" } }, "summary" : "Gets datasources by owner.", "tags" : [ "legacy catalog - data" ] } }, "/metadata/data/sources/{owner}/{sourceid}" : { "get" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "getDatabase", "parameters" : [ { "description" : "id of the user or organization", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "description" : "database source id", "in" : "path", "name" : "sourceid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatabaseDto" } } }, "description" : "default response" } }, "summary" : "Get an individual datasource metadata", "tags" : [ "legacy catalog - data" ] } }, "/metadata/data/sources/{owner}/{sourceid}/tables" : { "get" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "getTables", "parameters" : [ { "description" : "id of the user or organization", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "description" : "database source id", "in" : "path", "name" : "sourceid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "query", "name" : "typelabel", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "typeiri", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int32", "default" : 10 } }, { "in" : "query", "name" : "from", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedGenericResultsMetadataResourceDto" } } }, "description" : "default response" } }, "summary" : "Get tables for a data source", "tags" : [ "legacy catalog - data" ] }, "post" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "createCatalogTable", "parameters" : [ { "description" : "id of the user or organization", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "description" : "database source id", "in" : "path", "name" : "sourceid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogTableRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateResponse" } } }, "description" : "Table Metadata created successfully." } }, "summary" : "Create a new table metadata.", "tags" : [ "legacy catalog - data" ] } }, "/metadata/data/sources/{owner}/{sourceid}/tables/iri/{tableiri}" : { "patch" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "patchCatalogTableByIri", "parameters" : [ { "description" : "id of the user or organization", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "description" : "database source id", "in" : "path", "name" : "sourceid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "tableiri", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogTableRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Update an existing table identified by IRI.", "tags" : [ "legacy catalog - data" ] } }, "/metadata/data/sources/{owner}/{sourceid}/tables/{tableid}" : { "delete" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "deleteCatalogTable", "parameters" : [ { "description" : "id of the user or organization", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "description" : "database source id", "in" : "path", "name" : "sourceid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "tableid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Delete a table.", "tags" : [ "legacy catalog - data" ] }, "get" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "getTable", "parameters" : [ { "description" : "id of the user or organization", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "description" : "database source id", "in" : "path", "name" : "sourceid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "tableid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "query", "name" : "schema", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataResourceDto" } } }, "description" : "default response" } }, "summary" : "Get an individual table metadata", "tags" : [ "legacy catalog - data" ] }, "patch" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "patchCatalogTable", "parameters" : [ { "description" : "id of the user or organization", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "description" : "database source id", "in" : "path", "name" : "sourceid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "tableid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "query", "name" : "schema", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogTableRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Update an existing table.", "tags" : [ "legacy catalog - data" ] }, "put" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "replaceCatalogTable", "parameters" : [ { "description" : "id of the user or organization", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "description" : "database source id", "in" : "path", "name" : "sourceid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "tableid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogTableRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Replace an existing table", "tags" : [ "legacy catalog - data" ] } }, "/metadata/data/sources/{owner}/{sourceid}/tables/{tableid}/columns" : { "get" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "getTableColumns", "parameters" : [ { "description" : "id of the user or organization", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "description" : "database source id", "in" : "path", "name" : "sourceid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "tableid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int32", "default" : 10 } }, { "in" : "query", "name" : "from", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedGenericResultsMetadataResourceDto" } } }, "description" : "default response" } }, "summary" : "Get columns for a given table", "tags" : [ "legacy catalog - data" ] }, "post" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "createCatalogColumn", "parameters" : [ { "description" : "id of the user or organization", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "description" : "database source id", "in" : "path", "name" : "sourceid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "tableid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogColumnRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateResponse" } } }, "description" : "Column Metadata created successfully." } }, "summary" : "Create a Column.", "tags" : [ "legacy catalog - data" ] } }, "/metadata/data/sources/{owner}/{sourceid}/tables/{tableid}/columns/{columnid}" : { "delete" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "deleteCatalogColumn", "parameters" : [ { "description" : "id of the user or organization", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "description" : "database source id", "in" : "path", "name" : "sourceid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "tableid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "columnid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Delete a Column.", "tags" : [ "legacy catalog - data" ] }, "get" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "getTableColumn", "parameters" : [ { "description" : "id of the user or organization", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "description" : "database source id", "in" : "path", "name" : "sourceid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "tableid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "columnid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataResourceDto" } } }, "description" : "default response" } }, "summary" : "Get an individual column metadata", "tags" : [ "legacy catalog - data" ] }, "patch" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "patchCatalogColumn", "parameters" : [ { "description" : "id of the user or organization", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "description" : "database source id", "in" : "path", "name" : "sourceid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "tableid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "columnid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogColumnRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Update an existing Column.", "tags" : [ "legacy catalog - data" ] }, "put" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "replaceCatalogColumn", "parameters" : [ { "description" : "id of the user or organization", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "description" : "database source id", "in" : "path", "name" : "sourceid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "tableid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "columnid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogColumnRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Replace an existing column", "tags" : [ "legacy catalog - data" ] } }, "/metadata/glossary/suggest/{owner}/{id}" : { "patch" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "suggestCatalogGlossary", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataSuggestRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "suggest for an existing glossary.", "tags" : [ "legacy catalog - glossary" ] } }, "/metadata/glossary/{owner}" : { "get" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "getCatalogGlossariesByOwner", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "typelabel", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "typeiri", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int32", "default" : 10 } }, { "in" : "query", "name" : "from", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedGenericResultsMetadataResourceDto" } } }, "description" : "default response" } }, "summary" : "Gets metadata glossary by owner.", "tags" : [ "legacy catalog - glossary" ] }, "post" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "createCatalogGlossary", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateResponse" } } }, "description" : "Glossary Metadata created successfully." } }, "summary" : "Create a new glossary metadata.", "tags" : [ "legacy catalog - glossary" ] } }, "/metadata/glossary/{owner}/{id}" : { "delete" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "deleteCatalogGlossary", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Delete a Glossary.", "tags" : [ "legacy catalog - glossary" ] }, "get" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "getCatalogGlossary", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataResourceDto" } } }, "description" : "default response" } }, "summary" : "Get an individual metadata glossary", "tags" : [ "legacy catalog - glossary" ] }, "patch" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "patchCatalogGlossary", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Update an existing glossary.", "tags" : [ "legacy catalog - glossary" ] }, "put" : { "description" : "Please refer to the updated IRI-based resource endpoints.", "operationId" : "replaceCatalogGlossary", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MetadataRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Replace an existing glossary", "tags" : [ "legacy catalog - glossary" ] } }, "/metadata/relationships/{owner}" : { "post" : { "description" : "Please refer to the updated IRI-based relationship endpoints.", "operationId" : "createRelationship", "parameters" : [ { "description" : "User name and unique identifier of the user or organization a resource belongs to.\nFor example, in the URL: https://acme.data.world/jonloyens/an-intro-to-dataworld-dataset, jonloyens is the unique identifier of the owner.\n", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelationshipCreateOrDeleteRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Legacy - Creates a relationship between two catalog resources", "tags" : [ "legacy catalog - relationships" ] } }, "/metadata/relationships/{owner}/delete" : { "post" : { "description" : "Please refer to the updated IRI-based relationship endpoints.", "operationId" : "deleteRelationship", "parameters" : [ { "description" : "User name and unique identifier of the user or organization a resource belongs to.\nFor example, in the URL: https://acme.data.world/jonloyens/an-intro-to-dataworld-dataset, jonloyens is the unique identifier of the owner.\n", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelationshipCreateOrDeleteRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Legacy - Deletes a relationship between two catalog resources", "tags" : [ "legacy catalog - relationships" ] } }, "/metadata/relationships/{owner}/iri" : { "post" : { "description" : "If a resource A is related to resource B and C, this endpoint will return B and C. See request body for further filtering options.", "operationId" : "getRelationshipsByIri", "parameters" : [ { "description" : "User name and unique identifier of the user or organization a resource belongs to.\nFor example, in the URL: https://acme.data.world/jonloyens/an-intro-to-dataworld-dataset, jonloyens is the unique identifier of the owner.\n", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "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’s catalog page.", "in" : "query", "name" : "iri", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "description" : "Return additional information about the resource. For example, if the resource is in a collection, the collection IRI will be returned by default. If hydration is enabled, the collection's title and description will also be returned.", "in" : "query", "name" : "hydrations", "schema" : { "type" : "boolean", "default" : false } }, { "description" : "Number of results to return", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "A token supplied by the previous response to retrieve the next page of results", "in" : "query", "name" : "next", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelationshipGetRequestByIri" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedGenericResultsMetadataResourceDtoV2" } } }, "description" : "default response" } }, "summary" : "Get resources that are related to a resource identified by IRI", "tags" : [ "catalog relationships" ] } }, "/metadata/relationships/{owner}/iri/create" : { "post" : { "description" : "Creates a directed relationship between two catalog resources with one being the source and the other being the target.", "operationId" : "createRelationshipByIri", "parameters" : [ { "description" : "User name and unique identifier of the user or organization a resource belongs to.\nFor example, in the URL: https://acme.data.world/jonloyens/an-intro-to-dataworld-dataset, jonloyens is the unique identifier of the owner.\n", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelationshipCreateOrDeleteRequestByIri" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Creates a relationship between two catalog resources identified by IRI", "tags" : [ "catalog relationships" ] } }, "/metadata/relationships/{owner}/iri/delete" : { "post" : { "description" : "Deletes a directed relationship between two catalog resources with one being the source and the other being the target.", "operationId" : "deleteRelationshipByIri", "parameters" : [ { "description" : "User name and unique identifier of the user or organization a resource belongs to.\nFor example, in the URL: https://acme.data.world/jonloyens/an-intro-to-dataworld-dataset, jonloyens is the unique identifier of the owner.\n", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelationshipCreateOrDeleteRequestByIri" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Deletes a relationship between two catalog resources identified by IRI", "tags" : [ "catalog relationships" ] } }, "/metadata/relationships/{owner}/resource/{resourceId}" : { "post" : { "description" : "Please refer to the updated IRI-based relationship endpoints.", "operationId" : "getRelationships", "parameters" : [ { "description" : "User name and unique identifier of the user or organization a resource belongs to.\nFor example, in the URL: https://acme.data.world/jonloyens/an-intro-to-dataworld-dataset, jonloyens is the unique identifier of the owner.\n", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "resourceId", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "description" : "Number of results to return", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "A token supplied by the previous response to retrieve the next page of results", "in" : "query", "name" : "next", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelationshipGetRequestById" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedGenericResultsMetadataResourceDto" } } }, "description" : "default response" } }, "summary" : "Legacy - Get resources that are related to a resource", "tags" : [ "legacy catalog - relationships" ] } }, "/metadata/relationships/{owner}/table/{sourceId}/{tableId}" : { "post" : { "description" : "Please refer to the updated IRI-based relationship endpoints.", "operationId" : "getTableRelationships", "parameters" : [ { "description" : "User name and unique identifier of the user or organization a resource belongs to.\nFor example, in the URL: https://acme.data.world/jonloyens/an-intro-to-dataworld-dataset, jonloyens is the unique identifier of the owner.\n", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "description" : "ID of dataset that the table is in", "in" : "path", "name" : "sourceId", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "tableId", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "description" : "Number of results to return", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "A token supplied by the previous response to retrieve the next page of results", "in" : "query", "name" : "next", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelationshipGetRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedGenericResultsMetadataResourceDto" } } }, "description" : "default response" } }, "summary" : "Legacy - Get resources that are related to a table", "tags" : [ "legacy catalog - relationships" ] } }, "/metadata/resources/bulk/property/{owner}" : { "patch" : { "description" : "Delete properties from a maximum of 25 resources of any type in the organization at once. To delete properties from a single resource, use \"Delete properties from a resource\".", "operationId" : "bulkDeleteProperty", "parameters" : [ { "description" : "User name and unique identifier of the user or organization a resource belongs to.\nFor example, in the URL: https://acme.data.world/jonloyens/an-intro-to-dataworld-dataset, jonloyens is the unique identifier of the owner.\n", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BulkDeletePropertyRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogResourceBulkResponse" } } }, "description" : "default response" } }, "summary" : "Bulk: delete properties from resources", "tags" : [ "catalog resources" ] } }, "/metadata/resources/bulk/{owner}" : { "patch" : { "description" : "Update a maximum of 25 resources of any type in the organization at once. To create one resource at a time, use \"Create a new resource\". Also, see the aforementioned endpoint for further update behaviors.", "operationId" : "bulkUpdate", "parameters" : [ { "description" : "User name and unique identifier of the user or organization a resource belongs to.\nFor example, in the URL: https://acme.data.world/jonloyens/an-intro-to-dataworld-dataset, jonloyens is the unique identifier of the owner.\n", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Set this option when updating properties that supports having a list of values. Given a list of values in the request body, should this request add to the existing list, remove the specified values, or replace the existing list with the specified values?", "in" : "query", "name" : "updateListBy", "required" : true, "schema" : { "type" : "string", "default" : "ADD", "enum" : [ "ADD", "REMOVE", "REPLACE" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogResourceBulkRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogResourceBulkResponse" } } }, "description" : "default response" } }, "summary" : "Bulk: update multiple resources at once", "tags" : [ "catalog resources" ] }, "post" : { "description" : "Create a maximum of 25 resources of any type in the organization at once. The resources are created with the provided properties. To create one resource at a time, use \"Create a new resource\".", "operationId" : "bulkCreate", "parameters" : [ { "description" : "User name and unique identifier of the user or organization a resource belongs to.\nFor example, in the URL: https://acme.data.world/jonloyens/an-intro-to-dataworld-dataset, jonloyens is the unique identifier of the owner.\n", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogResourceBulkCreateRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogResourceBulkResponse" } } }, "description" : "default response" } }, "summary" : "Bulk: create multiple resources at once", "tags" : [ "catalog resources" ] } }, "/metadata/resources/property/{owner}" : { "delete" : { "description" : "Delete properties from a resource of any type in the organization. To update properties, use \"Update a resource\". To delete properties from multiple resources at once, use \"Bulk: delete properties from resources\".", "operationId" : "deleteProperty", "parameters" : [ { "description" : "User name and unique identifier of the user or organization a resource belongs to.\nFor example, in the URL: https://acme.data.world/jonloyens/an-intro-to-dataworld-dataset, jonloyens is the unique identifier of the owner.\n", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "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’s catalog page.", "in" : "query", "name" : "iri", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Property is identified by its IRI", "in" : "query", "name" : "property", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogResourceResponse" } } }, "description" : "default response" } }, "summary" : "Delete properties from a resource", "tags" : [ "catalog resources" ] } }, "/metadata/resources/search" : { "post" : { "description" : "Search for resources in the organization. See request body for filtering options. To paginate through results, use \"from\" and \"size\" query parameters. To return more details about the resources, see \"hydration\" query parameter.", "operationId" : "searchResources", "parameters" : [ { "description" : "Size of page to fetch", "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 1000 } }, { "description" : "Result number to start fetch from (not the page number to start from)", "in" : "query", "name" : "from", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "description" : "Sort results by fields", "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "Return additional information about the resource. For example, if the resource is in a collection, the collection IRI will be returned by default. If hydration is enabled, the collection's title and description will also be returned.", "in" : "query", "name" : "hydration", "schema" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "agent", "catalog", "catalogConcept", "properties", "resourceHierarchy" ] }, "uniqueItems" : true } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrgScopedSearchRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedGenericResultsOrgScopedSearchedResourceDto" } } }, "description" : "default response" } }, "summary" : "Search for resources", "tags" : [ "catalog resources" ] } }, "/metadata/resources/{owner}" : { "delete" : { "description" : "Delete a resource of any type in the organization.", "operationId" : "delete", "parameters" : [ { "description" : "User name and unique identifier of the user or organization a resource belongs to.\nFor example, in the URL: https://acme.data.world/jonloyens/an-intro-to-dataworld-dataset, jonloyens is the unique identifier of the owner.\n", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "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’s catalog page.", "in" : "query", "name" : "iri", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Delete a resource", "tags" : [ "catalog resources" ] }, "get" : { "description" : "Return details about a resource of any type in the organization. See \"hydrations\" query parameter for options to return even more details.", "operationId" : "getResourceByIRI", "parameters" : [ { "description" : "User name and unique identifier of the user or organization a resource belongs to.\nFor example, in the URL: https://acme.data.world/jonloyens/an-intro-to-dataworld-dataset, jonloyens is the unique identifier of the owner.\n", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "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’s catalog page.", "in" : "query", "name" : "iri", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Return additional information about the resource. For example, if the resource is in a collection, the collection IRI will be returned by default. If hydration is enabled, the collection's title and description will also be returned.", "in" : "query", "name" : "hydrations", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogResourceGetResponse" } } }, "description" : "default response" } }, "summary" : "Get a resource", "tags" : [ "catalog resources" ] }, "patch" : { "description" : "Update a resource of any type in the organization. Properties that are not defined in the request are not updated. When updating properties that have a single value, the old value is replaced by the new value in the request. When updating properties that have a list of values, see \"updateListBy\" query parameter for more granular controls. To delete properties, use \"Delete properties from a resource\". To update multiple resources at once, use \"Bulk: update multiple resources at once\".", "operationId" : "update", "parameters" : [ { "description" : "User name and unique identifier of the user or organization a resource belongs to.\nFor example, in the URL: https://acme.data.world/jonloyens/an-intro-to-dataworld-dataset, jonloyens is the unique identifier of the owner.\n", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "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’s catalog page.", "in" : "query", "name" : "iri", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Set this option when updating properties that supports having a list of values. Given a list of values in the request body, should this request add to the existing list, remove the specified values, or replace the existing list with the specified values?", "in" : "query", "name" : "updateListBy", "required" : true, "schema" : { "type" : "string", "default" : "ADD", "enum" : [ "ADD", "REMOVE", "REPLACE" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogResourceRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogResourceResponse" } } }, "description" : "default response" } }, "summary" : "Update a resource", "tags" : [ "catalog resources" ] }, "post" : { "description" : "Create a new resource of any type in the organization. The resource is created with the provided properties. To create multiple resources at once, use \"Bulk: create multiple resources at once\".", "operationId" : "create", "parameters" : [ { "description" : "User name and unique identifier of the user or organization a resource belongs to.\nFor example, in the URL: https://acme.data.world/jonloyens/an-intro-to-dataworld-dataset, jonloyens is the unique identifier of the owner.\n", "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogResourceCreateRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CatalogResourceResponse" } } }, "description" : "default response" } }, "summary" : "Create a new resource", "tags" : [ "catalog resources" ] } }, "/metadata/{owner}/resources/clear" : { "post" : { "description" : "This is an advanced operation and should be used with caution. The data.world catalog graph relies on a layered model that keeps the content from collected source systems separate from edits made by end users on the platform. This allows the collected source system data to update regularly withoutoverwriting enrichment and curation efforts that are authored on data.world. Sometimes, however, it is desirable to overwrite the end user edits or let the source system metadata replace user edits. This endpoint can be used to clear all end user edits for a given metadata resource or list of resources, restoring the source system values.", "operationId" : "clearMetadataResource", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ClearResourcesRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Clear all user edits from a resource", "tags" : [ "catalog resources" ] } }, "/metadata/{owner}/resources/properties/clear" : { "put" : { "description" : "This is an advanced operation and should be used with caution. The data.world catalog graph relies on a layered model that keeps the content from collected source systems separate from edits made by end users on the platform. This allows the collected source system data to update regularly without overwriting enrichment and curation efforts that are authored on data.world. Sometimes, however, it is desirable to overwrite the end user edits or let the source system metadata replace user edits. This endpoint can be used to clear a specific user-edited metadata field, restoring the source system values.", "operationId" : "clearMetadataResourceProperties", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ClearResourcePropertiesRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Clear all user edits on specified properties from a resource", "tags" : [ "catalog resources" ] } }, "/organizations/{agentid}/authorizations/{teamid}" : { "post" : { "description" : "Authorize a Team to access an organization", "operationId" : "authorizeOrgAccess", "parameters" : [ { "description" : "organization agent ID", "in" : "path", "name" : "agentid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "description" : "team agent ID", "in" : "path", "name" : "teamid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessageDto" } } }, "description" : "default response" } }, "summary" : "Authorize a Team to access an organization", "tags" : [ "organizations" ] } }, "/organizations/{id}" : { "get" : { "description" : "Get organization details", "operationId" : "getOrganizationDetails", "parameters" : [ { "description" : "Organization ID.", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrgDetailsResponse" } } }, "description" : "default response" } }, "summary" : "Get organization details", "tags" : [ "organizations" ] } }, "/projects/{owner}" : { "get" : { "description" : "List projects that the currently authenticated user has access to, for the specified owner; when the\nproject is open, or when project is private but has view/edit/manage permissions for the authenticated user", "operationId" : "getProjectsByOwner", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Number of results to return", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "A token supplied by the previous response to retrieve the next page of results", "in" : "query", "name" : "next", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedProjectResults" } } }, "description" : "default response" } }, "summary" : "List projects for a specified owner", "tags" : [ "projects" ] }, "post" : { "description" : "Create a new project.", "operationId" : "createProject", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProjectCreateRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateProjectResponse" } } }, "description" : "Project created successfully." } }, "summary" : "Create a data project", "tags" : [ "projects" ] } }, "/projects/{owner}/{id}" : { "delete" : { "description" : "Delete a project and associated data. This operation cannot be undone, but you may recreate the project\nusing the same id.", "operationId" : "deleteProject", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Delete a data project", "tags" : [ "projects" ] }, "get" : { "description" : "Retrieve a project. The definition of the project will be returned, not the associated data. Use\n`POST:/sql/{owner}/{id}` or `POST:/sparql/{owner}/{id}` to query the data or use dataset APIs to retrieve\ndata from linked datasets.", "operationId" : "getProject", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProjectSummaryResponse" } } }, "description" : "default response" } }, "summary" : "Retrieve a data project", "tags" : [ "projects" ] }, "patch" : { "description" : "Update an existing project. 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.", "operationId" : "patchProject", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProjectPatchRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Update a data project", "tags" : [ "projects" ] }, "put" : { "description" : "Create or replace a project with a given id. If a project exists with the same id, this call will reset\nsuch project redefining all its attributes.", "operationId" : "replaceProject", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProjectPutRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Create / Replace a data project", "tags" : [ "projects" ] } }, "/projects/{owner}/{id}/linkedDatasets/{linkedDatasetOwner}/{linkedDatasetId}" : { "delete" : { "description" : "Remove a linked dataset from a project.", "operationId" : "removeLinkedDataset", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "linkedDatasetOwner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "linkedDatasetId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Unlink dataset", "tags" : [ "projects" ] }, "put" : { "description" : "Add a linked dataset to a project.", "operationId" : "addLinkedDataset", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "linkedDatasetOwner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "linkedDatasetId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Link dataset", "tags" : [ "projects" ] } }, "/projects/{owner}/{id}/queries" : { "get" : { "description" : "List published saved queries associated with a project.", "operationId" : "getProjectQueries", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Number of results to return", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "A token supplied by the previous response to retrieve the next page of results", "in" : "query", "name" : "next", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedQueryResults" } } }, "description" : "default response" } }, "summary" : "List published queries", "tags" : [ "queries" ] }, "post" : { "description" : "Create a saved query in a specified project.", "operationId" : "createSavedQuery_1", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateQueryRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QuerySummaryResponse" } } }, "description" : "default response" } }, "summary" : "Create a saved query", "tags" : [ "queries" ] } }, "/projects/{owner}/{id}/queries/{queryId}" : { "delete" : { "description" : "Delete a saved query in a specified project.", "operationId" : "deleteSavedQuery_1", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "queryId", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Delete a saved query", "tags" : [ "queries" ] }, "put" : { "description" : "Update a saved query in a specified project.", "operationId" : "updateSavedQuery_1", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "queryId", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QueryPutRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QuerySummaryResponse" } } }, "description" : "default response" } }, "summary" : "Update a saved query", "tags" : [ "queries" ] } }, "/projects/{owner}/{id}/userQueries" : { "get" : { "description" : "List user saved queries associated with a project.", "operationId" : "getUserSavedProjectQueries", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Number of results to return", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "A token supplied by the previous response to retrieve the next page of results", "in" : "query", "name" : "next", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedQueryResults" } } }, "description" : "default response" } }, "summary" : "List saved queries", "tags" : [ "queries" ] } }, "/projects/{owner}/{id}/v/{versionId}" : { "get" : { "description" : "Retrieve a project version. The definition of the project will be returned.", "operationId" : "getProjectByVersion", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "versionId", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProjectSummaryResponse" } } }, "description" : "default response" } }, "summary" : "Retrieve a data project version", "tags" : [ "projects" ] } }, "/properties/{owner}" : { "get" : { "description" : "Get supported metadata properties by owner.\n\nThis endpoint can be used to obtain a reference list of supported custom metadata properties for your\norganization's catalog. Custom properties for resources in your catalog require an ApiBinding to be\nconfigured for use in the public API. For more information about how to correctly configure ApiBindings,\nplease reach out to your data.world support representative or message help@data.world.", "operationId" : "getPropertiesByOwner", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "categorylabel", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "typelabel", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CatalogPropertyDto" } } } }, "description" : "default response" } }, "summary" : "Get supported metadata properties by owner", "tags" : [ "legacy catalog - properties" ] } }, "/queries/{id}" : { "get" : { "description" : "Retrieve a saved query. Query definitions will be returned, not query results. To retrieve query results\nuse `GET:/queries/{id}/results`.", "operationId" : "getQuery", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QuerySummaryResponse" } } }, "description" : "default response" } }, "summary" : "Retrieve a saved query", "tags" : [ "queries" ] } }, "/queries/{id}/results" : { "get" : { "description" : "Execute a saved query.\n\nSQL results are available in a variety of formats. By default, `application/json` will be returned. Set\nthe `Accept` header to one of the following values in accordance with your preference:\n\n* `text/csv`\n* `application/json`\n* `application/json-l`\n* `application/x-ndjson`\n\nSPARQL results are available in a variety of formats. By default, `application/sparql-results+json` will\nbe returned. Set the `Accept` header to one of the following values in accordance with your preference:\n\n- `application/sparql-results+xml`\n- `application/sparql-results+json`\n- `application/rdf+json`\n- `application/rdf+xml`\n- `text/csv`\n- `text/tab-separated-values`\n- `text/turtle`", "operationId" : "executeQuery", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "in" : "query", "name" : "includeTableSchema", "schema" : { "type" : "boolean", "default" : false } }, { "description" : "Query token to use with cancel", "in" : "query", "name" : "queryruntoken", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { }, "application/json-l" : { }, "application/rdf+json" : { }, "application/rdf+xml" : { }, "application/sparql-results+json" : { }, "application/sparql-results+xml" : { }, "application/trig" : { }, "application/x-ndjson" : { }, "text/csv" : { }, "text/tab-separated-values" : { }, "text/turtle" : { } }, "description" : "default response" } }, "summary" : "Execute a saved query", "tags" : [ "queries" ] }, "post" : { "description" : "Execute a saved query (same as GET:/queries/{id}/results) with the option to specify named query\nparameters.", "operationId" : "executeQueryWithPost", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "description" : "Query token to use with cancel", "in" : "query", "name" : "queryruntoken", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SavedQueryExecutionRequest" } } } }, "responses" : { "200" : { "content" : { "application/json" : { }, "application/json-l" : { }, "application/rdf+json" : { }, "application/rdf+xml" : { }, "application/sparql-results+json" : { }, "application/sparql-results+xml" : { }, "application/trig" : { }, "application/x-ndjson" : { }, "text/csv" : { }, "text/tab-separated-values" : { }, "text/turtle" : { } }, "description" : "default response" } }, "summary" : "Execute a saved query (with parameters)", "tags" : [ "queries" ] } }, "/queries/{id}/v/{versionId}" : { "get" : { "description" : "Retrieve a version of a saved query. Query definitions will be returned, not query results.", "operationId" : "getQueryVersion", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "in" : "path", "name" : "versionId", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QuerySummaryResponse" } } }, "description" : "default response" } }, "summary" : "Retrieve a saved query version", "tags" : [ "queries" ] } }, "/requests/accept" : { "post" : { "description" : "Accept a resource request. The defined contribution or transfer will happen. For more details on resource requests, see \"Get a resource request\".", "operationId" : "acceptRequest_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AcceptRequestDto" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessageDto" } } }, "description" : "default response" } }, "summary" : "Accept a resource request", "tags" : [ "requests - resource" ] } }, "/requests/auth" : { "post" : { "description" : "Create a request asking for access against a dataset. A request can ask the resource admin for permission to access a resource. It may also be an invitation from the resource admin to give others access to a resource.", "operationId" : "createAuthRequest", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthRequestCreateDto" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthRequestDto" } } }, "description" : "default response" } }, "summary" : "Create an authorization request", "tags" : [ "requests - authorization" ] } }, "/requests/auth/accept" : { "post" : { "description" : "Accept an authorization request. This will give the grantee access to the resource. For more details about authorization request, see \"Create an authorization request\".", "operationId" : "acceptRequest", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthRequestRespondDto" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessageDto" } } }, "description" : "default response" } }, "summary" : "Accept an authorization request", "tags" : [ "requests - authorization" ] } }, "/requests/auth/approver" : { "get" : { "description" : "Get a list of authorization requests that can be approved or rejected by the user. For more details about authorization request, see \"Create an authorization request\".", "operationId" : "getForApprover", "parameters" : [ { "description" : "Number of results to return", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "A token supplied by the previous response to retrieve the next page of results", "in" : "query", "name" : "next", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedResultsDtoAuthRequestDto" } } }, "description" : "default response" } }, "summary" : "Get authorization requests that can be approved/rejected", "tags" : [ "requests - authorization" ] } }, "/requests/auth/delete" : { "post" : { "description" : "Delete an authorization request. This will delete the request. The grantee will not receive any access to the resource. For more details about authorization request, see \"Create an authorization request\".", "operationId" : "deleteRequest", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthRequestRespondDto" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessageDto" } } }, "description" : "default response" } }, "summary" : "Delete an authorization request", "tags" : [ "requests - authorization" ] } }, "/requests/auth/reject" : { "post" : { "description" : "Reject an authorization request. This will delete the request. The grantee will not receive any access to the resource. For more details about authorization request, see \"Create an authorization request\".", "operationId" : "rejectRequest", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthRequestRespondDto" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessageDto" } } }, "description" : "default response" } }, "summary" : "Reject an authorization request", "tags" : [ "requests - authorization" ] } }, "/requests/owner/{agentid}" : { "get" : { "description" : "Get all resource requests done to resources in an organization. For more details on resource requests, see \"Get a resource request\".", "operationId" : "getRequests", "parameters" : [ { "description" : "organization ID", "in" : "path", "name" : "agentid", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "description" : "Number of results to return", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "A token supplied by the previous response to retrieve the next page of results", "in" : "query", "name" : "next", "schema" : { "type" : "string" } }, { "description" : "Sort results by fields", "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "query", "name" : "includeTaskLinkedRequests", "schema" : { "type" : "boolean", "default" : true } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedGenericResultsPublicResourceRequestDto" } } }, "description" : "default response" } }, "summary" : "Get all resource requests in an organization", "tags" : [ "requests - resource" ] } }, "/requests/reject" : { "post" : { "description" : "Reject a resource request. This deletes the request. For more details on resource requests, see \"Get a resource request\".", "operationId" : "rejectRequest_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RejectRequestDto" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessageDto" } } }, "description" : "default response" } }, "summary" : "Reject a resource request", "tags" : [ "requests - resource" ] } }, "/requests/suggest" : { "post" : { "description" : "This API allows users to submit requests for modifications or contributions to dataset or metadata resources. Users can propose changes or transfers within an organization's collections, specifying details about the resource and type of request through structured parameters.", "operationId" : "createResourceRequest", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicResourceRequestDto" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicResourceRequestDto" } } }, "description" : "default response" } }, "summary" : "Create a resource request", "tags" : [ "requests - resource" ] } }, "/requests/{requestid}" : { "delete" : { "description" : "Delete a resource request. For more details on resource requests, see \"Get a resource request\".", "operationId" : "deleteRequest_1", "parameters" : [ { "description" : "ID of the request to delete.", "in" : "path", "name" : "requestid", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessageDto" } } }, "description" : "default response" } }, "summary" : "Delete a resource request", "tags" : [ "requests - resource" ] }, "get" : { "description" : "Get a resource request. Request can be a contribution on a metadata resource or transfer of a metadata resource into an organization's collections.", "operationId" : "getRequest", "parameters" : [ { "in" : "path", "name" : "requestid", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicResourceRequestDto" } } }, "description" : "default response" } }, "summary" : "Get a resource request", "tags" : [ "requests - resource" ] } }, "/search" : { "post" : { "operationId" : "searchResources_1", "parameters" : [ { "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int32", "default" : 10 } }, { "in" : "query", "name" : "from", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "in" : "query", "name" : "hydration", "schema" : { "type" : "array", "enum" : [ "agent, catalog, catalogConcept, properties, resourceHierarchy" ], "items" : { "type" : "string", "enum" : [ "agent", "catalog", "catalogConcept", "properties", "resourceHierarchy", "agent, catalog, catalogConcept, properties, resourceHierarchy" ] }, "uniqueItems" : true } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedGenericResultsSearchedResourceDto" } } }, "description" : "default response" } }, "summary" : "Advanced search on resources", "tags" : [ "search" ] } }, "/search/resources" : { "post" : { "description" : "Simple search is a light weight API implementation exposing similar search capabilities as our main\nplatform search UI.\n\nBy default, the search response will return mixed result types including metadata resources, datasets,\nprojects, queries, insights, tables, and comments.\n\nA free-text search term is required. Simple search does not support complex keyword or logical operator\ngrammar. Light weight filters for resource owner and resource category are supported. You may optionally\nspecify the includeCommunityResults param to query for resources in the data.world open data community.", "operationId" : "simpleSearchResources", "parameters" : [ { "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int32", "default" : 10 } }, { "in" : "query", "name" : "from", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "in" : "query", "name" : "hydration", "schema" : { "type" : "array", "enum" : [ "agent, catalog, catalogConcept, properties, resourceHierarchy" ], "items" : { "type" : "string", "enum" : [ "agent", "catalog", "catalogConcept", "properties", "resourceHierarchy", "agent, catalog, catalogConcept, properties, resourceHierarchy" ] }, "uniqueItems" : true } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SimpleSearchRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedGenericResultsSearchedResourceDto" } } }, "description" : "default response" } }, "summary" : "Simple search on resources", "tags" : [ "search" ] } }, "/serviceaccount/{owner}" : { "get" : { "operationId" : "getServiceAccounts", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 50, "minimum" : 1 } }, { "in" : "query", "name" : "next", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedServiceAccountDetails" } } }, "description" : "default response" } }, "summary" : "Gets all service accounts by owner.", "tags" : [ "serviceaccount" ] }, "post" : { "operationId" : "createServiceAccount", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountCreateRequestDto" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountCreateResponseDto" } } }, "description" : "default response" } }, "summary" : "Create a new service account.", "tags" : [ "serviceaccount" ] } }, "/serviceaccount/{serviceAccount}" : { "delete" : { "operationId" : "deleteServiceAccount", "parameters" : [ { "in" : "path", "name" : "serviceAccount", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Delete service account", "tags" : [ "serviceaccount" ] }, "patch" : { "operationId" : "updateServiceAccount", "parameters" : [ { "in" : "path", "name" : "serviceAccount", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountUpdateDto" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Update service account", "tags" : [ "serviceaccount" ] } }, "/serviceaccount/{serviceAccount}/refresh" : { "post" : { "operationId" : "refreshServiceAccountToken", "parameters" : [ { "in" : "path", "name" : "serviceAccount", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountRefreshTokenRequestDto" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountCreateResponseDto" } } }, "description" : "default response" } }, "summary" : "Refresh service account token", "tags" : [ "serviceaccount" ] } }, "/sparql/{owner}" : { "get" : { "description" : "Execute a SPARQL query. The query will default to using the :current graph if the query contains no FROM\nclauses and no default graph URI parameters are specified, in which case it will return a 404 if the\n:current graph does not exist for the org.\n\nSPARQL results are available in a variety of formats. By default, `application/sparql-results+json` will\nbe returned. Set the `Accept` header to one of the following values in accordance with your preference\nand the type of the query (SELECT, CONSTRUCT, DESCRIBE, ASK):\n\n- `application/sparql-results+xml`\n- `application/sparql-results+json`\n- `application/rdf+json`\n- `application/rdf+xml`\n- `text/csv`\n- `text/tab-separated-values`\n- `text/turtle`\n\nNew to SPARQL? Check out data.world's [SPARQL tutorial](https://docs.data.world/tutorials/sparql/).", "operationId" : "queryViaGetWithDefaultGraph", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "query", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "query", "name" : "diagnose", "schema" : { "type" : "boolean", "default" : false } }, { "description" : "Specify URI for named graph(s) to query, overriding any FROM clauses in the query. If the default-graph-uri parameter is omitted and there are no FROM clauses, the :current graph will be used. See [Our Docs](https://docs.data.world/en/168180-understanding-the-catalog-graph.html#UUID-46e644b5-119a-a4a2-eb69-e09ce33bd986) for more info.", "in" : "query", "name" : "default-graph-uri", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "Specify URI for named graph(s) to query, overriding any FROM NAMED clauses in the query. See [Our Docs](https://docs.data.world/en/168180-understanding-the-catalog-graph.html#UUID-46e644b5-119a-a4a2-eb69-e09ce33bd986) for more info.", "in" : "query", "name" : "named-graph-uri", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "Query token to use with cancel", "in" : "query", "name" : "queryruntoken", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/rdf+json" : { }, "application/rdf+xml" : { }, "application/sparql-results+json" : { }, "application/sparql-results+xml" : { }, "text/csv" : { }, "text/tab-separated-values" : { }, "text/turtle" : { } }, "description" : "default response" } }, "summary" : "Execute SPARQL query via GET with the default graph", "tags" : [ "queries" ] }, "post" : { "description" : "Execute a SPARQL query. The query will default to using the :current graph if the query contains no FROM\nclauses and no default graph URI parameters are specified, in which case it will return a 404 if the\n:current graph does not exist for the org.\n\nSPARQL results are available in a variety of formats. By default, `application/sparql-results+json` will\nbe returned. Set the `Accept` header to one of the following values in accordance with your preference\nand the type of the query (SELECT, CONSTRUCT, DESCRIBE, ASK):\n\n- `application/sparql-results+xml`\n- `application/sparql-results+json`\n- `application/rdf+json`\n- `application/rdf+xml`\n- `text/csv`\n- `text/tab-separated-values`\n- `text/turtle`\n\nNew to SPARQL? Check out data.world's [SPARQL tutorial](https://docs.data.world/tutorials/sparql/).", "operationId" : "queryWithJsonRequestWithDefaultGraph", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SparqlQueryRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/rdf+json" : { }, "application/rdf+xml" : { }, "application/sparql-results+json" : { }, "application/sparql-results+xml" : { }, "text/csv" : { }, "text/tab-separated-values" : { }, "text/turtle" : { } }, "description" : "default response" } }, "summary" : "Execute SPARQL query via POST with the default graph", "tags" : [ "queries" ] } }, "/sparql/{owner}/{id}" : { "get" : { "description" : "Execute a SPARQL query against a dataset or data project.\n\nSPARQL results are available in a variety of formats. By default, `application/sparql-results+json` will\nbe returned. Set the `Accept` header to one of the following values in accordance with your preference\nand the type of the query (SELECT, CONSTRUCT, DESCRIBE, ASK):\n\n- `application/sparql-results+xml`\n- `application/sparql-results+json`\n- `application/rdf+json`\n- `application/rdf+xml`\n- `text/csv`\n- `text/tab-separated-values`\n- `text/turtle`\n\nNew to SPARQL? Check out data.world's [SPARQL tutorial](https://docs.data.world/tutorials/sparql/).", "operationId" : "queryViaGet", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Dataset to query, e.g. `ddw-catalogs`", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "query", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "query", "name" : "diagnose", "schema" : { "type" : "boolean", "default" : false } }, { "description" : "Specify URI for named graph(s) to query, overriding any FROM clauses in the query. See [Our Docs](https://docs.data.world/en/168180-understanding-the-catalog-graph.html#UUID-46e644b5-119a-a4a2-eb69-e09ce33bd986) for more info.", "in" : "query", "name" : "default-graph-uri", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "Specify URI for named graph(s) to query, overriding any FROM NAMED clauses in the query. See [Our Docs](https://docs.data.world/en/168180-understanding-the-catalog-graph.html#UUID-46e644b5-119a-a4a2-eb69-e09ce33bd986) for more info.", "in" : "query", "name" : "named-graph-uri", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "Query token to use with cancel", "in" : "query", "name" : "queryruntoken", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/rdf+json" : { }, "application/rdf+xml" : { }, "application/sparql-results+json" : { }, "application/sparql-results+xml" : { }, "text/csv" : { }, "text/tab-separated-values" : { }, "text/turtle" : { } }, "description" : "default response" } }, "summary" : "Execute SPARQL query via GET", "tags" : [ "queries" ] }, "post" : { "description" : "Execute a SPARQL query against a dataset or data project.\n\nSPARQL results are available in a variety of formats. By default, `application/sparql-results+json` will\nbe returned. Set the `Accept` header to one of the following values in accordance with your preference\nand the type of the query (SELECT, CONSTRUCT, DESCRIBE, ASK):\n\n- `application/sparql-results+xml`\n- `application/sparql-results+json`\n- `application/rdf+json`\n- `application/rdf+xml`\n- `text/csv`\n- `text/tab-separated-values`\n- `text/turtle`\n\nNew to SPARQL? Check out data.world's [SPARQL tutorial](https://docs.data.world/tutorials/sparql/).", "operationId" : "queryWithJsonRequest", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Dataset to query, e.g. `ddw-catalogs`", "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SparqlQueryRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/rdf+json" : { }, "application/rdf+xml" : { }, "application/sparql-results+json" : { }, "application/sparql-results+xml" : { }, "text/csv" : { }, "text/tab-separated-values" : { }, "text/turtle" : { } }, "description" : "default response" } }, "summary" : "Execute SPARQL query via POST", "tags" : [ "queries" ] } }, "/sql/{owner}/{id}" : { "get" : { "description" : "Same as `POST:/sql/{owner}/{id}`", "operationId" : "sqlGet", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "includeTableSchema", "schema" : { "type" : "boolean", "default" : false } }, { "in" : "query", "name" : "query", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "query", "name" : "dialect", "schema" : { "type" : "string", "default" : "DW_SQL", "enum" : [ "DW_SQL", "POSTGRESQL" ] } }, { "in" : "query", "name" : "diagnose", "schema" : { "type" : "boolean", "default" : false } }, { "description" : "Query token to use with cancel", "in" : "query", "name" : "queryruntoken", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { }, "application/json-l" : { }, "application/x-ndjson" : { }, "text/csv" : { } }, "description" : "default response" } }, "summary" : "SQL query (via GET)", "tags" : [ "queries" ] }, "post" : { "description" : "Execute a SQL query against a dataset or data project.\n\nSQL results are available in a variety of formats. By default, `application/json` will be returned. Set\nthe `Accept` header to one of the following values in accordance with your preference:\n\n* `text/csv`\n* `application/json`\n* `application/json-l`\n* `application/x-ndjson`\n\nNew to SQL? Check out data.world's [SQL manual](https://docs.data.world/tutorials/dwsql/) .", "operationId" : "sqlPostWithJsonRequest", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "dialect", "schema" : { "type" : "string", "default" : "DW_SQL", "enum" : [ "DW_SQL", "POSTGRESQL" ] } }, { "in" : "query", "name" : "diagnose", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SqlQueryRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { }, "application/json-l" : { }, "application/x-ndjson" : { }, "text/csv" : { } }, "description" : "default response" } }, "summary" : "SQL query", "tags" : [ "queries" ] } }, "/sql/{owner}/{id}/describe" : { "post" : { "description" : "This endpoint describes what columns will be included if the given SQL query is performed against the specified dataset.\nNew to SQL? Check out data.world's [SQL manual](https://docs.data.world/tutorials/dwsql/) .", "operationId" : "sqlDescribe", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "dialect", "schema" : { "type" : "string", "default" : "DW_SQL", "enum" : [ "DW_SQL", "POSTGRESQL" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SqlQueryRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { }, "application/json-l" : { }, "application/x-ndjson" : { }, "text/csv" : { } }, "description" : "default response" } }, "summary" : "Describe a SQL query", "tags" : [ "queries" ] } }, "/streams/{owner}/{id}/{streamId}" : { "post" : { "description" : "Append JSON data to a stream associated with a dataset.\n\ndata.world streams are append-only by default. Alternatively, if a primary key is specified (see:\n`POST:/streams/{owner}/{id}/{streamId}/schema`), data.world will replace records with the same primary\nkey value.\n\n**Streams don't need to be created before you can append data to them**. They will be created on-demand,\n when the first record is appended or by defining its schema.\n\nMultiple records can be appended at once by using JSON-L (`application/json-l`) as the request content type.\n\n**IMPORTANT**\n\nData uploaded to a dataset via a stream is not immediatelly processed. Instead, it is processed\nautomatically in accordance with the dataset settings (default: daily) or as a result of calling\n`POST:/datasets/{owner}/{id}/sync`.\n\nOnce processed, the contents of a stream will appear as part of the respective dataset as a `.jsonl`\nfile (e.g. `my-stream` will produce a file named `my-stream.jsonl`).\n", "operationId" : "appendRecords", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "streamId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { }, "application/json-l" : { }, "application/n-triples" : { }, "application/rdf+xml" : { }, "text/turtle" : { } }, "description" : "records to append", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { } }, "description" : "default response" } }, "summary" : "Append record(s)", "tags" : [ "streams" ] } }, "/streams/{owner}/{id}/{streamId}/records" : { "delete" : { "description" : " Delete all records previously appended to stream.\n", "operationId" : "deleteRecords", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "streamId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Delete all records", "tags" : [ "streams" ] } }, "/streams/{owner}/{id}/{streamId}/schema" : { "get" : { "description" : "Retrieve stream schema.\n", "operationId" : "getStreamSchema", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "streamId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StreamSchema" } } }, "description" : "default response" } }, "summary" : "Retrieve stream schema", "tags" : [ "streams" ] }, "patch" : { "description" : "\"Set or update a stream's schema.\n\nThe schema of a stream defines its primary key(s) and sort/sequence field.\n\ndata.world streams are append-only by default. Alternatively, if a primary key is specified, data.world\nwill replace records with the same primary key value. data.world will sort records by sequence field\nvalue and will discard all but the last record appended for each given primary key value.\n\nThe `updateMethod` parameter specifies how data.world should handle existing records when schema is\nupdated. Currently, the only `updateMethod` supported is `TRUNCATED`. data.world will discard all\nrecords when the schema is updated.\"\n", "operationId" : "patchStreamSchema", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "streamId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StreamSchemaPatchRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Set / Update stream schema", "tags" : [ "streams" ] } }, "/telemetry/governanceBilling" : { "get" : { "description" : "This endpoint executes query against ddw-catalogs to get data from governance billing.", "operationId" : "governanceBilling", "parameters" : [ { "in" : "query", "name" : "agentId", "schema" : { "type" : "string", "default" : "datadotworldsupport" } }, { "in" : "query", "name" : "sampleData", "schema" : { "type" : "boolean", "default" : false } }, { "in" : "query", "name" : "catalog", "schema" : { "type" : "string", "default" : "main" } } ], "responses" : { "200" : { "content" : { "application/json" : { }, "application/json-l" : { }, "application/x-ndjson" : { }, "text/csv" : { } }, "description" : "default response" } }, "summary" : "Get governance billing query result", "tags" : [ "telemetry" ] } }, "/topics" : { "post" : { "description" : "This API allows users to initiate a new topic for discussions and comments. To create a topic, the user must have access to the resource.", "operationId" : "createTopic", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicTopicDto" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicTopicDto" } } }, "description" : "default response" } }, "summary" : "Create a new topic", "tags" : [ "topics and comments - resource" ] } }, "/topics/comments/recent" : { "get" : { "description" : "This API retrieves recently updated comments that are open and discoverable. Users can filter results by the owner's ID and specify the number of comments to fetch, with a limit of 100 and a default of 5.", "operationId" : "getRecentComments", "parameters" : [ { "description" : "Optional parameter to reduce the result set by owner who created it", "in" : "query", "name" : "owner", "schema" : { "type" : "string" } }, { "description" : "Optional parameter to return number of matched comments with limit of 100 and default size of 5", "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int32", "default" : 5, "maximum" : 100 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedGenericResultsPublicCommentDto" } } }, "description" : "default response" } }, "summary" : "Get recently updated comments", "tags" : [ "topics and comments - resource" ] } }, "/topics/hot" : { "get" : { "description" : "This API allows users to access trending topics determined by their level of activity. Users can specify the number of topics to retrieve per request, with a maximum limit of 1000 topics. If the number is not specified, it defaults to 10.", "operationId" : "getHotTopics", "parameters" : [ { "description" : "Optional parameter to return number of found hot topics with limit of 100 and default size of 5", "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int32", "default" : 5, "maximum" : 100 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedGenericResultsPublicTopicDto" } } }, "description" : "default response" } }, "summary" : "Get active topics", "tags" : [ "topics and comments - resource" ] } }, "/topics/{owner}" : { "get" : { "description" : "Retrieve open and discoverable topics associated with a specific owner. If an optional resource is provided in the query parameter, this will retrieve topics for the resource that is owned by the owner. To reference a dataset insight, both `datasetId` and `insightUuid` should be provided. To reference a metadata resource, `iri` should be provided.\"\n", "operationId" : "getTopicsByResource", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "datasetId", "schema" : { "type" : "string" } }, { "description" : "The parameter requires datasetId to be provided.", "in" : "query", "name" : "insightUuid", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "iri", "schema" : { "type" : "string" } }, { "description" : "Size of page to fetch", "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 1000 } }, { "description" : "Result number to start fetch from (not the page number to start from)", "in" : "query", "name" : "from", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "description" : "Sort results by fields", "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedGenericResultsPublicTopicDto" } } }, "description" : "default response" } }, "summary" : "Get topics for an owner and optional resource", "tags" : [ "topics and comments - resource" ] } }, "/topics/{owner}/{topicUuid}" : { "delete" : { "description" : "This API allows users to remove a topic they have permission to access, specified by the owner's ID and the topic's UUID. This DELETE request ensures the topic is successfully deleted if access criteria are met.", "operationId" : "deleteTopic", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "topicUuid", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "content" : { "application/json" : { } }, "description" : "default response" } }, "summary" : "Delete an existing topic", "tags" : [ "topics and comments - resource" ] }, "get" : { "description" : "Access an individual topic using this API by providing the owner's identifier and the unique topic UUID. This API ensures user permissions are validated for visibility and access to the specified topic.", "operationId" : "getTopic", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "topicUuid", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicTopicDto" } } }, "description" : "default response" } }, "summary" : "Get a topic", "tags" : [ "topics and comments - resource" ] }, "put" : { "description" : "This API enables users to modify details of a topic they have access to, identified by the owner's ID and the topic's UUID. This PUT request ensures that all changes comply with the required access permissions and topic visibility settings.", "operationId" : "updateTopic", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "topicUuid", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicTopicDto" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicTopicDto" } } }, "description" : "default response" } }, "summary" : "Update an existing topic", "tags" : [ "topics and comments - resource" ] } }, "/topics/{owner}/{topicUuid}/comments" : { "get" : { "description" : "This API allows users to retrieve comments for a specific topic they have access to, identified by the owner's ID and the topic's UUID. Users can control the number of comments returned, with options to sort and paginate results.", "operationId" : "getCommentsByTopic", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "topicUuid", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "description" : "Size of page to fetch", "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 1000 } }, { "description" : "Result number to start fetch from (not the page number to start from)", "in" : "query", "name" : "from", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "description" : "Sort results by fields", "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedGenericResultsPublicCommentDto" } } }, "description" : "default response" } }, "summary" : "Get comments for a topic", "tags" : [ "topics and comments - resource" ] }, "post" : { "description" : "This API enables users to add a comment to a specific topic, provided they have access permissions. This POST request requires the owner's ID and the topic's UUID, along with the comment content, to successfully create and store the comment.", "operationId" : "createComment", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "topicUuid", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicCommentDto" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicCommentDto" } } }, "description" : "default response" } }, "summary" : "Create a comment", "tags" : [ "topics and comments - resource" ] } }, "/topics/{owner}/{topicUuid}/comments/{commentid}" : { "delete" : { "description" : "This API allows users to remove a comment from a topic, provided they have access rights. This DELETE request requires the owner's ID, topic's UUID, and the comment ID to successfully execute the deletion.", "operationId" : "deleteComment", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "topicUuid", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "in" : "path", "name" : "commentid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { } }, "description" : "default response" } }, "summary" : "Delete an existing comment", "tags" : [ "topics and comments - resource" ] }, "get" : { "description" : "This API allows users to access a specific comment within a topic, provided they have the necessary access permissions. This GET request requires the owner's ID and the topic's UUID to retrieve the comment details.", "operationId" : "getComment", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "topicUuid", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "in" : "path", "name" : "commentid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicCommentDto" } } }, "description" : "default response" } }, "summary" : "Get a comment", "tags" : [ "topics and comments - resource" ] }, "put" : { "description" : "This API allows users to modify the content of a comment within a topic, provided they have the necessary permissions. By using a PUT request with the owner's ID, topic's UUID, and comment ID, users can update the comment's details effectively.", "operationId" : "updateComment", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "topicUuid", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } }, { "in" : "path", "name" : "commentid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicCommentDto" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicCommentDto" } } }, "description" : "default response" } }, "summary" : "Update an existing comment", "tags" : [ "topics and comments - resource" ] } }, "/uploads/{owner}/{id}/files" : { "post" : { "description" : "\"Upload multiple files at once to a dataset.\n\nThis endpoint expects requests of type `multipart/form-data` and you can include one or more parts named\n`file`, each containing a different file to be uploaded.\n\nFor example, assuming that you want to upload two local files named `file1.csv` and `file2.csv` to a\nhypothetical dataset `https://data.world/awesome-user/awesome-dataset`, this is what the cURL command\nwould look like.\n\n```bash\ncurl \\\n -H \"Authorization: Bearer \" \\\n -F \"file=@file1.csv\" \\\n -F \"file=@file2.csv\" \\\n https://api.data.world/v0/uploads/awesome-user/awesome-dataset/files\n```\n\nSwagger clients may limit this method of upload to one file at a time. Other HTTP clients capable of\nmaking multipart/form-data requests can be used to upload multiple files in a single request.\"\n", "operationId" : "uploadFiles", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "expandArchives", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "multipart/form-data" : { "encoding" : { "file" : { "style" : "form" } }, "schema" : { "type" : "object", "properties" : { "file" : { "type" : "string", "format" : "binary", "description" : "Multipart-encoded file contents" } }, "required" : [ "file" ] } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Upload files", "tags" : [ "files" ] } }, "/uploads/{owner}/{id}/files/{file}" : { "put" : { "description" : "Upload one file at a time to a dataset.\n\nThis endpoint expects requests of type `application/octet-stream`.\n\nFor example, assuming that you want to upload a local file named `file1.csv` to a hypothetical dataset\n`https://data.world/awesome-user/awesome-dataset` and choose its name on data.world to be\n`better-name.csv`, this is what the cURL command would look like.\n\n```bash\ncurl \\\n -H \"Authorization: Bearer \" \\\n -X PUT -H \"Content-Type: application/octet-stream\" \\\n --data-binary @file1.csv \\\n https://api.data.world/v0/uploads/awesome-user/awesome-dataset/files/better-name.csv\n```\n\nThis method of upload is typically not supported by Swagger clients. Other HTTP clients can be used to\nsupply the contents of the file directly in the body of the request.\n", "operationId" : "uploadFile", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Filename", "in" : "path", "name" : "file", "required" : true, "schema" : { "type" : "string", "maxLength" : 128, "minLength" : 1, "pattern" : "^[^/]+$" } }, { "in" : "query", "name" : "expandArchive", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } }, "application/octet-stream" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "file data", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Upload a file", "tags" : [ "files" ] } }, "/user" : { "get" : { "description" : "Retrieve user profile information of the currently authenticated user.", "operationId" : "getUserData", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserDataResponse" } } }, "description" : "default response" } }, "summary" : "Retrieve user data", "tags" : [ "user" ] } }, "/user/datasets/contributing" : { "get" : { "description" : "List datasets that the currently authenticated user has access to because he or she is a contributor.", "operationId" : "fetchContributingDatasets", "parameters" : [ { "in" : "query", "name" : "fields", "schema" : { "type" : "string" } }, { "description" : "Number of results to return", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "A token supplied by the previous response to retrieve the next page of results", "in" : "query", "name" : "next", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedDatasetResults" } } }, "description" : "default response" } }, "summary" : "List datasets as contributor", "tags" : [ "user" ] } }, "/user/datasets/liked" : { "get" : { "description" : "List datasets that the currently authenticated user liked (bookmarked).", "operationId" : "fetchLikedDatasets", "parameters" : [ { "in" : "query", "name" : "fields", "schema" : { "type" : "string" } }, { "description" : "Number of results to return", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "A token supplied by the previous response to retrieve the next page of results", "in" : "query", "name" : "next", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedDatasetResults" } } }, "description" : "default response" } }, "summary" : "List liked (bookmarked) datasets", "tags" : [ "user" ] } }, "/user/datasets/own" : { "get" : { "description" : "List datasets that the currently authenticated user has access to because he or she is the owner.", "operationId" : "fetchDatasets", "parameters" : [ { "in" : "query", "name" : "fields", "schema" : { "type" : "string" } }, { "description" : "Number of results to return", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "A token supplied by the previous response to retrieve the next page of results", "in" : "query", "name" : "next", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedDatasetResults" } } }, "description" : "default response" } }, "summary" : "List datasets as owner", "tags" : [ "user" ] } }, "/user/organizations" : { "get" : { "description" : "List organizations that the currently authenticated user is a member of.", "operationId" : "fetchOrganizations", "parameters" : [ { "description" : "Number of results to return", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "A token supplied by the previous response to retrieve the next page of results", "in" : "query", "name" : "next", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedOrganizationResults" } } }, "description" : "default response" } }, "summary" : "List organization memberships", "tags" : [ "user" ] } }, "/user/projects/contributing" : { "get" : { "description" : "List projects that the currently authenticated user has access to because he or she is a contributor.", "operationId" : "fetchContributingProjects", "parameters" : [ { "description" : "Number of results to return", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "A token supplied by the previous response to retrieve the next page of results", "in" : "query", "name" : "next", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedProjectResults" } } }, "description" : "default response" } }, "summary" : "List projects as contributor", "tags" : [ "user" ] } }, "/user/projects/liked" : { "get" : { "description" : "List projects that the currently authenticated user liked (bookmarked).", "operationId" : "fetchLikedProjects", "parameters" : [ { "description" : "Number of results to return", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "A token supplied by the previous response to retrieve the next page of results", "in" : "query", "name" : "next", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedProjectResults" } } }, "description" : "default response" } }, "summary" : "List liked (bookmarked) projects", "tags" : [ "user" ] } }, "/user/projects/own" : { "get" : { "description" : "List projects that the currently authenticated user has access to because he or she is the owner.", "operationId" : "fetchProjects", "parameters" : [ { "description" : "Number of results to return", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "A token supplied by the previous response to retrieve the next page of results", "in" : "query", "name" : "next", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedProjectResults" } } }, "description" : "default response" } }, "summary" : "List projects owned", "tags" : [ "user" ] } }, "/user/webhooks" : { "get" : { "description" : "List webhook subscriptions associated with the currently authenticated user.", "operationId" : "getWebhooks", "parameters" : [ { "description" : "Number of results to return", "in" : "query", "name" : "limit", "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "maximum" : 100, "minimum" : 1 } }, { "description" : "A token supplied by the previous response to retrieve the next page of results", "in" : "query", "name" : "next", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedSubscriptionResults" } } }, "description" : "default response" } }, "summary" : "List subscriptions", "tags" : [ "webhooks" ] } }, "/user/webhooks/datasets/{owner}/{id}" : { "delete" : { "description" : "Delete webhook subscription associated with the currently authenticated user and to a given dataset.", "operationId" : "unsubscribeFromDataset", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Unsubscribe from dataset", "tags" : [ "webhooks" ] }, "get" : { "description" : "Retrieve webhook subscription associated with the currently authenticated user and to a given dataset.", "operationId" : "getForDataset", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Subscription" } } }, "description" : "default response" } }, "summary" : "Retrieve dataset subscription", "tags" : [ "webhooks" ] }, "put" : { "description" : "Create webhook subscription associated with the currently authenticated user and to a given dataset.", "operationId" : "subscribeToDataset", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionCreateRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Subscribe to dataset", "tags" : [ "webhooks" ] } }, "/user/webhooks/projects/{owner}/{id}" : { "delete" : { "description" : "Delete webhook subscription associated with the currently authenticated user and to a given project.", "operationId" : "unsubscribeFromProject", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Unsubscribe from data project", "tags" : [ "webhooks" ] }, "get" : { "description" : "Retrieve webhook subscription associated with the currently authenticated user and to a given project.", "operationId" : "getForProject", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Subscription" } } }, "description" : "default response" } }, "summary" : "Retrieve data project subscription", "tags" : [ "webhooks" ] }, "put" : { "description" : "Create webhook subscription associated with the currently authenticated user and to a given project.", "operationId" : "subscribeToProject", "parameters" : [ { "in" : "path", "name" : "owner", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionCreateRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Subscribe to data project", "tags" : [ "webhooks" ] } }, "/user/webhooks/users/{account}" : { "delete" : { "description" : "Delete webhook subscription associated with the currently authenticated user and to a given user account.", "operationId" : "unsubscribeFromUser", "parameters" : [ { "in" : "path", "name" : "account", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Unsubscribe from account", "tags" : [ "webhooks" ] }, "get" : { "description" : "Retrieve webhook subscription associated with the currently authenticated user and to a given user account.", "operationId" : "getForUser", "parameters" : [ { "in" : "path", "name" : "account", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Subscription" } } }, "description" : "default response" } }, "summary" : "Retrieve account subscription", "tags" : [ "webhooks" ] }, "put" : { "description" : "Create webhook subscription associated with the currently authenticated user and to a given user account.", "operationId" : "subscribeToUser", "parameters" : [ { "in" : "path", "name" : "account", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionCreateRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessMessage" } } }, "description" : "default response" } }, "summary" : "Subscribe to account", "tags" : [ "webhooks" ] } }, "/users/{account}" : { "get" : { "description" : "Retrieve user profile information for the specified account.", "operationId" : "getAccount", "parameters" : [ { "in" : "path", "name" : "account", "required" : true, "schema" : { "type" : "string", "minLength" : 1 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserDataResponse" } } }, "description" : "default response" } }, "summary" : "Retrieve a user's profile", "tags" : [ "users" ] } } }, "components" : { "schemas" : { "AcceptRequestDto" : { "type" : "object", "properties" : { "collectionIds" : { "type" : "array", "description" : "Only required for transfer requests. A list of collection identifiers (not IRI) that the resource should be transferred into. These collections must be in the organization noted as the \"granteeParty\" in the request.", "items" : { "type" : "string" } }, "requestid" : { "type" : "string", "format" : "uuid", "description" : "ID of the request to accept." } }, "required" : [ "requestid" ] }, "AddCustomIriPropertyContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "entityType" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "property" : { "type" : "string" }, "target" : { "type" : "string" }, "type" : { "type" : "string", "const" : "AddCustomIriProperty" }, "value" : { "type" : "string" }, "valueEntityType" : { "type" : "string" } } } ], "required" : [ "entityType", "property", "target", "value" ] }, "AddCustomLiteralPropertyContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "entityType" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "property" : { "type" : "string" }, "target" : { "type" : "string" }, "type" : { "type" : "string", "const" : "AddCustomLiteralProperty" }, "value" : { "type" : "string" }, "valueType" : { "type" : "string" } } } ], "required" : [ "entityType", "property", "target", "value", "valueType" ] }, "AddTagContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "entityType" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "tag" : { "type" : "string" }, "target" : { "type" : "string" }, "type" : { "type" : "string", "const" : "AddTag" } } } ], "required" : [ "entityType", "tag", "target" ] }, "AddToCatalogContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "catalogIri" : { "type" : "string" }, "entryIri" : { "type" : "string" }, "entryType" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "type" : { "type" : "string", "const" : "AddToCatalog" } } } ], "required" : [ "catalogIri", "entryIri", "entryType" ] }, "AddUsesDataFromContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "analysisIri" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "tableIri" : { "type" : "string" }, "type" : { "type" : "string", "const" : "AddUsesDataFrom" } } } ], "required" : [ "analysisIri", "tableIri" ] }, "AddUsesDatasetContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "analysisIri" : { "type" : "string" }, "datasetIri" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "type" : { "type" : "string", "const" : "AddUsesDataset" } } } ], "required" : [ "analysisIri", "datasetIri" ] }, "AgentHydrationDto" : { "type" : "object", "properties" : { "avatarUrl" : { "type" : "string" }, "deactivated" : { "type" : "boolean" }, "displayName" : { "type" : "string" }, "id" : { "type" : "string" } } }, "AnalysisImage" : { "type" : "object", "properties" : { "externalUrl" : { "type" : "string" } } }, "AssetStatus" : { "type" : "object", "properties" : { "assetStatusLabel" : { "type" : "string" }, "dispositionLabel" : { "type" : "string" } } }, "AuthRequestCreateDto" : { "type" : "object", "properties" : { "dataset" : { "$ref" : "#/components/schemas/DatasetIdentifierRequest", "description" : "The dataset that grantee will receive access to" }, "granteeId" : { "type" : "string", "description" : "ID of the user that will be granted access" }, "level" : { "type" : "string", "description" : "Level of access the grantee will receive", "enum" : [ "DISCOVER", "READ", "WRITE", "ADMIN" ] } }, "required" : [ "dataset", "granteeId", "level" ] }, "AuthRequestDto" : { "type" : "object", "properties" : { "approverParty" : { "$ref" : "#/components/schemas/PublicParty", "description" : "User designated to approve the request", "oneOf" : [ { "$ref" : "#/components/schemas/PublicUserParty" }, { "$ref" : "#/components/schemas/PublicGroupParty" } ] }, "created" : { "type" : "string", "format" : "date-time" }, "granteeParty" : { "$ref" : "#/components/schemas/PublicParty", "description" : "User or group that will be granted access if approved", "oneOf" : [ { "$ref" : "#/components/schemas/PublicUserParty" }, { "$ref" : "#/components/schemas/PublicGroupParty" } ] }, "level" : { "type" : "string", "description" : "Level of access the grantee will receive", "enum" : [ "NONE", "SAML_GATED", "DISCOVER", "MEMBER", "READ", "WRITE", "ADMIN" ] }, "requesterParty" : { "$ref" : "#/components/schemas/PublicParty", "description" : "User that initiated the request", "oneOf" : [ { "$ref" : "#/components/schemas/PublicUserParty" }, { "$ref" : "#/components/schemas/PublicGroupParty" } ] }, "requestid" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for the request" }, "resource" : { "$ref" : "#/components/schemas/PublicResource", "description" : "The resource that grantee will receive access to", "oneOf" : [ { "$ref" : "#/components/schemas/PublicAnalysisResource" }, { "$ref" : "#/components/schemas/PublicCollectionResource" }, { "$ref" : "#/components/schemas/PublicColumnResource" }, { "$ref" : "#/components/schemas/PublicDatabaseResource" }, { "$ref" : "#/components/schemas/PublicDatasetResource" }, { "$ref" : "#/components/schemas/PublicDatasetInsightResource" }, { "$ref" : "#/components/schemas/PublicGlossaryResource" }, { "$ref" : "#/components/schemas/PublicGroupParty" }, { "$ref" : "#/components/schemas/PublicMetadataResource" }, { "$ref" : "#/components/schemas/PublicTableResource" } ] }, "updated" : { "type" : "string", "format" : "date-time" }, "visibility" : { "type" : "string", "description" : "Authorization visibility", "enum" : [ "PRIVATE", "PUBLIC" ] } } }, "AuthRequestRespondDto" : { "type" : "object", "properties" : { "dataset" : { "$ref" : "#/components/schemas/DatasetIdentifierRequest", "description" : "The dataset that this request is for" }, "requestId" : { "type" : "string", "format" : "uuid", "description" : "ID of the request to accept" } }, "required" : [ "dataset", "requestId" ] }, "AutomationTaskDetailsDto" : { "type" : "object", "properties" : { "automationId" : { "type" : "string", "format" : "uuid" } }, "required" : [ "automationId" ] }, "BadgeDto" : { "type" : "object", "description" : "Check definition", "properties" : { "badgeIri" : { "type" : "string", "format" : "uri", "description" : "Badge's IRI defined in the metadata profile.\n The default Badges included in every metadata profile are:\n https://dwec.data.world/v0/default-profile/GoodBadge,\n https://dwec.data.world/v0/default-profile/PoorBadge, and\n https://dwec.data.world/v0/default-profile/ModerateBadge." }, "resource" : { "$ref" : "#/components/schemas/DatabaseResource", "description" : "Metadata resource associated with the Badge", "oneOf" : [ { "$ref" : "#/components/schemas/IRIResource" }, { "$ref" : "#/components/schemas/Database" }, { "$ref" : "#/components/schemas/DatabaseTable" }, { "$ref" : "#/components/schemas/DatabaseColumn" } ] } }, "required" : [ "badgeIri", "resource" ] }, "BadgesDto" : { "type" : "object", "description" : "Pairs of metadata resources and their data quality Badge", "properties" : { "badges" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BadgeDto" }, "maxItems" : 100, "minItems" : 1 } }, "required" : [ "badges" ] }, "BasicResource" : { "type" : "object", "properties" : { "iri" : { "type" : "string", "format" : "uri", "description" : "IRI of the resource" }, "url" : { "type" : "string", "format" : "uri", "description" : "A URL that redirects to the resource's page on data.world" } }, "required" : [ "iri", "url" ] }, "BulkDeletePropertyRequest" : { "type" : "object", "properties" : { "resources" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } }, "description" : "A map of resource IRI to property IRIs to delete" } } }, "CatalogAnalysisHydrationDto" : { "type" : "object", "properties" : { "agentid" : { "type" : "string" }, "analysisid" : { "type" : "string" }, "assetStatus" : { "$ref" : "#/components/schemas/AssetStatus" }, "catalogs" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CatalogId" } }, "createdBy" : { "$ref" : "#/components/schemas/AgentHydrationDto" }, "description" : { "type" : "string" }, "entryTypeHierarchy" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntryType" } }, "entryTypeLabel" : { "type" : "string" }, "previewImage" : { "$ref" : "#/components/schemas/AnalysisImage" }, "referent" : { "type" : "string" }, "title" : { "type" : "string" }, "type" : { "type" : "string" }, "updated" : { "type" : "string", "format" : "date-time" } } }, "CatalogBusinessTermHydrationDto" : { "type" : "object", "properties" : { "abstract_" : { "type" : "string" }, "agentid" : { "type" : "string" }, "assetStatus" : { "$ref" : "#/components/schemas/AssetStatus" }, "businessTermid" : { "type" : "string" }, "catalogs" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CatalogId" } }, "createdBy" : { "$ref" : "#/components/schemas/AgentHydrationDto" }, "description" : { "type" : "string" }, "entryTypeHierarchy" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntryType" } }, "entryTypeLabel" : { "type" : "string" }, "referent" : { "type" : "string" }, "title" : { "type" : "string" }, "type" : { "type" : "string" }, "updated" : { "type" : "string", "format" : "date-time" } } }, "CatalogColumnHydrationDto" : { "type" : "object", "properties" : { "agentid" : { "type" : "string" }, "assetStatus" : { "$ref" : "#/components/schemas/AssetStatus" }, "columnid" : { "type" : "string" }, "createdBy" : { "$ref" : "#/components/schemas/AgentHydrationDto" }, "description" : { "type" : "string" }, "entryTypeHierarchy" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntryType" } }, "entryTypeLabel" : { "type" : "string" }, "referent" : { "type" : "string" }, "title" : { "type" : "string" }, "type" : { "type" : "string" }, "updated" : { "type" : "string", "format" : "date-time" } } }, "CatalogColumnRequest" : { "type" : "object", "properties" : { "assetStatusIri" : { "type" : "string", "maxLength" : 5000, "minLength" : 0 }, "collections" : { "type" : "array", "description" : "Catalog Collection to which this metadata resource is added. Required for POST and PUT.Available catalog collection can be discovered via appropriate discovery endpoints.", "example" : [ "Aid Option" ], "items" : { "type" : "string", "description" : "Catalog Collection to which this metadata resource is added. Required for POST and PUT.Available catalog collection can be discovered via appropriate discovery endpoints.", "example" : [ "Aid Option" ] } }, "columnIndex" : { "type" : "integer", "format" : "int32", "description" : "Column index values from 1 and upwards. 0 is default.", "example" : 5 }, "dataType" : { "type" : "string", "description" : "Data Type name for column. Required for POST and PUT.", "example" : "BIGINT" }, "description" : { "type" : "string", "description" : "A short, but descriptive statement about the metadata resource.", "example" : "Aid given to charity is an option that can be exercised by individuals and corporations", "maxLength" : 5000, "minLength" : 0 }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/StringOrArray" }, "description" : "Custom properties for the metadata resource mapped to API Bindings. Can be simple name-value string pairs or nested values for a string name. See examples for details." }, "summary" : { "type" : "string", "maxLength" : 25000, "minLength" : 0 }, "tags" : { "type" : "array", "description" : "A collection of tags to identify the relevance of metadata resource. Tags with no spaces is defacto standard", "example" : [ "HumanitarianAid" ], "items" : { "type" : "string", "description" : "A collection of tags to identify the relevance of metadata resource. Tags with no spaces is defacto standard", "example" : [ "HumanitarianAid" ] } }, "title" : { "type" : "string", "description" : "Title of the metadata resource. Required for POST and PUT.", "example" : "crypto.snowflake", "maxLength" : 120, "minLength" : 1 }, "typeLabel" : { "type" : "string", "description" : "Indicates the type of metadata resource. Some examples of valid values are Report, Tableau dashboard, Glossary, Table, Database view etc. Default values will be assumed if not provided. Defaults to Report for analysis resources, Glossary for Glossary resources, Table for Table resources and Column for Column resources. Once specified during creation, this cannot be changed via PATCH. Only a PUT can change the type ", "example" : "Tableau dashboard" } } }, "CatalogConceptHydrationDto" : { "type" : "object", "properties" : { "altLabel" : { "type" : "string" }, "iri" : { "type" : "string" }, "owner" : { "type" : "string" }, "prefLabel" : { "type" : "string" } } }, "CatalogDatabaseHydrationDto" : { "type" : "object", "properties" : { "agentid" : { "type" : "string" }, "assetStatus" : { "$ref" : "#/components/schemas/AssetStatus" }, "catalogs" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CatalogId" } }, "createdBy" : { "$ref" : "#/components/schemas/AgentHydrationDto" }, "description" : { "type" : "string" }, "entryTypeHierarchy" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntryType" } }, "entryTypeLabel" : { "type" : "string" }, "identifier" : { "type" : "string" }, "referent" : { "type" : "string" }, "title" : { "type" : "string" }, "type" : { "type" : "string" }, "updated" : { "type" : "string", "format" : "date-time" } } }, "CatalogHydrationDto" : { "type" : "object", "properties" : { "agentid" : { "type" : "string" }, "ancestors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CatalogId" } }, "catalogid" : { "type" : "string" }, "createdBy" : { "$ref" : "#/components/schemas/AgentHydrationDto" }, "description" : { "type" : "string" }, "entryTypeHierarchy" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntryType" } }, "entryTypeLabel" : { "type" : "string" }, "referent" : { "type" : "string" }, "title" : { "type" : "string" }, "type" : { "type" : "string" }, "updated" : { "type" : "string", "format" : "date-time" } } }, "CatalogId" : { "type" : "object", "properties" : { "collectionId" : { "type" : "string" }, "owner" : { "type" : "string" }, "referent" : { "type" : "string" } }, "required" : [ "collectionId", "owner", "referent" ] }, "CatalogPropertyDto" : { "type" : "object", "properties" : { "allowedValues" : { "type" : "array", "items" : { "type" : "string" } }, "categoryLabel" : { "type" : "string" }, "label" : { "type" : "string" }, "multivalued" : { "type" : "boolean" }, "typeLabel" : { "type" : "string" } } }, "CatalogRequest" : { "type" : "object", "properties" : { "assetStatusIri" : { "type" : "string" }, "description" : { "type" : "string", "maxLength" : 5000, "minLength" : 0 }, "tags" : { "type" : "array", "items" : { "type" : "string" } }, "title" : { "type" : "string", "maxLength" : 120, "minLength" : 1 } } }, "CatalogResourceBulkCreateRequest" : { "type" : "object", "properties" : { "resources" : { "type" : "array", "description" : "A list of resources to create", "items" : { "$ref" : "#/components/schemas/CatalogResourceCreateRequest" }, "maxItems" : 25, "minItems" : 1 } } }, "CatalogResourceBulkRequest" : { "type" : "object", "properties" : { "resources" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/CatalogResourceRequest" }, "description" : "A map of resource IRI to properties to update" } } }, "CatalogResourceBulkResponse" : { "type" : "object", "properties" : { "resources" : { "type" : "array", "description" : "Resources that were updated", "items" : { "$ref" : "#/components/schemas/BasicResource" } } } }, "CatalogResourceCreateRequest" : { "type" : "object", "properties" : { "collections" : { "type" : "array", "description" : "Collections, identified by IRI, that this resource is added into. Required when creating a resource. Available collections can be discovered using \"Search for resources\" endpoint.", "items" : { "type" : "string" } }, "iri" : { "type" : "string", "description" : "Optional IRI of the resource. If not provided, an IRI will be generated." }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/StringOrArray" }, "description" : "Create/update any property that is associated with a metadata presentation. Key is the IRI of the property. Value is the intended value of the property.", "example" : "\"{\n \"https://democorpprofile.linked.data.world/d/ddw-catalogs/domain_expert\": \"Sample Name\",\n \"https://democorpprofile.linked.data.world/d/ddw-catalogs/geographies_available\": [\n \"https://democorpprofile.linked.data.world/d/ddw-catalogs/geography_europe\",\n \"https://democorpprofile.linked.data.world/d/ddw-catalogs/geography_asia\" ]\n}\"\n" }, "title" : { "type" : "string", "description" : "Title of the resource. Required when creating a resource.", "maxLength" : 120, "minLength" : 1 }, "type" : { "type" : "string", "description" : "IRI of the type of the resource" } }, "required" : [ "type" ] }, "CatalogResourceGetResponse" : { "type" : "object", "properties" : { "hydrations" : { "$ref" : "#/components/schemas/PubSearchHydrations" }, "resource" : { "$ref" : "#/components/schemas/CatalogResourceResponse" } } }, "CatalogResourceRequest" : { "type" : "object", "properties" : { "collections" : { "type" : "array", "description" : "Collections, identified by IRI, that this resource is added into. Required when creating a resource. Available collections can be discovered using \"Search for resources\" endpoint.", "items" : { "type" : "string" } }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/StringOrArray" }, "description" : "Create/update any property that is associated with a metadata presentation. Key is the IRI of the property. Value is the intended value of the property.", "example" : "\"{\n \"https://democorpprofile.linked.data.world/d/ddw-catalogs/domain_expert\": \"Sample Name\",\n \"https://democorpprofile.linked.data.world/d/ddw-catalogs/geographies_available\": [\n \"https://democorpprofile.linked.data.world/d/ddw-catalogs/geography_europe\",\n \"https://democorpprofile.linked.data.world/d/ddw-catalogs/geography_asia\" ]\n}\"\n" }, "title" : { "type" : "string", "description" : "Title of the resource. Required when creating a resource.", "maxLength" : 120, "minLength" : 1 } } }, "CatalogResourceResponse" : { "type" : "object", "properties" : { "collections" : { "type" : "array", "description" : "Collections that the resource is a part of", "items" : { "type" : "string", "format" : "uri" } }, "iri" : { "type" : "string", "format" : "uri", "description" : "IRI of the resource" }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/StringOrArray" }, "description" : "All properties of the resource that are associated with a metadata presentation. Key is the IRI of the property. Value is the value of the property." }, "sourceId" : { "type" : "string", "description" : "Database of the resource (applies only to tables and columns)" }, "tableId" : { "type" : "string", "description" : "Table id of the resource (applies only to columns)" }, "tableIri" : { "type" : "string", "description" : "Table IRI of the resource (applies only to columns)" }, "title" : { "type" : "string", "description" : "Title of the resource" }, "types" : { "type" : "array", "description" : "Type of the resource", "items" : { "type" : "string", "format" : "uri" } }, "url" : { "type" : "string", "format" : "uri", "description" : "A URL that redirects to the resource's page on data.world" } } }, "CatalogTableHydrationDto" : { "type" : "object", "properties" : { "agentid" : { "type" : "string" }, "catalogs" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CatalogId" } }, "createdBy" : { "$ref" : "#/components/schemas/AgentHydrationDto" }, "description" : { "type" : "string" }, "entryTypeHierarchy" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntryType" } }, "entryTypeLabel" : { "type" : "string" }, "id" : { "type" : "string" }, "referent" : { "type" : "string" }, "source" : { "$ref" : "#/components/schemas/SourceId" }, "sourceId" : { "$ref" : "#/components/schemas/SourceId" }, "tableid" : { "type" : "string" }, "title" : { "type" : "string" }, "type" : { "type" : "string" }, "updated" : { "type" : "string", "format" : "date-time" } } }, "CatalogTableRequest" : { "type" : "object", "properties" : { "assetStatusIri" : { "type" : "string", "maxLength" : 5000, "minLength" : 0 }, "collections" : { "type" : "array", "description" : "Catalog Collection to which this metadata resource is added. Required for POST and PUT.Available catalog collection can be discovered via appropriate discovery endpoints.", "example" : [ "Aid Option" ], "items" : { "type" : "string", "description" : "Catalog Collection to which this metadata resource is added. Required for POST and PUT.Available catalog collection can be discovered via appropriate discovery endpoints.", "example" : [ "Aid Option" ] } }, "description" : { "type" : "string", "description" : "A short, but descriptive statement about the metadata resource.", "example" : "Aid given to charity is an option that can be exercised by individuals and corporations", "maxLength" : 5000, "minLength" : 0 }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/StringOrArray" }, "description" : "Custom properties for the metadata resource mapped to API Bindings. Can be simple name-value string pairs or nested values for a string name. See examples for details." }, "summary" : { "type" : "string", "maxLength" : 25000, "minLength" : 0 }, "tags" : { "type" : "array", "description" : "A collection of tags to identify the relevance of metadata resource. Tags with no spaces is defacto standard", "example" : [ "HumanitarianAid" ], "items" : { "type" : "string", "description" : "A collection of tags to identify the relevance of metadata resource. Tags with no spaces is defacto standard", "example" : [ "HumanitarianAid" ] } }, "title" : { "type" : "string", "description" : "Title of the metadata resource. Required for POST and PUT.", "example" : "crypto.snowflake", "maxLength" : 120, "minLength" : 1 }, "typeLabel" : { "type" : "string", "description" : "Indicates the type of metadata resource. Some examples of valid values are Report, Tableau dashboard, Glossary, Table, Database view etc. Default values will be assumed if not provided. Defaults to Report for analysis resources, Glossary for Glossary resources, Table for Table resources and Column for Column resources. Once specified during creation, this cannot be changed via PATCH. Only a PUT can change the type ", "example" : "Tableau dashboard" } } }, "CatalogTableSuggestRequest" : { "type" : "object", "properties" : { "collectionsToAdd" : { "type" : "array", "description" : "Catalog Collection to which this metadata resource is added. Required for POST and PUT.Available catalog collection can be discovered via appropriate discovery endpoints.", "example" : [ "Aid Option" ], "items" : { "type" : "string", "description" : "Catalog Collection to which this metadata resource is added. Required for POST and PUT.Available catalog collection can be discovered via appropriate discovery endpoints.", "example" : [ "Aid Option" ] } }, "collectionsToRemove" : { "type" : "array", "description" : "Catalog Collection to which this metadata resource is added. Required for POST and PUT.Available catalog collection can be discovered via appropriate discovery endpoints.", "example" : [ "Aid Option" ], "items" : { "type" : "string", "description" : "Catalog Collection to which this metadata resource is added. Required for POST and PUT.Available catalog collection can be discovered via appropriate discovery endpoints.", "example" : [ "Aid Option" ] } }, "description" : { "type" : "string", "description" : "A short, but descriptive statement about the metadata resource.", "example" : "Aid given to charity is an option that can be exercised by individuals and corporations", "maxLength" : 5000, "minLength" : 0 }, "message" : { "type" : "string", "description" : "Message for the suggestion", "example" : "I strongly suggest", "maxLength" : 250, "minLength" : 1 }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/StringOrArray" }, "description" : "Custom properties for the metadata resource mapped to API BindingsCan be simple name-value string pairs or nested values for a string name. See examples for details." }, "summary" : { "type" : "string", "maxLength" : 25000, "minLength" : 0 }, "tagsToAdd" : { "type" : "array", "description" : "A collection of tags to identify the relevance of metadata resource. Tags with no spaces is defacto standard", "example" : [ "HumanitarianAid" ], "items" : { "type" : "string", "description" : "A collection of tags to identify the relevance of metadata resource. Tags with no spaces is defacto standard", "example" : [ "HumanitarianAid" ] } }, "tagsToRemove" : { "type" : "array", "description" : "A collection of tags to identify the relevance of metadata resource. Tags with no spaces is defacto standard", "example" : [ "HumanitarianAid" ], "items" : { "type" : "string", "description" : "A collection of tags to identify the relevance of metadata resource. Tags with no spaces is defacto standard", "example" : [ "HumanitarianAid" ] } }, "title" : { "type" : "string", "description" : "Title of the metadata resource. Required for POST and PUT.", "example" : "crypto.snowflake", "maxLength" : 120, "minLength" : 1 }, "typeLabel" : { "type" : "string", "description" : "Indicates the type of metadata resource. Some examples of valid values are Report, Tableau dashboard, Glossary, Table, Database view etc. Default values will be assumed if not provided. Defaults to Report for analysis resources, Glossary for Glossary resources, Table for Table resources and Column for Column resources. Once specified during creation, this cannot be changed via PATCH. Only a PUT can change the type ", "example" : "Tableau dashboard" } } }, "CheckDto" : { "type" : "object", "description" : "Check definition", "properties" : { "description" : { "type" : "string", "description" : "Description of the check" }, "dimension" : { "type" : "string", "description" : "The dimension of the check, e.g. 'validation', 'data freshness', 'anomalies', etc." }, "id" : { "type" : "string", "description" : "Unique identifier of the check", "minLength" : 1 }, "lastUpdated" : { "type" : "string", "format" : "date-time", "description" : "The time when the check was created or last updated." }, "priorityLevel" : { "type" : "string", "description" : "Priority level" }, "query" : { "type" : "string", "description" : "SQL query of the check. Or the name of an internal function like \"TableExistsBasic\"", "minLength" : 1 }, "resource" : { "$ref" : "#/components/schemas/DatabaseResource", "description" : "Corresponding resource of the check", "oneOf" : [ { "$ref" : "#/components/schemas/IRIResource" }, { "$ref" : "#/components/schemas/Database" }, { "$ref" : "#/components/schemas/DatabaseTable" }, { "$ref" : "#/components/schemas/DatabaseColumn" } ] }, "source" : { "type" : "string", "description" : "Data quality provider where this Check came from" }, "title" : { "type" : "string", "description" : "Title of the check", "minLength" : 1 }, "url" : { "type" : "string", "format" : "uri", "description" : "Check URL" }, "weight" : { "type" : "number", "format" : "double", "default" : 1, "description" : "A multiplier to the score of a Check Run. If a Check Run results in a score of 10 and the Check has\na weight of 1.5, the overall score for the resource will be interpreted as 15." } }, "required" : [ "id", "lastUpdated", "query", "resource", "source", "title" ] }, "CheckRunDto" : { "type" : "object", "description" : "Execution of a check against a metadata resource", "properties" : { "config" : { "$ref" : "#/components/schemas/CheckDto", "description" : "Check configuration" }, "end" : { "type" : "string", "format" : "date-time", "description" : "Time when execution was completed" }, "evaluatedMessage" : { "type" : "string", "description" : "Success or error message" }, "historyMessage" : { "type" : "string", "description" : "Message describing how many runs have passed/failed in the past" }, "result" : { "type" : "string", "description" : "Execution status", "enum" : [ "PASS", "FAIL", "WARN" ] }, "runSuccessful" : { "type" : "boolean", "description" : "Indicates whether execution was completed successfully" }, "score" : { "type" : "number", "format" : "double", "description" : "Evaluated score for the resource after this check run" }, "start" : { "type" : "string", "format" : "date-time", "description" : "Time when execution was started" }, "url" : { "type" : "string", "format" : "uri", "description" : "Check execution URL" } }, "required" : [ "config", "end", "result", "runSuccessful", "start" ] }, "CheckRunsDto" : { "type" : "object", "description" : "Executions of a check against a metadata resource", "properties" : { "checkRuns" : { "type" : "array", "description" : "The list of executions", "items" : { "$ref" : "#/components/schemas/CheckRunDto" }, "maxItems" : 100, "minItems" : 1 } }, "required" : [ "checkRuns" ] }, "ClearResourcePropertiesRequest" : { "type" : "object", "properties" : { "properties" : { "type" : "array", "description" : "Properties of the specified metadata resource", "items" : { "type" : "string" }, "minItems" : 1 }, "resource" : { "type" : "string", "description" : "A metadata resource", "minLength" : 1 }, "resourceType" : { "type" : "string", "description" : "Type iri of specified metadata resource", "minLength" : 1 } }, "required" : [ "properties", "resource", "resourceType" ] }, "ClearResourcesRequest" : { "type" : "object", "properties" : { "resourceType" : { "type" : "string", "description" : "Type iri of specified metadata resources", "minLength" : 1 }, "resources" : { "type" : "array", "description" : "List of metadata resource iris", "items" : { "type" : "string" }, "minItems" : 1 } }, "required" : [ "resourceType", "resources" ] }, "CollectionHydrationDto" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "id" : { "type" : "string", "description" : "dct:identifier of the collection" }, "iri" : { "type" : "string" }, "owner" : { "type" : "string" }, "title" : { "type" : "string" } } }, "ConnectionDto" : { "type" : "object", "properties" : { "advancedProperties" : { "type" : "object", "additionalProperties" : { "type" : "string" }, "description" : "Advanced properties" }, "credentials" : { "$ref" : "#/components/schemas/DatabaseCredentials", "description" : "Database Credentials" }, "database" : { "type" : "string", "description" : "Database/Schema Logical Name", "example" : "schemadw", "maxLength" : 256, "minLength" : 0, "pattern" : "[\\w\\_]{0,}" }, "host" : { "type" : "string", "description" : "Database Host", "example" : "dwserver.thinktank.com" }, "name" : { "type" : "string", "description" : "Connection name", "example" : "Humanitarian_Aid", "maxLength" : 1024, "minLength" : 0, "pattern" : "[\\w\\_\\.-]{0,}" }, "port" : { "type" : "integer", "format" : "int32", "description" : "Database Port", "example" : 5432, "maximum" : 65535, "minimum" : 1 }, "properties" : { "type" : "object", "additionalProperties" : { "type" : "string" }, "description" : "Properties such as auto commit, isolation level etc." }, "sshTunnel" : { "$ref" : "#/components/schemas/SshTunnel", "description" : "ssh tunnel configuration" }, "sslRequired" : { "type" : "boolean", "description" : "Is ssl required", "example" : true }, "trustedServerCertificates" : { "type" : "string", "description" : "trusted server certificates", "maxLength" : 100000, "minLength" : 0 }, "type" : { "type" : "string", "description" : "Database Type", "enum" : [ "ATHENA", "AZURESYNAPSE", "BIGQUERY", "DB2", "DENODO", "HIVE", "DATABRICKS", "INFOR_ION", "MYSQL", "ORACLE", "POSTGRESQL", "REDSHIFT", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TABLEAU" ], "example" : "ATHENA" }, "usePrivateKey" : { "type" : "boolean", "description" : "Should this connection use a private key?" }, "verifyServerCertificate" : { "type" : "boolean", "description" : "Should server certificate be verified", "example" : true } } }, "ContributionActivity" : { "type" : "object", "discriminator" : { "mapping" : { "AddCustomIriProperty" : "#/components/schemas/AddCustomIriPropertyContribution", "AddCustomLiteralProperty" : "#/components/schemas/AddCustomLiteralPropertyContribution", "AddTag" : "#/components/schemas/AddTagContribution", "AddToCatalog" : "#/components/schemas/AddToCatalogContribution", "AddUsesDataFrom" : "#/components/schemas/AddUsesDataFromContribution", "AddUsesDataset" : "#/components/schemas/AddUsesDatasetContribution", "CreateAnalysis" : "#/components/schemas/CreateAnalysisContribution", "CreateBusinessTerm" : "#/components/schemas/CreateBusinessTermContribution", "CreateCatalog" : "#/components/schemas/CreateCatalogContribution", "CreateCatalogResource" : "#/components/schemas/CreateCatalogResourceContribution", "CreateDataset" : "#/components/schemas/CreateDatasetContribution", "CreateExternalResource" : "#/components/schemas/CreateExternalResourceContribution", "CreateMissingDatasetAndLinkAnalysis" : "#/components/schemas/CreateMissingDatasetAndLinkAnalysisContribution", "CreateMissingDatasetAndLinkTable" : "#/components/schemas/CreateMissingDatasetAndLinkTableContribution", "ReferenceBusinessTerm" : "#/components/schemas/ReferenceBusinessTermContribution", "RemoveCustomIriProperty" : "#/components/schemas/RemoveCustomIriPropertyContribution", "RemoveCustomLiteralProperty" : "#/components/schemas/RemoveCustomLiteralPropertyContribution", "RemoveFromCatalog" : "#/components/schemas/RemoveFromCatalogContribution", "RemoveTag" : "#/components/schemas/RemoveTagContribution", "RemoveUsesDataFrom" : "#/components/schemas/RemoveUsesDataFromContribution", "RemoveUsesDataset" : "#/components/schemas/RemoveUsesDatasetContribution", "SetAssetStatus" : "#/components/schemas/SetAssetStatusContribution", "SetCustomIriProperty" : "#/components/schemas/SetCustomIriPropertyContribution", "SetCustomLiteralProperty" : "#/components/schemas/SetCustomLiteralPropertyContribution", "SetCustomStringProperty" : "#/components/schemas/SetCustomStringPropertyContribution", "SetDescription" : "#/components/schemas/SetDescriptionContribution", "SetLicense" : "#/components/schemas/SetLicenseContribution", "SetName" : "#/components/schemas/SetNameContribution", "SetSummary" : "#/components/schemas/SetSummaryContribution", "UnreferenceBusinessTerm" : "#/components/schemas/UnreferenceBusinessTermContribution" }, "propertyName" : "type" }, "properties" : { "contributionHydratables" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ContributionHydratable" } }, "type" : { "type" : "string", "enum" : [ "AddCustomIriProperty", "AddCustomLiteralProperty", "AddTag", "AddToCatalog", "AddUsesDataFrom", "AddUsesDataset", "CreateAnalysis", "CreateBusinessTerm", "CreateCatalog", "CreateCatalogResource", "CreateDataset", "CreateExternalResource", "CreateMissingDatasetAndLinkAnalysis", "CreateMissingDatasetAndLinkTable", "ReferenceBusinessTerm", "RemoveCustomIriProperty", "RemoveCustomLiteralProperty", "RemoveFromCatalog", "RemoveTag", "RemoveUsesDataFrom", "RemoveUsesDataset", "SetAssetStatus", "SetCustomIriProperty", "SetCustomLiteralProperty", "SetCustomStringProperty", "SetDescription", "SetLicense", "SetName", "SetSummary", "UnreferenceBusinessTerm" ] } }, "required" : [ "type" ] }, "ContributionDto" : { "type" : "object", "properties" : { "activities" : { "type" : "array", "description" : "Details about the contribution", "items" : { "$ref" : "#/components/schemas/ContributionActivity" } }, "activityType" : { "type" : "string", "description" : "The type of contribution that is being made", "enum" : [ "METADATA_EDIT", "RELATIONSHIP" ] }, "type" : { "type" : "string", "description" : "The type of resource that this contribution is done on", "enum" : [ "METADATA", "DATASET" ] } }, "required" : [ "activities", "activityType", "type" ] }, "ContributionHydratable" : { "type" : "object", "properties" : { "agentId" : { "type" : "string" }, "entityType" : { "type" : "string", "minLength" : 1 }, "identifier" : { "type" : "string", "minLength" : 1 } }, "required" : [ "entityType", "identifier" ] }, "CreateAnalysisContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "analysisIri" : { "type" : "string" }, "catalogIri" : { "type" : "string" }, "name" : { "type" : "string" }, "subclass" : { "type" : "string" }, "type" : { "type" : "string", "const" : "CreateAnalysis" } } } ], "required" : [ "catalogIri", "name" ] }, "CreateBusinessTermContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "businessTermIri" : { "type" : "string" }, "catalogIri" : { "type" : "string" }, "name" : { "type" : "string" }, "subclass" : { "type" : "string" }, "type" : { "type" : "string", "const" : "CreateBusinessTerm" } } } ], "required" : [ "catalogIri", "name" ] }, "CreateCatalogContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "catalogIri" : { "type" : "string" }, "name" : { "type" : "string" }, "parentCatalogIri" : { "type" : "string" }, "subclass" : { "type" : "string" }, "type" : { "type" : "string", "const" : "CreateCatalog" } } } ], "required" : [ "name" ] }, "CreateCatalogResourceContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "catalogIri" : { "type" : "array", "items" : { "type" : "string" }, "minItems" : 1 }, "name" : { "type" : "string" }, "resourceIri" : { "type" : "string" }, "resourceTypeIri" : { "type" : "string" }, "type" : { "type" : "string", "const" : "CreateCatalogResource" } } } ], "required" : [ "catalogIri", "name", "resourceTypeIri" ] }, "CreateDatasetContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "agentId" : { "type" : "string" }, "datasetId" : { "type" : "string" }, "datasetIri" : { "type" : "string" }, "title" : { "type" : "string" }, "type" : { "type" : "string", "const" : "CreateDataset" } } } ], "required" : [ "agentId", "datasetId", "title" ] }, "CreateDatasetResponse" : { "type" : "object", "properties" : { "message" : { "type" : "string", "maxLength" : 256, "minLength" : 0 }, "uri" : { "type" : "string", "format" : "uri" } }, "required" : [ "uri" ] }, "CreateExternalResourceContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "entityIri" : { "type" : "string" }, "entityType" : { "type" : "string" }, "externalUrl" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string", "const" : "CreateExternalResource" } } } ], "required" : [ "entityType", "externalUrl" ] }, "CreateInsightResponse" : { "type" : "object", "properties" : { "message" : { "type" : "string", "maxLength" : 256, "minLength" : 0 }, "uri" : { "type" : "string", "format" : "uri" } }, "required" : [ "uri" ] }, "CreateMissingDatasetAndLinkAnalysisContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "agentId" : { "type" : "string" }, "analysisIri" : { "type" : "string" }, "datasetId" : { "type" : "string" }, "datasetIri" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "title" : { "type" : "string" }, "type" : { "type" : "string", "const" : "CreateMissingDatasetAndLinkAnalysis" } } } ], "required" : [ "agentId", "analysisIri", "datasetId", "title" ] }, "CreateMissingDatasetAndLinkTableContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "agentId" : { "type" : "string" }, "databaseTableIri" : { "type" : "string" }, "datasetId" : { "type" : "string" }, "datasetIri" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "title" : { "type" : "string" }, "type" : { "type" : "string", "const" : "CreateMissingDatasetAndLinkTable" } } } ], "required" : [ "agentId", "databaseTableIri", "datasetId", "title" ] }, "CreateOrUpdateUserRequest" : { "type" : "object", "properties" : { "assignments" : { "type" : "array", "description" : "Organizations with groups that user should be assigned to. The requester needs to be an admin of the requested organizations.", "items" : { "$ref" : "#/components/schemas/UserAssignment" }, "maxItems" : 10, "minItems" : 0 }, "credentials" : { "type" : "string", "description" : "credentials" }, "displayName" : { "type" : "string", "description" : "Human-readable organization or agent name", "maxLength" : 128, "minLength" : 0 }, "email" : { "type" : "string", "description" : "email", "maxLength" : 128, "minLength" : 0 } }, "required" : [ "credentials", "displayName", "email" ] }, "CreateProjectResponse" : { "type" : "object", "properties" : { "message" : { "type" : "string", "maxLength" : 256, "minLength" : 0 }, "uri" : { "type" : "string", "format" : "uri" } }, "required" : [ "uri" ] }, "CreateQueryRequest" : { "type" : "object", "properties" : { "content" : { "type" : "string" }, "description" : { "type" : "string", "maxLength" : 1000, "minLength" : 0 }, "language" : { "type" : "string", "enum" : [ "SPARQL", "SQL" ] }, "name" : { "type" : "string", "maxLength" : 128, "minLength" : 0 }, "published" : { "type" : "boolean" } }, "required" : [ "content", "language", "name" ] }, "CreateResponse" : { "type" : "object", "properties" : { "message" : { "type" : "string", "maxLength" : 256, "minLength" : 0 }, "uri" : { "type" : "string", "format" : "uri" } }, "required" : [ "uri" ] }, "DataQualityAuditRecord" : { "type" : "object", "properties" : { "auditType" : { "type" : "string" }, "executedAt" : { "type" : "string", "format" : "date-time" }, "message" : { "type" : "string" }, "requestId" : { "type" : "string" }, "resourceIri" : { "type" : "string" } } }, "DataQualityAuditsDto" : { "type" : "object", "description" : "Audits of the Data Quality", "properties" : { "audits" : { "type" : "array", "description" : "The list of audits", "items" : { "$ref" : "#/components/schemas/DataQualityAuditRecord" } } } }, "Database" : { "allOf" : [ { "$ref" : "#/components/schemas/DatabaseResource" }, { "type" : "object", "properties" : { "context" : { "type" : "string", "description" : "The original organization agent ID that the resource was collected into. This can be found in the RDF\nfile outputted by the collector. In the RDF, there is a resource of type \"dwec:CatalogCuration\" containing\nmany configuration properties. The \"context\" property is this field.\n", "minLength" : 1 }, "database" : { "type" : "string", "description" : "The Database", "minLength" : 1 }, "databaseLocation" : { "type" : "string", "description" : "Database server host and port, formatted as \"host:port\". This can be found in the RDF file outputted by the\ncollector. In the RDF, there is a resource of type \"dwec:CatalogCuration\" containing many configuration\nproperties. The \"host\" property is part of this field. Port can be found under any \"dwec:Database\"\nresource under the predicate \"dwec:databasePort\".\n", "minLength" : 1 }, "type" : { "type" : "string", "const" : "DATABASE" } } } ], "description" : "A database", "required" : [ "context", "database", "databaseLocation" ] }, "DatabaseColumn" : { "allOf" : [ { "$ref" : "#/components/schemas/DatabaseResource" }, { "type" : "object", "properties" : { "column" : { "type" : "string", "description" : "The table column", "minLength" : 1 }, "context" : { "type" : "string", "description" : "The original organization agent ID that the resource was collected into. This can be found in the RDF\nfile outputted by the collector. In the RDF, there is a resource of type \"dwec:CatalogCuration\" containing\nmany configuration properties. The \"context\" property is this field.\n", "minLength" : 1 }, "database" : { "type" : "string", "description" : "The Database", "minLength" : 1 }, "databaseLocation" : { "type" : "string", "description" : "Database server host and port, formatted as \"host:port\". This can be found in the RDF file outputted by the\ncollector. In the RDF, there is a resource of type \"dwec:CatalogCuration\" containing many configuration\nproperties. The \"host\" property is part of this field. Port can be found under any \"dwec:Database\"\nresource under the predicate \"dwec:databasePort\".\n", "minLength" : 1 }, "schema" : { "type" : "string", "description" : "The database schema" }, "table" : { "type" : "string", "description" : "The database table", "minLength" : 1 }, "type" : { "type" : "string", "const" : "COLUMN" } } } ], "description" : "A column in a database table", "required" : [ "column", "context", "database", "databaseLocation", "table" ] }, "DatabaseCredentials" : { "type" : "object", "properties" : { "password" : { "type" : "string", "description" : "password", "example" : "!AdHJfGgd@3#", "maxLength" : 16384, "minLength" : 0 }, "user" : { "type" : "string", "description" : "user name", "example" : "johnsmith", "maxLength" : 1024, "minLength" : 0 } }, "required" : [ "user" ] }, "DatabaseDto" : { "type" : "object", "properties" : { "catalog" : { "type" : "string" }, "created" : { "type" : "string", "format" : "date-time" }, "environment" : { "type" : "string" }, "id" : { "type" : "string" }, "port" : { "type" : "integer", "format" : "int32" }, "schema" : { "type" : "string" }, "server" : { "type" : "string" }, "type" : { "type" : "string" }, "updated" : { "type" : "string", "format" : "date-time" } } }, "DatabaseMetadataSpecDto" : { "type" : "object", "properties" : { "tableSpecs" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TableMetadataSpecDto" }, "maxItems" : 100, "minItems" : 0 } } }, "DatabaseResource" : { "discriminator" : { "mapping" : { "COLUMN" : "#/components/schemas/DatabaseColumn", "DATABASE" : "#/components/schemas/Database", "IRI" : "#/components/schemas/IRIResource", "TABLE" : "#/components/schemas/DatabaseTable" }, "propertyName" : "type" }, "properties" : { "type" : { "type" : "string", "enum" : [ "IRI", "DATABASE", "TABLE", "COLUMN" ] } }, "required" : [ "type" ] }, "DatabaseSourceReference" : { "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "owner" : { "type" : "string" } }, "required" : [ "id", "owner" ] }, "DatabaseTable" : { "allOf" : [ { "$ref" : "#/components/schemas/DatabaseResource" }, { "type" : "object", "properties" : { "context" : { "type" : "string", "description" : "The original organization agent ID that the resource was collected into. This can be found in the RDF\nfile outputted by the collector. In the RDF, there is a resource of type \"dwec:CatalogCuration\" containing\nmany configuration properties. The \"context\" property is this field.\n", "minLength" : 1 }, "database" : { "type" : "string", "description" : "The Database", "minLength" : 1 }, "databaseLocation" : { "type" : "string", "description" : "Database server host and port, formatted as \"host:port\". This can be found in the RDF file outputted by the\ncollector. In the RDF, there is a resource of type \"dwec:CatalogCuration\" containing many configuration\nproperties. The \"host\" property is part of this field. Port can be found under any \"dwec:Database\"\nresource under the predicate \"dwec:databasePort\".\n", "minLength" : 1 }, "schema" : { "type" : "string", "description" : "The database schema" }, "table" : { "type" : "string", "description" : "The database table", "minLength" : 1 }, "type" : { "type" : "string", "const" : "TABLE" } } } ], "description" : "A table in a database", "required" : [ "context", "database", "databaseLocation", "table" ] }, "DatasetCreateRequest" : { "type" : "object", "properties" : { "assetStatusIri" : { "type" : "string" }, "autoSyncInterval" : { "type" : "string", "description" : "Interval in which files should be synced", "enum" : [ "NEVER", "HOURLY", "DAILY", "WEEKLY" ] }, "description" : { "type" : "string", "maxLength" : 120, "minLength" : 0 }, "files" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FileCreateRequest" } }, "license" : { "type" : "string", "enum" : [ "Public Domain, PDDL, CC-0, CC-BY, CDLA-Permissive-1.0, CC-BY-IGO, CC-BY 3.0, CC-BY 3.0 AU, CC-BY 3.0 IGO, CC-BY-SA, CC-BY-SA 3.0, CDLA-Sharing-1.0, CC BY-NC, CC BY-ND, CC BY-ND 3.0, CC-BY 3.0 NZ, CC-BY-NC 3.0, CC BY-NC-ND, CC-BY-NC-SA 3.0, CC-BY-SA 3.0 NZ, CC-BY-NC-SA 3.0 NZ, CC-BY-NC 3.0 NZ, CC-BY-NC-ND-NZ-3.0, CC BY-NC-SA, Italian-ODL, MIT License, OGL, OGL-Canada, OGL-Nova Scotia, OGL-UK, OSODL, ODC-BY, ODC-ODbL, Other" ] }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/StringOrArray" }, "description" : "Create/update any property that is associated with a metadata presentation. Key is the IRI of the property. Value is the intended value of the property." }, "summary" : { "type" : "string", "maxLength" : 25000, "minLength" : 0 }, "tags" : { "type" : "array", "items" : { "type" : "string" } }, "title" : { "type" : "string", "maxLength" : 60, "minLength" : 1 }, "visibility" : { "type" : "string", "enum" : [ "OPEN, PRIVATE" ] } }, "required" : [ "title", "visibility" ] }, "DatasetHydrationDto" : { "type" : "object", "properties" : { "_abstract" : { "type" : "string", "writeOnly" : true }, "abstract" : { "type" : "string" }, "agentid" : { "type" : "string" }, "createdBy" : { "$ref" : "#/components/schemas/AgentHydrationDto" }, "datasetid" : { "type" : "string" }, "headline" : { "type" : "string" }, "name" : { "type" : "string" }, "project" : { "type" : "boolean" }, "referent" : { "type" : "string" }, "relationship" : { "$ref" : "#/components/schemas/ResourceRelationshipDto" }, "type" : { "type" : "string" }, "updated" : { "type" : "string", "format" : "date-time" }, "userUpdated" : { "type" : "string", "format" : "date-time" } } }, "DatasetIdentifier" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "owner" : { "type" : "string" } }, "required" : [ "id", "owner" ] }, "DatasetIdentifierRequest" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of dataset" }, "owner" : { "type" : "string", "description" : "ID of user or organization that owns the dataset" } }, "required" : [ "id", "owner" ] }, "DatasetPatchRequest" : { "type" : "object", "properties" : { "assetStatusIri" : { "type" : "string" }, "autoSyncInterval" : { "type" : "string", "description" : "Interval in which files should be synced", "enum" : [ "NEVER", "HOURLY", "DAILY", "WEEKLY" ] }, "description" : { "type" : "string" }, "license" : { "type" : "string", "enum" : [ "Public Domain, PDDL, CC-0, CC-BY, CDLA-Permissive-1.0, CC-BY-IGO, CC-BY 3.0, CC-BY 3.0 AU, CC-BY 3.0 IGO, CC-BY-SA, CC-BY-SA 3.0, CDLA-Sharing-1.0, CC BY-NC, CC BY-ND, CC BY-ND 3.0, CC-BY 3.0 NZ, CC-BY-NC 3.0, CC BY-NC-ND, CC-BY-NC-SA 3.0, CC-BY-SA 3.0 NZ, CC-BY-NC-SA 3.0 NZ, CC-BY-NC 3.0 NZ, CC-BY-NC-ND-NZ-3.0, CC BY-NC-SA, Italian-ODL, MIT License, OGL, OGL-Canada, OGL-Nova Scotia, OGL-UK, OSODL, ODC-BY, ODC-ODbL, Other" ] }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/JsonNode" } }, "summary" : { "type" : "string" }, "tags" : { "type" : "array", "description" : "Tags included in a PATCH request will replace all previous tags.", "items" : { "type" : "string", "description" : "Tags included in a PATCH request will replace all previous tags." } }, "title" : { "type" : "string", "maxLength" : 60, "minLength" : 1 }, "visibility" : { "type" : "string", "enum" : [ "OPEN, PRIVATE" ] } } }, "DatasetPutRequest" : { "type" : "object", "properties" : { "assetStatusIri" : { "type" : "string" }, "description" : { "type" : "string", "maxLength" : 120, "minLength" : 0 }, "license" : { "type" : "string", "enum" : [ "Public Domain, PDDL, CC-0, CC-BY, CDLA-Permissive-1.0, CC-BY-IGO, CC-BY 3.0, CC-BY 3.0 AU, CC-BY 3.0 IGO, CC-BY-SA, CC-BY-SA 3.0, CDLA-Sharing-1.0, CC BY-NC, CC BY-ND, CC BY-ND 3.0, CC-BY 3.0 NZ, CC-BY-NC 3.0, CC BY-NC-ND, CC-BY-NC-SA 3.0, CC-BY-SA 3.0 NZ, CC-BY-NC-SA 3.0 NZ, CC-BY-NC 3.0 NZ, CC-BY-NC-ND-NZ-3.0, CC BY-NC-SA, Italian-ODL, MIT License, OGL, OGL-Canada, OGL-Nova Scotia, OGL-UK, OSODL, ODC-BY, ODC-ODbL, Other" ] }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/StringOrArray" }, "description" : "Create/update any property that is associated with a metadata presentation. Key is the IRI of the property. Value is the intended value of the property." }, "summary" : { "type" : "string", "maxLength" : 25000, "minLength" : 0 }, "tags" : { "type" : "array", "items" : { "type" : "string" } }, "title" : { "type" : "string", "maxLength" : 60, "minLength" : 1 }, "visibility" : { "type" : "string", "enum" : [ "OPEN, PRIVATE" ] } }, "required" : [ "title", "visibility" ] }, "DatasetStatistics" : { "type" : "object", "properties" : { "columnCount" : { "type" : "integer", "format" : "int32" }, "fileCount" : { "type" : "integer", "format" : "int32" }, "tableCount" : { "type" : "integer", "format" : "int32" } } }, "DatasetSummaryResponse" : { "type" : "object", "properties" : { "accessLevel" : { "type" : "string", "enum" : [ "NONE, DISCOVER, READ, WRITE, ADMIN" ] }, "assetStatus" : { "$ref" : "#/components/schemas/AssetStatus" }, "created" : { "type" : "string", "format" : "date-time" }, "datasetStatistics" : { "$ref" : "#/components/schemas/DatasetStatistics", "description" : "Describes number of files, tables, and columns in the dataset" }, "description" : { "type" : "string", "maxLength" : 120, "minLength" : 0 }, "dois" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Doi" } }, "files" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FileSummaryResponse" } }, "id" : { "type" : "string" }, "isProject" : { "type" : "boolean" }, "license" : { "type" : "string", "enum" : [ "Public Domain, PDDL, CC-0, CC-BY, CDLA-Permissive-1.0, CC-BY-IGO, CC-BY 3.0, CC-BY 3.0 AU, CC-BY 3.0 IGO, CC-BY-SA, CC-BY-SA 3.0, CDLA-Sharing-1.0, CC BY-NC, CC BY-ND, CC BY-ND 3.0, CC-BY 3.0 NZ, CC-BY-NC 3.0, CC BY-NC-ND, CC-BY-NC-SA 3.0, CC-BY-SA 3.0 NZ, CC-BY-NC-SA 3.0 NZ, CC-BY-NC 3.0 NZ, CC-BY-NC-ND-NZ-3.0, CC BY-NC-SA, Italian-ODL, MIT License, OGL, OGL-Canada, OGL-Nova Scotia, OGL-UK, OSODL, ODC-BY, ODC-ODbL, Other" ] }, "linkedDatasets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedDatasetSummaryResponse" }, "writeOnly" : true }, "owner" : { "type" : "string" }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/StringOrArray" }, "description" : "All properties of the resource that are associated with a metadata presentation. Key is the IRI of the property. Value is the value of the property." }, "similarResources" : { "type" : "array", "description" : "Similar datasets with the same owner", "items" : { "oneOf" : [ { "$ref" : "#/components/schemas/SimpleDataset" } ] } }, "status" : { "type" : "string", "enum" : [ "NEW, INPROGRESS, LOADED, SYSTEMERROR" ] }, "summary" : { "type" : "string", "maxLength" : 25000, "minLength" : 0 }, "tags" : { "type" : "array", "items" : { "type" : "string" } }, "title" : { "type" : "string", "maxLength" : 60, "minLength" : 1 }, "updated" : { "type" : "string", "format" : "date-time" }, "version" : { "type" : "string" }, "versionDois" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Doi" } }, "visibility" : { "type" : "string", "enum" : [ "OPEN, PRIVATE" ] } }, "required" : [ "accessLevel", "created", "id", "isProject", "owner", "status", "title", "updated", "version", "visibility" ] }, "DeleteCheckDto" : { "type" : "object", "description" : "A data quality check to delete", "properties" : { "checkId" : { "type" : "string", "description" : "Check identifier as provided by the data quality provider", "example" : "freshness-check-001", "minLength" : 1 }, "source" : { "type" : "string", "description" : "Data quality provider name as given at resource creation", "example" : "anamalo", "minLength" : 1 } }, "required" : [ "checkId", "source" ] }, "DeleteChecksDto" : { "type" : "object", "description" : "A list of data quality checks to delete", "properties" : { "checks" : { "type" : "array", "description" : "The list of checks to delete", "items" : { "$ref" : "#/components/schemas/DeleteCheckDto" }, "maxItems" : 100, "minItems" : 1 } }, "required" : [ "checks" ] }, "Doi" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time" }, "doi" : { "type" : "string" } }, "required" : [ "created", "doi" ] }, "DwccSpecDto" : { "type" : "object", "properties" : { "databaseId" : { "type" : "string" }, "metadataToExclude" : { "type" : "array", "items" : { "type" : "string" } }, "sourceDatabase" : { "type" : "string" }, "sourceSchemas" : { "type" : "array", "items" : { "type" : "string" } }, "targetCatalog" : { "type" : "string" } } }, "EmojiIcon" : { "allOf" : [ { "$ref" : "#/components/schemas/Icon" }, { "type" : "object", "properties" : { "type" : { "type" : "string", "const" : "emoji" }, "value" : { "type" : "string" } } } ] }, "EntryType" : { "type" : "object", "properties" : { "icon" : { "$ref" : "#/components/schemas/Icon", "oneOf" : [ { "$ref" : "#/components/schemas/EmojiIcon" }, { "$ref" : "#/components/schemas/ImageIcon" }, { "$ref" : "#/components/schemas/SvgIcon" } ] }, "instantiable" : { "type" : "boolean" }, "label" : { "type" : "string" }, "pluralLabel" : { "type" : "string" }, "requestable" : { "type" : "boolean" }, "type" : { "type" : "string", "description" : "Entry type IRI" } } }, "ErrorMessage" : { "type" : "object", "properties" : { "code" : { "type" : "integer", "format" : "int32" }, "details" : { "type" : "string" }, "message" : { "type" : "string" } } }, "FileBatchUpdateRequest" : { "type" : "object", "properties" : { "files" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FileCreateOrUpdateRequest" } } } }, "FileCreateOrUpdateRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string", "maxLength" : 120, "minLength" : 1 }, "labels" : { "type" : "array", "items" : { "type" : "string" } }, "mediaType" : { "type" : "string" }, "mediaTypeLocked" : { "type" : "boolean" }, "name" : { "type" : "string", "maxLength" : 128, "minLength" : 1, "pattern" : "^[^/]+$" }, "source" : { "$ref" : "#/components/schemas/FileSourceCreateOrUpdateRequest" } }, "required" : [ "name" ] }, "FileCreateRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string", "maxLength" : 120, "minLength" : 1 }, "labels" : { "type" : "array", "items" : { "type" : "string" } }, "name" : { "type" : "string", "maxLength" : 128, "minLength" : 1, "pattern" : "^[^/]+$" }, "source" : { "$ref" : "#/components/schemas/FileSourceCreateRequest" } }, "required" : [ "name", "source" ] }, "FileMetadataResponse" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time" }, "createdBy" : { "type" : "string" }, "description" : { "type" : "string", "maxLength" : 120, "minLength" : 1 }, "labels" : { "type" : "array", "items" : { "type" : "string" } }, "name" : { "type" : "string", "maxLength" : 128, "minLength" : 1, "pattern" : "^[^/]+$" }, "sizeInBytes" : { "type" : "integer", "format" : "int64" }, "updated" : { "type" : "string", "format" : "date-time" }, "updatedBy" : { "type" : "string" } }, "required" : [ "created", "name", "updated" ] }, "FileMetadataUpdateRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "labels" : { "type" : "array", "items" : { "type" : "string" }, "uniqueItems" : true } } }, "FileSourceCreateOrUpdateRequest" : { "type" : "object", "properties" : { "authorization" : { "$ref" : "#/components/schemas/WebAuthorization" }, "credentials" : { "$ref" : "#/components/schemas/WebCredentials" }, "dataTables" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/QueryExecutionDto" } }, "databaseMetadataSpec" : { "$ref" : "#/components/schemas/DatabaseMetadataSpecDto" }, "databaseSource" : { "$ref" : "#/components/schemas/DatabaseSourceReference" }, "dwccSpec" : { "$ref" : "#/components/schemas/DwccSpecDto" }, "expandArchive" : { "type" : "boolean" }, "method" : { "type" : "string", "enum" : [ "GET", "POST" ] }, "oauthToken" : { "$ref" : "#/components/schemas/OauthTokenReference" }, "requestEntity" : { "type" : "string", "maxLength" : 10000, "minLength" : 0 }, "requestHeaders" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "tableSpec" : { "$ref" : "#/components/schemas/SingleTableMetadataSpecDto" }, "url" : { "type" : "string", "format" : "uri" }, "useDwCredentials" : { "type" : "boolean" }, "viewRequest" : { "$ref" : "#/components/schemas/ViewRequestDto" } } }, "FileSourceCreateRequest" : { "type" : "object", "properties" : { "authorization" : { "$ref" : "#/components/schemas/WebAuthorization" }, "credentials" : { "$ref" : "#/components/schemas/WebCredentials" }, "dataTables" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/QueryExecutionDto" } }, "databaseMetadataSpec" : { "$ref" : "#/components/schemas/DatabaseMetadataSpecDto" }, "databaseSource" : { "$ref" : "#/components/schemas/DatabaseSourceReference" }, "dwccSpec" : { "$ref" : "#/components/schemas/DwccSpecDto" }, "expandArchive" : { "type" : "boolean" }, "method" : { "type" : "string", "enum" : [ "GET", "POST" ] }, "oauthToken" : { "$ref" : "#/components/schemas/OauthTokenReference" }, "requestEntity" : { "type" : "string", "maxLength" : 10000, "minLength" : 0 }, "requestHeaders" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "tableSpec" : { "$ref" : "#/components/schemas/SingleTableMetadataSpecDto" }, "url" : { "type" : "string", "format" : "uri" }, "useDwCredentials" : { "type" : "boolean" }, "viewRequest" : { "$ref" : "#/components/schemas/ViewRequestDto" } } }, "FileSourceSummaryResponse" : { "type" : "object", "properties" : { "authorization" : { "$ref" : "#/components/schemas/WebAuthorization" }, "credentials" : { "$ref" : "#/components/schemas/WebCredentials" }, "dataTables" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/QueryExecutionDto" } }, "databaseMetadataSpec" : { "$ref" : "#/components/schemas/DatabaseMetadataSpecDto" }, "databaseSource" : { "$ref" : "#/components/schemas/DatabaseSourceReference" }, "dwccSpec" : { "$ref" : "#/components/schemas/DwccSpecDto" }, "expandArchive" : { "type" : "boolean" }, "lastSyncFailure" : { "type" : "string", "format" : "date-time" }, "lastSyncStart" : { "type" : "string", "format" : "date-time" }, "lastSyncSuccess" : { "type" : "string", "format" : "date-time" }, "mediaType" : { "type" : "string" }, "mediaTypeLocked" : { "type" : "boolean" }, "method" : { "type" : "string", "enum" : [ "GET", "POST" ] }, "oauthToken" : { "$ref" : "#/components/schemas/OauthTokenReference" }, "requestEntity" : { "type" : "string", "maxLength" : 10000, "minLength" : 0 }, "requestHeaders" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "syncStatus" : { "type" : "string", "enum" : [ "NEW", "INPROGRESS", "OK", "SYSTEMERROR" ] }, "syncSummary" : { "type" : "string" }, "tableSpec" : { "$ref" : "#/components/schemas/SingleTableMetadataSpecDto" }, "url" : { "type" : "string", "format" : "uri" }, "useDwCredentials" : { "type" : "boolean" }, "viewRequest" : { "$ref" : "#/components/schemas/ViewRequestDto" } }, "required" : [ "syncStatus" ] }, "FileSummaryResponse" : { "type" : "object", "properties" : { "created" : { "type" : "string", "format" : "date-time" }, "createdBy" : { "type" : "string" }, "description" : { "type" : "string", "maxLength" : 120, "minLength" : 1 }, "labels" : { "type" : "array", "items" : { "type" : "string" } }, "name" : { "type" : "string", "maxLength" : 128, "minLength" : 1, "pattern" : "^[^/]+$" }, "sizeInBytes" : { "type" : "integer", "format" : "int64" }, "source" : { "$ref" : "#/components/schemas/FileSourceSummaryResponse" }, "updated" : { "type" : "string", "format" : "date-time" }, "updatedBy" : { "type" : "string" } }, "required" : [ "created", "name", "updated" ] }, "GroupHydrationDto" : { "type" : "object", "properties" : { "agentid" : { "type" : "string" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "groupid" : { "type" : "string" } } }, "HostedImage" : { "allOf" : [ { "$ref" : "#/components/schemas/Image" }, { "type" : "object", "properties" : { "type" : { "type" : "string", "const" : "hosted" }, "url" : { "type" : "string" } } } ] }, "IRIResource" : { "allOf" : [ { "$ref" : "#/components/schemas/DatabaseResource" }, { "type" : "object", "properties" : { "iri" : { "type" : "string", "format" : "uri", "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’s catalog page." }, "type" : { "type" : "string", "const" : "IRI" } } } ], "description" : "A metadata resource represented by an IRI", "required" : [ "iri" ] }, "Icon" : { "type" : "object", "discriminator" : { "mapping" : { "emoji" : "#/components/schemas/EmojiIcon", "image" : "#/components/schemas/ImageIcon", "svg-image" : "#/components/schemas/SvgIcon" }, "propertyName" : "type" }, "properties" : { "type" : { "type" : "string", "enum" : [ "emoji", "image", "svg-image" ] } } }, "Image" : { "type" : "object", "discriminator" : { "mapping" : { "hosted" : "#/components/schemas/HostedImage", "provided" : "#/components/schemas/ProvidedImage" }, "propertyName" : "type" }, "properties" : { "type" : { "type" : "string", "enum" : [ "hosted", "provided" ] } } }, "ImageIcon" : { "allOf" : [ { "$ref" : "#/components/schemas/Icon" }, { "type" : "object", "properties" : { "image" : { "$ref" : "#/components/schemas/Image", "oneOf" : [ { "$ref" : "#/components/schemas/HostedImage" }, { "$ref" : "#/components/schemas/ProvidedImage" } ] }, "largeImage" : { "$ref" : "#/components/schemas/Image", "oneOf" : [ { "$ref" : "#/components/schemas/HostedImage" }, { "$ref" : "#/components/schemas/ProvidedImage" } ] }, "selectedImage" : { "$ref" : "#/components/schemas/Image", "oneOf" : [ { "$ref" : "#/components/schemas/HostedImage" }, { "$ref" : "#/components/schemas/ProvidedImage" } ] }, "type" : { "type" : "string", "const" : "image" } } } ] }, "InsightBody" : { "type" : "object", "properties" : { "embedUrl" : { "type" : "string", "format" : "uri" }, "imageUrl" : { "type" : "string", "format" : "uri" }, "markdownBody" : { "type" : "string", "maxLength" : 25000, "minLength" : 0 } } }, "InsightCreateRequest" : { "type" : "object", "properties" : { "body" : { "$ref" : "#/components/schemas/InsightBody" }, "dataSourceLinks" : { "type" : "array", "items" : { "type" : "string", "format" : "uri" } }, "description" : { "type" : "string", "maxLength" : 25000, "minLength" : 0 }, "sourceLink" : { "type" : "string", "format" : "uri" }, "thumbnail" : { "type" : "string", "format" : "uri" }, "title" : { "type" : "string", "maxLength" : 128, "minLength" : 1 } }, "required" : [ "body", "title" ] }, "InsightHydrationDto" : { "type" : "object", "properties" : { "body" : { "type" : "string" }, "createdBy" : { "$ref" : "#/components/schemas/AgentHydrationDto" }, "dataSources" : { "type" : "array", "items" : { "type" : "string", "format" : "uri" } }, "dataset" : { "$ref" : "#/components/schemas/DatasetHydrationDto" }, "datasetid" : { "type" : "string" }, "description" : { "type" : "string" }, "insightid" : { "type" : "string" }, "thumbnail" : { "type" : "string", "format" : "uri" }, "title" : { "type" : "string" }, "type" : { "type" : "string" }, "updated" : { "type" : "string", "format" : "date-time" } } }, "InsightPatchRequest" : { "type" : "object", "properties" : { "body" : { "$ref" : "#/components/schemas/InsightBody" }, "dataSourceLinks" : { "type" : "array", "description" : "Data source links included in a PATCH request will replace existing data source links.", "items" : { "type" : "string", "format" : "uri" } }, "description" : { "type" : "string" }, "sourceLink" : { "type" : "string", "format" : "uri" }, "thumbnail" : { "type" : "string", "format" : "uri" }, "title" : { "type" : "string", "maxLength" : 128, "minLength" : 1 } } }, "InsightPutRequest" : { "type" : "object", "properties" : { "body" : { "$ref" : "#/components/schemas/InsightBody" }, "dataSourceLinks" : { "type" : "array", "items" : { "type" : "string", "format" : "uri" } }, "description" : { "type" : "string", "maxLength" : 25000, "minLength" : 0 }, "sourceLink" : { "type" : "string", "format" : "uri" }, "thumbnail" : { "type" : "string", "format" : "uri" }, "title" : { "type" : "string", "maxLength" : 128, "minLength" : 1 } }, "required" : [ "body", "title" ] }, "InsightSummaryResponse" : { "type" : "object", "properties" : { "author" : { "type" : "string" }, "body" : { "$ref" : "#/components/schemas/InsightBody" }, "created" : { "type" : "string", "format" : "date-time" }, "dataSourceLinks" : { "type" : "array", "items" : { "type" : "string", "format" : "uri" } }, "description" : { "type" : "string", "maxLength" : 25000, "minLength" : 0 }, "id" : { "type" : "string", "format" : "uuid" }, "sourceLink" : { "type" : "string", "format" : "uri" }, "thumbnail" : { "type" : "string", "format" : "uri" }, "title" : { "type" : "string", "maxLength" : 128, "minLength" : 1 }, "updated" : { "type" : "string", "format" : "date-time" }, "version" : { "type" : "string" } }, "required" : [ "author", "body", "created", "id", "title", "updated", "version" ] }, "JsonNode" : { }, "LinkedDatasetCreateOrUpdateRequest" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "owner" : { "type" : "string" } }, "required" : [ "id", "owner" ] }, "LinkedDatasetSummaryResponse" : { "type" : "object", "properties" : { "accessLevel" : { "type" : "string", "enum" : [ "NONE, DISCOVER, READ, WRITE, ADMIN" ] }, "created" : { "type" : "string", "format" : "date-time" }, "description" : { "type" : "string", "maxLength" : 120, "minLength" : 0 }, "id" : { "type" : "string" }, "license" : { "type" : "string", "enum" : [ "Public Domain, PDDL, CC-0, CC-BY, CDLA-Permissive-1.0, CC-BY-IGO, CC-BY 3.0, CC-BY 3.0 AU, CC-BY 3.0 IGO, CC-BY-SA, CC-BY-SA 3.0, CDLA-Sharing-1.0, CC BY-NC, CC BY-ND, CC BY-ND 3.0, CC-BY 3.0 NZ, CC-BY-NC 3.0, CC BY-NC-ND, CC-BY-NC-SA 3.0, CC-BY-SA 3.0 NZ, CC-BY-NC-SA 3.0 NZ, CC-BY-NC 3.0 NZ, CC-BY-NC-ND-NZ-3.0, CC BY-NC-SA, Italian-ODL, MIT License, OGL, OGL-Canada, OGL-Nova Scotia, OGL-UK, OSODL, ODC-BY, ODC-ODbL, Other" ] }, "owner" : { "type" : "string" }, "summary" : { "type" : "string", "maxLength" : 25000, "minLength" : 0 }, "tags" : { "type" : "array", "items" : { "type" : "string" } }, "title" : { "type" : "string", "maxLength" : 60, "minLength" : 1 }, "updated" : { "type" : "string", "format" : "date-time" }, "version" : { "type" : "string" }, "visibility" : { "type" : "string", "enum" : [ "OPEN, PRIVATE" ] } }, "required" : [ "accessLevel", "created", "id", "owner", "title", "updated", "visibility" ] }, "MetadataRequest" : { "type" : "object", "properties" : { "assetStatusIri" : { "type" : "string", "maxLength" : 5000, "minLength" : 0 }, "collections" : { "type" : "array", "description" : "Catalog Collection to which this metadata resource is added. Required for POST and PUT.Available catalog collection can be discovered via appropriate discovery endpoints.", "example" : [ "Aid Option" ], "items" : { "type" : "string", "description" : "Catalog Collection to which this metadata resource is added. Required for POST and PUT.Available catalog collection can be discovered via appropriate discovery endpoints.", "example" : [ "Aid Option" ] } }, "description" : { "type" : "string", "description" : "A short, but descriptive statement about the metadata resource.", "example" : "Aid given to charity is an option that can be exercised by individuals and corporations", "maxLength" : 5000, "minLength" : 0 }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/StringOrArray" }, "description" : "Custom properties for the metadata resource mapped to API Bindings. Can be simple name-value string pairs or nested values for a string name. See examples for details." }, "summary" : { "type" : "string", "maxLength" : 25000, "minLength" : 0 }, "tags" : { "type" : "array", "description" : "A collection of tags to identify the relevance of metadata resource. Tags with no spaces is defacto standard", "example" : [ "HumanitarianAid" ], "items" : { "type" : "string", "description" : "A collection of tags to identify the relevance of metadata resource. Tags with no spaces is defacto standard", "example" : [ "HumanitarianAid" ] } }, "title" : { "type" : "string", "description" : "Title of the metadata resource. Required for POST and PUT.", "example" : "crypto.snowflake", "maxLength" : 120, "minLength" : 1 }, "typeLabel" : { "type" : "string", "description" : "Indicates the type of metadata resource. Some examples of valid values are Report, Tableau dashboard, Glossary, Table, Database view etc. Default values will be assumed if not provided. Defaults to Report for analysis resources, Glossary for Glossary resources, Table for Table resources and Column for Column resources. Once specified during creation, this cannot be changed via PATCH. Only a PUT can change the type ", "example" : "Tableau dashboard" } } }, "MetadataResourceDto" : { "type" : "object", "properties" : { "assetStatus" : { "$ref" : "#/components/schemas/AssetStatus" }, "category" : { "type" : "string" }, "collections" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CatalogId" } }, "columnIndex" : { "type" : "integer", "format" : "int32" }, "created" : { "type" : "string", "format" : "date-time" }, "dataType" : { "type" : "string" }, "description" : { "type" : "string" }, "encodedIri" : { "type" : "string" }, "externalUrls" : { "type" : "array", "items" : { "type" : "string" } }, "id" : { "type" : "string" }, "iri" : { "type" : "string" }, "owner" : { "type" : "string" }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/StringOrArray" }, "description" : "All properties of the resource that are associated with a metadata presentation. Key is the IRI of the property. Value is the value of the property." }, "relationshipTypes" : { "type" : "array", "items" : { "type" : "string" } }, "rootParentTypeIri" : { "type" : "string" }, "rootParentTypeLabel" : { "type" : "string" }, "summary" : { "type" : "string" }, "table" : { "$ref" : "#/components/schemas/TableId" }, "tags" : { "type" : "array", "items" : { "type" : "string" } }, "title" : { "type" : "string" }, "typeIri" : { "type" : "string" }, "typeLabel" : { "type" : "string" }, "updated" : { "type" : "string", "format" : "date-time" }, "url" : { "type" : "string", "format" : "uri" }, "visibility" : { "type" : "string", "enum" : [ "DISCOVERABLE", "OPEN", "PRIVATE" ] } }, "required" : [ "created", "id", "owner", "visibility" ] }, "MetadataResourceDtoV2" : { "type" : "object", "properties" : { "category" : { "type" : "string" }, "collections" : { "type" : "array", "items" : { "type" : "string" } }, "created" : { "type" : "string", "format" : "date-time" }, "id" : { "type" : "string" }, "iri" : { "type" : "string" }, "owner" : { "type" : "string" }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/StringOrArray" }, "description" : "All properties of the resource that are associated with a metadata presentation. Key is the IRI of the property. Value is the value of the property." }, "relationshipTypes" : { "type" : "array", "items" : { "type" : "string" } }, "resourceDetails" : { "$ref" : "#/components/schemas/ResourceDetails" }, "title" : { "type" : "string" }, "updated" : { "type" : "string", "format" : "date-time" }, "url" : { "type" : "string", "format" : "uri" } }, "required" : [ "created", "updated" ] }, "MetadataSuggestRequest" : { "type" : "object", "properties" : { "collectionsToAdd" : { "type" : "array", "description" : "Catalog Collection to which this metadata resource is added. Required for POST and PUT.Available catalog collection can be discovered via appropriate discovery endpoints.", "example" : [ "Aid Option" ], "items" : { "type" : "string", "description" : "Catalog Collection to which this metadata resource is added. Required for POST and PUT.Available catalog collection can be discovered via appropriate discovery endpoints.", "example" : [ "Aid Option" ] } }, "collectionsToRemove" : { "type" : "array", "description" : "Catalog Collection to which this metadata resource is added. Required for POST and PUT.Available catalog collection can be discovered via appropriate discovery endpoints.", "example" : [ "Aid Option" ], "items" : { "type" : "string", "description" : "Catalog Collection to which this metadata resource is added. Required for POST and PUT.Available catalog collection can be discovered via appropriate discovery endpoints.", "example" : [ "Aid Option" ] } }, "description" : { "type" : "string", "description" : "A short, but descriptive statement about the metadata resource.", "example" : "Aid given to charity is an option that can be exercised by individuals and corporations", "maxLength" : 5000, "minLength" : 0 }, "message" : { "type" : "string", "description" : "Message for the suggestion", "example" : "I strongly suggest", "maxLength" : 250, "minLength" : 1 }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/StringOrArray" }, "description" : "Custom properties for the metadata resource mapped to API BindingsCan be simple name-value string pairs or nested values for a string name. See examples for details." }, "summary" : { "type" : "string", "maxLength" : 25000, "minLength" : 0 }, "tagsToAdd" : { "type" : "array", "description" : "A collection of tags to identify the relevance of metadata resource. Tags with no spaces is defacto standard", "example" : [ "HumanitarianAid" ], "items" : { "type" : "string", "description" : "A collection of tags to identify the relevance of metadata resource. Tags with no spaces is defacto standard", "example" : [ "HumanitarianAid" ] } }, "tagsToRemove" : { "type" : "array", "description" : "A collection of tags to identify the relevance of metadata resource. Tags with no spaces is defacto standard", "example" : [ "HumanitarianAid" ], "items" : { "type" : "string", "description" : "A collection of tags to identify the relevance of metadata resource. Tags with no spaces is defacto standard", "example" : [ "HumanitarianAid" ] } }, "title" : { "type" : "string", "description" : "Title of the metadata resource. Required for POST and PUT.", "example" : "crypto.snowflake", "maxLength" : 120, "minLength" : 1 }, "typeLabel" : { "type" : "string", "description" : "Indicates the type of metadata resource. Some examples of valid values are Report, Tableau dashboard, Glossary, Table, Database view etc. Default values will be assumed if not provided. Defaults to Report for analysis resources, Glossary for Glossary resources, Table for Table resources and Column for Column resources. Once specified during creation, this cannot be changed via PATCH. Only a PUT can change the type ", "example" : "Tableau dashboard" } } }, "OauthTokenReference" : { "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "owner" : { "type" : "string" }, "site" : { "type" : "string" } }, "required" : [ "id", "owner", "site" ] }, "OrgDetailsResponse" : { "type" : "object", "properties" : { "avatarUrl" : { "type" : "string", "description" : "URL that points to a small, graphical representation of an organization", "maxLength" : 256, "minLength" : 0 }, "company" : { "type" : "string", "description" : "Company name" }, "created" : { "type" : "string", "format" : "date-time" }, "description" : { "type" : "string", "description" : "Short description of an organization." }, "displayName" : { "type" : "string", "description" : "Human-readable organization name", "maxLength" : 128, "minLength" : 0 }, "id" : { "type" : "string", "description" : "Organization agentid" }, "location" : { "type" : "string", "description" : "Company location" }, "summary" : { "type" : "string", "description" : "Details of an organization." }, "updated" : { "type" : "string", "format" : "date-time" }, "website" : { "type" : "string", "description" : "Company website URL" } }, "required" : [ "id" ] }, "OrgScopedSearchRequest" : { "type" : "object", "properties" : { "assetStatus" : { "type" : "array", "description" : "Filter by asset status label.", "items" : { "type" : "string" }, "uniqueItems" : true }, "collection" : { "type" : "array", "description" : "Filter by collection IRI", "items" : { "type" : "string" }, "uniqueItems" : true }, "createdRange" : { "$ref" : "#/components/schemas/Range", "description" : "Filter by range of date that the resource was created." }, "minAccessLevel" : { "type" : "string", "description" : "Minimum access level to filter by.", "enum" : [ "NONE", "SAML_GATED", "DISCOVER", "MEMBER", "READ", "WRITE", "ADMIN" ] }, "owner" : { "type" : "string", "description" : "User name and unique identifier of the user or organization a resource belongs to.\nFor example, in the URL: https://acme.data.world/jonloyens/an-intro-to-dataworld-dataset, jonloyens is the unique identifier of the owner." }, "property" : { "type" : "object", "additionalProperties" : { }, "description" : "Filter by custom properties." }, "query" : { "type" : "string" }, "tag" : { "type" : "array", "description" : "Filter by tags.", "items" : { "type" : "string" }, "uniqueItems" : true }, "type" : { "type" : "array", "description" : "Filter by type of metadata resource. Both IRI and label are accepted.", "items" : { "type" : "string" }, "uniqueItems" : true }, "updatedRange" : { "$ref" : "#/components/schemas/Range", "description" : "Filter by range of date that the resource was updated." } }, "required" : [ "owner" ] }, "OrgScopedSearchedResourceDto" : { "type" : "object", "properties" : { "category" : { "type" : "string" }, "created" : { "type" : "string", "format" : "date-time" }, "creator" : { "type" : "string" }, "id" : { "type" : "string" }, "iri" : { "type" : "string" }, "numLikes" : { "type" : "integer", "format" : "int32" }, "owner" : { "type" : "string" }, "properties" : { "type" : "object", "additionalProperties" : { } }, "resourceDetails" : { "$ref" : "#/components/schemas/ResourceDetails" }, "resourceLink" : { "type" : "string", "format" : "uri" }, "sourceId" : { "type" : "string" }, "sourceOfRecord" : { "type" : "string" }, "tableId" : { "type" : "string" }, "tableIri" : { "type" : "string" }, "title" : { "type" : "string" }, "updated" : { "type" : "string", "format" : "date-time" }, "updatedBy" : { "type" : "string" } }, "required" : [ "category", "id", "owner" ] }, "OrganizationDataResponse" : { "type" : "object", "properties" : { "avatarUrl" : { "type" : "string", "maxLength" : 256, "minLength" : 0 }, "baseUrl" : { "type" : "string" }, "created" : { "type" : "string", "format" : "date-time" }, "displayName" : { "type" : "string", "maxLength" : 128, "minLength" : 0 }, "id" : { "type" : "string" }, "type" : { "type" : "string", "description" : "Indicates organization type.", "enum" : [ "DEFAULT", "MEMBERS_ONLY", "INTEGRATIONS", "ONTOLOGIES", "ANALYSIS", "CATALOG_ENVIRONMENT", "CATALOG_SANDBOX_ENVIRONMENT", "CATALOG_SOURCES", "CATALOG_CONFIG" ] }, "updated" : { "type" : "string", "format" : "date-time" } }, "required" : [ "created", "id", "updated" ] }, "PaginatedConnectionResults" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int32", "minimum" : 0 }, "nextPageToken" : { "type" : "string" }, "records" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConnectionDto" } } }, "required" : [ "count", "records" ] }, "PaginatedDatabaseResults" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int32", "minimum" : 0 }, "nextPageToken" : { "type" : "string" }, "records" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DatabaseDto" } } }, "required" : [ "count", "records" ] }, "PaginatedDatasetResults" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int32", "minimum" : 0 }, "nextPageToken" : { "type" : "string" }, "records" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DatasetSummaryResponse" } } }, "required" : [ "count", "records" ] }, "PaginatedGenericResultsMetadataResourceDto" : { "type" : "object", "properties" : { "consistent" : { "type" : "boolean" }, "count" : { "type" : "integer", "format" : "int32", "minimum" : 0 }, "hydrations" : { "$ref" : "#/components/schemas/PubSearchHydrations" }, "next" : { "type" : "string" }, "records" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MetadataResourceDto" } } } }, "PaginatedGenericResultsMetadataResourceDtoV2" : { "type" : "object", "properties" : { "consistent" : { "type" : "boolean" }, "count" : { "type" : "integer", "format" : "int32", "minimum" : 0 }, "hydrations" : { "$ref" : "#/components/schemas/PubSearchHydrations" }, "next" : { "type" : "string" }, "records" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MetadataResourceDtoV2" } } } }, "PaginatedGenericResultsOrgScopedSearchedResourceDto" : { "type" : "object", "properties" : { "consistent" : { "type" : "boolean" }, "count" : { "type" : "integer", "format" : "int32", "minimum" : 0 }, "hydrations" : { "$ref" : "#/components/schemas/PubSearchHydrations" }, "next" : { "type" : "string" }, "records" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/OrgScopedSearchedResourceDto" } } } }, "PaginatedGenericResultsPublicCommentDto" : { "type" : "object", "properties" : { "consistent" : { "type" : "boolean" }, "count" : { "type" : "integer", "format" : "int32", "minimum" : 0 }, "hydrations" : { "$ref" : "#/components/schemas/PubSearchHydrations" }, "next" : { "type" : "string" }, "records" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PublicCommentDto" } } } }, "PaginatedGenericResultsPublicResourceRequestDto" : { "type" : "object", "properties" : { "consistent" : { "type" : "boolean" }, "count" : { "type" : "integer", "format" : "int32", "minimum" : 0 }, "hydrations" : { "$ref" : "#/components/schemas/PubSearchHydrations" }, "next" : { "type" : "string" }, "records" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PublicResourceRequestDto" } } } }, "PaginatedGenericResultsPublicTopicDto" : { "type" : "object", "properties" : { "consistent" : { "type" : "boolean" }, "count" : { "type" : "integer", "format" : "int32", "minimum" : 0 }, "hydrations" : { "$ref" : "#/components/schemas/PubSearchHydrations" }, "next" : { "type" : "string" }, "records" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PublicTopicDto" } } } }, "PaginatedGenericResultsSearchedResourceDto" : { "type" : "object", "properties" : { "consistent" : { "type" : "boolean" }, "count" : { "type" : "integer", "format" : "int32", "minimum" : 0 }, "hydrations" : { "$ref" : "#/components/schemas/PubSearchHydrations" }, "next" : { "type" : "string" }, "records" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SearchedResourceDto" } } } }, "PaginatedInsightResults" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int32", "minimum" : 0 }, "nextPageToken" : { "type" : "string" }, "records" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InsightSummaryResponse" } } }, "required" : [ "count", "records" ] }, "PaginatedOrganizationResults" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int32", "minimum" : 0 }, "nextPageToken" : { "type" : "string" }, "records" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/OrganizationDataResponse" } } }, "required" : [ "count", "records" ] }, "PaginatedProjectResults" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int32", "minimum" : 0 }, "nextPageToken" : { "type" : "string" }, "records" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProjectSummaryResponse" } } }, "required" : [ "count", "records" ] }, "PaginatedQueryResults" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int32", "minimum" : 0 }, "nextPageToken" : { "type" : "string" }, "records" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/QuerySummaryResponse" } } }, "required" : [ "count", "records" ] }, "PaginatedResultsDtoAuthRequestDto" : { "type" : "object", "properties" : { "consistent" : { "type" : "boolean" }, "count" : { "type" : "integer", "format" : "int32", "minimum" : 0 }, "next" : { "type" : "string" }, "records" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AuthRequestDto" } } } }, "PaginatedSearchResultsDtoMetadataResourceDto" : { "type" : "object", "properties" : { "consistent" : { "type" : "boolean" }, "count" : { "type" : "integer", "format" : "int32", "minimum" : 0 }, "facets" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SearchFacetResult" } } }, "hydrations" : { "$ref" : "#/components/schemas/SearchHydrations" }, "next" : { "type" : "string" }, "records" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MetadataResourceDto" } } } }, "PaginatedServiceAccountDetails" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int32", "minimum" : 0 }, "nextPageToken" : { "type" : "string" }, "records" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ServiceAccountDetailsDto" } } }, "required" : [ "count", "records" ] }, "PaginatedSubscriptionResults" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int32", "minimum" : 0 }, "nextPageToken" : { "type" : "string" }, "records" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubscriptionResponse" } } }, "required" : [ "count", "records" ] }, "PingStatusDto" : { "type" : "object", "properties" : { "cleanupStarted" : { "type" : "boolean" }, "cleanupSuccess" : { "type" : "boolean" }, "configureStarted" : { "type" : "boolean" }, "configureSuccess" : { "type" : "boolean" }, "connectHost" : { "type" : "string" }, "connectStarted" : { "type" : "boolean" }, "connectSuccess" : { "type" : "boolean" }, "done" : { "type" : "boolean", "description" : "Is the ping operation 100% complete?" }, "elapsed" : { "type" : "number", "format" : "double" }, "errorMessage" : { "type" : "string", "description" : "Failures" }, "internalError" : { "type" : "boolean", "description" : "Is the cause of a failure likely an internal bug in our code, not something users have control over?" }, "queryStarted" : { "type" : "boolean" }, "querySuccess" : { "type" : "boolean" }, "queryText" : { "type" : "string" }, "serverDescription" : { "type" : "string", "description" : "Technical string describing the location of the database on the network. This may be a JDBC url." }, "serverType" : { "type" : "string", "enum" : [ "ATHENA", "AZURESYNAPSE", "BIGQUERY", "DB2", "DENODO", "HIVE", "DATABRICKS", "INFOR_ION", "MYSQL", "ORACLE", "POSTGRESQL", "REDSHIFT", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TABLEAU" ] }, "sslCertificateChain" : { "type" : "array", "description" : "If the ping failed due to an SSL issue", "items" : { "type" : "string" } }, "sslCertificateNameProblem" : { "type" : "boolean", "description" : "Did the ping fail because the server's name didn't match the name in the certificate?" }, "sslCertificateTrustPathProblem" : { "type" : "boolean", "description" : "Did the ping fail because it didn't trust the server's certificate due to a lack of a path to a root CA?" }, "sslNotSupported" : { "type" : "boolean", "description" : "Did the ping fail because it tried to use SSL but the server+port combination doesn't support SSL?" }, "success" : { "type" : "boolean", "description" : "Everything successfully done" }, "tunnelHost" : { "type" : "string" }, "tunnelStarted" : { "type" : "boolean" }, "tunnelSuccess" : { "type" : "boolean" } } }, "ProjectCreateRequest" : { "type" : "object", "properties" : { "files" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FileCreateRequest" } }, "license" : { "type" : "string", "enum" : [ "Public Domain, PDDL, CC-0, CC-BY, CDLA-Permissive-1.0, CC-BY-IGO, CC-BY 3.0, CC-BY 3.0 AU, CC-BY 3.0 IGO, CC-BY-SA, CC-BY-SA 3.0, CDLA-Sharing-1.0, CC BY-NC, CC BY-ND, CC BY-ND 3.0, CC-BY 3.0 NZ, CC-BY-NC 3.0, CC BY-NC-ND, CC-BY-NC-SA 3.0, CC-BY-SA 3.0 NZ, CC-BY-NC-SA 3.0 NZ, CC-BY-NC 3.0 NZ, CC-BY-NC-ND-NZ-3.0, CC BY-NC-SA, Italian-ODL, MIT License, OGL, OGL-Canada, OGL-Nova Scotia, OGL-UK, OSODL, ODC-BY, ODC-ODbL, Other" ] }, "linkedDatasets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedDatasetCreateOrUpdateRequest" } }, "objective" : { "type" : "string", "maxLength" : 120, "minLength" : 0 }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/StringOrArray" }, "description" : "Create/update any property that is associated with a metadata presentation. Key is the IRI of the property. Value is the intended value of the property." }, "summary" : { "type" : "string", "maxLength" : 25000, "minLength" : 0 }, "tags" : { "type" : "array", "items" : { "type" : "string" } }, "title" : { "type" : "string", "maxLength" : 60, "minLength" : 1 }, "visibility" : { "type" : "string", "enum" : [ "OPEN, PRIVATE" ] } }, "required" : [ "title", "visibility" ] }, "ProjectPatchRequest" : { "type" : "object", "properties" : { "license" : { "type" : "string", "enum" : [ "Public Domain, PDDL, CC-0, CC-BY, CDLA-Permissive-1.0, CC-BY-IGO, CC-BY 3.0, CC-BY 3.0 AU, CC-BY 3.0 IGO, CC-BY-SA, CC-BY-SA 3.0, CDLA-Sharing-1.0, CC BY-NC, CC BY-ND, CC BY-ND 3.0, CC-BY 3.0 NZ, CC-BY-NC 3.0, CC BY-NC-ND, CC-BY-NC-SA 3.0, CC-BY-SA 3.0 NZ, CC-BY-NC-SA 3.0 NZ, CC-BY-NC 3.0 NZ, CC-BY-NC-ND-NZ-3.0, CC BY-NC-SA, Italian-ODL, MIT License, OGL, OGL-Canada, OGL-Nova Scotia, OGL-UK, OSODL, ODC-BY, ODC-ODbL, Other" ] }, "linkedDatasets" : { "type" : "array", "description" : "Linked datasets included in a PATCH request will be added. Previously linked datasets will be preserved without modification.", "items" : { "$ref" : "#/components/schemas/LinkedDatasetCreateOrUpdateRequest" } }, "objective" : { "type" : "string" }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/JsonNode" } }, "summary" : { "type" : "string" }, "tags" : { "type" : "array", "description" : "Tags included in a PATCH request will replace all previous tags.", "items" : { "type" : "string", "description" : "Tags included in a PATCH request will replace all previous tags." } }, "title" : { "type" : "string", "maxLength" : 60, "minLength" : 1 }, "visibility" : { "type" : "string", "enum" : [ "OPEN, PRIVATE" ] } } }, "ProjectPutRequest" : { "type" : "object", "properties" : { "license" : { "type" : "string", "enum" : [ "Public Domain, PDDL, CC-0, CC-BY, CDLA-Permissive-1.0, CC-BY-IGO, CC-BY 3.0, CC-BY 3.0 AU, CC-BY 3.0 IGO, CC-BY-SA, CC-BY-SA 3.0, CDLA-Sharing-1.0, CC BY-NC, CC BY-ND, CC BY-ND 3.0, CC-BY 3.0 NZ, CC-BY-NC 3.0, CC BY-NC-ND, CC-BY-NC-SA 3.0, CC-BY-SA 3.0 NZ, CC-BY-NC-SA 3.0 NZ, CC-BY-NC 3.0 NZ, CC-BY-NC-ND-NZ-3.0, CC BY-NC-SA, Italian-ODL, MIT License, OGL, OGL-Canada, OGL-Nova Scotia, OGL-UK, OSODL, ODC-BY, ODC-ODbL, Other" ] }, "linkedDatasets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedDatasetCreateOrUpdateRequest" } }, "objective" : { "type" : "string", "maxLength" : 120, "minLength" : 0 }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/StringOrArray" }, "description" : "Create/update any property that is associated with a metadata presentation. Key is the IRI of the property. Value is the intended value of the property." }, "summary" : { "type" : "string", "maxLength" : 25000, "minLength" : 0 }, "tags" : { "type" : "array", "items" : { "type" : "string" } }, "title" : { "type" : "string", "maxLength" : 60, "minLength" : 1 }, "visibility" : { "type" : "string", "enum" : [ "OPEN, PRIVATE" ] } }, "required" : [ "title", "visibility" ] }, "ProjectSummaryResponse" : { "type" : "object", "properties" : { "accessLevel" : { "type" : "string", "enum" : [ "NONE, DISCOVER, READ, WRITE, ADMIN" ] }, "assetStatus" : { "$ref" : "#/components/schemas/AssetStatus" }, "created" : { "type" : "string", "format" : "date-time" }, "datasetStatistics" : { "$ref" : "#/components/schemas/DatasetStatistics", "description" : "Describes number of files, tables, and columns in the project" }, "dois" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Doi" }, "writeOnly" : true }, "files" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FileSummaryResponse" } }, "id" : { "type" : "string" }, "license" : { "type" : "string", "enum" : [ "Public Domain, PDDL, CC-0, CC-BY, CDLA-Permissive-1.0, CC-BY-IGO, CC-BY 3.0, CC-BY 3.0 AU, CC-BY 3.0 IGO, CC-BY-SA, CC-BY-SA 3.0, CDLA-Sharing-1.0, CC BY-NC, CC BY-ND, CC BY-ND 3.0, CC-BY 3.0 NZ, CC-BY-NC 3.0, CC BY-NC-ND, CC-BY-NC-SA 3.0, CC-BY-SA 3.0 NZ, CC-BY-NC-SA 3.0 NZ, CC-BY-NC 3.0 NZ, CC-BY-NC-ND-NZ-3.0, CC BY-NC-SA, Italian-ODL, MIT License, OGL, OGL-Canada, OGL-Nova Scotia, OGL-UK, OSODL, ODC-BY, ODC-ODbL, Other" ] }, "linkedDatasets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedDatasetSummaryResponse" } }, "objective" : { "type" : "string", "maxLength" : 120, "minLength" : 0 }, "owner" : { "type" : "string" }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/StringOrArray" }, "description" : "All properties of the resource that are associated with a metadata presentation. Key is the IRI of the property. Value is the value of the property." }, "similarResources" : { "type" : "array", "description" : "Similar projects with the same owner", "items" : { "oneOf" : [ { "$ref" : "#/components/schemas/SimpleDataset" } ] } }, "status" : { "type" : "string", "enum" : [ "NEW, INPROGRESS, LOADED, SYSTEMERROR" ] }, "summary" : { "type" : "string", "maxLength" : 25000, "minLength" : 0 }, "tags" : { "type" : "array", "items" : { "type" : "string" } }, "title" : { "type" : "string", "maxLength" : 60, "minLength" : 1 }, "updated" : { "type" : "string", "format" : "date-time" }, "version" : { "type" : "string" }, "versionDois" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Doi" }, "writeOnly" : true }, "visibility" : { "type" : "string", "enum" : [ "OPEN, PRIVATE" ] } }, "required" : [ "accessLevel", "created", "id", "owner", "status", "title", "updated", "version", "visibility" ] }, "PropertyHydrationDto" : { "type" : "object", "properties" : { "label" : { "type" : "array", "description" : "Label of the metadata presentation associated with the property", "items" : { "type" : "string" } } } }, "ProvidedImage" : { "allOf" : [ { "$ref" : "#/components/schemas/Image" }, { "type" : "object", "properties" : { "slug" : { "type" : "string" }, "type" : { "type" : "string", "const" : "provided" } } } ] }, "PubSearchHydrations" : { "type" : "object", "properties" : { "agents" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/AgentHydrationDto" } }, "catalogConcepts" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/CatalogConceptHydrationDto" } }, "collections" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/CollectionHydrationDto" } }, "properties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/PropertyHydrationDto" } }, "relationships" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/RelationshipHydrationDto" } }, "resourceHierarchy" : { "type" : "object", "additionalProperties" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResourceHierarchyDto" } } } } } }, "PublicAnalysisResource" : { "allOf" : [ { "$ref" : "#/components/schemas/PublicResource" }, { "type" : "object", "properties" : { "referent" : { "type" : "string", "description" : "An analysis referent" }, "type" : { "type" : "string", "const" : "ANALYSIS" } } } ], "required" : [ "owner", "referent" ], "title" : "Analysis Resource" }, "PublicCollectionResource" : { "allOf" : [ { "$ref" : "#/components/schemas/PublicResource" }, { "type" : "object", "properties" : { "referent" : { "type" : "string", "description" : "A collection referent" }, "type" : { "type" : "string", "const" : "CATALOG" } } } ], "required" : [ "owner", "referent" ], "title" : "Collection Metadata Resource" }, "PublicColumnResource" : { "allOf" : [ { "$ref" : "#/components/schemas/PublicResource" }, { "type" : "object", "properties" : { "referent" : { "type" : "string", "description" : "A column referent" }, "type" : { "type" : "string", "const" : "COLUMN" } } } ], "required" : [ "owner", "referent" ], "title" : "Column Metadata Resource" }, "PublicCommentDto" : { "type" : "object", "properties" : { "body" : { "type" : "string", "description" : "Body content of the comment." }, "commentid" : { "type" : "string", "description" : "Comment id generated while creating a comment. Returned for reference but must be provided through URL only." }, "owner" : { "type" : "string", "description" : "An organization owning a comment. Returned for reference but must be provided through URL only." }, "topicUuid" : { "type" : "string", "format" : "uuid", "description" : "Topic unique id stored along comments. Returned for reference but must be provided through URL only." } } }, "PublicDatabaseResource" : { "allOf" : [ { "$ref" : "#/components/schemas/PublicResource" }, { "type" : "object", "properties" : { "referent" : { "type" : "string", "description" : "A database referent" }, "type" : { "type" : "string", "const" : "DATABASE" } } } ], "required" : [ "owner", "referent" ], "title" : "Database Metadata Resource" }, "PublicDatasetInsightResource" : { "allOf" : [ { "$ref" : "#/components/schemas/PublicResource" }, { "type" : "object", "properties" : { "datasetId" : { "type" : "string", "description" : "ID of a dataset" }, "insightUuid" : { "type" : "string", "format" : "uuid", "description" : "ID of a dataset insight" }, "type" : { "type" : "string", "const" : "DATASET_INSIGHT" } } } ], "required" : [ "datasetId", "insightUuid", "owner" ], "title" : "Dataset Insight Resource" }, "PublicDatasetResource" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PublicResource" }, { "$ref" : "#/components/schemas/DatasetIdentifier" }, { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of a dataset" } } } ], "required" : [ "id", "owner" ], "title" : "Dataset Resource" }, "PublicGlossaryResource" : { "allOf" : [ { "$ref" : "#/components/schemas/PublicResource" }, { "type" : "object", "properties" : { "referent" : { "type" : "string", "description" : "A glossary referent" }, "type" : { "type" : "string", "const" : "GLOSSARY" } } } ], "required" : [ "owner", "referent" ], "title" : "Glossary Metadata Resource" }, "PublicGroupParty" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PublicParty" }, { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of a group" }, "owner" : { "type" : "string", "description" : "ID of an organization that owns the resource", "title" : "organization id" }, "type" : { "type" : "string", "const" : "GROUP" } } }, { "$ref" : "#/components/schemas/PublicResource" } ], "required" : [ "id", "owner" ], "title" : "Group Identifier" }, "PublicMetadataResource" : { "allOf" : [ { "$ref" : "#/components/schemas/PublicResource" }, { "type" : "object", "properties" : { "referent" : { "type" : "string", "description" : "A metadata resource referent" }, "type" : { "type" : "string", "const" : "METADATA_RESOURCE" } } } ], "required" : [ "owner", "referent" ], "title" : "Metadata Resource" }, "PublicParty" : { "discriminator" : { "mapping" : { "GROUP" : "#/components/schemas/PublicGroupParty", "USER" : "#/components/schemas/PublicUserParty" }, "propertyName" : "type" }, "properties" : { "type" : { "type" : "string", "enum" : [ "USER", "GROUP" ] } }, "required" : [ "type" ] }, "PublicResource" : { "type" : "object", "discriminator" : { "mapping" : { "ANALYSIS" : "#/components/schemas/PublicAnalysisResource", "CATALOG" : "#/components/schemas/PublicCollectionResource", "COLUMN" : "#/components/schemas/PublicColumnResource", "DATABASE" : "#/components/schemas/PublicDatabaseResource", "DATASET" : "#/components/schemas/PublicDatasetResource", "DATASET_INSIGHT" : "#/components/schemas/PublicDatasetInsightResource", "GLOSSARY" : "#/components/schemas/PublicGlossaryResource", "GROUP" : "#/components/schemas/PublicGroupParty", "METADATA_RESOURCE" : "#/components/schemas/PublicMetadataResource", "TABLE" : "#/components/schemas/PublicTableResource" }, "propertyName" : "type" }, "properties" : { "owner" : { "type" : "string", "description" : "ID of an organization that owns the resource", "title" : "organization id" }, "type" : { "type" : "string", "enum" : [ "ANALYSIS", "CATALOG", "COLUMN", "DATABASE", "DATASET", "DATASET_INSIGHT", "GLOSSARY", "GROUP", "METADATA_RESOURCE", "TABLE" ] } }, "required" : [ "owner", "type" ] }, "PublicResourceRequestDto" : { "type" : "object", "properties" : { "approverParty" : { "$ref" : "#/components/schemas/PublicParty", "description" : "The organization that can approve the request. Ignored in create request.", "oneOf" : [ { "$ref" : "#/components/schemas/PublicUserParty" }, { "$ref" : "#/components/schemas/PublicGroupParty" } ] }, "contribution" : { "$ref" : "#/components/schemas/ContributionDto", "description" : "Provides details on the contribution, if this is a contribution request." }, "created" : { "type" : "string", "format" : "date-time" }, "granteeOwner" : { "type" : "string", "description" : "If this is a transfer request, this is the organization that will receive the resource. Otherwise, this is the same as approverParty." }, "message" : { "type" : "string" }, "requestId" : { "type" : "string", "format" : "uuid", "description" : "A unique id of the request assigned by the service and returned in response thus must not be provided in create request." }, "requesterParty" : { "$ref" : "#/components/schemas/PublicParty", "description" : "The user that created this request. Ignored in create request.", "oneOf" : [ { "$ref" : "#/components/schemas/PublicUserParty" }, { "$ref" : "#/components/schemas/PublicGroupParty" } ] }, "resource" : { "$ref" : "#/components/schemas/PublicResource", "description" : "The resource that the request is created for. Only DATASET and METADATA_RESOURCE are allowed.", "oneOf" : [ { "$ref" : "#/components/schemas/PublicDatasetResource" }, { "$ref" : "#/components/schemas/PublicMetadataResource" } ] }, "resourceRequestType" : { "type" : "string", "description" : "The type of request", "enum" : [ "CONTRIBUTION", "TRANSFER" ] }, "transferAsset" : { "$ref" : "#/components/schemas/TransferAssetDto", "description" : "Provides details on the transfer, if this is a transfer request." }, "updated" : { "type" : "string", "format" : "date-time" } }, "required" : [ "resource", "resourceRequestType" ] }, "PublicTableResource" : { "allOf" : [ { "$ref" : "#/components/schemas/PublicResource" }, { "type" : "object", "properties" : { "referent" : { "type" : "string", "description" : "Resource referent" }, "type" : { "type" : "string", "const" : "TABLE" } } } ], "required" : [ "owner", "referent" ], "title" : "Table Metadata Resource" }, "PublicTopicDto" : { "type" : "object", "properties" : { "defaultTopic" : { "type" : "boolean", "description" : "True if this is the default topic for the specified resource. There should only be 1 topic with this field set per resource. Must be provided while creating a topic only." }, "resource" : { "$ref" : "#/components/schemas/PublicResource", "description" : "A resource for which the topic is created.", "oneOf" : [ { "$ref" : "#/components/schemas/PublicDatasetResource" }, { "$ref" : "#/components/schemas/PublicDatasetInsightResource" }, { "$ref" : "#/components/schemas/PublicMetadataResource" } ] }, "title" : { "type" : "string" }, "topicId" : { "type" : "string", "description" : "Short friendly form of a topic id that uniquely identifies the topic within a resource." }, "topicSlug" : { "type" : "string", "description" : "Short friendly form of a topic title." }, "topicUuid" : { "type" : "string", "format" : "uuid", "description" : "Unique id of the topic generated while create new one. Returned for reference but must be provided through URL only." }, "visibility" : { "type" : "string", "description" : "Topic visibility. The field is required.", "enum" : [ "DISCOVERABLE", "OPEN", "PRIVATE" ] } } }, "PublicUserParty" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the user" } }, "required" : [ "id" ], "title" : "User Identifier" }, "QueryExecutionDto" : { "type" : "object", "properties" : { "query" : { "type" : "string", "maxLength" : 10000, "minLength" : 1 } }, "required" : [ "query" ] }, "QueryParameter" : { "type" : "object", "properties" : { "datatype" : { "type" : "string" }, "type" : { "type" : "string" } } }, "QueryPutRequest" : { "type" : "object", "properties" : { "content" : { "type" : "string" }, "description" : { "type" : "string", "maxLength" : 1000, "minLength" : 0 }, "name" : { "type" : "string", "maxLength" : 128, "minLength" : 0 }, "published" : { "type" : "boolean" } }, "required" : [ "content", "name" ] }, "QuerySummaryResponse" : { "type" : "object", "properties" : { "body" : { "type" : "string" }, "created" : { "type" : "string", "format" : "date-time" }, "description" : { "type" : "string" }, "id" : { "type" : "string", "format" : "uuid" }, "language" : { "type" : "string", "enum" : [ "SPARQL", "SQL" ] }, "name" : { "type" : "string" }, "owner" : { "type" : "string" }, "parameters" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/QueryParameter" } }, "updated" : { "type" : "string", "format" : "date-time" }, "version" : { "type" : "string" } } }, "Range" : { "type" : "object", "properties" : { "endDate" : { "type" : "string", "description" : "Inclusive. Format is YYYY-MM-DD in UTC. If inputted by itself (without startDate), it will match all dates before this date and this date." }, "startDate" : { "type" : "string", "description" : "Inclusive. Format is YYYY-MM-DD in UTC. If inputted by itself (without endDate),it will match all dates after this date and this date." } } }, "RdfTerm" : { "type" : "object", "properties" : { "datatype" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "literal", "uri", "bnode" ] }, "value" : { "type" : "string" }, "xml:lang" : { "type" : "string" } }, "required" : [ "type", "value" ] }, "ReferenceBusinessTermContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "businessTermIri" : { "type" : "string" }, "entityType" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "target" : { "type" : "string" }, "type" : { "type" : "string", "const" : "ReferenceBusinessTerm" } } } ], "required" : [ "businessTermIri", "entityType", "target" ] }, "RejectRequestDto" : { "type" : "object", "properties" : { "requestid" : { "type" : "string", "format" : "uuid", "description" : "ID of the request to reject." } }, "required" : [ "requestid" ] }, "RelationshipCreateOrDeleteRequest" : { "type" : "object", "properties" : { "relationshipType" : { "type" : "string", "format" : "uri", "description" : "IRI of the relationship type" }, "sourceDatasetId" : { "type" : "string", "description" : "If source is a table or column, populate with database ID that contains table." }, "sourceId" : { "type" : "string" }, "sourceTableId" : { "type" : "string", "description" : "If source is a column, populate with table ID that contains column." }, "sourceType" : { "type" : "string", "enum" : [ "CATALOG", "ANALYSIS", "BUSINESS_TERM", "COLUMN", "DATA_TYPE", "DATABASE", "DATASET", "PROJECT", "TABLE", "CONCEPT", "UNKNOWN_CATALOG_ENTRY" ] }, "sourceTypeIri" : { "type" : "string", "format" : "uri", "description" : "IRI of specified sourceType, this is required when sourceType is generic." }, "targetDatasetId" : { "type" : "string", "description" : "If target is a table or column, populate with database ID that contains table." }, "targetId" : { "type" : "string" }, "targetTableId" : { "type" : "string", "description" : "If target is a column, populate with table ID that contains column." }, "targetType" : { "type" : "string", "description" : "Type of targetId.", "enum" : [ "CATALOG", "ANALYSIS", "BUSINESS_TERM", "COLUMN", "DATA_TYPE", "DATABASE", "DATASET", "PROJECT", "TABLE", "CONCEPT", "UNKNOWN_CATALOG_ENTRY" ] } }, "required" : [ "relationshipType", "sourceId", "sourceType", "targetId", "targetType" ] }, "RelationshipCreateOrDeleteRequestByIri" : { "type" : "object", "properties" : { "iri" : { "type" : "string", "description" : "IRI of the relationship type" }, "sourceIri" : { "type" : "string", "description" : "IRI of the source resource" }, "sourceType" : { "type" : "string", "description" : "IRI of source resource's type" }, "targetIri" : { "type" : "string", "description" : "IRI of the target resource" } }, "required" : [ "iri", "sourceIri", "sourceType", "targetIri" ] }, "RelationshipGetRequest" : { "type" : "object", "properties" : { "byRelationTypes" : { "type" : "array", "description" : "Filter by these relation types. Relation types should be IRIs.", "example" : "https://dwec.data.world/v0/usesDataFrom", "items" : { "type" : "string" } }, "byResourceTypes" : { "type" : "array", "description" : "Filter by these resource types.", "items" : { "type" : "string", "enum" : [ "CATALOG", "ANALYSIS", "BUSINESS_TERM", "COLUMN", "DATA_TYPE", "DATABASE", "DATASET", "PROJECT", "TABLE", "CONCEPT", "UNKNOWN_CATALOG_ENTRY" ] } } } }, "RelationshipGetRequestById" : { "type" : "object", "properties" : { "byRelationTypes" : { "type" : "array", "description" : "Filter by these relation types. Relation types should be IRIs.", "example" : "https://dwec.data.world/v0/usesDataFrom", "items" : { "type" : "string" } }, "byResourceTypes" : { "type" : "array", "description" : "Filter by these resource types.", "items" : { "type" : "string", "enum" : [ "CATALOG", "ANALYSIS", "BUSINESS_TERM", "COLUMN", "DATA_TYPE", "DATABASE", "DATASET", "PROJECT", "TABLE", "CONCEPT", "UNKNOWN_CATALOG_ENTRY" ] } }, "resourceType" : { "type" : "string", "description" : "The type of resourceId.", "enum" : [ "CATALOG", "ANALYSIS", "BUSINESS_TERM", "COLUMN", "DATA_TYPE", "DATABASE", "DATASET", "PROJECT", "TABLE", "CONCEPT", "UNKNOWN_CATALOG_ENTRY" ] } }, "required" : [ "resourceType" ] }, "RelationshipGetRequestByIri" : { "type" : "object", "properties" : { "byRelationTypes" : { "type" : "array", "description" : "Filter by these relation types. Relation types are identified by their IRI.", "example" : "https://dwec.data.world/v0/usesDataFrom", "items" : { "type" : "string" } }, "byResourceTypes" : { "type" : "array", "description" : "Filter by these resource types. Resource types are identified by their IRI.", "items" : { "type" : "string" } } } }, "RelationshipHydrationDto" : { "type" : "object", "properties" : { "labels" : { "type" : "array", "description" : "Label of the relationship presentation associated with the relationship", "items" : { "type" : "string" } } } }, "RemoveCustomIriPropertyContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "entityType" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "property" : { "type" : "string" }, "target" : { "type" : "string" }, "type" : { "type" : "string", "const" : "RemoveCustomIriProperty" }, "value" : { "type" : "string" }, "valueEntityType" : { "type" : "string" } } } ], "required" : [ "entityType", "property", "target", "value" ] }, "RemoveCustomLiteralPropertyContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "entityType" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "property" : { "type" : "string" }, "target" : { "type" : "string" }, "type" : { "type" : "string", "const" : "RemoveCustomLiteralProperty" }, "value" : { "type" : "string" }, "valueType" : { "type" : "string" } } } ], "required" : [ "entityType", "property", "target", "value", "valueType" ] }, "RemoveFromCatalogContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "catalogIri" : { "type" : "string" }, "entryIri" : { "type" : "string" }, "entryType" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "type" : { "type" : "string", "const" : "RemoveFromCatalog" } } } ], "required" : [ "catalogIri", "entryIri", "entryType" ] }, "RemoveTagContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "entityType" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "tag" : { "type" : "string" }, "target" : { "type" : "string" }, "type" : { "type" : "string", "const" : "RemoveTag" } } } ], "required" : [ "entityType", "tag", "target" ] }, "RemoveUsesDataFromContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "analysisIri" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "tableIri" : { "type" : "string" }, "type" : { "type" : "string", "const" : "RemoveUsesDataFrom" } } } ], "required" : [ "analysisIri", "tableIri" ] }, "RemoveUsesDatasetContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "analysisIri" : { "type" : "string" }, "datasetIri" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "type" : { "type" : "string", "const" : "RemoveUsesDataset" } } } ], "required" : [ "analysisIri", "datasetIri" ] }, "ResourceDetails" : { "type" : "object", "properties" : { "typeDetails" : { "$ref" : "#/components/schemas/TypeDetails" } } }, "ResourceHierarchyDto" : { "type" : "object", "properties" : { "assetStatus" : { "$ref" : "#/components/schemas/AssetStatus", "description" : "Resource status: Pending, Approved etc." }, "hierarchy" : { "type" : "array", "description" : "Parent types of this resource's type. Returns the most specific type followed by its parent. The first item is the same as type. The last item is the root type.", "items" : { "$ref" : "#/components/schemas/EntryType" } }, "icon" : { "$ref" : "#/components/schemas/Icon", "description" : "Resource icon details.", "oneOf" : [ { "$ref" : "#/components/schemas/EmojiIcon" }, { "$ref" : "#/components/schemas/ImageIcon" }, { "$ref" : "#/components/schemas/SvgIcon" } ] }, "iri" : { "type" : "string", "description" : "Resource IRI." }, "owner" : { "type" : "string", "description" : "The ID of the organization that this resource belongs to" }, "title" : { "type" : "string", "description" : "Resource title" }, "type" : { "type" : "string", "description" : "Resource simple type name, e.g. catalogDatabase, catalogEntry etc." }, "typeLabel" : { "type" : "string", "description" : "Resource type label." } } }, "ResourceRelationshipDto" : { "type" : "object", "properties" : { "contributor" : { "type" : "boolean" }, "liked" : { "type" : "boolean" } } }, "SavedQueryExecutionRequest" : { "type" : "object", "properties" : { "datasetVersions" : { "type" : "string" }, "defaultGraphUris" : { "type" : "array", "items" : { "type" : "string" } }, "includeTableSchema" : { "type" : "boolean" }, "maxRows" : { "type" : "integer", "format" : "int64" }, "namedGraphUris" : { "type" : "array", "items" : { "type" : "string" } }, "parameters" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/RdfTerm" } }, "queryRunToken" : { "type" : "string" } } }, "SearchFacetResult" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int64" }, "term" : { "type" : "string" } } }, "SearchHydrations" : { "type" : "object", "properties" : { "agents" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/AgentHydrationDto" } }, "catalogAnalysis" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/CatalogAnalysisHydrationDto" } }, "catalogBusinessTerms" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/CatalogBusinessTermHydrationDto" } }, "catalogColumns" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/CatalogColumnHydrationDto" } }, "catalogConcepts" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/CatalogConceptHydrationDto" } }, "catalogDatabases" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/CatalogDatabaseHydrationDto" } }, "catalogTables" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/CatalogTableHydrationDto" } }, "catalogs" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/CatalogHydrationDto" } }, "datasets" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/DatasetHydrationDto" } }, "groups" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/GroupHydrationDto" } }, "insights" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/InsightHydrationDto" } }, "metadataResources" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/MetadataResourceDto" } }, "resourceHierarchy" : { "type" : "object", "additionalProperties" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResourceHierarchyDto" } } } }, "tasks" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/TaskFetchDto" } }, "unknownCatalogEntry" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/UnknownCatalogEntryHydrationDto" } } } }, "SearchRequest" : { "type" : "object", "properties" : { "assetStatus" : { "type" : "array", "description" : "Filter by asset status label.", "items" : { "type" : "string" }, "uniqueItems" : true }, "category" : { "type" : "array", "description" : "Filter by categories.", "items" : { "type" : "string", "enum" : [ "catalogAnalysis", "catalogBusinessTerm", "catalogColumn", "catalogDataType", "catalogTable", "collection", "comment", "dataset", "datatable", "file", "insight", "integration", "project", "query", "unknownCatalogEntry" ] }, "uniqueItems" : true }, "collection" : { "type" : "array", "description" : "Filter by collection IRI", "items" : { "type" : "string" }, "uniqueItems" : true }, "createdRange" : { "$ref" : "#/components/schemas/Range", "description" : "Filter by range of date that the resource was created." }, "minAccessLevel" : { "type" : "string", "description" : "Minimum access level to filter by.", "enum" : [ "NONE", "SAML_GATED", "DISCOVER", "MEMBER", "READ", "WRITE", "ADMIN" ] }, "owner" : { "type" : "array", "description" : "Filter by owners. Owners are identified by their IDs.", "items" : { "type" : "string" }, "uniqueItems" : true }, "property" : { "type" : "object", "additionalProperties" : { }, "description" : "Filter by custom properties." }, "query" : { "type" : "string" }, "tag" : { "type" : "array", "description" : "Filter by tags.", "items" : { "type" : "string" }, "uniqueItems" : true }, "type" : { "type" : "array", "description" : "Filter by type of metadata resource. Both IRI and label are accepted.", "items" : { "type" : "string" }, "uniqueItems" : true }, "updatedRange" : { "$ref" : "#/components/schemas/Range", "description" : "Filter by range of date that the resource was updated." }, "visibility" : { "type" : "string", "description" : "Filter by visibility.", "enum" : [ "DISCOVERABLE", "OPEN", "PRIVATE" ] } }, "required" : [ "query" ] }, "SearchedResourceDto" : { "type" : "object", "properties" : { "assetStatus" : { "$ref" : "#/components/schemas/AssetStatus" }, "category" : { "type" : "string" }, "collections" : { "type" : "array", "items" : { "type" : "string" } }, "created" : { "type" : "string", "format" : "date-time" }, "creator" : { "type" : "string" }, "description" : { "type" : "string" }, "fileCount" : { "type" : "integer", "format" : "int32" }, "id" : { "type" : "string" }, "iri" : { "type" : "string" }, "numLikes" : { "type" : "integer", "format" : "int32" }, "owner" : { "type" : "string" }, "properties" : { "type" : "object", "additionalProperties" : { } }, "resourceDetails" : { "$ref" : "#/components/schemas/ResourceDetails" }, "resourceLink" : { "type" : "string", "format" : "uri" }, "sourceId" : { "type" : "string" }, "sourceOfRecord" : { "type" : "string" }, "summary" : { "type" : "string" }, "tableId" : { "type" : "string" }, "tableIri" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "type" : "string" } }, "title" : { "type" : "string" }, "updated" : { "type" : "string", "format" : "date-time" }, "updatedBy" : { "type" : "string" } }, "required" : [ "category", "id", "owner" ] }, "ServiceAccountCreateRequestDto" : { "type" : "object", "properties" : { "desiredUsername" : { "type" : "string", "description" : "Used to create service account user name" }, "displayName" : { "type" : "string", "description" : "Display name to show in UI" }, "expiryDate" : { "type" : "string", "format" : "date-time" }, "isScimEnabled" : { "type" : "boolean", "writeOnly" : true }, "scimEnabled" : { "type" : "boolean" } } }, "ServiceAccountCreateResponseDto" : { "type" : "object", "properties" : { "active" : { "type" : "string" }, "serviceAccountUsername" : { "type" : "string" }, "token" : { "type" : "string" } } }, "ServiceAccountDetailsDto" : { "type" : "object", "properties" : { "active" : { "type" : "boolean", "description" : "Indicate service account token enabled or disabled" }, "displayName" : { "type" : "string", "description" : "Human-readable service account name" }, "expiryDate" : { "type" : "string", "format" : "date-time", "description" : "Service account token expiry date" }, "serviceAccount" : { "type" : "string", "description" : "Agentid or username" } } }, "ServiceAccountRefreshTokenRequestDto" : { "type" : "object", "properties" : { "expiryDate" : { "type" : "string", "format" : "date-time" } } }, "ServiceAccountUpdateDto" : { "type" : "object", "properties" : { "active" : { "type" : "boolean" }, "displayName" : { "type" : "string" } }, "required" : [ "active" ] }, "SetAssetStatusContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "assetStatus" : { "type" : "string" }, "entityType" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "target" : { "type" : "string" }, "type" : { "type" : "string", "const" : "SetAssetStatus" } } } ], "required" : [ "assetStatus", "entityType", "target" ] }, "SetCustomIriPropertyContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "entityType" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "property" : { "type" : "string" }, "target" : { "type" : "string" }, "type" : { "type" : "string", "const" : "SetCustomIriProperty" }, "value" : { "type" : "string" } } } ], "required" : [ "entityType", "property", "target" ] }, "SetCustomLiteralPropertyContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "entityType" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "property" : { "type" : "string" }, "target" : { "type" : "string" }, "type" : { "type" : "string", "const" : "SetCustomLiteralProperty" }, "value" : { "type" : "string" }, "valueType" : { "type" : "string" } } } ], "required" : [ "entityType", "property", "target" ] }, "SetCustomStringPropertyContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "entityType" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "property" : { "type" : "string" }, "target" : { "type" : "string" }, "type" : { "type" : "string", "const" : "SetCustomStringProperty" }, "value" : { "type" : "string" } } } ], "required" : [ "entityType", "property", "target" ] }, "SetDescriptionContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "description" : { "type" : "string" }, "entityType" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "target" : { "type" : "string" }, "type" : { "type" : "string", "const" : "SetDescription" } } } ], "required" : [ "description", "entityType", "target" ] }, "SetLicenseContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "entityType" : { "type" : "string" }, "license" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "target" : { "type" : "string" }, "type" : { "type" : "string", "const" : "SetLicense" } } } ], "required" : [ "entityType", "license", "target" ] }, "SetNameContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "entityType" : { "type" : "string" }, "name" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "target" : { "type" : "string" }, "type" : { "type" : "string", "const" : "SetName" } } } ], "required" : [ "entityType", "target" ] }, "SetSummaryContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "entityType" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "summary" : { "type" : "string" }, "target" : { "type" : "string" }, "type" : { "type" : "string", "const" : "SetSummary" } } } ], "required" : [ "entityType", "target" ] }, "SimpleDataset" : { "allOf" : [ { "$ref" : "#/components/schemas/SimpleResource" }, { "type" : "object", "properties" : { "description" : { "type" : "string", "maxLength" : 120, "minLength" : 0 }, "id" : { "type" : "string" }, "license" : { "type" : "string", "enum" : [ "Public Domain, PDDL, CC-0, CC-BY, CDLA-Permissive-1.0, CC-BY-IGO, CC-BY 3.0, CC-BY 3.0 AU, CC-BY 3.0 IGO, CC-BY-SA, CC-BY-SA 3.0, CDLA-Sharing-1.0, CC BY-NC, CC BY-ND, CC BY-ND 3.0, CC-BY 3.0 NZ, CC-BY-NC 3.0, CC BY-NC-ND, CC-BY-NC-SA 3.0, CC-BY-SA 3.0 NZ, CC-BY-NC-SA 3.0 NZ, CC-BY-NC 3.0 NZ, CC-BY-NC-ND-NZ-3.0, CC BY-NC-SA, Italian-ODL, MIT License, OGL, OGL-Canada, OGL-Nova Scotia, OGL-UK, OSODL, ODC-BY, ODC-ODbL, Other" ] }, "owner" : { "type" : "string" }, "summary" : { "type" : "string", "maxLength" : 25000, "minLength" : 0 }, "tags" : { "type" : "array", "items" : { "type" : "string" } }, "title" : { "type" : "string", "maxLength" : 60, "minLength" : 1 }, "type" : { "type" : "string", "enum" : [ "dataset", "project" ] }, "visibility" : { "type" : "string", "enum" : [ "OPEN, PRIVATE" ] } } } ], "required" : [ "id", "owner" ] }, "SimpleResource" : { "type" : "object", "discriminator" : { "mapping" : { "dataset" : "#/components/schemas/SimpleDataset", "project" : "#/components/schemas/SimpleDataset" }, "propertyName" : "type" }, "properties" : { "type" : { "type" : "string", "description" : "The type of the resource", "enum" : [ "dataset", "project" ] } } }, "SimpleSearchRequest" : { "type" : "object", "properties" : { "category" : { "type" : "array", "description" : "Filter by categories.", "items" : { "type" : "string", "enum" : [ "catalogAnalysis", "catalogBusinessTerm", "catalogColumn", "catalogDataType", "catalogTable", "collection", "comment", "dataset", "datatable", "file", "insight", "integration", "project", "query", "unknownCatalogEntry" ] }, "uniqueItems" : true }, "includeCommunityResults" : { "type" : "boolean" }, "owner" : { "type" : "array", "description" : "Filter by owners. Owners are identified by their IDs.", "items" : { "type" : "string" }, "uniqueItems" : true }, "query" : { "type" : "string" } }, "required" : [ "query" ] }, "SingleTableMetadataSpecDto" : { "type" : "object", "properties" : { "database" : { "type" : "string" }, "schema" : { "type" : "string" }, "table" : { "type" : "string" }, "tableType" : { "type" : "string", "enum" : [ "EXTRACT", "VIRTUAL" ] } } }, "SourceId" : { "type" : "object", "properties" : { "agentid" : { "type" : "string" }, "sourceid" : { "type" : "string" } } }, "SparqlQueryRequest" : { "type" : "object", "properties" : { "datasetVersions" : { "type" : "string" }, "defaultGraphUris" : { "type" : "array", "items" : { "type" : "string" } }, "diagnose" : { "type" : "boolean" }, "namedGraphUris" : { "type" : "array", "items" : { "type" : "string" } }, "query" : { "type" : "string" }, "queryRunToken" : { "type" : "string" } }, "required" : [ "query" ] }, "SqlQueryRequest" : { "type" : "object", "properties" : { "datasetVersions" : { "type" : "string" }, "includeTableSchema" : { "type" : "boolean" }, "query" : { "type" : "string" }, "queryRunToken" : { "type" : "string" } }, "required" : [ "query" ] }, "SshTunnel" : { "type" : "object", "properties" : { "host" : { "type" : "string", "description" : "ssh tunnel host", "example" : "passthru.tunnel.ca" }, "port" : { "type" : "integer", "format" : "int32", "description" : "Tunnel Port", "example" : 3454, "maximum" : 65535, "minimum" : 1 }, "user" : { "type" : "string", "description" : "user name", "example" : "johnsmith", "maxLength" : 1024, "minLength" : 0 }, "userKeyPair" : { "type" : "boolean", "description" : "whether authentication is required", "example" : true } }, "required" : [ "host", "user", "userKeyPair" ] }, "StreamSchema" : { "type" : "object", "properties" : { "primaryKeyFields" : { "type" : "array", "items" : { "type" : "string" }, "maxItems" : 10, "minItems" : 1 }, "sequenceField" : { "type" : "string" } } }, "StreamSchemaPatchRequest" : { "type" : "object", "properties" : { "primaryKeyFields" : { "type" : "array", "items" : { "type" : "string" } }, "sequenceField" : { "type" : "string" }, "updateMethod" : { "type" : "string", "enum" : [ "TRUNCATE" ] } }, "required" : [ "updateMethod" ] }, "StringOrArray" : { "oneOf" : [ { "type" : "string" }, { "type" : "array", "items" : { "type" : "string" } } ] }, "Subscription" : { "type" : "object", "properties" : { "dataset" : { "$ref" : "#/components/schemas/DatasetIdentifier" }, "events" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "ALL" ] } }, "project" : { "$ref" : "#/components/schemas/DatasetIdentifier" }, "user" : { "$ref" : "#/components/schemas/UserIdentifier" } }, "required" : [ "events" ] }, "SubscriptionApiLinks" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri" } }, "required" : [ "self" ] }, "SubscriptionCreateRequest" : { "type" : "object", "properties" : { "events" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "ALL" ] }, "maxItems" : 50, "minItems" : 1 } }, "required" : [ "events" ] }, "SubscriptionLinks" : { "type" : "object", "properties" : { "api" : { "$ref" : "#/components/schemas/SubscriptionApiLinks" } }, "required" : [ "api" ] }, "SubscriptionResponse" : { "type" : "object", "properties" : { "dataset" : { "$ref" : "#/components/schemas/PublicDatasetResource" }, "events" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "ALL" ] } }, "links" : { "$ref" : "#/components/schemas/SubscriptionLinks" }, "project" : { "$ref" : "#/components/schemas/PublicDatasetResource" }, "user" : { "$ref" : "#/components/schemas/PublicUserParty" } }, "required" : [ "events" ] }, "SuccessMessage" : { "type" : "object", "properties" : { "message" : { "type" : "string", "maxLength" : 256, "minLength" : 0 } } }, "SuccessMessageDto" : { "type" : "object", "properties" : { "message" : { "type" : "string", "maxLength" : 256, "minLength" : 0 } } }, "SvgIcon" : { "allOf" : [ { "$ref" : "#/components/schemas/Icon" }, { "type" : "object", "properties" : { "image" : { "$ref" : "#/components/schemas/Image", "oneOf" : [ { "$ref" : "#/components/schemas/HostedImage" }, { "$ref" : "#/components/schemas/ProvidedImage" } ] }, "largeImage" : { "$ref" : "#/components/schemas/Image", "oneOf" : [ { "$ref" : "#/components/schemas/HostedImage" }, { "$ref" : "#/components/schemas/ProvidedImage" } ] }, "selectedImage" : { "$ref" : "#/components/schemas/Image", "oneOf" : [ { "$ref" : "#/components/schemas/HostedImage" }, { "$ref" : "#/components/schemas/ProvidedImage" } ] }, "type" : { "type" : "string", "const" : "svg-image" } } } ] }, "TableBatchUpdateRequest" : { "type" : "object", "properties" : { "tables" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FileCreateOrUpdateRequest" } } } }, "TableId" : { "type" : "object", "properties" : { "owner" : { "type" : "string" }, "sourceId" : { "type" : "string" }, "tableId" : { "type" : "string" } }, "required" : [ "owner", "tableId" ] }, "TableMetadataSpecDto" : { "type" : "object", "properties" : { "database" : { "type" : "string" }, "schema" : { "type" : "string" }, "tablePrefixes" : { "type" : "array", "items" : { "type" : "string" } }, "tableTypes" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "TABLE", "EXTERNAL_TABLE", "VIEW" ] } }, "tables" : { "type" : "array", "items" : { "type" : "string" } } } }, "TaskFetchDto" : { "type" : "object", "properties" : { "arguments" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "automationTaskDetails" : { "$ref" : "#/components/schemas/AutomationTaskDetailsDto" }, "claimableBy" : { "type" : "array", "items" : { "type" : "string" }, "minItems" : 1 }, "claimableByCurrentUser" : { "type" : "boolean" }, "claimedAt" : { "type" : "string", "format" : "date-time" }, "claimedBy" : { "type" : "string" }, "continuationId" : { "type" : "string" }, "created" : { "type" : "string", "format" : "date-time" }, "description" : { "type" : "string" }, "endTime" : { "type" : "string", "format" : "date-time" }, "executionEngine" : { "type" : "string", "enum" : [ "AWS_SIMPLE_WORKFLOW", "AWS_STEP_FUNCTIONS", "CAMUNDA" ] }, "externalFormId" : { "type" : "string" }, "externalTaskId" : { "type" : "string" }, "guidance" : { "type" : "string" }, "jobId" : { "type" : "string", "format" : "uuid" }, "name" : { "type" : "string" }, "ownerAgentid" : { "type" : "string" }, "resources" : { "type" : "array", "items" : { "type" : "string" }, "minItems" : 1 }, "returnValueJson" : { "type" : "string" }, "startTime" : { "type" : "string", "format" : "date-time" }, "status" : { "type" : "string", "enum" : [ "CREATED", "CLAIMED", "COMPLETING", "COMPLETED", "CANCELING", "CANCELED" ] }, "tags" : { "type" : "array", "items" : { "type" : "string" } }, "taskId" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier for the task" }, "taskType" : { "type" : "string", "minLength" : 1 }, "type" : { "type" : "string", "enum" : [ "FORM" ] }, "updated" : { "type" : "string", "format" : "date-time" } }, "required" : [ "claimableBy", "executionEngine", "ownerAgentid", "resources", "tags", "taskType", "type" ] }, "TransferAssetDto" : { "type" : "object", "properties" : { "entityType" : { "type" : "string", "description" : "The type of resource being transferred", "minLength" : 1 }, "identifier" : { "type" : "string", "description" : "The dct:identifier of resource being transferred" }, "iri" : { "type" : "string", "description" : "The IRI of resource being transferred", "minLength" : 1 } }, "required" : [ "entityType", "iri" ] }, "TypeDetails" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "label" : { "type" : "string" }, "subtypeOf" : { "type" : "string" } } }, "UnknownCatalogEntryHydrationDto" : { "type" : "object", "properties" : { "agentid" : { "type" : "string" }, "assetStatus" : { "$ref" : "#/components/schemas/AssetStatus" }, "catalogs" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CatalogId" } }, "createdBy" : { "$ref" : "#/components/schemas/AgentHydrationDto" }, "description" : { "type" : "string" }, "entryTypeHierarchy" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EntryType" } }, "entryTypeLabel" : { "type" : "string" }, "identifier" : { "type" : "string" }, "referent" : { "type" : "string" }, "title" : { "type" : "string" }, "type" : { "type" : "string" }, "updated" : { "type" : "string", "format" : "date-time" } } }, "UnreferenceBusinessTermContribution" : { "allOf" : [ { "$ref" : "#/components/schemas/ContributionActivity" }, { "type" : "object", "properties" : { "businessTermIri" : { "type" : "string" }, "entityType" : { "type" : "string" }, "overrideType" : { "type" : "string", "enum" : [ "SET", "ADD", "REMOVE" ] }, "target" : { "type" : "string" }, "type" : { "type" : "string", "const" : "UnreferenceBusinessTerm" } } } ], "required" : [ "businessTermIri", "entityType", "target" ] }, "UserAssignment" : { "type" : "object", "properties" : { "groups" : { "type" : "array", "description" : "Groups in the organization that user should be assigned to", "items" : { "type" : "string", "minLength" : 1 }, "maxItems" : 30, "minItems" : 0, "uniqueItems" : true }, "orgAgentId" : { "type" : "string", "description" : "Organization that user should be assigned to" } }, "required" : [ "orgAgentId" ] }, "UserDataResponse" : { "type" : "object", "properties" : { "avatarUrl" : { "type" : "string", "maxLength" : 256, "minLength" : 0 }, "baseUrl" : { "type" : "string" }, "created" : { "type" : "string", "format" : "date-time" }, "displayName" : { "type" : "string", "maxLength" : 128, "minLength" : 0 }, "id" : { "type" : "string" }, "updated" : { "type" : "string", "format" : "date-time" } }, "required" : [ "created", "id", "updated" ] }, "UserIdentifier" : { "type" : "object", "properties" : { "id" : { "type" : "string" } }, "required" : [ "id" ] }, "ViewRequestDto" : { "type" : "object", "properties" : { "baseAgentId" : { "type" : "string" }, "baseDatasetId" : { "type" : "string" }, "queryId" : { "type" : "string", "format" : "uuid" }, "queryName" : { "type" : "string" }, "queryText" : { "type" : "string", "maxLength" : 10000, "minLength" : 1 }, "queryType" : { "type" : "string", "enum" : [ "SPARQL", "SQL" ] }, "runAsAgentId" : { "type" : "string" }, "targetAgentId" : { "type" : "string" }, "targetDatasetId" : { "type" : "string" } }, "required" : [ "baseAgentId", "baseDatasetId", "queryName", "queryType", "runAsAgentId", "targetAgentId", "targetDatasetId" ] }, "WebAuthorization" : { "type" : "object", "properties" : { "credentials" : { "type" : "string", "maxLength" : 2048, "minLength" : 1 }, "type" : { "type" : "string", "maxLength" : 50, "minLength" : 0 } }, "required" : [ "type" ] }, "WebCredentials" : { "type" : "object", "properties" : { "password" : { "type" : "string", "maxLength" : 2048, "minLength" : 0 }, "user" : { "type" : "string", "maxLength" : 2048, "minLength" : 0 } }, "required" : [ "user" ] } }, "securitySchemes" : { "bearerAuth" : { "bearerFormat" : "JWT", "scheme" : "bearer", "type" : "http" } } }, "jsonSchemaDialect" : "https://spec.openapis.org/oas/3.1/dialect/base" }