v1

latestOpenAPI 3.0.02026-08-04122577.8 KB

datafiles

Get descriptive info for the specified data files.

get/api/v1/data-files

Query parameters

allowInternalFilesboolean

If set to false, do not return data files with internal extensions else return all the data files.

appIdstring nullable

Example:f34b91a1-0dc3-44ac-a847-51cb84122c84

Only return files scoped to the specified app. If this parameter is not specified, only files that are not scoped to any app are returned. "*" implies all app-scoped files are returned.

baseNameWildcardstring nullable

Example:*SomeFileName*

If present, return only items whose base name matches the given wildcard. Wildcards include '*' and '?' characters to allow for multiple matches. The base name is the actual file or folder name without any folder pathing included.

connectionIdstring uuid nullable

Example:ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc

Return files and folders that reside in the space referenced by the specified DataFiles connection. If this parameter is not specified, the user's personal space is implied.

excludeFilesboolean

If set to true, exclude files in the returned list (IE, only return folders). If false, include files.

excludeSubFoldersboolean

If set to true, exclude folders and files that reside in sub-folders of the root being searched. If false, include all items in full folder hierarchy that recursively reside under the root. That is, setting to true results in only the direct children of the root being returned.

folderIdstring uuid nullable

Example:ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc

If present, return only items which reside under the folder specified by the given ID. If not present, items that live at the root of the space are returned. This property is mutually exclusive with 'folderPath'.

folderPathstring nullable

Example:some/folder

If present, return only items which reside under the specified folder path. If not present, items that live at the root of the space are returned. This property is mutually exclusive with 'folderId'.

includeAllSpacesboolean

If set to true, and connectionId is not specified, return files and folders from all spaces the given user has access to (including the personal space). If connectionId is specified, this parameter is ignored.

includeFoldersboolean

If set to true, include folders in the returned list. If false, only return data files.

includeFolderStatsboolean

If set to true, include computed folder statistics for folders in the returned list. If false, this information is not returned.

limitinteger

Example:5

If present, the maximum number of data files to return.

namestring nullable

Example:MyFile.csv

Filter the list of files returned to the given file name.

notOwnerIdstring nullable

Example:lDL4DIINndhL_iJkcbqWyJenuwizP-2D

If present, fetch the data files whose owner is not the specified owner. If a connectionId is specified in this case, the returned list is constrained to the specified space. If connectionId is not specified, then the returned list is constrained to the calling user's personal space. If includeAllSpaces is set to true, and connectionId is not specified, the returned list is from all spaces the given user has access to (including the personal space).

ownerIdstring nullable

Example:lDL4DIINndhL_iJkcbqWyJenuwizP-2D

If present, fetch the data files for the specified owner. If a connectionId is specified in this case, the returned list is constrained to the specified space. If connectionId is not specified, then all files owned by the specified user are returned regardless of the personal space that a given file resides in.

pagestring nullable

Example:NzlmNzI5NWMtZGJlZC00Y2Y4LThkNDAtMzQ5ZDU3YzNjMzQ1

If present, the cursor that starts the page of data that is returned.

<p>Members:</p><ul></ul>

Example:name

The name of the field used to sort the result. By default, the sort order is ascending. Putting a '+' prefix on the sort field name explicitly indicates ascending sort order. A '-' prefix indicates a descending sort order.

Response

The file list was retrieved.

Example response

{
  "data": [
    {
      "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"
    }
  ]
}

All 12 operations