• Public
  • Public/Protected
  • All

This interface defines the options that can be sent into the download data set function




Optional attributes

attributes: ZosFilesAttributes

The path to a .zosattributes file used to control file conversion and tagging.

Optional binary

binary: boolean

The indicator to view the data set or USS file in binary mode Has priority over record for datasets If binary and record are both specified, binary is used

Optional directory

directory: string

The local directory to download all members from a pds



Optional encoding

encoding: string

Code page encoding

Optional excludePatterns

excludePatterns: string[]

Exclude data sets that match these DSLEVEL patterns. Any data sets that match this pattern will not be downloaded


"ibmuser.*.jcl, ibmuser.rexa."


Use the List.dataSetsMatchingPattern API to match data sets and exclude patterns

Optional extension

extension: string

The extension you want to use for the file





Optional extensionMap

extensionMap: {}

Map data set names that match your pattern to the desired extension



Type declaration

  • [key: string]: string

Optional failFast

failFast: boolean

Indicates if a download operation for multiple files/data sets should fail as soon as the first failure happens. If set to true, the first failure will throw an error and abort the download operation. If set to false, individual download failures will be reported after all other downloads have completed. The default value is true for backward compatibility.

Optional file

file: string

The local file to download the data set to



Optional includeHidden

includeHidden: boolean

Specifies whether hidden files whose names begin with a dot should be downloaded.

Optional localEncoding

localEncoding: string

The local file encoding to pass as a "Content-Type" header

Optional maxConcurrentRequests

maxConcurrentRequests: number

The maximum REST requests to perform at once Increasing this value results in faster downloads but increases resource consumption on z/OS and risks encountering an error caused by making too many requests at once. Default: 1

Optional overwrite

overwrite: boolean

Specifies whether local files should be overwritten when downloaded.

Optional preserveOriginalLetterCase

preserveOriginalLetterCase: boolean

Indicates if the created directories and files use the original letter case, which is for data sets always uppercase. The default value is false for backward compability. If the option "directory" or "file" is provided, this option doesn't have any effect. This option has only effect on automatically generated directories and files.

Optional record

record: boolean

The indicator to view the data set in record mode Should not be specified for USS files If binary and record are both specified, binary is used

Optional responseTimeout

responseTimeout: number

The maximum amount of time for the TSO servlet to wait for a response before returning an error

Optional returnEtag

returnEtag: boolean

The indicator to force return of ETag. If set to 'true' it forces the response to include an "ETag" header, regardless of the size of the response data. If it is not present, the the default is to only send an Etag for data sets smaller than a system determined length, which is at least 8MB.

Optional task

Task status object used by CLI handlers to create progress bars Optional

Optional volume

volume: string

The volume on which the data set is stored

Generated using TypeDoc