Resource Operations

Rulex Factory provides a set of API requests aiming to perform operations on resources.

---

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 more details on how to retrieve IDs.	str
body	connectionInfo	The parameters to connect to the database. It is a different dictionary 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:

{
"status": "completed",
"code": 0,
"data": "979aff9f-a43c-4ea8-8b39-c0457587f93d",
"desc": "",
"status_code": 200,
"topic": "resource/Create/Database/c4ff0035-4a1b-4270-9821-66cc8b8cbf9e"

}

---

Create Filesystem

Description: Creates a new filesystem in the environment, which is identified by 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 more details on how to retrieve IDs.	str
body	connectionInfo	The parameters to connect to the filesystem. It is a different dictionary for each type of filesystem, 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, it 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": "e2aea3b4-04c1-4164-b8dd-df2269da33c1",
  "desc": "",
  "status_code": 200,
  "topic": "resource/Create/Filesystem/c4ff0035-4a1b-4270-9821-66cc8b8cbf9e"
}

---

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:

{
  "status": "completed",
  "code": 0,
  "data": "56c826aa-8066-4a82-b2a3-d965ea42c3bb",
  "desc": "",
  "status_code": 200,
  "topic": "resource/Create/Macro/c4ff0035-4a1b-4270-9821-66cc8b8cbf9e"
}

---

Create Repository

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

POST /resource/create/repository/{envId}

Parameters

Parameters in bold are mandatory.

Location	Name	Description	Type
path	envId	The ID of the environment where the new repository will be created. See Get Resource ID for further details on how to retrieve IDs.	str
body	connectionInfo	The parameters to connect to the repository. Please refer to repository 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:

{
    "status": "completed",
    "code": 0,
    "data": "59e8474f-46cc-4563-9f13-3fae2a786e80",
    "desc": "",
    "status_code": 200,
    "topic": "resource/Create/Repository/c4ff0035-4a1b-4270-9821-66cc8b8cbf9e"
}

---

Create Source

Description: Creates a new general resource 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 repository	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:

{
  "status": "completed",
  "code": 0,
  "data": "0d11afdc-369b-45ca-b17a-8888edc06c7e",
  "desc": "",
  "status_code": 200,
  "topic": "resource/Create/Source/c4ff0035-4a1b-4270-9821-66cc8b8cbf9e"
}

---

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 more details on how to retrieve IDs.	str
body	connectionInfo	The parameters to define the vault. It is a different dictionary 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 vault. 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": "987c549a-9379-4eb7-9904-8776c5d554eb",
  "desc": "",
  "status_code": 200,
  "topic": "resource/Create/Vault/c4ff0035-4a1b-4270-9821-66cc8b8cbf9e"
}

---

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

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

---

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

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

---

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

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

---

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:

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

---

Delete Resources

Description: Deletes the resources of various types identified with the IDs provided in the resDict parameter.

POST /resource/delete/resources

Parameters

Parameters in bold are mandatory.

Location	Name	Description	Type
body	resDict	A JSON dictionary containing as keys one or more of the resource types: database filesystem macro vault repository environment flow and as value another dictionary with id and label list entries. these lists contain IDs and labels of the resources we want to delete for the particular considered resource type. See Get Resource ID for further details on how to retrieve IDs. Note label dictionary entry is only used for Progress communication. It may not match the actual name of the deleted resource. Example request body: { "resDict": { "filesystem" : { "id": ["0d11afdc-369b-45ca-b17a-8888edc06c7e", "ff9ee464-64e7-4a68-bd2c-b3340da9feb3"], "label": ["APIFilesystem", "APISource"] }, "flow" : { "id": ["0d11afdc-3667-45ca-b17a-8867edc06c7e"], "label": ["FlowTest"] } } }	dict

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%"
}

---

Delete Source

Description: Deletes a general resource identified with the ID(s) sourceId.

POST /resource/delete/source

Parameters

Parameters in bold are mandatory.

Location	Name	Description	Type
querystring	sourceIds	The id(s) of the resource(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.
querystring	srctype	The type of the source to be created. Possible sources are: filesystem database macro vault repository	str
body	sourceLabels	The name(s) of the resource(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%"
}

---

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:

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

---

Export Source

Description: Exports one or more resources of type srctype, identified with the IDs srcIds, to a generic filesystem, which can be your local filesystem or a remote one.

POST /resource/export/source

Parameters

Parameters in bold are mandatory.

Location	Name	Description	Type
body	srctype	The single type of the exported resources. It could be one of: database filesystem macro repository vault	list
body	srcIds	The ID(s) of the resource(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	srcLabels	The labels of the resources 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 resources. 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%"
}

---

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:

{
  "status": "completed",
  "code": 0,
  "data": {},
  "desc": "",
  "status_code": 200,
  "topic": "resource/Rename/Database/48770ac5-1bb9-4d93-9c7f-41b904cef395"
}

---

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:

{
  "status": "completed",
  "code": 0,
  "data": {},
  "desc": "",
  "status_code": 200,
  "topic": "resource/Rename/Database/48770ac5-1bb9-4d93-9c7f-41b904cef395"
}

---

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:

{
  "status": "completed",
  "code": 0,
  "data": {},
  "desc": "",
  "status_code": 200,
  "topic": "resource/Rename/Database/f38c841d-98e0-4329-8863-3710dd82ef4e"
}

---

Rename Repository

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

POST /resource/rename/repository/{sourceId}

Parameters

Parameters in bold are mandatory.

Location	Name	Description	Type
path	sourceId	The ID of the repository 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/Repository/72fb12ad-ac40-4bee-9e42-666b70eafda6"
}

---

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:

{
  "status": "completed",
  "code": 0,
  "data": {},
  "desc": "",
  "status_code": 200,
  "topic": "resource/Rename/Vault/34c39c82-5629-4795-b997-72b9f554884e"
}

---

Copy Database

Description: Copy a database from the environment pointed by {envId} to a potentially different environment indicated by {{destenv_Id}}.

POST /resource/copy/database/{envId}

Parameters

Parameters in bold are mandatory.

Location	Name	Description	Type
path	envId	The ID of the source environment where the environment will be taken. See Get Resource ID for further details on how to retrieve IDs.	str
querystring	id	The list of ids of the database to be copied.	list
querystring	label	The list of names of the database affected by the modification occurred.	list
querystring	cut	If yes, the original resource will be erased at the end of the transition.	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)	dict

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%"
}

---

Copy Filesystem

Description: Copy a filesystem from the environment pointed by {envId} to a potentially different environment indicated by {{destenv_Id}}.

POST /resource/copy/filesystem/{envId}

Parameters

Parameters in bold are mandatory.

Location	Name	Description	Type
path	envId	The ID of the source environment where the environment will be taken. See Get Resource ID for further details on how to retrieve IDs.	str
querystring	id	The list of ids of the filesystem to be copied.	list
querystring	label	The list of names of the filesystem affected by the modification occurred.	list
querystring	cut	If yes, the original resource will be erased at the end of the transition.	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)	dict

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%"
}

---

Copy Macro

Description: Copy a macro from the environment pointed by {envId} to a potentially different environment indicated by {{destenv_Id}}.

POST /resource/copy/macro/{envId}

Parameters

Parameters in bold are mandatory.

Location	Name	Description	Type
path	envId	The ID of the source environment where the environment will be taken. See Get Resource ID for further details on how to retrieve IDs.	str
querystring	id	The list of ids of the macro to be copied.	list
querystring	label	The list of names of the macro affected by the modification occurred.	list
querystring	cut	If yes, the original resource will be erased at the end of the transition.	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)	dict

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%"
}

---

Copy Repository

Description: Copy a repository from the environment pointed by {envId} to a potentially different environment indicated by {{destenv_Id}}.

POST /resource/copy/repository/{envId}

Parameters

Parameters in bold are mandatory.

Location	Name	Description	Type
path	envId	The ID of the source environment where the environment will be taken. See Get Resource ID for further details on how to retrieve IDs.	str
querystring	id	The list of ids of the repository to be copied.	list
querystring	label	The list of names of the repository affected by the modification occurred.	list
querystring	cut	If yes, the original resource will be erased at the end of the transition.	str
body	permissionList	The permissions assigned to the new repository. 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

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%"
}

---

Copy Resources

Description: Copy the resources of various types identified with the IDs provided in the resDict parameter.

POST /resource/copy/resources

Parameters

Parameters in bold are mandatory.

Location	Name	Description	Type
body	resDict	A JSON dictionary containing as keys one or more of the resource types: database filesystem macro vault repository environment flow and as value another dictionary with id and label list entries. these lists contain IDs and labels of the resources we want to delete for the particular considered resource type. See Get Resource ID for further details on how to retrieve IDs. Note label dictionary entry is only used for Progress communication. It may not match the actual name of the deleted resource. Example request body: { "resDict": { "filesystem" : { "id": ["0d11afdc-369b-45ca-b17a-8888edc06c7e", "ff9ee464-64e7-4a68-bd2c-b3340da9feb3"], "label": ["APIFilesystem", "APISource"] }, "flow" : { "id": ["0d11afdc-3667-45ca-b17a-8867edc06c7e"], "label": ["FlowTest"] } } }	dict

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%"
}

---

Copy Vault

Description: Copy a vault from the environment pointed by {envId} to a potentially different environment indicated by {{destenv_Id}}.

POST /resource/copy/vault/{envId}

Parameters

Parameters in bold are mandatory.

Location	Name	Description	Type
path	envId	The ID of the source environment where the environment will be taken. See Get Resource ID for further details on how to retrieve IDs.	str
querystring	id	The list of ids of the vault to be copied.	list
querystring	label	The list of names of the vault affected by the modification occurred.	list
querystring	cut	If yes, the original resource will be erased at the end of the transition.	str
body	permissionList	The permissions assigned to the new vault. 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

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%"
}

---

List Start Resources

Description: Lists all the resources in the last seen environment for the current user.

GET /resource/list/startresources

Parameters

Parameters in bold are mandatory.

Location	Name	Description	Type
querystring	resourceTypes	The resource types to be considered in the list operation. 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": {
      "resources": {},
      "n_resources": 0,
      "create": true,
      "folder": {
          "id": "55e6e7f4-7bfc-4726-b506-afe61893d701",
          "name": "Env_postman"
      },
      "path": {
          "id": [
              "c8ca121e-91ef-4ad3-8df2-735d5cd08049",
              "60587735-cc2d-4325-ac4e-38c544f966e3"
          ],
          "name": [
              "/",
              "rulex"
          ]
      }
  },
  "desc": "",
  "status_code": 200,
  "topic": "resource/List/StartResources"
}

---

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:

{
  "status": "completed",
  "code": 0,
  "data": {
      "resources": {
          "e919d82d-2e10-4753-ae1b-610190ec873c": {
              "type": "database",
              "name": "APIPostgres",
              "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/Database/d4c60ad0-1a2b-4d29-875f-c56108e1ecd7"
}

---

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:

{
  "status": "completed",
  "code": 0,
  "data": {
      "resources": {},
      "n_resources": 0,
      "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/Filesystem/d4c60ad0-1a2b-4d29-875f-c56108e1ecd7"
}

---

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:

{
  "status": "completed",
  "code": 0,
  "data": {
      "resources": {
          "f38c841d-98e0-4329-8863-3710dd82ef4e": {
              "type": "macro",
              "name": "APIMacro_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/Macro/d4c60ad0-1a2b-4d29-875f-c56108e1ecd7"
}

---

List Repository

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

GET /resource/list/repository/{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:

{
  "status": "completed",
  "code": 0,
  "data": {
      "resources": {
          "72fb12ad-ac40-4bee-9e42-666b70eafda6": {
              "type": "repository",
              "name": "APIRepository_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/Repository/d4c60ad0-1a2b-4d29-875f-c56108e1ecd7"
}

---

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:

{
  "status": "completed",
  "code": 0,
  "data": {
      "resources": {
          "34c39c82-5629-4795-b997-72b9f554884e": {
              "type": "vault",
              "name": "APIVault_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/Vault/d4c60ad0-1a2b-4d29-875f-c56108e1ecd7"
}

---

Execute Macro

Description: Execute the macro identified with the ID macroId.

POST /resource/execute/macro/{macroId}

Parameters

Parameters in bold are mandatory.

Location	Name	Description	Type
path	macroId	The id of the macro you want to execute. See Get Resource ID for further details on how to retrieve the ID.	str

Response

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

{
}