Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %iKnow.Metrics.MetricWSAPI
Private  Storage   

%iKnow.Metrics.MetricWSAPI


class %iKnow.Metrics.MetricWSAPI extends
%iKnow.Queries.AbstractWSAPI

This is an automatically generated class, offering a functionally equivalent set of methods and queries as %iKnow.Metrics.MetricAPI, exposed as WebMethod methods.

See the classdocs for %iKnow.Metrics.MetricAPI for more information.

This class was generated by %iKnow.Metrics.MetricAPI.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 6


Summary


Properties
AddressingIn AddressingOut Attachments Base64LineBreaks
BodyId BodyXmlId ContentId ContentLocation
FaultAddressing FaultHeaders HeadersIn HeadersOut
ImportHandler IsMTOM Location MTOMRequired
MsgClass OutputTypeAttribute Password RMSession
ReferencesInline RequestMessageStart ResponseAttachments ResponseContentId
ResponseContentLocation SAXFlags SecurityContextToken SecurityIn
SecurityNamespace SecurityOut SessionCookie SoapFault
SoapVersion Timeout Transport Username
WriteSOAPBodyMethod

Methods
%AddEnvelopeNamespace %AddToSaveSet %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%Extends %GetParameter %IsA %IsModified
%New %NormalizeObject %ObjectModified %OnCreateRMSession
%OriginalNamespace %PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %ValidateObject ConvertParameter Decrypt
Encrypt EscapeHTML EscapeURL FileWSDL
GetBodyId GetMetricId GetMetrics GetTargets
GetTop GetValue HyperEventCall HyperEventHead
Include Initialize InsertHiddenField InsertHiddenFields
IsPrivate Link MakeFault MakeFault12
MakeSecurityFault MakeStatusFault NormalizeName OnCancelSecureConversation
OnPageError OnPostHTTP OnPostHyperEvent OnPostWebMethod
OnPreHyperEvent OnPreWebMethod OnRequestMessage OnSOAPRequest
OnStartSecureConversation Page Process ProcessBinary
ProcessBody ProcessBodyNode QuoteJS Reset
ReturnFault ReturnOneWay RewriteURL SetValue
ShowError StartTimer StopTimer ThrowError
UnescapeHTML UnescapeURL WSAddSignatureConfirmation


Parameters


• parameter NAMESPACE = "http://www.intersystems.com/iKnow/Metrics/MetricWSAPI";
NAMESPACE - Should be an unique URI Override this parameter in the subclass with the unique namespace URI of your organization. Override this parameter in the subclass.
• parameter SERVICENAME = "iKnow.Metrics.MetricWSAPI";
SERVICENAME - Should be the name of the service for which this is a proxy. Override this parameter in the subclass.
• parameter USECLASSNAMESPACES = 1;
When USECLASSNAMESPACES = 1, then the WSDL of the Web service reflects the namespaces defined for the referenced classes by the NAMESPACE parameters of those classes. The default, for compatibility with previous versions, is that the NAMESPACE parameters of the referenced classes are ignored when creating the WSDL. If USECLASSNAMESPACES has no value, then the default value from ^ISCSOAP("USECLASSNAMESPACES") is used.

Methods


• classmethod GetMetricId(pDomainId As %Integer, pMetricName As %Integer) as %Library.Integer [ WebMethod ]
Returns the ID corresponding to the supplied metric name for this domain.
• classmethod GetMetrics(pDomainId As %Integer) as %XML.DataSet [ WebMethod ]
Returns all the metrics registered in this domain.
• classmethod GetTargets(pDomainId As %Integer, pMetricId As %Integer) as %XML.DataSet [ WebMethod ]
Returns all the target types registered for a given metric.
• classmethod GetTop(pDomainId As %Integer, pMetricId As %Integer, pPage As %Integer = 1, pPageSize As %Integer = 10, pContext As %String = "", pTargetType As %String = "") as %XML.DataSet [ WebMethod ]

Returns the elements with the highest values for custom metric pMetricId, optionally restricted to the target type pTargetType.

pContext is ignored when the metric is type $$$IKMTRTYPEDOMAIN and should be a source ID for $$$IKMTRTYPESOURCE or a metadata value for $$$IKMTRTYPEGROUP. In the latter case, pContext is optional and the top entries for all metadata values will be returned if left blank.

• classmethod GetValue(pDomainId As %Integer, pMetricId As %Integer, pTargetType As %String, pTargetId As %Integer, pContext As %String = "") as %Library.Numeric [ WebMethod ]

Returns the value of a particular target element identified by pTargetId (for example, when pTargetType = $$$IKMTRENTITY, pTargetId is a unique entity ID).

pContext is only required when the metric is not of type $$$IKMTRTYPEDOMAIN and should be a source ID for $$$IKMTRTYPESOURCE or a metadata value for $$$IKMTRTYPEGROUP.

• classmethod SetValue(pDomainId As %Integer, pMetricId As %Integer, pTargetType As %String, pTargetId As %Integer, pValue As %Integer, pContext As %String = "") as %Boolean [ WebMethod ]

Sets the value of a particular target element identified by pTargetId (for example, when pTargetType = $$$IKMTRENTITY, pTargetId is a unique entity ID) to pValue.

pContext is only required when the metric is not of type $$$IKMTRTYPEDOMAIN and should be a source ID for $$$IKMTRTYPESOURCE or a metadata value for $$$IKMTRTYPEGROUP.