system.config.delete
New in 8.3.8
This function is used in Python Scripting.
Description​
Deletes a resource of the specified type.
Client Permission Restrictions​
This scripting function has no Client Permission restrictions.
Syntax​
system.config.delete(*moduleId, typeId, [name], [collection], signature, [force], [actor])
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​
| Type | Parameter | Description |
|---|---|---|
| String | *moduleId | The module ID portion of the resource type identifier. |
| String | *typeId | The type ID portion of the resource type identifier. |
| String | *name | The name of the resource. Required for named resources, but must be omitted for singleton resources. [Optional] |
| String | *collection | The collection containing the resource. If omitted, uses the active definition. [Optional] |
| String | *signature | The hex-encoded signature of the resource. |
| Boolean | *force | If true, deletes the resource even if other resources reference it. If omitted, default is false. [Optional] |
| String | *actor | A string identifying the actor performing the operation. If not specified, an identifier will be automatically generated. [Optional] |
Returns​
Nothing
Scope​
Gateway
Code Examples​
Code Snippet
# This example deletes a specified database connection resource.
# Get the required signature argument from your resource using system.config.getResource()
moduleId = "ignition"
typeId = "database-connection"
name = "coolSQL"
# Use the getResource() function
myResource = system.config.getResource(moduleId=moduleId, typeId=typeId, name=name)
# Declare the resource signature variable
signature = myResource.signature
# Use the delete() function
system.config.delete(moduleId=moduleId, typeId=typeId, name=name, signature=signature)