ApexERPHost

<back to all web services

GetDbServerMetricView

Requires Authentication
Required role:SysAdmin
The following routes are available for this service:
GET/dbadmin/servers/databases/metrics/{MetricId*}
GET/dbadmin/servers/{ServerId}/databases/metrics/{MetricId*}
GetDbServerMetricView Parameters:
NameParameterData TypeRequiredDescription
ServerIdpathstringNo
DbNamequerystringNo
MetricIdpathstringNo
GetDbServerMetricViewResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultSetformList<DynamicData>No
MetaformDictionary<string, string>No
DynamicData Parameters:
NameParameterData TypeRequiredDescription
SchemaformDynamicDataSchemaNo
DataformList<List<String>>No
DynamicDataSchema Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ColumnsformList<DataColumnInfo>No
DataColumnInfo Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
TypeformintNo
MaxLengthformint?No
FormatformstringNo
ComplexTypeSchemaformDynamicDataSchemaNo

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/databases/metrics/{MetricId*} HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDbServerMetricViewResponse 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>
  <ResultSet xmlns:d2p1="http://schemas.datacontract.org/2004/07/Apex.Services">
    <d2p1:DynamicData>
      <d2p1:Schema>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:Columns>
          <d2p1:DataColumnInfo>
            <d2p1:Id>0</d2p1:Id>
            <d2p1:Name>String</d2p1:Name>
            <d2p1:Type>0</d2p1:Type>
            <d2p1:MaxLength>0</d2p1:MaxLength>
            <d2p1:Format>String</d2p1:Format>
            <d2p1:ComplexTypeSchema>
              <d2p1:Name>String</d2p1:Name>
              <d2p1:Columns>
                <d2p1:DataColumnInfo>
                  <d2p1:Id>0</d2p1:Id>
                  <d2p1:Name>String</d2p1:Name>
                  <d2p1:Type>0</d2p1:Type>
                  <d2p1:MaxLength>0</d2p1:MaxLength>
                  <d2p1:Format>String</d2p1:Format>
                  <d2p1:ComplexTypeSchema>
                    <d2p1:Name>String</d2p1:Name>
                    <d2p1:Columns>
                      <d2p1:DataColumnInfo>
                        <d2p1:Id>0</d2p1:Id>
                        <d2p1:Name>String</d2p1:Name>
                        <d2p1:Type>0</d2p1:Type>
                        <d2p1:MaxLength>0</d2p1:MaxLength>
                        <d2p1:Format>String</d2p1:Format>
                        <d2p1:ComplexTypeSchema i:nil="true" />
                      </d2p1:DataColumnInfo>
                    </d2p1:Columns>
                  </d2p1:ComplexTypeSchema>
                </d2p1:DataColumnInfo>
              </d2p1:Columns>
            </d2p1:ComplexTypeSchema>
          </d2p1:DataColumnInfo>
        </d2p1:Columns>
      </d2p1:Schema>
      <d2p1:Data xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:ArrayOfstring>
          <d4p1:string>String</d4p1:string>
        </d4p1:ArrayOfstring>
      </d2p1:Data>
    </d2p1:DynamicData>
  </ResultSet>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</GetDbServerMetricViewResponse>