ScannerVision Web Server

<back to all web services

GetConnections

The following routes are available for this service:
GET/connections
"use strict";
export class GetConnections {
    constructor(init) { Object.assign(this, init) }
}
/** @typedef {'Group'|'User'} */
export var PermissionType;
(function (PermissionType) {
    PermissionType["Group"] = "Group"
    PermissionType["User"] = "User"
})(PermissionType || (PermissionType = {}));
/** @typedef {number} */
export var PropertyType;
(function (PropertyType) {
    PropertyType[PropertyType["Binary"] = 1] = "Binary"
    PropertyType[PropertyType["Boolean"] = 2] = "Boolean"
    PropertyType[PropertyType["ConnectionString"] = 3] = "ConnectionString"
    PropertyType[PropertyType["Credential"] = 4] = "Credential"
    PropertyType[PropertyType["Integer"] = 5] = "Integer"
    PropertyType[PropertyType["Picklist"] = 6] = "Picklist"
    PropertyType[PropertyType["String"] = 7] = "String"
    PropertyType[PropertyType["OAuth2"] = 8] = "OAuth2"
    PropertyType[PropertyType["Certificate"] = 9] = "Certificate"
})(PropertyType || (PropertyType = {}));
export class GetConnectionsResponse {
    /** @param {{Connections?:IConnectorConnection[],IsAuthenticated?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {IConnectorConnection[]} */
    Connections;
    /** @type {boolean} */
    IsAuthenticated;
}

JavaScript GetConnections DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /connections HTTP/1.1 
Host: buildmax.org 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'GetConnectionsResponse' using the custom 'csv' filter}No parameterless constructor defined for this object.