ApexERPHost

<back to all web services

SaveDbServer

Requires Authentication
Required role:SysAdmin
The following routes are available for this service:
POST/dbadmin/servers
SaveDbServer Parameters:
NameParameterData TypeRequiredDescription
ServerbodyDbServerNo
DbServer Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
TypeformintNo
ConnStringformstringNo
SupportedDbMetricsformList<DbServerMetricViewMeta>No
SupportedDbActionsformList<DbServerActionMeta>No
DbServerMetricViewMeta Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
GroupNameformstringNo
DescriptionformstringNo
ViewTypeformstringNo
SortIdformint?No
AllowAutoRefreshformbool?No
HasDbFilterformbool?No
DbFilterRequiredformbool?No
ActionsformList<DbServerActionBinding>No
DetailViewSourceColumnformstringNo
UnIdformGuid?No
DbServerActionBinding Parameters:
NameParameterData TypeRequiredDescription
ActionIdformstringNo
ParametersformDictionary<string, string>No
DbServerActionMeta Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
DescriptionformstringNo
ParametersformList<DbServerActionParameterMeta>No
ResultTypeformstringNo
UnIdformGuid?No
DbServerActionParameterMeta Parameters:
NameParameterData TypeRequiredDescription
SortIdformintNo
NameformstringNo
DescriptionformstringNo
SourceColumnformstringNo
TypeformstringNo
Requiredformbool?No
SaveDbServerResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
NewDbIdformstringNo

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.

POST /dbadmin/servers HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Server":{"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"}]}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"NewDbId":"String"}