Purpose

Updates a system configuration setting.

URL

https://<myserver>:<port>/api/admin/configurations/{id}

Method

PUT

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.

The URL parameter "id" described in the following table is required.

Property Description Valid Values
"id" The ID of the configurations attribute being returned. 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

1 is the ID for setting the delimiter for an authentication service.

2 is the ID for secureChangePassword.

3 is the ID for setting the default OData version for new data sources.

4 is the ID for setting the default entity name mode for OData V4 data sources.

5 is the ID for enabling or disabling the third-party JDBC data store feature.

6 is the ID for enabling or disabling password policy enforcement.

7 is the ID to configure how the system persists system monitor details.

8 is the ID to configure the IP whitelist filtering feature.

Request Definition


    {
      "value": attribute_value
    }
Property Description Valid Values
"value" The value of the configurations attribute. Valid values vary depending on the attribute.

For an authentication delimiter (1), a string can be specified. It is recommended to set a single character that is not generally used in a service name. (for example, ":" or "|"). By default, the value is null.

For secureChangePassword (2), true is specified to require the user to specify a current password as well as a new password. False is specified to require only a new password.

For default OData version for new data sources (3), 4 is the only valid value.

For default entity mode for OData V4 sources (4), valid values are: GUESS, PLURALIZE, SINGULARIZE and SUFFIX.

For the JDBC data store feature (5), valid values are true and false. When set to true, the JDBC data store feature is enabled.

For password policy (6), valid values are -1, 1, or 2. Setting to -1 disables the enforcement of any password policy. Setting to 1 enforces the default password policy. Setting to 2 enforces the custom password policy.

For system monitor details persistence (7), valid values are 0 - no persistence, 1 - log, 2 - database, 3 - log and database. The default value is 1.

For IP whitelist filtering (8), valid values are true and false. The default value is true.

Sample Request Payload

The following PUT operation sets the external authentication delimiter to the bar symbol (|).

PUT https://MyServer:8443/api/admin/configurations/1

    {
      "value": "|"
    }

Sample Server Failure Response 


{
  "error": {
    "code": 222206007,
    "message": {
      "lang": "en-US",
      "value": "Invalid user ID or password."
    }
  }
}

Authentication

Basic Authentication using Login ID and Password.

Authorization

The user must have the Administrator (12) or the Configurations (22) permission.