Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%iKnow.Semantics.ProximityWSAPI

class %iKnow.Semantics.ProximityWSAPI extends %iKnow.Queries.AbstractWSAPI

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

See the classdocs for %iKnow.Semantics.ProximityAPI for more information.

This class was generated by : %iKnow.Semantics.ProximityAPI.cls

Method Inventory

Parameters

parameter NAMESPACE = http://www.intersystems.com/iKnow/Semantics/ProximityWSAPI;
Inherited description: 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.Semantics.ProximityWSAPI;
Inherited description: SERVICENAME - Should be the name of the service for which this is a proxy. Override this parameter in the subclass.
parameter USECLASSNAMESPACES = 1;
Inherited description: 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 GetProfile(pDomainId As %Integer, pEntity As %String, pPage As %Integer = 1, pPageSize As %Integer = 10, pFilter As %String(MAXLEN=32767)="", pBlacklistIDs As %ListOfDataTypes = "") as %XML.DataSet [ WebMethod ]
Returns the proximity profile for the entity pEntity. This profile is calculated based on the aggregated distance to pEntity in all paths in the domain (when pFilter=""), optionally constrained to all paths in a specific set of sources (when pFilter!="")
classmethod GetProfileById(pDomainId As %Integer, pEntUniId As %Integer, pPage As %Integer = 1, pPageSize As %Integer = 10, pFilter As %String(MAXLEN=32767)="", pBlacklistIDs As %ListOfDataTypes = "") as %XML.DataSet [ WebMethod ]
Returns the proximity profile for the entity represented by pEntUniId. See also GetProfile()
classmethod GetProfileBySource(pDomainId As %Integer, pEntity As %String, pExternalId As %String, pPage As %Integer = 1, pPageSize As %Integer = 10) as %XML.DataSet [ WebMethod ]
Returns the proximity profile for a given entity pEntity in source pExtId.
classmethod GetProfileBySourceId(pDomainId As %Integer, pEntUniId As %Integer, pSrcId As %Integer, pPage As %Integer = 1, pPageSize As %Integer = 10) as %XML.DataSet [ WebMethod ]
Returns the proximity profile for a given entity identified by pEntUniId in source pSrcId.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab