<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a standalone installation, or the machine hosting the load balancer for a load balancer installation. For a standalone installation, <port> is the port number specified as the Server Access Port during installation. For a load balancer installation, <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.
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 third party JDBC data store plugin feature.
6 is the ID for enabling or disabling the default Password Policy.
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.
See sample response below.
"value"
The value of the configurations attribute.
See sample response below.
Sample Server Success Response
Status code: 200
Successful response
{
"configurations": [
{
"id": 1,
"description": "Delimiter between user name and authentication
service/configuration name",
"value": null
},
{
"id": 2,
"description": "Enable Secure Password Change, when value is set to
true, the change password api will require a valid old password
in order to update the logged in user password.",
"value": "true"
},
{
"id": 3,
"description": "Default OData version for new data sources. Valid
values are 2 or 4.",
"value": "4"
},
{
"id": 4,
"description": "Default entity name mode for OData V4 data sources.
Valid values are: GUESS, PLURALIZE, SINGULARIZE and SUFFIX",
"value": "GUESS"
},
{
"id": 5,
"description": "Disable or enable third party JDBC data store. When the value is set to true, third party JDBC
data store will be enabled. When the value is set to false, third party JDBC data store will be disabled. By default, this is set to 'true'.",
"value": "true"
},
{
"id": 6,
"description": "Valid values are: 1 or -1. Value of 1 enforces that
the password be in compliant with the default password policy. Value
of -1 turns off the Password Policy enforcement.Any other value will
be treated like -1",
"value": "-1"
},
{
"id": 7,
"description": "Configures how the system persists system monitor details. 0 - no persistence, 1 - (default) log, 2 - database, 3 - log and database",
"value": "1"
},
{
"id": 8,
"description": "Configure whitelist filtering. Enables filtering when value is set to 'true'. Default value is "true" ",
"value": "true"
}
]
}
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.
