Environment Operations¶

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

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:

{
  "status": "completed",
  "code": 0,
  "data": {
      "id": "eca9d0f8-21ea-4c7a-8b43-382d1df0f674"
  },
  "desc": "",
  "status_code": 200,
  "topic": "resource/Create/Environment/c4ff0035-4a1b-4270-9821-66cc8b8cbf9e"
}

Import Environment¶

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

POST /resource/import/environment/{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__.	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 .renv file used in the import (considered only in ‘__filesystem__’ or ‘__local__’ origins) “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 or the uri type of a custom connection. <other components>: in case of custom connection, parameters expressed as explained in filesystem configuration section.	dict
querystring	label	The new name of the imported flow.	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)	dict or list
body	license	The license to be passed to Rulex API.	dict
querystring	withprogress	If `true`, progress information will be calculated.	bool

Response

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

{
}

Export Environment¶

Description: Exports one or more environments, identified with the IDs envIds, to a generic filesystem, which can be your local filesystem or a remote one.

POST /resource/export/environment

Parameters

Parameters in bold are mandatory.

Location	Name	Description	Type
body	envIds	The ID(s) of the environments(s) to be exported.	list
body	params	The export parameters of the resources. It contains the key value pairs: source formed as in the Import source case by a key `uri` which could be a path to a saved filesystem resource, `local` for a download export or one of the `uri` types in case of a custom connection. <other components>: in case of custom connection, parameters expressed as explained in filesystem configuration section.	dict
body	envLabels	The labels of the environments to be exported. Used only for progress purposes.	list
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	newnames	The new names to be assigned to the exported environments. 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. This will be reflected on the name of the final .rfl created each.
querystring	onlyElement	If `true`, only exports the elements without the environment itself.	bool

Response

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

  {
    "status": "completed",
    "code": 0,
    "data": {
        "file_url": []
    },
    "desc": "",
    "status_code": 200,
    "progress": "100%"
}

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:

{
  "status": "completed",
  "code": 0,
  "data": {},
  "desc": "",
  "status_code": 200,
  "progress": "100%"
}

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:

{
  "status": "completed",
  "code": 0,
  "data": {},
  "desc": "",
  "status_code": 200,
  "topic": "resource/Rename/Environment/10b2dee9-b282-4cb7-bcd4-e255e6ff1e90"
}

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:

{
  "status": "completed",
  "code": 0,
  "data": {
      "resources": {
          "10b2dee9-b282-4cb7-bcd4-e255e6ff1e90": {
              "type": "environment",
              "name": "AP_Env_new",
              "isversioned": false,
              "islocked": false
          }
      },
      "n_resources": 1,
      "folder": {
          "id": "d4c60ad0-1a2b-4d29-875f-c56108e1ecd7",
          "name": "Env_cm"
      },
      "path": {
          "id": [
              "c8ca121e-91ef-4ad3-8df2-735d5cd08049",
              "60587735-cc2d-4325-ac4e-38c544f966e3"
          ],
          "name": [
              "/",
              "rulex"
          ]
      },
      "create": true
  },
  "desc": "",
  "status_code": 200,
  "topic": "resource/List/Environment/d4c60ad0-1a2b-4d29-875f-c56108e1ecd7"
}

Set Environment Variable¶

Description: Create a new environment variable or update 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 we want to modify. 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 value of the variable. In case of update of existing variable it could be omitted to maintain the previous value.	str, or list for multiple variables.
body	issensitive	A boolean to state if the variable is sensitive or not. In case of update of existing variable it could be omitted to maintain the previous value.	str, or list for multiple variables.

Response

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

{
  "status": "completed",
  "code": 0,
  "data": {},
  "desc": "",
  "status_code": 200,
  "topic": "resource/Set/VarEnv/2a71c414-8e0b-42e6-80ff-49e8dce6c8a5"
}

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.	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:

{
  "status": "completed",
  "code": 0,
  "data": {},
  "desc": "",
  "status_code": 200,
  "topic": "resource/Delete/VarEnv/c4ff0035-4a1b-4270-9821-66cc8b8cbf9e"
}

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:

{
  "status": "completed",
  "code": 0,
  "data": {},
  "desc": "",
  "status_code": 200,
  "topic": "resource/Rename/VarEnv/d4c60ad0-1a2b-4d29-875f-c56108e1ecd7"
}

List Environment Variable¶

Description: List the environment variables contained in the environment 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 variable to be renamed. 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:

{
  "status": "completed",
  "code": 0,
  "data": {
      "code": [
          {
              "name": "testenvvar_new",
              "value": "\"topolino\"",
              "issensitive": 0
          },
          {
              "name": "testenvvar3",
              "value": "\"pippo\"",
              "issensitive": 0
          }
      ],
      "vault": []
  },
  "desc": "",
  "status_code": 200,
  "topic": "resource/List/VarEnv/2a71c414-8e0b-42e6-80ff-49e8dce6c8a5"
}