Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
3		19

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	AddField	AddListOfValues	AddLovValue
ConvertParameter	Decrypt	Encrypt	EscapeHTML
EscapeURL	FileWSDL	GetBodyId	GetFieldId
GetFieldValues	GetFieldValuesById	GetFields	GetLovValues
GetLovs	GetValue	GetValueById	GetValues
GetValuesById	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
RemoveField	RemoveFieldById	Reset	ReturnFault
ReturnOneWay	RewriteURL	SecurityOutGet	SecurityOutSet
SetValue	SetValueById	ShowError	StartTimer
StopTimer	ThrowError	TimeoutSet	UnescapeHTML
UnescapeURL	UpdateField	UpdateFieldById	WSAddSignatureConfirmation

• parameter NAMESPACE = "http://www.intersystems.com/iKnow/Queries/MetadataWSAPI";

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.Queries.MetadataWSAPI";

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.

• classmethod AddField(domainId As %Integer, fieldName As %String, supportedOperators As %ListOfDataTypes = $lb($$$MDOPEQUAL), dataType As %String = $$$MDDTSTRING, buildBitstring As %Boolean = 0, caseSensitive As %Boolean = 0, lovId As %Integer = -1, validateLov As %Boolean = 1, hidden As %Boolean = 0) as %Library.Integer [ WebMethod ]

Adds a field definition with the given name and properties.

• The supportedOperators parameter specifies which operations (such as $$$MDOPEQUAL) will be available for filtering criteria
• If buildBitstring is true, the system will build a bitstring representation of all sources for every distinct metadata value, otherwise it will have entries for every source value and source.
• For dataType, choose either $$$MDDTSTRING, $$$MDDTNUMBER or $$$MDDTDATE ($horolog format)
• If buildBitstring is true, the system will build a bitstring representation of all sources for every distinct metadata value, otherwise it will have entries for every source value and source.
• If dataType is $$$MDDTSTRING, caseSensitive controls whether or not string values should be treated as case-sensitive.
• The lovId and validateLov parameters define wheter a List Of Values is available for this metadata field and whether input values should be verified against this list. See also AddListOfValues.
• If hidden is set to true, the field will by default not appear in metadata field and value lists.

• classmethod AddListOfValues(domainId As %Integer, lovName As %String, autoExtend As %Boolean = 1) as %Library.Integer [ WebMethod ]

Adds a List Of Values to the domain, which can then be used as a list of allowable values for one or more metadata fields.

• classmethod AddLovValue(domainId As %Integer, lovId As %Integer, value As %String, rank As %Integer = -1) as %Boolean [ WebMethod ]

Adds a new value to an existing List Of Values

• classmethod GetFieldId(domainId As %Integer, fieldName As %String) as %Library.Integer [ WebMethod ]

Returns the metadata field ID corresponding to the supplied name, or "" if none exists in this domain.

• classmethod GetFieldValues(domainId As %Integer, fieldName As %String, page As %Integer = 1, pageSize As %Integer = 10) as %XML.DataSet [ WebMethod ]

Returns all the distinct values currently in use for a given metadata field (by name).

• classmethod GetFieldValuesById(domainId As %Integer, mdFieldId As %Integer, page As %Integer = 1, pageSize As %Integer = 10) as %XML.DataSet [ WebMethod ]

Returns all the distinct values currently in use for a given metadata field (by ID).

• classmethod GetFields(domainId As %Integer, includeHidden As %Boolean = 0) as %XML.DataSet [ WebMethod ]

Returns all field definitions (including their properties) for the given domain.

Setting includeHidden to true will also return any metadata fields marked as 'hidden'.

• classmethod GetLovValues(domainId As %Integer, lovId As %Integer) as %XML.DataSet [ WebMethod ]

Returns all the allowed values for a given metadata LOV.

• classmethod GetLovs(domainId As %Integer, page As %Integer = 1, pageSize As %Integer = 10) as %XML.DataSet [ WebMethod ]

Returns a list of all the LOVs (List of Values) registered for this domain.

• classmethod GetValue(domainId As %Integer, fieldName As %String, externalId As %String) as %Library.String [ WebMethod ]

Returns the actual value for a given metadata field (by name) and source (by External ID).

• classmethod GetValueById(domainId As %Integer, fieldId As %Integer, srcId As %Integer) as %Library.String [ WebMethod ]

Returns the actual value for a given metadata field (by ID) and source (by Source ID).

• classmethod GetValues(domainId As %Integer, externalId As %String, includeHidden As %Boolean = 0) as %XML.DataSet [ WebMethod ]

Returns the actual metadata values for the given source (by External ID).

Setting includeHidden to true will also return the values for hidden metadata fields.

• classmethod GetValuesById(domainId As %Integer, srcId As %Integer, includeHidden As %Boolean = 0) as %XML.DataSet [ WebMethod ]

Returns the actual metadata values for the given source (by Source ID).

Setting includeHidden to true will also return the values for hidden metadata fields.

• classmethod RemoveField(domainId As %Integer, fieldName As %String) as %Boolean [ WebMethod ]

Removes a metadata field (by name) from the domain, including all references by existing sources.

• classmethod RemoveFieldById(domainId As %Integer, fieldId As %Integer) as %Boolean [ WebMethod ]

Removes a metadata field (by ID) from the domain, including all references by existing sources.

• classmethod SetValue(domainId As %Integer, fieldName As %String, externalId As %String, value As %String) as %Boolean [ WebMethod ]

Sets (or replaces if it exists) the value for a given metadata field (by name) for a given source (by External ID).

Values for fields of type $$$MDDTSTRING are normalized and stripped of whitespace and control characters at the beginning and end of the string.

• classmethod SetValueById(domainId As %Integer, fieldId As %Integer, srcId As %Integer, value As %String) as %Boolean [ WebMethod ]

Sets (or replaces if it exists) the value for a given metadata field (by ID) for a given source (by Source ID). Explicitly setting a value to "" (null/empty string) will erase the current value.

Values for fields of type $$$MDDTSTRING are normalized and stripped of whitespace and control characters at the beginning and end of the string.

• classmethod UpdateField(domainId As %Integer, fieldName As %String, supportedOperators As %ListOfDataTypes = "", buildBitstring As %Integer = -1, hidden As %Integer = -1, lovId As %Integer = -2, validateLov As %Integer = -1) as %Boolean [ WebMethod ]

Updates the properties for a given metadata field (by name). See also AddField.

Specifying a "" for the supportedOperators will leave the current value for that property. Similarly, specifying -1 for buildBitString, hidden and validateLov or -2 for lovId will leave their respective values unmodified. Setting lovId to -1 will unset the LOV for this field.

• classmethod UpdateFieldById(domainId As %Integer, fieldId As %Integer, supportedOperators As %ListOfDataTypes = "", buildBitstring As %Integer = -1, hidden As %Integer = -1, lovId As %Integer = -2, validateLov As %Integer = -1) as %Boolean [ WebMethod ]

Updates the properties for a given metadata field (by ID). See also AddField.

Specifying a "" for the supportedOperators will leave the current value for that property. Similarly, specifying -1 for buildBitString, hidden and validateLov or -2 for lovId will leave their respective values unmodified. Setting lovId to -1 will unset the LOV for this field.