Purpose
The save_configuration RESTful API updates configuration settings, performance settings, table-driven interface of the daemon, and configuration settings for stored procedures.
There are two variations of the save_configuration RESTful API that do the following:
- Update specified property
- Update all properties specified in the request body
The save_configuration RESTful API uses the following URL and method:
Item | Description | ||
---|---|---|---|
URL | /datamover/daemonProperties/propertyName /datamover/daemonProperties |
||
Method | PUT |
Request Parameters (propertyName)
This variation of the save_configuration RESTful API updates the specified property.
- propertyName
- Description: Configuration property name
- values
- Description: Property values per system
- unit
- Description: Unit of the value
- description
- Description: Additional information
- systemPairs
- Description: System pairs used to force job direction
- groupPools
- Description: User group pools
- targetUserPools
- Description: Systems for target user pool
- neverTargetSystems
- Description: Systems never used as the target system
- defaultDatabases
- Description: Databases used as default target or staging databases at system level
Response Parameters
- messages
- Description: Message indicating if the property value was update or remained the same.
- errors
- Description: Error message if property was not saved.
Response Example (propertyName)
{ "error":"The maximum value for property blocked.job.maxAllowedLimit cannot be greater that 25% of the maximum concurrent job limit. " }
save_configuration RESTful API Example (propertyName)
{ "propertyName": "agentCollector.agentHeartbeatWaitMillis", "values": [ { "value": "600000", "system": "ALL" } ], "description": "Purpose: To set the amount of time to wait for an Agent heartbeat before assuming it has gone out of service in milliseconds. Default: 600000" }
Request Parameters (Properties)
This variation of the save_configuration RESTful API updates all properties specified in the request body.
- propertyName
- Description: Configuration property name
- values
- Description: Property values per system
- unit
- Description: Unit of the value
- description
- Description: Additional information
- systemPairs
- Description: System pairs used to force job direction
- groupPools
- Description: User group pools
- targetUserPools
- Description: Systems for target user pool
- neverTargetSystems
- Description: Systems never used as the target system
- defaultDatabases
- Description: Databases used as default target or staging databases at system level
save_configuration RESTful API Example (Properties)
Response Example (Properties)
{ "error":"The maximum value for property blocked.job.maxAllowedLimit cannot be greater that 25% of the maximum concurrent job limit. " }