Data files

Data files represent the flat file storage associated with spaces in your Qlik Cloud tenant. Each space will have a corresponding data files connection, which you can list with data-connections.

Download OpenAPI spec

Endpoints

GET

/api/v1/data-files
POST

/api/v1/data-files
GET

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

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

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

/api/v1/data-files/{id}/actions/change-owner
POST

/api/v1/data-files/{id}/actions/change-space
POST

/api/v1/data-files/actions/change-space
POST

/api/v1/data-files/actions/delete
GET

/api/v1/data-files/connections
GET

/api/v1/data-files/connections/{id}
GET

/api/v1/data-files/quotas

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

allowInternalFiles boolean

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

default = false
appId string

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.
baseNameWildcard string

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.
connectionId string

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.

format = "uuid"
excludeFiles boolean

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

default = false
excludeSubFolders boolean

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.

default = false
folderId string

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'.

format = "uuid"
folderPath string

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'.
includeAllSpaces boolean

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.

default = false
includeFolders boolean

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

default = false
includeFolderStats boolean

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

default = false
limit integer

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

minimum = 1, maximum = 1000, default = 20, format = int32, default = 20
name string

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

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).
ownerId string

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.
page string

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

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.

Can be one of: "name""+name""-name""size""+size""-size""modifiedDate""+modifiedDate""-modifiedDate""folder""+folder""-folder""baseName""+baseName""-baseName"

Responses

200

The file list was retrieved.

application/json object
Show application/json properties
- data array of objects
  
  Required
  
  Properties of the uploaded data files.
  
  Show data properties
  
  id string
  
  Required
  
  The ID for the file or folder.
  
  format = "uuid"
  
  qri string
  
  The QRI generated from the datafile or folder's metadata.
  
  name string
  
  Required
  
  The full name of the file or folder, including any folder path prefix.
  
  size integer
  
  Required
  
  The size of the uploaded file, in bytes. 0 if this item represents a folder
  
  format = int64
  
  appId string
  
  If this file or folder is bound to the lifecycle of a specific app, this is the ID of this app.
  
  folder boolean
  
  Whether or not this given item represents a folder or a file.
  
  actions array of strings
  
  Required
  
  The CRUD actions that are allowed on the given data file.
  
  Values may be any of: "read""update""delete""list""change_owner""change_space"
  
  ownerId string
  
  Required
  
  The 'owner' of a file or folder is the user who last uploaded the item's content.
  
  spaceId string
  
  If the file or folder was created in a team space, this is the ID of that space.
  
  baseName string
  
  The name of the file or folder, not including any folder path prefix.
  
  folderId string
  
  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.
  
  format = "uuid"
  
  folderPath string
  
  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.
  
  createdDate string
  
  Required
  
  The date that the file or folder was created.
  
  format = "date-time"
  
  folderStats object
  
  Required
  
  Show folderStats properties
  
  totalFileCount integer
  
  Required
  
  The number of data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directFileCount integer
  
  Required
  
  The number of data files that reside as direct children of the given folder.
  
  format = int64
  
  totalFolderCount integer
  
  Required
  
  The number of folders that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  aggregateFileSize integer
  
  Required
  
  The sum of the file sizes, in bytes, of all data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directFolderCount integer
  
  Required
  
  The number of sub-folders that reside as direct children of the given folder.
  
  format = int64
  
  totalInternalFileCount integer
  
  Required
  
  The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directInternalFileCount integer
  
  Required
  
  The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as direct children of the given folder.
  
  format = int64
  
  totalAppScopedFileCount integer
  
  Required
  
  The number of app-scoped data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directAppScopedFileCount integer
  
  Required
  
  The number of app-scoped data files that reside as direct children of the given folder.
  
  format = int64
  
  aggregateInternalFileSize integer
  
  Required
  
  The sum of the file sizes, in bytes, of all internal data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  aggregateAppScopedFileSize integer
  
  Required
  
  The sum of the file sizes, in bytes, of all app-scoped data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  modifiedDate string
  
  The date that the updated file or folder was last modified.
  
  format = "date-time"
  
  contentUpdatedDate string
  
  If the data file's content was updated, this is the DateTime of the last content update.
  
  format = "date-time"
- links object
  
  Required
  
  Show links properties
  
  next object
  
  Required
  
  Show next properties
  
  href string
  
  The URL for the link.
  
  format = "uri"
  
  prev object
  
  Required
  
  Show prev properties
  
  href string
  
  The URL for the link.
  
  format = "uri"
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  The URL for the link.
  
  format = "uri"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

GET /api/v1/data-files

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataFiles.getDataFiles({})

qlik data-file ls

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-files" \
-H "Authorization: Bearer <access_token>"

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"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

multipart/form-data object
Show multipart/form-data properties
- File string
  
  IFormFile form multipart/form-data
  
  format = "binary"
- Json object
  
  See PostDataFileRequest schema which defines request structure. See PostDataFileRequest model.
  
  Show Json properties
  
  name string
  
  Required
  
  Name that will be given to the file or folder. It should be noted that the '/' character in the name indicates a 'path' separator in a logical folder hierarchy for the name. Names that contain '/'s should be used with the assumption that a logical 'folder hierarchy' is being defined for the full pathname of that file or folder. IE, a '/' is a significant character in the name.
  
  pattern = "^[^<>":\u0000|?*]+$"
  
  appId string
  
  If this file should be bound to the lifecycle of a specific app, this is the ID of this app. If this request is creating a folder, the specification of an app ID is not allowed.
  
  folder boolean
  
  If true, a folder will be created. If false, a file is created.
  
  default = false
  
  folderId string
  
  If the specified file or folder should be moved to become a a sub-item of an existing folder, this is the ID of this parent folder. Any additional folder path that is present on the Name property will be created as a subfolder hierarchy of this folder. If the FolderID is null, the file or folder specified in the Name property (including any folder prefix on that name), will be created in the root of the space.
  
  format = "uuid"
  
  sourceId string
  
  If a SourceId is specified, this is the ID of the existing data file or folder whose content should be copied into the specified data file or folder. That is, for a file instead of the file content being specified in the Data element, it is effectively copied from an existing, previously uploaded file. For a folder, rather than the new folder being empty, it's contents are copied from an existing, previously created folder.
  
  format = "uuid"
  
  connectionId string
  
  If present, this is the DataFiles connection that the upload should occur in the context of. If absent, the default is that the upload will occur in the context of the Personal Space DataFiles connection. If the DataFiles connection is different from the one specified when the file or folder was last POSTed or PUT, this will result in a logical move of this file or folder into the new space.
  
  format = "uuid"
  
  tempContentFileId string
  
  If a TempContentFileId is specified, this is the ID of a previously uploaded temporary content file whose content should be copied into the specified data file. That is, instead of the file content being specified in the Data element, it is effectively copied from an existing, previously uploaded file. The expectation is that this file was previously uploaded to the temporary content service, and the ID specified here is the one returned from the temp content upload request. This option does not apply when POSTing a folder.

Responses

201

New file or folder was created.

application/json object
Show application/json properties
- id string
  
  Required
  
  The ID for the file or folder.
  
  format = "uuid"
- qri string
  
  The QRI generated from the datafile or folder's metadata.
- name string
  
  Required
  
  The full name of the file or folder, including any folder path prefix.
- size integer
  
  Required
  
  The size of the uploaded file, in bytes. 0 if this item represents a folder
  
  format = int64
- appId string
  
  If this file or folder is bound to the lifecycle of a specific app, this is the ID of this app.
- folder boolean
  
  Whether or not this given item represents a folder or a file.
- actions array of strings
  
  Required
  
  The CRUD actions that are allowed on the given data file.
  
  Values may be any of: "read""update""delete""list""change_owner""change_space"
- ownerId string
  
  Required
  
  The 'owner' of a file or folder is the user who last uploaded the item's content.
- spaceId string
  
  If the file or folder was created in a team space, this is the ID of that space.
- baseName string
  
  The name of the file or folder, not including any folder path prefix.
- folderId string
  
  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.
  
  format = "uuid"
- folderPath string
  
  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.
- createdDate string
  
  Required
  
  The date that the file or folder was created.
  
  format = "date-time"
- folderStats object
  
  Required
  
  Show folderStats properties
  
  totalFileCount integer
  
  Required
  
  The number of data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directFileCount integer
  
  Required
  
  The number of data files that reside as direct children of the given folder.
  
  format = int64
  
  totalFolderCount integer
  
  Required
  
  The number of folders that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  aggregateFileSize integer
  
  Required
  
  The sum of the file sizes, in bytes, of all data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directFolderCount integer
  
  Required
  
  The number of sub-folders that reside as direct children of the given folder.
  
  format = int64
  
  totalInternalFileCount integer
  
  Required
  
  The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directInternalFileCount integer
  
  Required
  
  The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as direct children of the given folder.
  
  format = int64
  
  totalAppScopedFileCount integer
  
  Required
  
  The number of app-scoped data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directAppScopedFileCount integer
  
  Required
  
  The number of app-scoped data files that reside as direct children of the given folder.
  
  format = int64
  
  aggregateInternalFileSize integer
  
  Required
  
  The sum of the file sizes, in bytes, of all internal data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  aggregateAppScopedFileSize integer
  
  Required
  
  The sum of the file sizes, in bytes, of all app-scoped data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
- modifiedDate string
  
  The date that the updated file or folder was last modified.
  
  format = "date-time"
- contentUpdatedDate string
  
  If the data file's content was updated, this is the DateTime of the last content update.
  
  format = "date-time"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

409

A file or folder with the same name already exists in the specified user or app scope.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

413

The file exceeds the user's quota for maximum file size to upload.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

423

The file is already locked for read or write by another client.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

501

Not Implemented

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

POST /api/v1/data-files

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataFiles.uploadDataFile({
  File: 'string',
  Json: {
    appId: 'f34b91a1-0dc3-44ac-a847-51cb84122c84',
    connectionId:
      'ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc',
    folderId:
      'ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc',
    name: 'some/folder/MyFile.csv',
    sourceId:
      'f34b91a1-0dc3-44ac-a847-51cb84122c84',
    tempContentFileId: '624b0f54459f1c00018dade4',
  },
})

qlik data-file create \
  --name 'some/folder/MyFile.csv'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-files" \
-X POST \
-H "Content-type: multipart/form-data" \
-H "Authorization: Bearer <access_token>" \
-F "File=@/path/to/file" \
-F "Json={\"name\":\"some/folder/MyFile.csv\",\"appId\":\"f34b91a1-0dc3-44ac-a847-51cb84122c84\",\"folder\":false,\"folderId\":\"ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc\",\"sourceId\":\"f34b91a1-0dc3-44ac-a847-51cb84122c84\",\"connectionId\":\"ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc\",\"tempContentFileId\":\"624b0f54459f1c00018dade4\"}"

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"
}

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

id string

Required

The ID of the data file.

format = "uuid"

Responses

200

The file was located.

application/json object
Show application/json properties
- id string
  
  Required
  
  The ID for the file or folder.
  
  format = "uuid"
- qri string
  
  The QRI generated from the datafile or folder's metadata.
- name string
  
  Required
  
  The full name of the file or folder, including any folder path prefix.
- size integer
  
  Required
  
  The size of the uploaded file, in bytes. 0 if this item represents a folder
  
  format = int64
- appId string
  
  If this file or folder is bound to the lifecycle of a specific app, this is the ID of this app.
- folder boolean
  
  Whether or not this given item represents a folder or a file.
- actions array of strings
  
  Required
  
  The CRUD actions that are allowed on the given data file.
  
  Values may be any of: "read""update""delete""list""change_owner""change_space"
- ownerId string
  
  Required
  
  The 'owner' of a file or folder is the user who last uploaded the item's content.
- spaceId string
  
  If the file or folder was created in a team space, this is the ID of that space.
- baseName string
  
  The name of the file or folder, not including any folder path prefix.
- folderId string
  
  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.
  
  format = "uuid"
- folderPath string
  
  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.
- createdDate string
  
  Required
  
  The date that the file or folder was created.
  
  format = "date-time"
- folderStats object
  
  Required
  
  Show folderStats properties
  
  totalFileCount integer
  
  Required
  
  The number of data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directFileCount integer
  
  Required
  
  The number of data files that reside as direct children of the given folder.
  
  format = int64
  
  totalFolderCount integer
  
  Required
  
  The number of folders that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  aggregateFileSize integer
  
  Required
  
  The sum of the file sizes, in bytes, of all data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directFolderCount integer
  
  Required
  
  The number of sub-folders that reside as direct children of the given folder.
  
  format = int64
  
  totalInternalFileCount integer
  
  Required
  
  The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directInternalFileCount integer
  
  Required
  
  The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as direct children of the given folder.
  
  format = int64
  
  totalAppScopedFileCount integer
  
  Required
  
  The number of app-scoped data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directAppScopedFileCount integer
  
  Required
  
  The number of app-scoped data files that reside as direct children of the given folder.
  
  format = int64
  
  aggregateInternalFileSize integer
  
  Required
  
  The sum of the file sizes, in bytes, of all internal data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  aggregateAppScopedFileSize integer
  
  Required
  
  The sum of the file sizes, in bytes, of all app-scoped data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
- modifiedDate string
  
  The date that the updated file or folder was last modified.
  
  format = "date-time"
- contentUpdatedDate string
  
  If the data file's content was updated, this is the DateTime of the last content update.
  
  format = "date-time"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

404

A data file with the specified ID was not found.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataFiles.getDataFile(
  'ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc',
)

qlik data-file get 'ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-files/{id}" \
-H "Authorization: Bearer <access_token>"

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"
}

Facts

Rate limit

Special (800 requests per minute)

Path Parameters

id string

Required

The ID of the data file to update.

format = "uuid"

Request Body

multipart/form-data object
Show multipart/form-data properties
- File string
  
  IFormFile form multipart/form-data
  
  format = "binary"
- Json object
  
  See PutDataFileRequest schema which defines request structure. See PutDataFileRequest model.
  
  Show Json properties
  
  name string
  
  Name that will be given to the file or folder. If this name is different than the name used when the file or folder was last POSTed or PUT, this will result in a rename of the file or folder. It should be noted that the '/' character in a data file name indicates a 'path' separator in a logical folder hierarchy for the name. Names that contain '/'s should be used with the assumption that a logical 'folder hierarchy' is being defined for the full pathname of that file or folder.. '/' is a significant character in the data file or folder name.
  
  pattern = "^[^<>":\u0000|?*]+$"
  
  appId string
  
  If this file should be bound to the lifecycle of a specific app, this is the ID of this app. If this request is creating a folder, the specification of an app ID is not allowed.
  
  folderId string
  
  If the specified file or folder should be created as a sub-item of an existing folder, this is the ID of this parent folder. Any additional folder path that is present on the Name property will be created as a subfolder hierarchy of this folder. If the FolderID is null, the file or folder specified in the Name property (including any folder prefix on that name), will be created in the root of the space.
  
  format = "uuid"
  
  sourceId string
  
  If a SourceId is specified, this is the ID of the existing data file or folder whose content should be copied into the specified data file or folder. That is, for a file instead of the file content being specified in the Data element, it is effectively copied from an existing, previously uploaded file. For a folder, it's contents are copied from an existing, previously created folder. If there it existing content in the target folder, then how the source and target folder contents are merged together is specified in the FolderMergeBehavior option.
  
  format = "uuid"
  
  connectionId string
  
  If present, this is the DataFiles connection points to the space that the file or folder should reside in. If absent, the default is that the file or folder will reside in the Personal SPce. If the DataFiles connection is different from the one specified when the file or folder was last POSTed or PUT, this will result in a logical move of this file or folder into the new space.
  
  format = "uuid"
  
  tempContentFileId string
  
  If a TempContentFileId is specified, this is the ID of a previously uploaded temporary content file whose content should be copied into the specified data file. That is, instead of the file content being specified in the Data element, it is effectively copied from an existing, previously uploaded file. The expectation is that this file was previously uploaded to the temporary content service, and the ID specified here is the one returned from the temp content upload request.
  
  folderMergeBehavior string
  
  If a SourceId is specified, and a folder is being updated by this PUT operation, this specifies how the source folder contents should be applied to the target folder, if the target folder is not empty. 'merge' implies the contents of the source folder should be merged with the existing target contents. That is, all existing direct or indirect child items in the target folder are replaced by the same items in the source folder. All existing items in the target folder that are not present in the source folder are left, as is, in the target. 'replace' implies the contents of the source folder should replace the contents of the target folder. That is, all direct or indirect items in the target folder are removed before the items from the source folder are copied over. The resulting target folder only contains the items from the source folder. If not specified, the default behavior is 'merge'.
  Members:
  
  Can be one of: "merge""replace"

Responses

201

The file or folder was updated.

application/json object
Show application/json properties
- id string
  
  Required
  
  The ID for the file or folder.
  
  format = "uuid"
- qri string
  
  The QRI generated from the datafile or folder's metadata.
- name string
  
  Required
  
  The full name of the file or folder, including any folder path prefix.
- size integer
  
  Required
  
  The size of the uploaded file, in bytes. 0 if this item represents a folder
  
  format = int64
- appId string
  
  If this file or folder is bound to the lifecycle of a specific app, this is the ID of this app.
- folder boolean
  
  Whether or not this given item represents a folder or a file.
- actions array of strings
  
  Required
  
  The CRUD actions that are allowed on the given data file.
  
  Values may be any of: "read""update""delete""list""change_owner""change_space"
- ownerId string
  
  Required
  
  The 'owner' of a file or folder is the user who last uploaded the item's content.
- spaceId string
  
  If the file or folder was created in a team space, this is the ID of that space.
- baseName string
  
  The name of the file or folder, not including any folder path prefix.
- folderId string
  
  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.
  
  format = "uuid"
- folderPath string
  
  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.
- createdDate string
  
  Required
  
  The date that the file or folder was created.
  
  format = "date-time"
- folderStats object
  
  Required
  
  Show folderStats properties
  
  totalFileCount integer
  
  Required
  
  The number of data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directFileCount integer
  
  Required
  
  The number of data files that reside as direct children of the given folder.
  
  format = int64
  
  totalFolderCount integer
  
  Required
  
  The number of folders that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  aggregateFileSize integer
  
  Required
  
  The sum of the file sizes, in bytes, of all data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directFolderCount integer
  
  Required
  
  The number of sub-folders that reside as direct children of the given folder.
  
  format = int64
  
  totalInternalFileCount integer
  
  Required
  
  The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directInternalFileCount integer
  
  Required
  
  The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as direct children of the given folder.
  
  format = int64
  
  totalAppScopedFileCount integer
  
  Required
  
  The number of app-scoped data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directAppScopedFileCount integer
  
  Required
  
  The number of app-scoped data files that reside as direct children of the given folder.
  
  format = int64
  
  aggregateInternalFileSize integer
  
  Required
  
  The sum of the file sizes, in bytes, of all internal data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  aggregateAppScopedFileSize integer
  
  Required
  
  The sum of the file sizes, in bytes, of all app-scoped data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
- modifiedDate string
  
  The date that the updated file or folder was last modified.
  
  format = "date-time"
- contentUpdatedDate string
  
  If the data file's content was updated, this is the DateTime of the last content update.
  
  format = "date-time"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

404

A data file or folder with the specified ID was not found.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

409

If the file or folder was renamed during the update, a file or folder with the new name already exists. Also, if the space that the file or folder resides in was changed as part of the update, a file or folder with the same name already resides in the new space.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

413

The file exceeds the user's quota for maximum file size to upload.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

423

The file is already locked for read or write by another client. If a folder is being updated, then if any file or folder in the subfolder hierarchy of this folder is already locked for write.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataFiles.reuploadDataFile(
  'ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc',
  {
    File: 'string',
    Json: {
      appId:
        'f34b91a1-0dc3-44ac-a847-51cb84122c84',
      connectionId:
        'ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc',
      folderId:
        'ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc',
      folderMergeBehavior: 'merge',
      name: 'some/folder/MyFile.csv',
      sourceId:
        'f34b91a1-0dc3-44ac-a847-51cb84122c84',
      tempContentFileId:
        '624b0f54459f1c00018dade4',
    },
  },
)

qlik data-file update 'ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-files/{id}" \
-X PUT \
-H "Content-type: multipart/form-data" \
-H "Authorization: Bearer <access_token>" \
-F "File=@/path/to/file" \
-F "Json={\"name\":\"some/folder/MyFile.csv\",\"appId\":\"f34b91a1-0dc3-44ac-a847-51cb84122c84\",\"folderId\":\"ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc\",\"sourceId\":\"f34b91a1-0dc3-44ac-a847-51cb84122c84\",\"connectionId\":\"ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc\",\"tempContentFileId\":\"624b0f54459f1c00018dade4\",\"folderMergeBehavior\":\"merge\"}"

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"
}

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

id string

Required

The ID of the data file or folder to delete.

format = "uuid"

Responses

204

The file or folder was deleted.

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

404

A data file or folder with the specified ID was not found.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataFiles.deleteDataFile(
  'ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc',
)

qlik data-file rm 'ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-files/{id}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

This is primarily an admin type of operation. In general, the owner of a data file or folder is implicitly set as part of a create or update operation. For data files or folders that reside in a personal space, changing the owner has the effect of moving the data file to the new owner's personal space. Note that, If a given file or folder is not in the root of a personal space, this operation will not succeed, since the parent folder does not reside in the target owner's personal space. If the owner of a folder in the root of a personal space is changed, the owner of all subfolders and files within those subfolders will also recursively change.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

id string

Required

The ID of the data file or folder whose owner will be updated.

format = "uuid"

Request Body

The request.

application/json object
Show application/json properties
- ownerId string
  
  Required
  
  The ID of the new owner.

Responses

204

The file or folder's owner was changed.

400

An owner with the specified ID does not exist.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

403

The user does not have permission to modify the specified data file or folder, or if the item does not reside in the root of the space.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

404

A data file or folder with the specified ID was not found.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

409

If the file or folder is in a personal space, and the personal space of the new owner already has an item in the space with the same name as the item being moved.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

423

The file or folder is already locked for write by another client. For folders, any write lock on a subfolder or file underneath this folder implies a lock on the folder.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

POST /api/v1/data-files/{id}/actions/change-owner

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataFiles.changeDataFileOwner(
  'ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc',
  { ownerId: 'lDL4DIINndhL_iJkcbqWyJenuwizP-2D' },
)

qlik data-file change-owner 'ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc' \
  --ownerId 'lDL4DIINndhL_iJkcbqWyJenuwizP-2D'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-files/{id}/actions/change-owner" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"ownerId":"lDL4DIINndhL_iJkcbqWyJenuwizP-2D"}'

This is to allow for a separate admin type of operation that is more global in terms of access in cases where admin users may not explicitly have been granted full access to a given space within the declared space-level permissions. If the space ID is set to null, then the datafile or folder will end up residing in the personal space of the user who is the owner of the item. Note that, if a given file or folder is not in the root of a given space, this operation will not succeed, since the parent folder does not reside in the target space. If the space of a folder in the root of the source space is changed, all subfolders and files within those subfolders will also recursively be moved to the new space.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

id string

Required

The ID of the data file or folder whose space will be updated.

format = "uuid"

Request Body

The request.

application/json object
Show application/json properties
- spaceId string
  
  The ID of the space. If null, this data file will be moved to the user's personal space.

Responses

204

The file or folder's space was changed.

400

A space with the specified ID does not exist.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

403

The user does not have permission to modify the specified data file or folder, or if the item does not reside in the root of the space.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

404

A data file or folder with the specified ID was not found.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

409

If there is a file or folder in the target space with the same name as the item being moved.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

423

The file is already locked for write by another client. For folders, any write lock on a subfolder or file underneath this folder implies a lock on the folder.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

POST /api/v1/data-files/{id}/actions/change-space

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataFiles.moveDataFile(
  'ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc',
  { spaceId: '617979737a9f56e49dea2e6e' },
)

qlik data-file change-space 'ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-files/{id}/actions/change-space" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"spaceId":"617979737a9f56e49dea2e6e"}'

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

The batch of IDs for each data file in the batch whose space will be changed along with the space IDs for each change.

application/json object

Specifies the list of data file change space operations in a single batch.
Show application/json properties
- change-space array of objects
  
  Required
  
  The list of data files to delete.
  
  Show change-space properties
  
  id string
  
  Required
  
  The ID of the data file whose space will be changed.
  
  format = "uuid"
  
  spaceId string
  
  The ID of the new space. Passing in a null will result in the data file being moved to the user's personal space.

Responses

207

The result status of the change space operations on each specified data file.

application/json object
Show application/json properties
- data array of objects
  
  Required
  
  List of individual results for the items in the specified batch.
  
  Show data properties
  
  id string
  
  Required
  
  The unique identifier of the file.
  
  format = "uuid"
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.
  
  status integer
  
  Required
  
  The HTTP status code.
  
  format = int32

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

POST /api/v1/data-files/actions/change-space

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataFiles.moveDataFiles({
  'change-space': [
    {
      id: 'ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc',
      spaceId: '617979737a9f56e49dea2e6e',
    },
  ],
})

# qlik-cli has not implemented support for POST /api/v1/data-files/actions/change-space yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-files/actions/change-space" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"change-space":[{"id":"ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc","spaceId":"617979737a9f56e49dea2e6e"}]}'

Example Response

{
  "data": [
    {
      "id": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
      "code": "HTTP-200",
      "title": "Cursor not formatted correctly.",
      "detail": "Invalid encoding of cursor.",
      "status": 400
    }
  ]
}

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

The specification of the batch of data files and folders to delete.

application/json object
Show application/json properties
- delete array of objects
  
  Required
  
  If specified, the explicit list of data files to delete.
  
  Show delete properties
  
  id string
  
  Required
  
  The ID of the data file to delete.
  
  format = "uuid"
- deleteAllBySpace array of objects
  
  If specified, attempt to delete all of the data files from the specified shared spaces.
  
  Show deleteAllBySpace properties
  
  id string
  
  Required
  
  The ID of the space whose data files will be deleted.
  
  minLength = 1
- deleteAllFromPersonalSpace boolean
  
  If specified, attempt to delete all of the datafiles from ther user's personal space.

Responses

207

The result status of the delete operations on each specified data file or folder.

application/json object
Show application/json properties
- data array of objects
  
  Required
  
  List of individual results for the items in the specified batch.
  
  Show data properties
  
  id string
  
  Required
  
  The unique identifier of the file.
  
  format = "uuid"
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.
  
  status integer
  
  Required
  
  The HTTP status code.
  
  format = int32

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

POST /api/v1/data-files/actions/delete

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataFiles.deleteDataFiles({
  delete: [
    {
      id: 'ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc',
    },
  ],
  deleteAllBySpace: [
    { id: '617979737a9f56e49dea2e6e' },
  ],
  deleteAllFromPersonalSpace: true,
})

qlik data-file delete \
  --delete-id '' \
  --deleteAllBySpace-id ''

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-files/actions/delete" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"delete":[{"id":"ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc"}],"deleteAllBySpace":[{"id":"617979737a9f56e49dea2e6e"}],"deleteAllFromPersonalSpace":true}'

Example Response

{
  "data": [
    {
      "id": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
      "code": "HTTP-200",
      "title": "Cursor not formatted correctly.",
      "detail": "Invalid encoding of cursor.",
      "status": 400
    }
  ]
}

The non-filtered list contains a set of hardcoded connections, along with one connection per team space that the given user has access to.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

appId string

If present, get connections with connection strings that are scoped to the given app ID.
includeSpaceStats boolean

If set to true, include computed space-level statistics for the spaces represented by the connections in the returned list. If false, this information is not returned.

default = false
limit integer

If present, the maximum number of data file connection records to return.

minimum = 1, maximum = 1000, default = 20, format = int32, default = 20
name string

If present, only return connections with the given name.
page string

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

If true, only return the connections that access data in a personal space. Default is false.

default = false
sort string

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

Can be one of: "spaceId""+spaceId""-spaceId"
spaceId string

If present, only return the connection that accesses data files in the specified space.

Responses

200

Connection list was returned.

application/json object
Show application/json properties
- data array of objects
  
  Required
  
  Properties of the connections to the tenant spaces.
  
  Show data properties
  
  id string
  
  Required
  
  The unique identifier of the connection.
  
  format = "uuid"
  
  name string
  
  Required
  
  The name of the connection.
  
  type string
  
  Required
  
  The type of the connection.
  
  spaceId string
  
  The team space that the given connection is associated with. If null, the connection is not associated with any specific team space.
  
  spaceStats object
  
  Show spaceStats properties
  
  totalFileCount integer
  
  Required
  
  The number of data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directFileCount integer
  
  Required
  
  The number of data files that reside as direct children of the given folder.
  
  format = int64
  
  totalFolderCount integer
  
  Required
  
  The number of folders that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  aggregateFileSize integer
  
  Required
  
  The sum of the file sizes, in bytes, of all data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directFolderCount integer
  
  Required
  
  The number of sub-folders that reside as direct children of the given folder.
  
  format = int64
  
  totalInternalFileCount integer
  
  Required
  
  The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directInternalFileCount integer
  
  Required
  
  The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as direct children of the given folder.
  
  format = int64
  
  totalAppScopedFileCount integer
  
  Required
  
  The number of app-scoped data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directAppScopedFileCount integer
  
  Required
  
  The number of app-scoped data files that reside as direct children of the given folder.
  
  format = int64
  
  aggregateInternalFileSize integer
  
  Required
  
  The sum of the file sizes, in bytes, of all internal data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  aggregateAppScopedFileSize integer
  
  Required
  
  The sum of the file sizes, in bytes, of all app-scoped data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  connectStatement string
  
  Required
  
  The connect statement that will be passed to the connector when invoked.
- links object
  
  Required
  
  Show links properties
  
  next object
  
  Required
  
  Show next properties
  
  href string
  
  The URL for the link.
  
  format = "uri"
  
  prev object
  
  Required
  
  Show prev properties
  
  href string
  
  The URL for the link.
  
  format = "uri"
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  The URL for the link.
  
  format = "uri"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

GET /api/v1/data-files/connections

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataFiles.getDataFilesConnections({})

qlik data-file connection ls

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-files/connections" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
      "name": "DataFiles",
      "type": "qix-datafiles.exe",
      "spaceId": "617979737a9f56e49dea2e6e",
      "spaceStats": {
        "totalFileCount": 50,
        "directFileCount": 50,
        "totalFolderCount": 50,
        "aggregateFileSize": 10000,
        "directFolderCount": 50,
        "totalInternalFileCount": 50,
        "directInternalFileCount": 50,
        "totalAppScopedFileCount": 50,
        "directAppScopedFileCount": 50,
        "aggregateInternalFileSize": 10000,
        "aggregateAppScopedFileSize": 10000
      },
      "connectStatement": "CUSTOM CONNECT TO \\\"provider=qix-datafiles.exe;path=mydatafiles;\\\""
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

id string

Required

The ID of the connection.

format = "uuid"

Responses

200

The connection was returned.

application/json object
Show application/json properties
- id string
  
  Required
  
  The unique identifier of the connection.
  
  format = "uuid"
- name string
  
  Required
  
  The name of the connection.
- type string
  
  Required
  
  The type of the connection.
- spaceId string
  
  The team space that the given connection is associated with. If null, the connection is not associated with any specific team space.
- spaceStats object
  
  Show spaceStats properties
  
  totalFileCount integer
  
  Required
  
  The number of data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directFileCount integer
  
  Required
  
  The number of data files that reside as direct children of the given folder.
  
  format = int64
  
  totalFolderCount integer
  
  Required
  
  The number of folders that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  aggregateFileSize integer
  
  Required
  
  The sum of the file sizes, in bytes, of all data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directFolderCount integer
  
  Required
  
  The number of sub-folders that reside as direct children of the given folder.
  
  format = int64
  
  totalInternalFileCount integer
  
  Required
  
  The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directInternalFileCount integer
  
  Required
  
  The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as direct children of the given folder.
  
  format = int64
  
  totalAppScopedFileCount integer
  
  Required
  
  The number of app-scoped data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  directAppScopedFileCount integer
  
  Required
  
  The number of app-scoped data files that reside as direct children of the given folder.
  
  format = int64
  
  aggregateInternalFileSize integer
  
  Required
  
  The sum of the file sizes, in bytes, of all internal data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
  
  aggregateAppScopedFileSize integer
  
  Required
  
  The sum of the file sizes, in bytes, of all app-scoped data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.
  
  format = int64
- connectStatement string
  
  Required
  
  The connect statement that will be passed to the connector when invoked.

403

The space referenced by the specified connection was not found, or is not accessible to the current user.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

404

A connection with the specified ID was not found.

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

GET /api/v1/data-files/connections/{id}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataFiles.getDataFileConnection(
  'ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc',
)

qlik data-file connection get 'ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-files/connections/{id}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
  "name": "DataFiles",
  "type": "qix-datafiles.exe",
  "spaceId": "617979737a9f56e49dea2e6e",
  "spaceStats": {
    "totalFileCount": 50,
    "directFileCount": 50,
    "totalFolderCount": 50,
    "aggregateFileSize": 10000,
    "directFolderCount": 50,
    "totalInternalFileCount": 50,
    "directInternalFileCount": 50,
    "totalAppScopedFileCount": 50,
    "directAppScopedFileCount": 50,
    "aggregateInternalFileSize": 10000,
    "aggregateAppScopedFileSize": 10000
  },
  "connectStatement": "CUSTOM CONNECT TO \\\"provider=qix-datafiles.exe;path=mydatafiles;\\\""
}

Facts

Rate limit

Tier 1 (1000 requests per minute)

Responses

200

The quota information was retrieved.

application/json object
Show application/json properties
- size integer
  
  Required
  
  The current aggregate size of all files uploaded by a given user. If the current aggregate size is greater than the maximum aggregate size, this is a quota violation.
  
  format = int64
- maxSize integer
  
  Required
  
  The maximum aggregate size of all files uploaded by a given user.
  
  format = int64
- maxFileSize integer
  
  Required
  
  Maximum allowable size of an uploaded file.
  
  format = int64
- maxLargeFileSize integer
  
  Required
  
  Maximum allowable size for a single uploaded large data file (in bytes). This is a file that was indirectly uploaded using the temp content service chunked upload capability.
  
  format = int64
- allowedExtensions array of strings
  
  Required
  
  The allowed file extensions on files that are uploaded.
- allowedInternalExtensions array of strings
  
  Required
  
  The allowed file extensions for files that are only used internally by the system (and thus not typically shown to end users).

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Required
  
  List of errors and their properties.
  
  Show errors properties
  
  code string
  
  Required
  
  Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained error code, the error code is set to the HTTP status code.
  Members:
  DF-001 - The page cursor passed as a parameter to the GET operation is invalid.
  DF-002 - The sort specification passed as a parameter to the GET operation is invalid.
  DF-003 - FolderPath and FolderId are mutually exclusive, they cannot both be passed as parameters.
  DF-004 - The provided FolderPath must be in canonical form.
  DF-005 - The specified parent folder cannot be found.
  DF-006 - The specified owner cannot be found.
  DF-007 - A connection corresponding to the specified space cannot be found.
  DF-008 - THe specified ID must correspond to a folder, not a file.
  DF-009 - The specified space cannot be found.
  DF-010 - The specified file name contains an invalid file extension.
  DF-011 - The specified file name is missing a file extension.
  DF-012 - The specified temporary content file could not be found.
  DF-013 - Access to the specified space is forbidden.
  DF-014 - The specified connection cannot be found.
  DF-015 - The provided filename must be in canonical form.
  DF-016 - The datafile size quota for the given personal space has been exceeded.
  DF-017 - The specified source file or folder could not be found.
  DF-018 - The source and target of a datafile operation must either both be folders or both be files, but they are not.
  DF-019 - The specified target folder is a child of the specified source folder, which is not allowed.
  DF-020 - The specified folder does not exist in the specified space.
  DF-021 - The specified source file or folder is already locked.
  DF-022 - The automatic creation of a missing parent folder failed.
  DF-023 - An attempt to lock a parent folder of a given data file item failed.
  DF-024 - The attempt to copy a source file or folder to a target failed.
  DF-025 - The specified target file or folder is already locked.
  DF-026 - The request results in the creation of a folder hierarchy which is beyond the max allowed folder hierarchy depth.
  
  Can be one of: "HTTP-200""HTTP-201""HTTP-204""HTTP-400""HTTP-403""HTTP-404""HTTP-409""HTTP-413""HTTP-423""HTTP-500""HTTP-501""HTTP-503""DF-001""DF-002""DF-003""DF-004""DF-005""DF-006""DF-007""DF-008""DF-009""DF-010""DF-011""DF-012""DF-013""DF-014""DF-015""DF-016""DF-017""DF-018""DF-019""DF-020""DF-021""DF-022""DF-023""DF-024""DF-025""DF-026"
  
  title string
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to this occurrence of the problem.

GET /api/v1/data-files/quotas

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataFiles.getDataFilesQuotas()

qlik data-file quotas

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-files/quotas" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "size": 5000,
  "maxSize": 9223372036854776000,
  "maxFileSize": 524288000,
  "maxLargeFileSize": 6442450944,
  "allowedExtensions": "csv, xlsx, txt, qvd",
  "allowedInternalExtensions": "dxf, gml, qrep"
}

Data files

Endpoints

Get descriptive info for the specified data files.

Facts

Query Parameters

Responses

200

400

403

Example Response

Upload a new data file or create a new folder.

Facts

Request Body

Responses

201

400

403

409

413

423

501

Example Response

Get descriptive info for the specified data file.

Facts

Path Parameters

Responses

200

400

403

404

Example Response

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

Facts

Path Parameters

Request Body

Responses

201

400

403

404

409

413

423

Example Response

Delete the specified data file or folder. Deleting a folder will also recursively delete all files and subfolders that reside within the specified folder.

Facts

Path Parameters

Responses

204

400

403

404

Change the owner of an existing data file or folder.

Facts

Path Parameters

Request Body

Responses

204

400

403

404

409

423

Change the space that an existing data file or folder resides in.

Facts

Path Parameters

Request Body

Responses

204

400

403

404

409

423

Change the spaces that a set of existing data files or folders reside in a a single batch.

Facts

Request Body

Responses

207

400