DOCUMENTATIONAPI REFERENCEAI-Link
DownloadsSupport
Loading search results...
Configurations

Configurations

List API

HTTP REQUEST: GET

Get the list of all Configurations at the Organization scope.

GET/api/1.0/org/{orgId}/properties/configurations
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if the org identified by orgId does not exist.
500A server error occurred. Check the logs for more details.
200 Response Body
{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": [
    {
      "id": "account.host",
      "name": "account.host",
      "value": "local.infra.atscale.com",
      "type": "string",
      "role": "configuration",
      "group": "account",
      "configurable": true,
      "scope": "global"
    },
    {
      "id": "account.port",
      "name": "account.port",
      "value": "10500",
      "type": "int",
      "role": "configuration",
      "group": "account",
      "configurable": true,
      "scope": "global"
    },
    {
      "id": "modeler.host",
      "name": "modeler.host",
      "value": "local.infra.atscale.com",
      "type": "string",
      "role": "configuration",
      "group": "design center",
      "configurable": true,
      "scope": "global"
    },
    {
      "id": "tableau.server.readTimeout",
      "name": "tableau.server.readTimeout",
      "value": "60s",
      "type": "int",
      "role": "configuration",
      "group": "tableau",
      "configurable": true,
      "scope": "global"
    }
  ]
}

Update API

HTTP REQUEST: POST

Set the Configuration value for an Organization scoped Configuration

POST/api/1.0/org/{orgId}/properties/configurations/update
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) where you make updates
QUERY PARAMETERS
NameTypeDescription
namestringName of the configuration
valuestringNew value of the configuration
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if the org identified by orgId does not exist.
500A server error occurred. Check the logs for more details.
Request Body
{
  "name": "session.timeout",
  "value": "3h"
}
200 Response Body
{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": "3h"
}

Organization Override API

HTTP REQUEST: PUT

Create a new Organization Scoped Configuration with the value passed in.

PUT/api/1.0/org/{orgId}/properties/configurations/{globalConfigurationId}/{value}
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
globalConfigurationIdstringThe Global Scope Configuration ID (non-UUID, human readable) for which you are querying.
valuestringThe Value you want to set the configuration to
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if the org identified by orgId does not exist.
500A server error occurred. Check the logs for more details.
200 Response Body
{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "id": "account.host",
    "name": "account.host",
    "value": "value",
    "type": "string",
    "role": "configuration",
    "group": "account",
    "configurable": true,
    "scope": "local"
  }
}