REST API Reference Manual#

Here you can find the whole list of exposed REST API calls.

Warning

REST API service is exposed only in Rulex Platform Cloud version.

In Standalone version please use the Rulex Platform Command Line Interface.

Using the general approach is possible to map all this API calls in a command line arguments.

Auth Token#

Description: Provides the access bearer token.

POST /auth/token

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

body

auth_type

The authentication type used for obtaining the token. It can be ‘client-secret’ or ‘client-jwt’.

str

body

clientId

The client ID of the REST API user to perform authentication.

str

body

clientSecret

The REST API user’s client secret. It is mandatory if the auth_type is ‘client-secret’.

str

body

signedJWT

The REST API user’s signed JWT. It is mandatory if the auth_type is client-jwt’.

str

Response

The response schema for this specific request is:

{
  "access_token": "<the_access_token>",
  "expires_in": 7200,
  "refresh_expires_in": 7200,
  "refresh_token": "<the_refresh_token>",
  "token_type": "Bearer",
  "not-before-policy": 0,
  "session_state": "f39d6818-5c83-4cc5-92b5-6982112cac8c",
  "scope": "email profile"
}

Compute Flow#

Description: Computes a flow, which is identified with the {rflId}.

POST /compute/compute/flow/{rflId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

querystring

mode
The computation mode, which can be:

  • “flow”, to compute the whole flow;

  • “upto”, to compute upstream of the selected tasks;

  • “onwards”, to compute downstream the selected tasks;

  • “selected” to compute only the selected tasks.

str

querystring

onetime

Perform a one-time computation starting from a rfl file or a flow version on a repository. It can be true or false (default).

Imported file is automatically disambiguated from the other flows on the working area to permit infinite parallel computation of the same flow.

Flow at the end can be deleted according to an ad-hoc compute params entry.

bool

path

rflId

The ID of the flow. See Get Resource ID for further details on how to retrieve IDs.

str

body

taskList

The list of the tasks to be computed.

str, or list for multiple tasks.

body

compute_params
The computation parameters for the chosen flow, which can be:

  • “inmemory”: in which case: * 0 for a standard full computation (default) * 1 for a complete in memory computation * 2 for an in memory source saving computation

  • “procvar”: it contains a key/value dict with the list of process variables we want to overwrite for the current run. The values passed are not persistent.

  • “nparallel”: the maximum number of task which can be computed at the same time.

  • “failpolicy”: the policy to use if the computation fails; it can be “stopprocess”, “stopneighbours”, “continue”.

  • “prioritypolicy”: the policy to use to calculate the priorities; it can be “parentfirst” or “priorityfirst”.

  • “failpolicymacro”: the policy to use if the macro fails; it can be “continue”, “stopmacro”.

  • “floatprec”: the digit precision for real number operations.

  • “cache_vault_var”: if true the vault variables’ values are cached.

  • “suppress_alert”: if true alerts are not used in computation.

  • “deleteFlow”: in which case: * 0 is the default flow is not cancelled at the end of the computation * 1 flow is cancelled only in case of successful run * 2 flow is cancelled in any case

dict

body

import_params

The import information used in case of one-time computation (ignored in all other cases). Dictionary composed by:

  • “flowPath”: the internal path on the working area of Rulex Platform where to import the flow. The path is intended as environment path and base flow name. Suffix is automatically added to prevent name conflicts between parallel computations.

  • “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

Note

The syntax for the procvar parameter is the GOLD syntax, with specific rules whether the variable is ordinal or a string:

  • For all the variables: the @ symbol is not required before them, the variable is written in json format.

  • For ordinal variables: numbers must be included into ". e.g. {"var1":"2"}

  • For nominal variables: the string must be included into “, and it must be further included in ". e.g. {"var2":"\"string\""}

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Create Database#

Description: Creates a new database inside the environment identified by {envId}.

POST /resource/create/database/{envId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

envId

The ID of the environment where the new environment will be created. See Get Resource ID for further details on how to retrieve IDs.

str

body

connectionInfo

The parameters to connect to the database. It is a dictionary different for each type of database, please refer to database definition for key/value representation.

dict

querystring

label

The name of the new database.

str

body

permissionList

The permissions assigned to the new database. The parameters to specify are:

  • “name”: the name of the user or the group. If type entry 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 one of these values: “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 setpermissions permissions of the specified entity. They can be: “allow”, “deny”, “unspecified” (default value)

  • “share”: the share permissions of the specified entity. They can be: “allow”, “deny”, “unspecified” (default value)

list

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Create Environment#

Description: Creates a new environment inside the environment identified by {envId}.

POST /resource/create/environment/{envId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

envId

The ID of the environment where the new environment will be created. See Get Resource ID for further details on how to retrieve IDs.

str

querystring

label

The name of the new environment

str

body

permissionList

The permissions assigned to the new environment. The parameters to specify are:

  • “name”: the name of the user or the group. If type entry 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 one of these values: “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 setpermissions permissions of the specified entity. They can be: “allow”, “deny”, “unspecified” (default value)

  • “share”: the share permissions of the specified entity. They can be: “allow”, “deny”, “unspecified” (default value)

list

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Create Filesystem#

Description: Creates a new filesystem in the environment, which is identified with the ID {envId}.

POST /resource/create/filesystem/{envId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

envId

The ID of the environment where the new filesystem will be created.
See Get Resource ID for further details on how to retrieve IDs.

str

body

connectionInfo

The parameters to connect to the filesystem. It is a dictionary different for each type of filesystem, please refer to filesystem definition for key/value representation.

dict

querystring

label

The name of the new filesystem.

str

body

permissionList

The permissions assigned to the new filesystem. The parameters to specify are:

  • “name”: the name of the user or the group. If type entry 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 one of these values: “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 setpermissions permissions of the specified entity. They can be: “allow”, “deny”, “unspecified” (default value)

  • “share”: the share permissions of the specified entity. They can be: “allow”, “deny”, “unspecified” (default value)

list

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Create Flow#

Description: Creates a flow in the environment. The environment is identified by the {envId}.

POST /resource/create/flow/{envId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

envId

The ID of the environment where the flow will be created.
See Get Resource ID for further details on how to retrieve IDs.

str

querystring

label

The name of the flow to be created.

str

body

permissionList

The permissions assigned to the new flow. The parameters to specify are:

  • “name”: the name of the user or the group. If type entry 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 one of these values: “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 setpermissions permissions of the specified entity. They can be: “allow”, “deny”, “unspecified” (default value)

  • “share”: the share permissions of the specified entity. They can be: “allow”, “deny”, “unspecified” (default value)

list

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Create Macro#

Description: Creates a macro in the environment. The environment is identified by the {envId}.

POST /resource/create/macro/{envId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

envId

The ID of the environment where the new macro will be created. See Get Resource ID for further details on how to retrieve IDs.

str

body

connectionInfo

The parameters to define the macro. Please refer to macro definition for key/value representation.

dict

querystring

label

The name of the new macro.

str

body

permissionList

The permissions assigned to the new macro. The parameters to specify are:

  • “name”: the name of the user or the group. If type entry 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 one of these values: “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 setpermissions permissions of the specified entity. They can be: “allow”, “deny”, “unspecified” (default value)

  • “share”: the share permissions of the specified entity. They can be: “allow”, “deny”, “unspecified” (default value)

list

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Create Source#

Description: Creates a new source in the environment identified with the ID {envId}.

POST /resource/create/source/{envId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

envId

The ID of the environment where the new source will be created.
See Get Resource ID for further details on how to retrieve IDs.

str

querystring

srctype

The type of the source to be created. Possible sources are:

  • filesystem

  • database

  • macro

  • vault

str

body

connectionInfo

The parameters to define the generic source. Definition of connection representation depends on the srctype value. Please refer to resources definition and pick the correct source type to obtain the correct key/value representation.

dict

querystring

label

The name of the new source.

str

body

permissionList

The permissions assigned to the new source. The parameters to specify are:

  • “name”: the name of the user or the group. If type entry 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 one of these values: “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 setpermissions permissions of the specified entity. They can be: “allow”, “deny”, “unspecified” (default value)

  • “share”: the share permissions of the specified entity. They can be: “allow”, “deny”, “unspecified” (default value)

list

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Create Environment Variable#

Description: Creates a new environment variable in the environment identified with the ID {envId}.

POST /resource/create/varenv/{envId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

envId

The ID of the environment where the new source will be created.
See Get Resource ID for further details on how to retrieve IDs.

str

body

varname

The name of the variable.

str

body

vartype

The type of the variable. It can be:

  • code

  • vault

str

body

value

The original value of the variable.

str

body

issensitive

A flag which indicates if the variable contains sensitive data (“1”) or not (“0”).

int

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Create Vault#

Description: Creates a vault in the environment. The environment is identified by the {envId}.

POST /resource/create/vault/{envId}

Parameters

Parameters in bold are mandatory

Location

Name

Description

Type

path

envId

The ID of the environment where the vault will be created.
See Get Resource ID for further details on how to retrieve IDs.

str

body

connectionInfo

The parameters to define the vault. It is a dictionary different for each type of vault, please refer to vault definition for key/value representation.

dict

querystring

label

The name of the new vault.

str

body

permissionList

The permissions assigned to the new database. The parameters to specify are:

  • “name”: the name of the user or the group. If type entry 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 one of these values: “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 setpermissions permissions of the specified entity. They can be: “allow”, “deny”, “unspecified” (default value)

  • “share”: the share permissions of the specified entity. They can be: “allow”, “deny”, “unspecified” (default value)

list

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Delete Database#

Description: Deletes the database(s) identified with the ID(s) sourceIds.

POST resource/delete/database

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

querystring

sourceIds

The Id(s) of the database(s) to delete. See Get Resource ID for further details on how to retrieve IDs.
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”

str, or
list for multiple sources.

body

sourceLabels

The name(s) of the database(s) to delete.
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”

str, or
list for multiple names.

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Delete Environment#

Description: Deletes the environment(s) identified with the ID(s) envIds.

POST /resource/delete/environment

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

querystring

envIds

The id(s) of the environment(s) to delete. See Get Resource ID for further details on how to retrieve IDs.
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”

str, or
list for multiple environments.

body

envLabels

The name(s) of the environment(s) to delete.
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”.

str, or
list for multiple names.

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Delete Filesystem#

Description: Deletes the filesystem(s) identified with the ID(s) sourceId.

POST /resource/delete/filesystem

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

querystring

sourceIds

The id(s) of the filesystem(s) to delete. See Get Resource ID for further details on how to retrieve IDs.
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”

str, or
list for multiple filesystems.

body

sourceLabels

The name(s) of the filesystem(s) to delete.
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”

str, or
list for multiple names.

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Delete Flow#

Description: Deletes the flow(s), identified with the ID(s) flowIds.

POST /resource/delete/flow

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

querystring

flowIds

The id(s) of the flow(s) to delete. See Get Resource ID for further details on how to retrieve IDs.
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”

str, or
list for multiple flows

body

flowLabels

The name(s) of the flow(s) to delete.
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”

str, or
list for multiple names.

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Delete Macro#

Description: Deletes the macro(s) identified with the ID sourceIds.

POST /resource/delete/macro

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

querystring

sourceIds

The id of the macro(s) you want to delete. See Get Resource ID for further details on how to retrieve IDs.
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”

str, or
list for multiple macros.

body

sourceLabels

The name(s) of the macro(s) to delete.
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”

str, or
list for multiple names.

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Delete Repository#

Description: Deletes the repository(s), identified with the ID(s) sourceIds.

POST /resource/delete/repository

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

querystring

sourceIds

The id(s) of the repository to delete. See Get Resource ID for further details on how to retrieve IDs.
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”

str, or
list for multiple repositories.

body

sourceLabels

The name(s) of the repositories to delete.
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”

str, or
list for multiple names.

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Delete Environment Variable#

Description: Deletes one or more environment variables in the environment identified with the ID {envId}.

GET /resource/delete/varenv/{envId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

envId

The id of the environment where you want to delete the environment variable. To find out more on how to retrieve the ID, go to the Get Resource ID page. </p>

str

body

varname

The name of the variables to delete.

str, or
list for multiple variables.

body

vartype

The type of the variables to be deleted.

str, or
list for multiple variables.

querystring

alsocurr

If ‘True’ (default value), it deletes the environment variables from the current environment.
If ‘False’, the environment variables will be deleted in the child environment {envId}.

bool

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Delete Vault#

Description: Deletes the vault(s) identified with the ID(s) sourceIds.

POST /resource/delete/vault

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

querystring

sourceIds

The id(s) of the vault(s) you want to delete. See Get Resource ID for further details on how to retrieve IDs.
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”

str, or
list for multiple sources.

body

sourceLabels

The name(s) of the vault(s) to delete.
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”

str, or
list for multiple names.

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Export Flow#

Description: Exports one or more flows, identified with the IDs {flowIds}, to a generic filesystem, which can be your local filesystem or a remote one.

POST /resource/export/flow

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

body

flowIds

The IDs of the flows to be exported.
See Get Resource ID for further details on how to retrieve IDs.
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”

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.
    </li>
    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.
    </li>
    For HHTP, 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.
    </li>
    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 passowrd.
    • *"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.
    </li>
     For S3, you need to specify the following parameters:
    • *"s3bucket"*: the AWS storage area.
    • *"s3usr"*: AWS login username.
    • *"s3pwd"*: AWS login password.
    </li>
     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.
    </li> 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.
    • *"hdfspsd"*: HDFS login password.
    </li>

dict

body

flowLabels

The labels of the flows 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”

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, reference 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 start 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.
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”

str, or
list for multiple names.

querystring

newnames

The new names to be assigned to the exported flows.
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”

str, or
list for multiple names.

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Get File#

Description: Downloads a file after an export operation performed on a local filesystem. The path parameter {fileId} can be a single ID or the concatenation of multiple IDs, separated by a ‘/’. The ID is returned by the previous export operation. See Export Flow for details.

GET /get/file/{fileId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

fileId

The id of the filesystem where you want to save the file. See Get Resource ID for further details on how to retrieve IDs.

str

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Get Resource id#

Description: Returns the ID of the resource identified with the path {resourcePath} and the type {resourceType}.

GET /resource/get/ResourceId

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

querystring

resourcePath

The path of the resource.

str

querystring

resourceType

The type of the source whose ID will be retrieved.

str

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Get Result#

Description: Gets the result of the request identified with the ID {reqId}.

Warning

The results of the request will be kept for two days, after which they will be deleted.

GET /get/result/{reqId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

reqId

The id of the request. See API Structure for further details on how to set or retrieve API unique request ID.

str

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Import Flow#

Description: Imports one or more flows from a specified origin, placing them in the environment identified with the ID {envId}.

POST /resource/import/flow/{envId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

querystring

origin

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

str

path

envId

The ID of the environment where the flows will be imported. See Get Resource ID for further details on how to retrieve IDs.

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 memory mode (no interaction with the database)

bool

body

permissionList

The permissions assigned to the new database. The parameters to specify are:

  • “name”: the name of the user or the group. If type entry 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 one of these values: “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 setpermissions permissions of the specified entity. They can be: “allow”, “deny”, “unspecified” (default value)

  • “share”: the share permissions of the specified entity. They can be: “allow”, “deny”, “unspecified” (default value)

dict or list

querystring

withprogress

If True, progress information will be calculated.

bool

querystring

convertmodule

The mode chosen for module conversion.

str

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

List Database#

Description: Lists the databases in the parent environment identified with the ID {envId}.

GET /resource/list/database/{envId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

envId

The ID of the environment from which you want to retrieve the list of databases. See Get Resource ID for further details on how to retrieve IDs.

str

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

List Environment#

Description: Lists the environments contained in the parent environment identified with the ID {envId}.

GET /resource/list/environment/{envId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

envId

The ID of the parent environment from which you want to retrieve the list of environments. See Get Resource ID for further details on how to retrieve IDs.

str

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

List Filesystem#

Description: Lists the filesystem(s) contained in the parent environment, which is identified with the ID {envId}.

GET /resource/list/filesystem/{envId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

envId

The ID of the parent environment from which you want to retrieve the list of filesystems.
See Get Resource ID for further details on how to retrieve IDs.

str

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

List Flow#

Description: Lists the flows in the parent environment identified with the ID {envId}.

GET /resource/list/flow/{envId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

envId

The ID of the environment from which you want to retrieve the list of flows. See Get Resource ID for further details on how to retrieve IDs.

str

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

List Macro#

Description: Lists the macros in the parent environment identified with the ID {envId}.

GET /resource/list/macro/{envId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

envId

The ID of the environment from which you want to retrieve the list of macros. See Get Resource ID for further details on how to retrieve IDs.

str

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

List Environment Variables#

Description: Lists the environment variables in the parent environment identified with the ID {envId}.

GET /resource/list/varenv/{envId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

envId

The ID of the environment from which you want to retrieve the list of environment variables. See Get Resource ID for further details on how to retrieve IDs.

str

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

List Vault#

Description: Lists the vaults in the parent environment identified with the ID {envId}.

GET /resource/list/vault/{envId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

envId

The ID of the environment from which you want to retrieve the list of vaults. See Get Resource ID for further details on how to retrieve IDs.

str

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Refresh Token#

Description: Refreshes a bearer token.

POST /refresh/token

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

body

token

The token to be refreshed.

str

body

refreshToken

The refresh token, provided in the Auth Token along with the token.

str

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Rename Database#

Description: Renames the database identified with the ID {sourceId}.

POST /resource/rename/database/{sourceId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

sourceId

The ID of the database to be renamed. See Get Resource ID for further details on how to retrieve IDs.

str

querystring

newlabel

The new name for the resource.

str

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Rename Environment#

Description: Renames the environment identified with the ID {envId}.

POST /resource/rename/environment/{envId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

envId

The ID of the environment to be renamed. See Get Resource ID for further details on how to retrieve IDs.

str

querystring

newlabel

The new name for the resource.

str

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Rename Filesystem#

Description: Renames the filesystem identified with the ID {sourceId}.

POST /resource/rename/filesystem/{sourceId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

sourceId

The ID of the filesystem to be renamed. See Get Resource ID for further details on how to retrieve IDs.

str

querystring

newlabel

The new name for the resource.

str

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Rename Flow#

Description: Renames the flow identified with the ID {rflId}.

POST /resource/rename/flow/{rflId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

rflId

The ID of the flow to be renamed. See Get Resource ID for further details on how to retrieve IDs.

str

querystring

newlabel

The new name for the resource.

str

body

isSelected

If True, the renamed flow will be the one in use.

bool

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Rename Macro#

Description: Renames the macro identified with the ID {sourceId}.

POST /resource/rename/macro/{sourceId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

sourceId

The ID of the macro to be renamed. See Get Resource ID for further details on how to retrieve IDs.

str

querystring

newlabel

The new name for the resource.

str

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Rename Environment Variable#

Description: Renames the environment variable identified with the ID {envId},

POST /resource/rename/varenv/{envId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

envId

The ID of the environment variable to be renamed. See Get Resource ID for further details on how to retrieve IDs.

str

body

vartype

The variable type. It can be ‘code’ or ‘vault’.

str

body

oldname

The old name of the variable.

str

body

newname

The new name of the variable.

str

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Rename Vault#

Description: Renames the vault identified with the ID {sourceId}.

POST /resource/rename/vault/{sourceId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

sourceId

The ID of the vault to be renamed. See Get Resource ID for further details on how to retrieve IDs.

str

querystring

newlabel

The new name for the resource.

str

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Set Stop Computation#

Description: Ends the computation of the flow identified with the ID {rflId}.

POST /compute/set/stopcomputation/{rflId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

rflId

The ID of the flow which is computing. See Get Resource ID for further details on how to retrieve IDs.

str

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}

Set Environment Variable#

Description: Updates an existing environment variable in the environment identified with the ID {envId}.

POST /resource/set/varenv/{envId}

Parameters

Parameters in bold are mandatory.

Location

Name

Description

Type

path

envId

The ID of the environment which contains the variable to be updated. See Get Resource ID for further details on how to retrieve IDs.

str

body

varname

The name of the variable.

str, or
list for multiple variables.

body

vartype

The type of the variable. It can be ‘code’ or ‘vault’.

str, or
list for multiple variables.

body

value

The new name of the variable.

str, or
list for multiple variables.

body

issensitive

A flag to indicate if the variable contains sensitive data (1) or not (0).

int

Response

The response schema for this specific request follows standard exposed in api response section. An example response is:

{
}