Export Flow

Exports one or more flows, identified with their <flowIds>, to a generic filesystem, which can be your local filesystem or a remote one.

URI: POST /resource/export/flow

Parameters

Parameters in bold are mandatory

Location

Name

Description

Type

body

flowIds

The ID(s) of the flow(s) to be exported.

Lists must be transformed into a string, by joining the separate elements with commas ",", and wrapping any spaces with quotes. For example:

  • ["a", "b", "c"] --> "a,b,c"

  • ["first element", "second element", "third_element"] --> "'first element','second element',third_element"

See Get Resource ID for further details on how to retrieve IDs.

str, or list for multiple flows.

body

params

The export parameters of the flows. Depending on the URI, the other parameters vary.

  • “URI”: the source type. The possible sources are:

    • “local”: default value, it is the Local FileSystem.

    • “http”: remote connection.

    • “sharepoint”: remote connection.

    • “hdfs”: remote connection.

    • “s3”: remote connection.

    • “ftp”: remote connection.

    • “sharedrive”: remote connection.

For ShareDrive, you need to specify the following parameters:

  • “sdurl”: ShareDrive login url.

  • “sdport”: ShareDrive port. The default value is 445.

  • “sdusr”: ShareDrive login username.

  • “sdpwd”: ShareDrive login password.

  • “sddomain”: ShareDrive domain.

  • “sdshare”: ShareDrive share.

For HTTP, you need to specify the following parameters:

  • “httpauth”: the authentication scheme supported by the HTTP server API.

  • “httpusr”: HTTP login username.

  • “httppwd”: HTTP login password.

For FTP, you need to specify the following parameters:

  • “ftpurl”: the FTP host server that will be used for data exchange.

  • “ftpport”: the FTP port required for data exchange with the host server.

  • “ftpusr”: FTP login username.

  • “ftppwd”: FTP login password.

  • “ftpurl”: the FTP host server that will be used for data exchange.

  • “ftpport”: the FTP port required for data exchange with the host server. The default value is 21.

For S3, you need to specify the following parameters:

  • “s3bucket”: the AWS storage area.

  • “s3usr”: AWS login username.

  • “s3pwd”: AWS login password.

For SharePoint, you need to specify the following parameters:

  • “spurl”: SharePoint URL, which must have the following structure: https://[domain_or_server]/sites/[web_site].

  • “spusr”: SharePoint login username.

  • “sppwd”: SharePoint login password.

For HDFS, you need to specify the following parameters:

  • “hdfsurl”: the Apache Hadoop URL hdfsurl, which must have the following structure: http://[domain_or_server]:[port] (port usually is 50070).

  • “hdfsport”: the Apache Hadoop port required for data exchange with the host server. The default value is 50070.

  • “hdfsusr”: HDFS login username.

  • “hdfspwd”: HDFS login password.

dict

body

flowLabels

The labels of the flows to be exported.  

See note above if multiple flows are to be exported.

str, or list for multiple names.

body

diz_export

The parameters regarding the export mode. Their value can be True (default value) or False.

The export mode parameters available are:

  • topology: if true, the topology will be exported.

  • data: if true, the data will be exported.

  • doc: if true, the documentation will be exported.

  • graphics: if true, graphics will be exported.

  • events: if true, events will be exported.

  • modules: if true, modules will be exported.

  • var: if true, variables will be exported.

dict

querystring

source_refs

If True, references to saved sources will be exported.

bool

querystring

addsuffix

If True, the date and timestamp will be added to the end of the basename as a suffix.

bool

querystring

addprefix

If True, the date and timestamp will be added to the beginning of the basename as a prefix.

bool

querystring

addtag

If True, the tag name will be added to the end of the basename as a suffix.

bool

querystring

taskList

The list of the tasks to be exported.

See note above if multiple flows are to be exported.

str, or list for multiple tasks.

querystring

newnames

The new names to be assigned to the exported flows.

See note above if multiple flows are to be exported.

str, or list for multiple flows.

To see details on possible response codes, go to API Responses

Search