Skip to main content
Version: 8.3

system.config.getResources

New in 8.3.8


This function is used in Python Scripting.

Description​

Returns all resources of the specified type.

Client Permission Restrictions​

This scripting function has no Client Permission restrictions.

Syntax​

system.config.getResources(*moduleId, typeId)

tip

An asterisk indicates that all parameters following it are expecting keywords when the function is being called in your script. This means that, when using an asterisk-marked parameter, both the parameter and argument must be specified. For example, moduleId="ignition".

Parameters​

TypeParameterDescription
StringmoduleIdThe module ID portion of the resource type identifier.
StringtypeIdThe type ID portion of the resource type identifier.

Returns​

List - A List of all the resources of the specified type, as a PyResource.

Scope​

Gateway

Code Examples​

Code Snippet
# This example will return all available database connections on the Gateway and
# print them to a label on the same view.
moduleId = "ignition"
typeId = "database-connection"

allDBConnections = system.config.getResources(moduleId = moduleId, typeId = typeId)

self.getSibling("Label").props.text = str(allDBConnections)