Required role: | SysAdmin |
GET | /dbadmin/servers |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Result | form | List<DbServer> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
Type | form | int | No | |
ConnString | form | string | No | |
SupportedDbMetrics | form | List<DbServerMetricViewMeta> | No | |
SupportedDbActions | form | List<DbServerActionMeta> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
GroupName | form | string | No | |
Description | form | string | No | |
ViewType | form | string | No | |
SortId | form | int? | No | |
AllowAutoRefresh | form | bool? | No | |
HasDbFilter | form | bool? | No | |
DbFilterRequired | form | bool? | No | |
Actions | form | List<DbServerActionBinding> | No | |
DetailViewSourceColumn | form | string | No | |
UnId | form | Guid? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ActionId | form | string | No | |
Parameters | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
Description | form | string | No | |
Parameters | form | List<DbServerActionParameterMeta> | No | |
ResultType | form | string | No | |
UnId | form | Guid? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SortId | form | int | No | |
Name | form | string | No | |
Description | form | string | No | |
SourceColumn | form | string | No | |
Type | form | string | No | |
Required | form | bool? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /dbadmin/servers HTTP/1.1 Host: apex.nikoratrade.ge Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { ResponseStatus: { ErrorCode: String, Message: String, StackTrace: String, Errors: [ { ErrorCode: String, FieldName: String, Message: String, Meta: { String: String } } ], Meta: { String: String } }, Result: [ { Id: String, Name: String, Type: 0, ConnString: String, SupportedDbMetrics: [ { Id: String, Name: String, GroupName: String, Description: String, ViewType: String, SortId: 0, AllowAutoRefresh: False, HasDbFilter: False, DbFilterRequired: False, Actions: [ { ActionId: String, Parameters: { String: String } } ], DetailViewSourceColumn: String, UnId: 00000000000000000000000000000000 } ], SupportedDbActions: [ { Id: String, Name: String, Description: String, Parameters: [ { SortId: 0, Name: String, Description: String, SourceColumn: String, Type: String, Required: False } ], ResultType: String, UnId: 00000000000000000000000000000000 } ] } ] }