Purpose

Returns the configuration settings for a given ID.

URL

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

Method

GET

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.

Response Definition

The response takes the following format. The parameters of the response are described in the table that follows.

{
    "id": attribute_id,
    "description": "attribute_description",
    "value": "attribute_value"
}
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.

"description" The description of the configurations attribute. For values, see the sample response in Gets configuration.
"value" The value of the configurations attribute. For values, see the sample response in Gets configuration.

Sample Server Success Response

A sample successful response has the format:

Status code: 200
Successful response
{
    "id": 1,
    "description": "Delimiter between user name and authentication service/configuration name",
    "value": null
}

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.