Datafor

Appearance

Get connections

About 881 wordsAbout 3 min

apiConnections

Method
GET

Request URL

/plugin/datafor-modeler/api/connection/list

Authorization
Use of this API requires authentication. For details about the authentication method, see
Authorization.

Preconditions

  • The current user must have read privileges for the connections.

Content Type
No request body is typically used with a GET request. Parameters are provided via query string.

Parameters Schema

NameLocationTypeRequiredDescription
includeAccessMapquerystringNoWhether to include access mapping info (e.g., "true")

Response Examples

{
  "success": true,
  "databaseConnections": [
    {
      "connectSql": "",
      "databaseName": "training",
      "partitioned": false,
      "quoteAllFields": false,
      "extraOptionsOrder": {},
      "accessTypeValue": "NATIVE",
      "accessType": "NATIVE",
      "hostname": "127.0.0.1",
      "password": null,
      "connectionPoolingProperties": {
        "minIdle": "5",
        "maxIdle": "20",
        "testOnBorrow": "true",
        "validationQuery": "select 1",
        "initialSize": "5",
        "maxActive": "200"
      },
      "forcingIdentifiersToUpperCase": false,
      "id": "85f98919-fe84-409c-ac5a-7de78820e40d",
      "initialPoolSize": 0,
      "isUploadDataset": false,
      "partitioningInformation": null,
      "indexTablespace": "",
      "dataTablespace": "",
      "streamingResults": false,
      "databaseType": {
        "extraOptionsHelpUrl": "http://jdbc.postgresql.org/documentation/83/connect.html#connection-parameters",
        "defaultDatabaseName": null,
        "defaultOptions": null,
        "name": "PostgreSQL",
        "defaultDatabasePort": 5432,
        "shortName": "POSTGRESQL",
        "supportedAccessTypes": [
          "NATIVE",
          "ODBC",
          "JNDI"
        ]
      },
      "isSystem": false,
      "extraOptions": {},
      "forcingIdentifiersToLowerCase": false,
      "accessMap": [
        {
          "name": "0",
          "value": "true"
        },
        {
          "name": "1",
          "value": "true"
        },
        {
          "name": "2",
          "value": "true"
        },
        {
          "name": "4",
          "value": "true"
        }
      ],
      "name": "Demo",
      "sqlserverInstance": null,
      "attributes": {
        "PORT_NUMBER": "25432"
      },
      "maximumPoolSize": 0,
      "informixServername": "",
      "usingConnectionPool": true,
      "usingDoubleDecimalAsSchemaTableSeparator": false,
      "databasePort": "25432",
      "username": "postgres",
      "changed": false
    },
    {
      "connectSql": "",
      "databaseName": "sampledata",
      "partitioned": false,
      "quoteAllFields": false,
      "extraOptionsOrder": {},
      "accessTypeValue": "NATIVE",
      "accessType": "NATIVE",
      "hostname": "127.0.0.1",
      "password": null,
      "connectionPoolingProperties": {
        "minIdle": "5",
        "maxIdle": "20",
        "testOnBorrow": "true",
        "validationQuery": "select 1",
        "initialSize": "5",
        "maxActive": "200"
      },
      "forcingIdentifiersToUpperCase": false,
      "id": "82f7ce1a-798c-41f3-a3ba-33b64a581c83",
      "initialPoolSize": 0,
      "isUploadDataset": false,
      "partitioningInformation": null,
      "indexTablespace": "",
      "dataTablespace": "",
      "streamingResults": false,
      "databaseType": {
        "extraOptionsHelpUrl": "http://jdbc.postgresql.org/documentation/83/connect.html#connection-parameters",
        "defaultDatabaseName": null,
        "defaultOptions": null,
        "name": "PostgreSQL",
        "defaultDatabasePort": 5432,
        "shortName": "POSTGRESQL",
        "supportedAccessTypes": [
          "NATIVE",
          "ODBC",
          "JNDI"
        ]
      },
      "isSystem": false,
      "extraOptions": {},
      "forcingIdentifiersToLowerCase": false,
      "accessMap": [
        {
          "name": "0",
          "value": "true"
        },
        {
          "name": "1",
          "value": "true"
        },
        {
          "name": "2",
          "value": "true"
        },
        {
          "name": "4",
          "value": "true"
        }
      ],
      "name": "SampleData",
      "sqlserverInstance": null,
      "attributes": {
        "driverId": "postgresql",
        "PORT_NUMBER": "25432"
      },
      "maximumPoolSize": 0,
      "informixServername": "",
      "usingConnectionPool": true,
      "usingDoubleDecimalAsSchemaTableSeparator": false,
      "databasePort": "25432",
      "username": "postgres",
      "changed": false
    },
    {
      "connectSql": "",
      "databaseName": "foodmart",
      "partitioned": false,
      "quoteAllFields": false,
      "extraOptionsOrder": {},
      "accessTypeValue": "NATIVE",
      "accessType": "NATIVE",
      "hostname": "127.0.0.1",
      "password": null,
      "connectionPoolingProperties": {
        "minIdle": "5",
        "maxIdle": "20",
        "initialSize": "5",
        "maxActive": "200"
      },
      "forcingIdentifiersToUpperCase": false,
      "id": "3255113e-6d7e-4031-8a46-cc21dfda06e9",
      "initialPoolSize": 0,
      "isUploadDataset": false,
      "partitioningInformation": null,
      "indexTablespace": "",
      "dataTablespace": "",
      "streamingResults": false,
      "databaseType": {
        "extraOptionsHelpUrl": "http://jdbc.postgresql.org/documentation/83/connect.html#connection-parameters",
        "defaultDatabaseName": null,
        "defaultOptions": null,
        "name": "PostgreSQL",
        "defaultDatabasePort": 5432,
        "shortName": "POSTGRESQL",
        "supportedAccessTypes": [
          "NATIVE",
          "ODBC",
          "JNDI"
        ]
      },
      "isSystem": false,
      "extraOptions": {},
      "forcingIdentifiersToLowerCase": false,
      "accessMap": [
        {
          "name": "0",
          "value": "true"
        },
        {
          "name": "1",
          "value": "true"
        },
        {
          "name": "2",
          "value": "true"
        },
        {
          "name": "4",
          "value": "true"
        }
      ],
      "name": "foodmart",
      "sqlserverInstance": null,
      "attributes": {
        "driverId": "postgresql",
        "PORT_NUMBER": "25432"
      },
      "maximumPoolSize": 0,
      "informixServername": "",
      "usingConnectionPool": true,
      "usingDoubleDecimalAsSchemaTableSeparator": false,
      "databasePort": "25432",
      "username": "postgres",
      "changed": false
    }
  ]
}

HTTP Responses

HTTP Status CodeMeaningDescriptionData schema
200OKnoneInline

Response Data Schema (HTTP 200)

NameTypeRequiredDescription
successbooleanYesIndicates whether the request was successful
databaseConnections[object]YesArray of database connection objects
├── connectSqlstringYesSQL to run upon connection
├── databaseNamestringYesName of the database
├── partitionedbooleanYesWhether the database is partitioned
├── quoteAllFieldsbooleanYesWhether to quote all fields
├── extraOptionsOrderobjectYesOrder of extra options (if any)
├── accessTypeValuestringYesAccess type (e.g., NATIVE)
├── accessTypestringYesSame as accessTypeValue
├── hostnamestringYesHost IP or domain
├── passwordnullYesDatabase password (null if not retrieved)
├── connectionPoolingPropertiesobjectYesProperties for the connection pool
│ ├── minIdlestringYesMinimum idle connections
│ ├── maxIdlestringYesMaximum idle connections
│ ├── testOnBorrowstringNoWhether to test connection on borrow (e.g., "true")
│ ├── validationQuerystringNoSQL query to validate connections ("select 1")
│ ├── initialSizestringYesInitial pool size
│ └── maxActivestringYesMaximum active connections
├── forcingIdentifiersToUpperCasebooleanYesWhether to force identifiers to uppercase
├── idstringYesUnique ID for this connection configuration
├── initialPoolSizeintegerYesInitial size for the pool
├── isUploadDatasetbooleanYesWhether it’s an uploaded dataset
├── partitioningInformationnullYesDetails of partitioning (null if not used)
├── indexTablespacestringYesName of the index tablespace
├── dataTablespacestringYesName of the data tablespace
├── streamingResultsbooleanYesWhether to use streaming results
├── databaseTypeobjectYesDetails about the database type
│ ├── extraOptionsHelpUrlstringYesURL for extra driver options documentation
│ ├── defaultDatabaseNamenullYesDefault database name (null if not applicable)
│ ├── defaultOptionsnullYesDefault driver options
│ ├── namestringYesFull database type name (e.g., PostgreSQL)
│ ├── defaultDatabasePortintegerYesDefault port for the database type (e.g., 5432)
│ ├── shortNamestringYesShort name (e.g., POSTGRESQL)
│ └── supportedAccessTypes[string]YesSupported access types (e.g., [ "NATIVE", "ODBC", "JNDI" ])
├── isSystembooleanYesIndicates if it’s a system connection
├── extraOptionsobjectYesAdditional driver-specific options
├── forcingIdentifiersToLowerCasebooleanYesWhether to force identifiers to lowercase
├── accessMap[object]YesArray of access permission objects
│ ├── namestringYesPermission code ("0", "1", "2", "4", etc.)
│ └── valuestringYesWhether the permission is granted ("true" or "false")
├── namestringYesName of the connection
├── sqlserverInstancenullYesFor SQL Server instances (null if not used)
├── attributesobjectYesDriver-specific attributes
│ ├── PORT_NUMBERstringYesPort number ("25432")
│ └── driverIdstringYesDriver ID (e.g., postgresql)
├── maximumPoolSizeintegerYesMaximum pool size
├── informixServernamestringYesFor Informix server name (empty if not used)
├── usingConnectionPoolbooleanYesWhether a connection pool is in use
├── usingDoubleDecimalAsSchemaTableSeparatorbooleanYesWhether to treat double decimals as schema-table separators
├── databasePortstringYesPort for the database ("25432")
├── usernamestringYesDatabase user name (e.g., "postgres")
└── changedbooleanYesIndicates if the connection configuration has changed
Datafor Documentation
Copyright ©2025 Datafor All rights reserved.