Get Configurations

Purpose

Returns a list of system configuration settings.

URL

https://<myserver>:<port>/api/admin/configurations

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.

{
    "configurations": [
        {
            "id": attribute_id,
            "description": "attribute_description",
            "value": "attribute_value"
        }
    ]
}

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. 4 is the only supported value.",
            "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, 2 or -1.  Value of 2 enforces that the password be in compliance with the
                custom password policy. Value of 1 enforces that the password be in compliance with the default password
                policy. Value of -1 turns off the Password Policy enforcement. Any other value will be treated like -1",
            "value": "2"
        },
        {
            "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.