openapi: 3.2.0 info: title: data-files Datafiles API version: '' servers: - url: https://{tenant}.{region}.qlikcloud.com variables: region: default: us description: The region the tenant is hosted in tenant: default: your-tenant description: Name of the tenant that will be called tags: - name: datafiles paths: /api/v1/data-files: get: tags: - datafiles summary: Get descriptive info for the specified data files responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetDataFileInfosResponse' description: The file list was retrieved. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Forbidden parameters: - in: query name: allowInternalFiles schema: type: boolean default: false example: false example: false description: If set to false, do not return data files with internal extensions else return all the data files. - in: query name: appId schema: type: - string - 'null' example: f34b91a1-0dc3-44ac-a847-51cb84122c84 example: f34b91a1-0dc3-44ac-a847-51cb84122c84 description: '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.' - in: query name: baseNameWildcard schema: type: - string - 'null' example: '*SomeFileName*' example: '*SomeFileName*' description: '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.' - in: query name: connectionId schema: type: - string - 'null' format: uuid example: ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc example: ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc description: '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.' - in: query name: excludeFiles schema: type: boolean default: false example: false example: false description: If set to true, exclude files in the returned list (IE, only return folders). If false, include files. - in: query name: excludeSubFolders schema: type: boolean default: false example: false example: false description: '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.' - in: query name: folderId schema: type: - string - 'null' format: uuid example: ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc example: ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc description: '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''.' - in: query name: folderPath schema: type: - string - 'null' example: some/folder example: some/folder description: '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''.' - in: query name: includeAllSpaces schema: type: boolean default: false example: false example: false description: '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.' - in: query name: includeFolders schema: type: boolean default: false example: false example: false description: If set to true, include folders in the returned list. If false, only return data files. - in: query name: includeFolderStats schema: type: boolean default: false example: false example: false description: 'If set to true, include computed folder statistics for folders in the returned list. If false, this information is not returned.' - in: query name: limit schema: type: integer format: int32 default: 20 example: 5 maximum: 1000 minimum: 1 example: 5 description: If present, the maximum number of data files to return. - in: query name: name schema: type: - string - 'null' example: MyFile.csv example: MyFile.csv description: Filter the list of files returned to the given file name. - in: query name: notOwnerId schema: type: - string - 'null' example: lDL4DIINndhL_iJkcbqWyJenuwizP-2D example: lDL4DIINndhL_iJkcbqWyJenuwizP-2D description: '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).' - in: query name: ownerId schema: type: - string - 'null' example: lDL4DIINndhL_iJkcbqWyJenuwizP-2D example: lDL4DIINndhL_iJkcbqWyJenuwizP-2D description: '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.' - in: query name: page schema: type: - string - 'null' example: NzlmNzI5NWMtZGJlZC00Y2Y4LThkNDAtMzQ5ZDU3YzNjMzQ1 example: NzlmNzI5NWMtZGJlZC00Y2Y4LThkNDAtMzQ5ZDU3YzNjMzQ1 description: If present, the cursor that starts the page of data that is returned. - in: query name: sort schema: $ref: '#/components/schemas/GetDataFileInfosSortField' description: '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.' x-qlik-stability: stable x-qlik-visibility: public x-qlik-deprecated: false x-qlik-tier: tier: '1' limit: 1000 operationId: getApiV1DataFiles x-operation-id-source: derived post: tags: - datafiles summary: Upload a new data file or create a new folder responses: '201': content: application/json: schema: $ref: '#/components/schemas/DataFileUploadResponse' description: New file or folder was created. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Forbidden '409': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: A file or folder with the same name already exists in the specified user or app scope. '413': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: The file exceeds the user's quota for maximum file size to upload. '423': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: The file is already locked for read or write by another client. '501': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Not Implemented requestBody: content: multipart/form-data: schema: type: object required: - Json.Name properties: File: type: - string - 'null' format: binary description: IFormFile form multipart/form-data Json: type: object required: - name properties: name: type: string example: some/folder/MyFile.csv pattern: ^[^<>":\u0000|?*]+$ description: '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.' appId: type: - string - 'null' example: f34b91a1-0dc3-44ac-a847-51cb84122c84 description: '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: type: boolean default: false description: If true, a folder will be created. If false, a file is created. folderId: type: - string - 'null' format: uuid example: ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc description: '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.' sourceId: type: - string - 'null' format: uuid example: f34b91a1-0dc3-44ac-a847-51cb84122c84 description: '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.' connectionId: type: - string - 'null' format: uuid example: ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc description: '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.' tempContentFileId: type: - string - 'null' example: 624b0f54459f1c00018dade4 description: '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.' description: "See PostDataFileRequest schema which defines request structure.\n See PostDataFileRequest model." additionalProperties: false encoding: File: style: form Json: explode: false contentType: application/json x-qlik-stability: stable x-qlik-visibility: public x-qlik-deprecated: false x-qlik-tier: tier: '2' limit: 100 operationId: postApiV1DataFiles x-operation-id-source: derived /api/v1/data-files/{id}: get: tags: - datafiles summary: Get descriptive info for the specified data file responses: '200': content: application/json: schema: $ref: '#/components/schemas/DataFileUploadResponse' description: The file was located. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: A data file with the specified ID was not found. parameters: - in: path name: id schema: type: string format: uuid example: ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc required: true description: The ID of the data file. x-qlik-stability: stable x-qlik-visibility: public x-qlik-deprecated: false x-qlik-tier: tier: '1' limit: 1000 operationId: getApiV1DataFilesById x-operation-id-source: derived put: tags: - datafiles summary: Re-upload an existing data file or update an existing folder responses: '201': content: application/json: schema: $ref: '#/components/schemas/DataFileUploadResponse' description: The file or folder was updated. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: A data file or folder with the specified ID was not found. '409': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: "If the file or folder was renamed during the update, a file or folder with the new name\n already exists. Also, if the space that the file or folder resides in was changed as part of the update,\n a file or folder with the same name already resides in the new space." '413': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: The file exceeds the user's quota for maximum file size to upload. '423': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: "The file is already locked for read or write by another client. If a folder is being\n updated, then if any file or folder in the subfolder hierarchy of this folder is already locked for write." parameters: - in: path name: id schema: type: string format: uuid example: ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc required: true description: The ID of the data file to update. requestBody: content: multipart/form-data: schema: type: object properties: File: type: - string - 'null' format: binary description: IFormFile form multipart/form-data Json: type: object properties: name: type: - string - 'null' example: some/folder/MyFile.csv pattern: ^[^<>":\u0000|?*]+$ description: '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.' appId: type: - string - 'null' example: f34b91a1-0dc3-44ac-a847-51cb84122c84 description: '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: type: - string - 'null' format: uuid example: ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc description: '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.' sourceId: type: - string - 'null' format: uuid example: f34b91a1-0dc3-44ac-a847-51cb84122c84 description: '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.' connectionId: type: - string - 'null' format: uuid example: ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc description: '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.' tempContentFileId: type: - string - 'null' example: 624b0f54459f1c00018dade4 description: '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: $ref: '#/components/schemas/PutDataFileFolderMergeBehavior' description: "See PutDataFileRequest schema which defines request structure.\n See PutDataFileRequest model." additionalProperties: false encoding: File: style: form Json: explode: false contentType: application/json x-qlik-stability: stable x-qlik-visibility: public x-qlik-deprecated: false x-qlik-tier: tier: special limit: 800 operationId: putApiV1DataFilesById x-operation-id-source: derived delete: tags: - datafiles summary: Delete the specified data file or folder. responses: '204': description: The file or folder was deleted. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: A data file or folder with the specified ID was not found. parameters: - in: path name: id schema: type: string format: uuid example: ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc required: true description: The ID of the data file or folder to delete. x-qlik-stability: stable x-qlik-visibility: public x-qlik-deprecated: false x-qlik-tier: tier: '2' limit: 100 operationId: deleteApiV1DataFilesById x-operation-id-source: derived /api/v1/data-files/{id}/actions/change-owner: post: tags: - datafiles summary: Change the owner of an existing data file or folder responses: '204': description: The file or folder's owner was changed. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: An owner with the specified ID does not exist. '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: "The user does not have permission to modify the specified data file or folder, or if the\n item does not reside in the root of the space." '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: A data file or folder with the specified ID was not found. '409': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: "If the file or folder is in a personal space, and the personal space of the new owner\n already has an item in the space with the same name as the item being moved." '423': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: "The file or folder is already locked for write by another client. For folders, any\n write lock on a subfolder or file underneath this folder implies a lock on the folder." parameters: - in: path name: id schema: type: string format: uuid example: ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc required: true description: The ID of the data file or folder whose owner will be updated. description: '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.' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDataFileOwnerRequest' description: The request. x-qlik-stability: stable x-qlik-visibility: public x-qlik-deprecated: false x-qlik-tier: tier: '2' limit: 100 operationId: postApiV1DataFilesByIdActionsChangeOwner x-operation-id-source: derived /api/v1/data-files/{id}/actions/change-space: post: tags: - datafiles summary: Change the space that an existing data file or folder resides in responses: '204': description: The file or folder's space was changed. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: A space with the specified ID does not exist. '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: "The user does not have permission to modify the specified data file or folder, or if the\n item does not reside in the root of the space." '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: A data file or folder with the specified ID was not found. '409': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: "If there is a file or folder in the target space with the same name as the item being\n moved." '423': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: "The file is already locked for write by another client. For folders, any write lock on\n a subfolder or file underneath this folder implies a lock on the folder." parameters: - in: path name: id schema: type: string format: uuid example: ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc required: true description: "The ID of the data file or folder whose\n space will be updated." description: '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.' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDataFileSpaceRequest' description: The request. x-qlik-stability: stable x-qlik-visibility: public x-qlik-deprecated: false x-qlik-tier: tier: '2' limit: 100 operationId: postApiV1DataFilesByIdActionsChangeSpace x-operation-id-source: derived /api/v1/data-files/actions/change-space: post: tags: - datafiles summary: Change the spaces that a set of existing data files or folders reside in a a… responses: '207': content: application/json: schema: $ref: '#/components/schemas/MultiStatusResponse' description: The result status of the change space operations on each specified data file. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request description: '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 data file or folder will end up residing in the personal space of the user who is the owner of the item.' requestBody: content: application/json: schema: $ref: '#/components/schemas/DataFileBatchChangeSpaceRequest' description: "The batch of IDs for each data file in the batch whose space will be changed along with\n the space IDs for each change." x-qlik-stability: stable x-qlik-visibility: public x-qlik-deprecated: false x-qlik-tier: tier: '2' limit: 100 operationId: postApiV1DataFilesActionsChangeSpace x-operation-id-source: derived /api/v1/data-files/actions/delete: post: tags: - datafiles summary: Delete the specified set of data files and/or folders as a single batch responses: '207': content: application/json: schema: $ref: '#/components/schemas/MultiStatusResponse' description: The result status of the delete operations on each specified data file or folder. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request requestBody: content: application/json: schema: $ref: '#/components/schemas/DataFileBatchDeleteRequest' description: The specification of the batch of data files and folders to delete. x-qlik-stability: stable x-qlik-visibility: public x-qlik-deprecated: false x-qlik-tier: tier: '2' limit: 100 operationId: postApiV1DataFilesActionsDelete x-operation-id-source: derived /api/v1/data-files/connections: get: tags: - datafiles summary: Get the list of built-in connections used by the engine to load/write data files responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetConnectionsResponse' description: Connection list was returned. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Forbidden parameters: - in: query name: appId schema: type: - string - 'null' example: f34b91a1-0dc3-44ac-a847-51cb84122c84 example: f34b91a1-0dc3-44ac-a847-51cb84122c84 description: If present, get connections with connection strings that are scoped to the given app ID. - in: query name: includeSpaceStats schema: type: boolean default: false example: false example: false description: '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.' - in: query name: limit schema: type: integer format: int32 default: 20 example: 5 maximum: 1000 minimum: 1 example: 5 description: If present, the maximum number of data file connection records to return. - in: query name: name schema: type: - string - 'null' example: MySenseApp example: MySenseApp description: If present, only return connections with the given name. - in: query name: page schema: type: - string - 'null' example: NzlmNzI5NWMtZGJlZC00Y2Y4LThkNDAtMzQ5ZDU3YzNjMzQ1 example: NzlmNzI5NWMtZGJlZC00Y2Y4LThkNDAtMzQ5ZDU3YzNjMzQ1 description: If present, the cursor that starts the page of data that is returned. - in: query name: personal schema: type: boolean default: false example: true example: true description: If true, only return the connections that access data in a personal space. Default is false. - in: query name: sort schema: $ref: '#/components/schemas/GetConnectionsSortField' description: '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.' - in: query name: spaceId schema: type: - string - 'null' example: 617979737a9f56e49dea2e6e example: 617979737a9f56e49dea2e6e description: If present, only return the connection that accesses data files in the specified space. description: 'The non-filtered list contains a set of hardcoded connections, along with one connection per team space that the given user has access to.' x-qlik-stability: stable x-qlik-visibility: public x-qlik-deprecated: false x-qlik-tier: tier: '1' limit: 1000 operationId: getApiV1DataFilesConnections x-operation-id-source: derived /api/v1/data-files/connections/{id}: get: tags: - datafiles summary: Get the built-in connection used by the engine to load/write data files given a… responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConnectionsResponse' description: The connection was returned. '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: The space referenced by the specified connection was not found, or is not accessible to the current user. '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: A connection with the specified ID was not found. parameters: - in: path name: id schema: type: string format: uuid example: ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc required: true description: The ID of the connection. x-qlik-stability: stable x-qlik-visibility: public x-qlik-deprecated: false x-qlik-tier: tier: '1' limit: 1000 operationId: getApiV1DataFilesConnectionsById x-operation-id-source: derived /api/v1/data-files/quotas: get: tags: - datafiles summary: Get quota information for the calling user responses: '200': content: application/json: schema: $ref: '#/components/schemas/QuotaResponse' description: The quota information was retrieved. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Forbidden x-qlik-stability: stable x-qlik-visibility: public x-qlik-deprecated: false x-qlik-tier: tier: '1' limit: 1000 operationId: getApiV1DataFilesQuotas x-operation-id-source: derived components: schemas: ConnectionsResponse: type: object required: - connectStatement - id - name - type properties: id: type: string format: uuid example: ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc description: The unique identifier of the connection. name: type: string example: DataFiles description: The name of the connection. type: type: string example: qix-datafiles.exe description: The type of the connection. spaceId: type: - string - 'null' example: 617979737a9f56e49dea2e6e description: 'The team space that the given connection is associated with. If null, the connection is not associated with any specific team space.' spaceStats: $ref: '#/components/schemas/SpaceStatsResponse' connectStatement: type: string example: CUSTOM CONNECT TO \"provider=qix-datafiles.exe;path=mydatafiles;\" description: The connect statement that will be passed to the connector when invoked. additionalProperties: false MultiStatusResponse: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/MultiStatusResponseItem' description: List of individual results for the items in the specified batch. additionalProperties: false BatchDeleteAllBySpaceItem: type: object required: - id properties: id: type: string example: 617979737a9f56e49dea2e6e minLength: 1 description: The ID of the space whose data files will be deleted. additionalProperties: false LinksResponse: type: object required: - next - prev - self properties: next: $ref: '#/components/schemas/LinkResponse' prev: $ref: '#/components/schemas/LinkResponse' self: $ref: '#/components/schemas/LinkResponse' additionalProperties: false GetConnectionsResponse: type: object required: - data - links properties: data: type: array items: $ref: '#/components/schemas/ConnectionsResponse' description: Properties of the connections to the tenant spaces. links: $ref: '#/components/schemas/LinksResponse' additionalProperties: false DataFileBatchChangeSpaceRequest: type: object required: - change-space properties: change-space: type: array items: $ref: '#/components/schemas/BatchChangeSpaceItem' description: The list of data files to delete. description: Specifies the list of data file change space operations in a single batch. additionalProperties: false SpaceStatsResponse: type: object required: - aggregateAppScopedFileSize - aggregateFileSize - aggregateInternalFileSize - directAppScopedFileCount - directFileCount - directFolderCount - directInternalFileCount - totalAppScopedFileCount - totalFileCount - totalFolderCount - totalInternalFileCount properties: totalFileCount: type: integer format: int64 example: 50 description: 'The number of data files that reside as direct and indirect children of the given folder and it''s sub-folder hierarchy.' directFileCount: type: integer format: int64 example: 50 description: The number of data files that reside as direct children of the given folder. totalFolderCount: type: integer format: int64 example: 50 description: 'The number of folders that reside as direct and indirect children of the given folder and it''s sub-folder hierarchy.' aggregateFileSize: type: integer format: int64 example: 10000 description: '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.' directFolderCount: type: integer format: int64 example: 50 description: The number of sub-folders that reside as direct children of the given folder. totalInternalFileCount: type: integer format: int64 example: 50 description: '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.' directInternalFileCount: type: integer format: int64 example: 50 description: '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.' totalAppScopedFileCount: type: integer format: int64 example: 50 description: 'The number of app-scoped data files that reside as direct and indirect children of the given folder and it''s sub-folder hierarchy.' directAppScopedFileCount: type: integer format: int64 example: 50 description: The number of app-scoped data files that reside as direct children of the given folder. aggregateInternalFileSize: type: integer format: int64 example: 10000 description: '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.' aggregateAppScopedFileSize: type: integer format: int64 example: 10000 description: '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.' additionalProperties: false FolderStatsResponse: type: object required: - aggregateAppScopedFileSize - aggregateFileSize - aggregateInternalFileSize - directAppScopedFileCount - directFileCount - directFolderCount - directInternalFileCount - totalAppScopedFileCount - totalFileCount - totalFolderCount - totalInternalFileCount properties: totalFileCount: type: integer format: int64 example: 50 description: 'The number of data files that reside as direct and indirect children of the given folder and it''s sub-folder hierarchy.' directFileCount: type: integer format: int64 example: 50 description: The number of data files that reside as direct children of the given folder. totalFolderCount: type: integer format: int64 example: 50 description: 'The number of folders that reside as direct and indirect children of the given folder and it''s sub-folder hierarchy.' aggregateFileSize: type: integer format: int64 example: 10000 description: '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.' directFolderCount: type: integer format: int64 example: 50 description: The number of sub-folders that reside as direct children of the given folder. totalInternalFileCount: type: integer format: int64 example: 50 description: '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.' directInternalFileCount: type: integer format: int64 example: 50 description: '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.' totalAppScopedFileCount: type: integer format: int64 example: 50 description: 'The number of app-scoped data files that reside as direct and indirect children of the given folder and it''s sub-folder hierarchy.' directAppScopedFileCount: type: integer format: int64 example: 50 description: The number of app-scoped data files that reside as direct children of the given folder. aggregateInternalFileSize: type: integer format: int64 example: 10000 description: '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.' aggregateAppScopedFileSize: type: integer format: int64 example: 10000 description: '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.' additionalProperties: false ChangeDataFileSpaceRequest: type: object properties: spaceId: type: - string - 'null' example: 617979737a9f56e49dea2e6e description: The ID of the space. If null, this data file will be moved to the user's personal space. additionalProperties: false DataFileBatchDeleteRequest: type: object required: - delete properties: delete: type: array items: $ref: '#/components/schemas/BatchDeleteItem' description: If specified, the explicit list of data files to delete. deleteAllBySpace: type: - array - 'null' items: $ref: '#/components/schemas/BatchDeleteAllBySpaceItem' description: If specified, attempt to delete all of the data files from the specified shared spaces. deleteAllFromPersonalSpace: type: - boolean - 'null' example: true description: If specified, attempt to delete all of the datafiles from ther user's personal space. additionalProperties: false QuotaResponse: type: object required: - allowedExtensions - allowedInternalExtensions - maxFileSize - maxLargeFileSize - maxSize - size properties: size: type: integer format: int64 example: 5000 description: '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.' maxSize: type: integer format: int64 example: 9223372036854776000 description: The maximum aggregate size of all files uploaded by a given user. maxFileSize: type: integer format: int64 example: 524288000 description: Maximum allowable size of an uploaded file. maxLargeFileSize: type: integer format: int64 example: 6442450944 description: '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.' allowedExtensions: type: array items: type: string example: csv, xlsx, txt, qvd description: The allowed file extensions on files that are uploaded. example: csv, xlsx, txt, qvd description: The allowed file extensions on files that are uploaded. allowedInternalExtensions: type: array items: type: string example: dxf, gml, qrep description: 'The allowed file extensions for files that are only used internally by the system (and thus not typically shown to end users).' example: dxf, gml, qrep description: 'The allowed file extensions for files that are only used internally by the system (and thus not typically shown to end users).' additionalProperties: false ErrorResponseItem: type: object required: - code properties: code: $ref: '#/components/schemas/ErrorCode' title: type: - string - 'null' example: Cursor not formatted correctly. description: Summary of the problem. detail: type: - string - 'null' example: Invalid encoding of cursor. description: A human-readable explanation specific to this occurrence of the problem. additionalProperties: false GetDataFileInfosSortField: enum: - name - +name - -name - size - +size - -size - modifiedDate - +modifiedDate - -modifiedDate - folder - +folder - -folder - baseName - +baseName - -baseName type: string example: name description:

Members:

GetConnectionsSortField: enum: - spaceId - +spaceId - -spaceId type: string example: spaceId description:

Members:

PutDataFileFolderMergeBehavior: enum: - merge - replace type: string example: merge description: '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:

' BatchDeleteItem: type: object required: - id properties: id: type: string format: uuid example: ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc description: The ID of the data file to delete. additionalProperties: false MultiStatusResponseItem: type: object required: - code - id - status properties: id: type: string format: uuid example: ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc description: The unique identifier of the file. code: $ref: '#/components/schemas/ErrorCode' title: type: - string - 'null' example: Cursor not formatted correctly. description: Summary of the problem. detail: type: - string - 'null' example: Invalid encoding of cursor. description: A human-readable explanation specific to this occurrence of the problem. status: type: integer format: int32 example: 400 description: The HTTP status code. additionalProperties: false ErrorResponse: type: object required: - errors properties: errors: type: array items: $ref: '#/components/schemas/ErrorResponseItem' description: List of errors and their properties. additionalProperties: false LinkResponse: type: object properties: href: type: - string - 'null' format: uri description: The URL for the link. additionalProperties: false DataFileUploadResponse: type: object required: - actions - createdDate - folderStats - id - name - ownerId - size properties: id: type: string format: uuid example: ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc description: The ID for the file or folder. qri: type: - string - 'null' example: qri:qdf:space://ooSOGoLLaq7EMaSdSsCiGvLwcd_VAf1oU0mzwSfp_Qs#wME89c8gKu_Tpz8W_a0JKSbKC4hzbNu0NLVgqi2UFS0 description: The QRI generated from the datafile or folder's metadata. name: type: string example: some/folder/MyFile.csv description: The full name of the file or folder, including any folder path prefix. size: type: integer format: int64 example: 1024 description: The size of the uploaded file, in bytes. 0 if this item represents a folder appId: type: - string - 'null' example: f34b91a1-0dc3-44ac-a847-51cb84122c84 description: If this file or folder is bound to the lifecycle of a specific app, this is the ID of this app. folder: type: boolean example: true description: Whether or not this given item represents a folder or a file. actions: type: array items: $ref: '#/components/schemas/DataFilePermission' description: The CRUD actions that are allowed on the given data file. ownerId: type: string example: lDL4DIINndhL_iJkcbqWyJenuwizP-2D description: The 'owner' of a file or folder is the user who last uploaded the item's content. spaceId: type: - string - 'null' example: 617979737a9f56e49dea2e6e description: If the file or folder was created in a team space, this is the ID of that space. baseName: type: - string - 'null' example: MyFile.csv description: The name of the file or folder, not including any folder path prefix. folderId: type: - string - 'null' format: uuid example: ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc description: '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.' folderPath: type: - string - 'null' example: some/folder description: '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: type: string format: date-time example: '2020-07-07T20:52:40.8534780Z' description: The date that the file or folder was created. folderStats: $ref: '#/components/schemas/FolderStatsResponse' modifiedDate: type: - string - 'null' format: date-time example: '2020-07-07T20:52:40.8534780Z' description: The date that the updated file or folder was last modified. contentUpdatedDate: type: - string - 'null' format: date-time example: '2020-07-07T20:52:40.8534780Z' description: If the data file's content was updated, this is the DateTime of the last content update. additionalProperties: false DataFilePermission: enum: - read - update - delete - list - change_owner - change_space type: string example: Read description:

Members:

GetDataFileInfosResponse: type: object required: - data - links properties: data: type: array items: $ref: '#/components/schemas/DataFileUploadResponse' description: Properties of the uploaded data files. links: $ref: '#/components/schemas/LinksResponse' additionalProperties: false ChangeDataFileOwnerRequest: type: object required: - ownerId properties: ownerId: type: string example: lDL4DIINndhL_iJkcbqWyJenuwizP-2D description: The ID of the new owner. additionalProperties: false BatchChangeSpaceItem: type: object required: - id properties: id: type: string format: uuid example: ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc description: The ID of the data file whose space will be changed. spaceId: type: - string - 'null' example: 617979737a9f56e49dea2e6e description: 'The ID of the new space. Passing in a null will result in the data file being moved to the user''s personal space.' additionalProperties: false ErrorCode: enum: - 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 type: string example: HTTP-200 description: "Fine-grained error codes for data-files REST operations. For operations which do not have a more fine-grained\nerror code, the error code is set to the HTTP status code.

Members:

"