Class Ens.ServiceRegistry.API.REST.Query

class Ens.ServiceRegistry.API.REST.Query extends %CSP.REST

Provide a REST interface to the Registry service Used to search the Public Registry service

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
3		11

Summary

Methods
%ClassIsLatestVersion	%ClassName	%DispatchClassMethod	%DispatchGetModified
%DispatchGetProperty	%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty
%DispatchSetProperty	%Extends	%GetParameter	%IsA
%New	%OriginalNamespace	%PackageName	%SetModified
AcceptsContentType	AccessCheck	ConvertParameter	Decrypt
DispatchRequest	DrawCSS3STYLE	DrawHEAD	DrawSTHEAD
DrawSTTitle	DrawSTYLE	DrawTitle	DrawTitleSection
Encrypt	Error	EscapeHTML	EscapeURL
GetAbout	GetAuthChallenge	GetFileByID	GetServices
GetServicesByID	GetServicesByProtocols	GetServicesByStages	GetServicesByVersion
GetServicesByWord	GetServicesModifiedSince	Http403	Http404
Http405	Http500	HyperEventCall	HyperEventHead
Include	InsertHiddenField	InsertHiddenFields	IsPrivate
Link	Login	OnErrorSetup	OnHTTPHeader
OnHandleCorsRequest	OnHandleOptionsRequest	OnLoginPage	OnPage
OnPageError	OnPostHTTP	OnPostHyperEvent	OnPreDispatch
OnPreHTTP	OnPreHyperEvent	OnSecurityTokenPage	Page
QuoteJS	ReportHttpStatusCode	RewriteURL	SetResponseHeaderIfEmpty
ShowError	StartTimer	StatusToJSON	StatusToProxyObject
StopTimer	SupportedVerbs	ThrowError	UnescapeHTML
UnescapeURL	WriteFileContents	WriteServiceAsJSON

Parameters

• parameter CHARSET = "utf-8";

Specifies the default character set for the page. This can be overriden using the <CSP:CONTENT CHARSET=> tag, or by setting the %response.CharSet property in the OnPreHTTP method. If this parameter is not specified, then for the default charset is utf-8.

• parameter CONTENTTYPE = "application/json";

Specifies the default content type for the page. This can be overriden using the <CSP:CONTENT TYPE=> tag, or by setting the %response.ContentType property in the OnPreHTTP method. The default value if this parameter is not set is text/html.

• parameter EnforceJSONAccept = 0;

If true returns HTTP 406 if HTTP_ACCEPT is not application/json

Methods

• classmethod GetAbout() as %Status

Returns JSON object describing this REST API

• classmethod GetFileByID(pName As %String = "", pDomain As %String = "", pVersion As %String = "", pFilename As %String = "") as %Status

• classmethod GetServices(ByRef pSearchCriteria As %String) as %Status

Returns the services logged in user can see that match the search criteria

• classmethod GetServicesByID(pName As %String = "", pDomain As %String = "", pVersion As %String = "", pFilename As %String = "") as %Status

• classmethod GetServicesByProtocols(pProtocols) as %Status

• classmethod GetServicesByStages(pProtocols) as %Status

• classmethod GetServicesByVersion(pVersion) as %Status

• classmethod GetServicesByWord(pWord) as %Status

• classmethod GetServicesModifiedSince(pDate) as %Status

• classmethod WriteFileContents(pID As %String, pFilename As %String) as %Status

• classmethod WriteServiceAsJSON(pID As %String) as %Status

Class Reference IRIS for UNIX 2024.1.2
Documentation Search