path

envId

The ID of the environment where the flows will be imported.

To find out more on how to retrieve the ID, see Get Resource ID.

str

querystring

origin

The source where the flow to import is located. Possible values are '__filesystem__', '__local__', '__repo__'.    

str

body  

params

A dictionary describing the parameters of the import. Possible entries are:

• “path”: the path to the .rfl file used in the import (considered only in '__filesystem__' or '__local__' origins)

• “components”: used to select which components of the flow are considered. A dictionary with the following entries:

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

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

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

  • graphics: if true, graphics will be imported.

  • events: if true, events will be imported.

  • modules: if true, modules will be imported.

  • var: if true, variables will be imported.

• “source”: a dictionary formed by the internal information of the source used (considered only in '__filesystem__' case):

  • uri: the path of the Filesystem resource stored in the Rulex Platform working area.

dict  

querystring

incurr  

If True, the flow will be imported in the current flow .

bool

querystring

label      

The new name of the imported flow.

str  

querystring

inmemory  

If True, the flow will be imported in in memory mode (no interaction with the database).  

bool  

body  

permissionList  

The list of the permissions to be assigned to the imported flow. The parameters to specify are:

• “name”: the name of the user or of the group. If “type” is set to "other" this has to be null.

• “type”: the type of entity to which the permissions are assigned. It can be:

  • "user"

  • “group"

  • "other".

• “view”: the view permissions of the specified entity. They can be:

  • "allow"

  • "deny"

  • "unspecified" (default value).

• “modify”: the modify permissions of the specified entity. They can be:

  • "allow"

  • "deny"

  • "unspecified" (default value)

• “create”: the create permissions of the specified entity. They can be:

  • "allow"

  • "deny"

  • "unspecified" (default value)

• “execute”: the execute permissions of the specified entity. They can be:

  • "allow"

  • "deny"

  • "unspecified" (default value)

• “delete”: the delete permissions of the specified entity. They can be:

  • “allow"

  • "deny"

  • "unspecified" (default value)

• “setpermissions”: the set permissions permissions of the specified entity. They can be:

  • “allow"

  • "deny"

  • "unspecified" (default value)

• “sharepermissions”: the share permissions of the specified entity. They can be:

  • “allow"

  • "deny"

  • "unspecified" (default value)

dict, or list for multiple flows

querystring

withprogress  

If True, progress information will be calculated.

bool

querystring

convertmodule

The mode chosen for module conversion.

str