Function getDataFiles

Parameters

• query: {
      allowInternalFiles?: boolean;
      appId?: string;
      baseNameWildcard?: string;
      connectionId?: string;
      excludeFiles?: boolean;
      excludeSubFolders?: boolean;
      folderId?: string;
      folderPath?: string;
      includeAllSpaces?: boolean;
      includeFolders?: boolean;
      includeFolderStats?: boolean;
      limit?: number;
      name?: string;
      notOwnerId?: string;
      ownerId?: string;
      page?: string;
      sort?: GetDataFileInfosSortField;
  }

  an object with query parameters

  • OptionalallowInternalFiles?: boolean

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

  • OptionalappId?: 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.

  • OptionalbaseNameWildcard?: 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.

  • OptionalconnectionId?: 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.

  • OptionalexcludeFiles?: boolean

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

  • OptionalexcludeSubFolders?: 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.

  • OptionalfolderId?: 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'.

  • OptionalfolderPath?: 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'.

  • OptionalincludeAllSpaces?: 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.

  • OptionalincludeFolders?: boolean

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

  • OptionalincludeFolderStats?: boolean

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

  • Optionallimit?: number

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

  • Optionalname?: string

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

  • OptionalnotOwnerId?: 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).

  • OptionalownerId?: 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.

  • Optionalpage?: string

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

  • Optionalsort?: GetDataFileInfosSortField

    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.
• Optionaloptions: ApiCallOptions