{ "opencollection": "1.0.0", "info": { "name": "data.world Public catalog relationships files API", "version": "0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "files", "type": "folder" }, "items": [ { "info": { "name": "Add files from URLs", "type": "http" }, "http": { "method": "POST", "url": "/v0/datasets/:owner/:id/files", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete files", "type": "http" }, "http": { "method": "DELETE", "url": "/v0/datasets/:owner/:id/files", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Delete a file", "type": "http" }, "http": { "method": "DELETE", "url": "/v0/datasets/:owner/:id/files/:file", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "file", "value": "", "type": "path", "description": "Filename" } ] }, "docs": "Delete a single file from a dataset." }, { "info": { "name": "Get file description and labels", "type": "http" }, "http": { "method": "GET", "url": "/v0/datasets/:owner/:id/files/:file/metadata", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "file", "value": "", "type": "path" } ] }, "docs": "Get file description and labels" }, { "info": { "name": "Replace file description and labels", "type": "http" }, "http": { "method": "PUT", "url": "/v0/datasets/:owner/:id/files/:file/metadata", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "file", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace file description and labels" }, { "info": { "name": "Update file description and labels", "type": "http" }, "http": { "method": "PATCH", "url": "/v0/datasets/:owner/:id/files/:file/metadata", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "file", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Sync files (via GET)", "type": "http" }, "http": { "method": "GET", "url": "/v0/datasets/:owner/:id/sync", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Same as `POST:/dataset/{owner}/{id}/sync`. The id parameter can either be a dataset id or project id." }, { "info": { "name": "Sync files", "type": "http" }, "http": { "method": "POST", "url": "/v0/datasets/:owner/:id/sync", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Download a file", "type": "http" }, "http": { "method": "GET", "url": "/v0/file_download/:owner/:id/:file", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "file", "value": "", "type": "path" } ] }, "docs": "Download a file within the dataset as originally uploaded. Prefer `POST:/sql` or `POST:/sparql` for\nretrieving clean and structured data." }, { "info": { "name": "Upload files", "type": "http" }, "http": { "method": "POST", "url": "/v0/uploads/:owner/:id/files", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "expandArchives", "value": "", "type": "query" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": "\"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 \"f" }, { "info": { "name": "Upload a file", "type": "http" }, "http": { "method": "PUT", "url": "/v0/uploads/:owner/:id/files/:file", "params": [ { "name": "owner", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "file", "value": "", "type": "path", "description": "Filename" }, { "name": "expandArchive", "value": "", "type": "query" } ] }, "docs": "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-bina" } ] } ], "bundled": true }