Sign in

v1

latestOpenAPI 3.0.02026-08-04122577.8 KB
datafiles

Re-upload an existing data file or update an existing folder.

put/api/v1/data-files/{id}

Path parameters

idstring uuid required

The ID of the data file to update.

Response

The file or folder was updated.

idstring uuid required

The ID for the file or folder.

qristring nullable

The QRI generated from the datafile or folder's metadata.

namestring required

The full name of the file or folder, including any folder path prefix.

sizeinteger required

The size of the uploaded file, in bytes. 0 if this item represents a folder

appIdstring nullable

If this file or folder is bound to the lifecycle of a specific app, this is the ID of this app.

folderboolean

Whether or not this given item represents a folder or a file.

actionsDataFilePermission[] required

The CRUD actions that are allowed on the given data file.

ownerIdstring required

The 'owner' of a file or folder is the user who last uploaded the item's content.

spaceIdstring nullable

If the file or folder was created in a team space, this is the ID of that space.

baseNamestring nullable

The name of the file or folder, not including any folder path prefix.

folderIdstring uuid nullable

If the file or folder resides in a parent folder, this is the parent folder ID. If the file or folder does not reside in a parent folder, this value is null.

folderPathstring nullable

If the file or folder resides in a parent folder, this is the parent folder path. If the file or folder does not reside in a parent folder, this value is null.

createdDatestring date-time required

The date that the file or folder was created.

modifiedDatestring date-time nullable

The date that the updated file or folder was last modified.

contentUpdatedDatestring date-time nullable

If the data file's content was updated, this is the DateTime of the last content update.

Example response

{
  "id": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
  "qri": "qri:qdf:space://ooSOGoLLaq7EMaSdSsCiGvLwcd_VAf1oU0mzwSfp_Qs#wME89c8gKu_Tpz8W_a0JKSbKC4hzbNu0NLVgqi2UFS0",
  "name": "some/folder/MyFile.csv",
  "size": 1024,
  "appId": "f34b91a1-0dc3-44ac-a847-51cb84122c84",
  "folder": true,
  "actions": [
    "Read"
  ],
  "ownerId": "lDL4DIINndhL_iJkcbqWyJenuwizP-2D",
  "spaceId": "617979737a9f56e49dea2e6e",
  "baseName": "MyFile.csv",
  "folderId": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
  "folderPath": "some/folder",
  "createdDate": "2020-07-07T20:52:40.8534780Z",
  "folderStats": {
    "totalFileCount": 50,
    "directFileCount": 50,
    "totalFolderCount": 50,
    "aggregateFileSize": 10000,
    "directFolderCount": 50,
    "totalInternalFileCount": 50,
    "directInternalFileCount": 50,
    "totalAppScopedFileCount": 50,
    "directAppScopedFileCount": 50,
    "aggregateInternalFileSize": 10000,
    "aggregateAppScopedFileSize": 10000
  },
  "modifiedDate": "2020-07-07T20:52:40.8534780Z",
  "contentUpdatedDate": "2020-07-07T20:52:40.8534780Z"
}