Class Reference
%iKnow.Utils.MaintenanceWSAPI
Server:basexml
Instance:SOAXML
User:UnknownUser
  
-
  [BASEXML] >  [%iKnow] >  [Utils] >  [MaintenanceWSAPI]
Private  Storage

class %iKnow.Utils.MaintenanceWSAPI extends %SOAP.WebService, %iKnow.Queries.AbstractWSAPI

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

See the classdocs for %iKnow.Utils.MaintenanceAPI for more information.

This class was generated by %iKnow.Utils.MaintenanceAPI.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 15


Summary

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

Methods
%%OIDGet %AddToSaveSet %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%Extends %GetParameter %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject AddEntityToBlackList AddStringToBlackList BlacklistContainsElement
ConvertParameter CreateBlackList Decrypt DropBlackList
Encrypt EscapeHTML EscapeURL FileWSDL
GetBlackListElements GetBlackListId GetBlackLists GetBodyId
GetUserDictionaries GetUserDictionaryEntries HyperEventBody HyperEventCall
HyperEventFrame 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 RemoveEntityFromBlackList RemoveStringFromBlackList Reset
ReturnFault ReturnOneWay RewriteURL SecurityOutGet
SecurityOutSet ShowError StartTimer StopTimer
ThrowError TimeoutSet UnescapeHTML UnescapeURL
WSAddSignatureConfirmation


Parameters

• parameter NAMESPACE = "http://www.intersystems.com/iKnow/Utils/MaintenanceWSAPI";
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.Utils.MaintenanceWSAPI";
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 AddEntityToBlackList(domainId As %Integer, blackListId As %Integer, entUniId As %Integer) as %Boolean [ WebMethod ]
Adds an existing entity (by ID) to a BlackList
• classmethod AddStringToBlackList(domainId As %Integer, blackListId As %Integer, string As %String) as %Boolean [ WebMethod ]
Adds a string to a BlackList, adding it as an entity if it didn't exist in the domain before.
• classmethod BlacklistContainsElement(domainId As %Integer, blackListId As %Integer, entUniId As %Integer) as %Library.Integer [ WebMethod ]
• classmethod CreateBlackList(domainId As %Integer, name As %String, description As %String = "") as %Library.Integer [ WebMethod ]

Create a new BlackList entry with the given name and description

• classmethod DropBlackList(domainId As %Integer, blackListId As %Integer) as %Boolean [ WebMethod ]
Drops a BlackList (entities part of the list will not be deleted from the domain)
• classmethod GetBlackListElements(domainId As %Integer, blackListId As %Integer) as %XML.DataSet [ WebMethod ]
Retrieves a list of all the strings in the specified BlackList
• classmethod GetBlackListId(domainId As %Integer, name As %String) as %Library.Integer [ WebMethod ]
Finds the BlackList ID corresponding to the supplied name.
• classmethod GetBlackLists(domainId As %Integer) as %XML.DataSet [ WebMethod ]
Retrieves a list of all the BlackLists registered in this domain.
• classmethod GetUserDictionaries() as %XML.DataSet [ WebMethod ]
Returns a list of all the User Dictionaries in this namespace.
• classmethod GetUserDictionaryEntries(userDictId As %Integer) as %XML.DataSet [ WebMethod ]

Returns the contents of a User Dictionary.

• classmethod RemoveEntityFromBlackList(domainId As %Integer, blackListId As %Integer, entUniId As %Integer) as %Boolean [ WebMethod ]
Removes an entity (by ID) from a BlackList (but not from the domain)
• classmethod RemoveStringFromBlackList(domainId As %Integer, blackListId As %Integer, string As %String) as %Boolean [ WebMethod ]
Removes a string from a BlackList (but not from the domain)