| GET | /connections |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Connections | form | IEnumerable<IConnectorConnection> | No | |
| IsAuthenticated | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ConnectorId | form | Guid | No | |
| Description | form | string | No | |
| Id | form | string | No | |
| MaxConnections | form | int | No | |
| Name | form | string | No | |
| Permissions | form | ReadOnlyCollection<IConnectionPermission> | No | |
| PropertyDescriptions | form | ReadOnlyCollection<IConnectionPropertyDescription> | No | |
| SetupUser | form | IUser | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Allow | form | bool | No | |
| Connection | form | IConnectorConnection | No | |
| Type | form | PermissionType | No |
| Group | |
| User |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Description | form | string | No | |
| Name | form | string | No | |
| PropertyId | form | Guid | No | |
| PropertyType | form | PropertyType | No |
| Name | Value | |
|---|---|---|
| Binary | 1 | |
| Boolean | 2 | |
| ConnectionString | 3 | |
| Credential | 4 | |
| Integer | 5 | |
| Picklist | 6 | |
| String | 7 | |
| OAuth2 | 8 | |
| Certificate | 9 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Groups | form | ReadOnlyCollection<IUserGroup> | No | |
| EmailAddress | form | string | No | |
| HasPassword | form | bool | No | |
| HomeFolder | form | string | No | |
| Password | form | string | No | |
| SbcUser | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Users | form | ReadOnlyCollection<IUser> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{Unable to show example output for type 'GetConnectionsResponse' using the custom 'other' filter}No parameterless constructor defined for this object.