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?

Ens.ServiceRegistry.External.API

class Ens.ServiceRegistry.External.API extends %Library.RegisteredObject

Method Inventory

Parameters

parameter DOMAIN = Ensemble;

Methods

classmethod CloneService(pID As %String, pName As %String, pDomain As %String, pVersion As %String) as %Status
classmethod Count() as %Integer
classmethod DeleteAction(pID) as %Status
classmethod DeleteAttribute(pID) as %Status
classmethod DeleteContact(pID) as %Status
classmethod DeleteFile(pID) as %Status
classmethod DeleteService(pID As %String) as %String
classmethod ExistsAction(pID) as %Boolean
classmethod ExistsAttribute(pID) as %Boolean
classmethod ExistsContact(pID) as %Boolean
classmethod ExistsFile(pID) as %Boolean
classmethod ExistsService(pName As %String, pDomain As %String, pVersion As %String) as %Boolean
classmethod ListServices(Output tStreamString)
classmethod PerformSearch(ByRef pSearchCriteria, ByRef pExtendedCriteria, pStatus As %Status = $$$OK) as %SQL.Statement
Search the Registry for services which match the provided set of pSearchCriteria and pExtendedCriteria. Both sets of criteria will take the form of arrays.

Allowed subscripts for pSearchCriteria are:
  • 'Version' as a single version
  • 'WordMatch' as a string of text contained in a service's name domain description endpoint or topics list
  • 'Protocols' which has subscripts 'File','FTP','HL7','HTTP','REST','SOAP','SQL','X12', and 'Other' as boolean values
  • 'Stages' which has subscripts 'Concept','Defunct','Deprecated','Development','Live','Staging', and 'Test' as boolean values
Any extra subscripts will be ignored.

The pExtendedCriteria array takes the following form:
  • pExtendedCriteria(Criterion) = Type, where Criterion is a number and Type is either 'AND' or 'OR'
  • pExtendedCriteria(Criterion,Condition) = Type, where Condition is a number and Type is 'IF','AND', or 'OR'. The first condition in a criterion set should be of type 'IF'.
  • pExtendedCriteria(Criterion,Condition,"attr") is the name of an attribute
  • pExtendedCriteria(Criterion,Condition,"op") is the name of a comparison operation to be performed on the attribute. Allowed operations are =,!=,>,<,>=,<=,CONTAINS,DOESNOTCONTAIN
  • pExtendedCriteria(Criterion,Condition,"val") is the value which the attribute's value is being compared to.

classmethod SaveService(pProxy As %ZEN.proxyObject) as %Status

Inherited Members

Inherited Methods

FeedbackOpens in a new tab