Save Configuration | RESTful API | Teradata Data Mover - 17.10 - Save Configuration (RESTful API) - Teradata Data Mover

Teradata® Data Mover User Guide

Product
Teradata Data Mover
Release Number
17.10
Release Date
June 2021
Content Type
User Guide
Publication ID
B035-4101-061K
Language
English (United States)

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
JSON Data Type: String
Required: Yes
values
Description: Property values per system
JSON Data Type: JSON Array (valueType Object)
Required: Yes
unit
Description: Unit of the value
JSON Data Type: String
Required: No
description
Description: Additional information
JSON Data Type: String
Required: Yes
systemPairs
Description: System pairs used to force job direction
JSON Data Type: JSON Array (systemPairType Object)
Required: No
groupPools
Description: User group pools
JSON Data Type: JSON Array (userGroupType Object)
Required: No
targetUserPools
Description: Systems for target user pool
JSON Data Type: JSON Array (systemType Object)
Required: No
neverTargetSystems
Description: Systems never used as the target system
JSON Data Type: JSON Array (String)
Required: No
defaultDatabases
Description: Databases used as default target or staging databases at system level
JSON Data Type: JSON Array (systemLevelDatabaseType Object)
Required: No

Response Parameters

messages
Description: Message indicating if the property value was update or remained the same.
JSON Data Type: JSON Array (String)
errors
Description: Error message if property was not saved.
JSON Data Type: JSON Array (String)

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
JSON Data Type: String
Required: Yes
values
Description: Property values per system
JSON Data Type: JSON Array(valueType Object)
Required: Yes
unit
Description: Unit of the value
JSON Data Type: String
Required: No
description
Description: Additional information
JSON Data Type: String
Required: Yes
systemPairs
Description: System pairs used to force job direction
JSON Data Type: JSON Array(systemPairType Object)
Required: No
groupPools
Description: User group pools
JSON Data Type: JSON Array(userGroupType Object)
Required: No
targetUserPools
Description: Systems for target user pool
JSON Data Type: JSON Array(systemType Object)
Required: No
neverTargetSystems
Description: Systems never used as the target system
JSON Data Type: JSON Array(String)
Required: No
defaultDatabases
Description: Databases used as default target or staging databases at system level
JSON Data Type: JSON Array(systemLevelDatabaseType Object)
Required: No

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