Configuration Update Configuration Module
Updates the specified configuration module. Expects an _update object containing the field(s) to be updated and their corresponding value(s). For most use cases, configuration module data should be the only module attribute that it is necessary to update. This method does not support partial updates on specific sub-sections of the data object.
Privileges required:
UPDATE ENTERPRISE_PROFILE, or
UPDATE OPERATOR_PROFILE
Request
URI
POST
https://{api_host}/portal/rest/configuration/updateConfigurationModule
COPY
Request Body
{
"id": 0,
"configurationModuleId": 0,
"enterpriseId": 0,
"basic": false,
"_update": {
"created": "string",
"effective": "string",
"modified": "string",
"id": 0,
"name": "string",
"type": "string",
"description": "string",
"configurationId": 0,
"data": {},
"schemaVersion": "string",
"version": "string",
"metadata": {},
"refs": {}
}
}
integer
id
Optional
Alias for configurationModuleId
integer
configurationModuleId
Optional
The id of the target configuration module. This parameter, or its alias id, is required.
integer
enterpriseId
Optional
enterpriseId
boolean
basic
Optional
basic
Responses
200
Request was successfully processed
Returns
configuration_update_configuration_module_result
of type(s)
application/json
This response body class contains all of the following:
Inlineconfiguration_update_configuration_module_result0
"configuration_update_configuration_module_result Object"Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/portal/rest/configuration/updateConfigurationModule