ApexERPHost

<back to all web services

GetDbServers

Requires Authentication
Required role:SysAdmin
The following routes are available for this service:
GET/dbadmin/servers
GetDbServersResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<DbServer>No
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

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

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDbServersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.DbAdmin">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <DbServer>
      <Id>String</Id>
      <Name>String</Name>
      <Type>0</Type>
      <ConnString>String</ConnString>
      <SupportedDbMetrics>
        <DbServerMetricViewMeta>
          <Id>String</Id>
          <Name>String</Name>
          <GroupName>String</GroupName>
          <Description>String</Description>
          <ViewType>String</ViewType>
          <SortId>0</SortId>
          <AllowAutoRefresh>false</AllowAutoRefresh>
          <HasDbFilter>false</HasDbFilter>
          <DbFilterRequired>false</DbFilterRequired>
          <Actions>
            <DbServerActionBinding>
              <ActionId>String</ActionId>
              <Parameters xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:KeyValueOfstringstring>
                  <d8p1:Key>String</d8p1:Key>
                  <d8p1:Value>String</d8p1:Value>
                </d8p1:KeyValueOfstringstring>
              </Parameters>
            </DbServerActionBinding>
          </Actions>
          <DetailViewSourceColumn>String</DetailViewSourceColumn>
          <UnId>00000000-0000-0000-0000-000000000000</UnId>
        </DbServerMetricViewMeta>
      </SupportedDbMetrics>
      <SupportedDbActions>
        <DbServerActionMeta>
          <Id>String</Id>
          <Name>String</Name>
          <Description>String</Description>
          <Parameters>
            <DbServerActionParameterMeta>
              <SortId>0</SortId>
              <Name>String</Name>
              <Description>String</Description>
              <SourceColumn>String</SourceColumn>
              <Type>String</Type>
              <Required>false</Required>
            </DbServerActionParameterMeta>
          </Parameters>
          <ResultType>String</ResultType>
          <UnId>00000000-0000-0000-0000-000000000000</UnId>
        </DbServerActionMeta>
      </SupportedDbActions>
    </DbServer>
  </Result>
</GetDbServersResponse>