Skip to main content

Ens.ServiceRegistry.Public.Action

SQL Table Name: Ens_ServiceRegistry_Public.Action

Action or WebMethod of a service

Property Inventory

Method Inventory

Parameters

parameter ROWLEVELSECURITY = 1;
Inherited description: ROWLEVELSECURITY = 1 | <property> means that row level security is active and the list of users/roles for a given instance/row is contained in a generated property. If the value of this parameter is a valid property name then that property will be used as the reader list and only generated if not already defined.

Properties

property Description as %String);
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property Idempotent as %Boolean [ InitialExpression = 0 ];
Does this method have no additional persistent effect on the server state if re-executed a second time or more?
Property methods: IdempotentDisplayToLogical(), IdempotentGet(), IdempotentGetStored(), IdempotentIsValid(), IdempotentLogicalToDisplay(), IdempotentLogicalToXSD(), IdempotentNormalize(), IdempotentSet(), IdempotentXSDToLogical()
property Name as %String) [ Required ];
Name of the action, activity, or web method - a human readable identifier
Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property ReadOnly as %Boolean [ InitialExpression = 0 ];
Does this action have no persistent effect on the server state?
Property methods: ReadOnlyDisplayToLogical(), ReadOnlyGet(), ReadOnlyGetStored(), ReadOnlyIsValid(), ReadOnlyLogicalToDisplay(), ReadOnlyLogicalToXSD(), ReadOnlyNormalize(), ReadOnlySet(), ReadOnlyXSDToLogical()
property Ref as %String) [ Required ];
Identifier of the action or web method
Property methods: RefDisplayToLogical(), RefGet(), RefGetStored(), RefIsValid(), RefLogicalToDisplay(), RefLogicalToOdbc(), RefNormalize(), RefSet()
property RequestSchema as Ens.ServiceRegistry.Schema;
Request body type
Property methods: RequestSchemaGet(), RequestSchemaGetObject(), RequestSchemaGetObjectId(), RequestSchemaGetStored(), RequestSchemaGetSwizzled(), RequestSchemaIsEmpty(), RequestSchemaIsValid(), RequestSchemaNewObject(), RequestSchemaSet(), RequestSchemaSetObject(), RequestSchemaSetObjectId(), RequestSchemaUnSwizzle()
property ResponseSchema as Ens.ServiceRegistry.Schema;
Response body type
Property methods: ResponseSchemaGet(), ResponseSchemaGetObject(), ResponseSchemaGetObjectId(), ResponseSchemaGetStored(), ResponseSchemaGetSwizzled(), ResponseSchemaIsEmpty(), ResponseSchemaIsValid(), ResponseSchemaNewObject(), ResponseSchemaSet(), ResponseSchemaSetObject(), ResponseSchemaSetObjectId(), ResponseSchemaUnSwizzle()
relationship Service as Service [ Required , Inverse = Actions , Cardinality = parent ];
Property methods: ServiceGet(), ServiceGetObject(), ServiceGetObjectId(), ServiceGetStored(), ServiceGetSwizzled(), ServiceIsValid(), ServiceNewObject(), ServiceOnDelete(), ServiceRClose(), ServiceRExec(), ServiceRFetch(), ServiceRelate(), ServiceSQLCompute(), ServiceSet(), ServiceSetObject(), ServiceSetObjectId(), ServiceUnRelate(), ServiceUnSwizzle()
property Verb as %String (MAXLEN = 64);
The HTTP method expected by the action, if relevant
Property methods: VerbDisplayToLogical(), VerbGet(), VerbGetStored(), VerbIsValid(), VerbLogicalToDisplay(), VerbLogicalToOdbc(), VerbNormalize(), VerbSet()

Methods

classmethod %SecurityPolicy(Service) as %String [ SQLProc = Action_sys_SecurityPolicy ]
Projected as the stored procedure: Action_sys_SecurityPolicy

Indexes

index (%RLI on %READERLIST(ELEMENTS));
index (Name on Name) [IdKey, Type = key];
Index methods: NameCheck(), NameDelete(), NameDisplayToLogical(), NameExists(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameOpen(), NameSQLCheckUnique(), NameSQLExists(), NameSQLFindPKeyByConstraint(), NameSQLFindRowIDByConstraint(), NameSet()

Triggers

trigger OnDelete (BEFORE event DELETE);

Inherited Members

Inherited Methods

Storage

Storage Model: CacheStorage (Ens.ServiceRegistry.Public.Action)

{%%PARENT}("Actions")(ID)
=
%%CLASSNAME
Ref
Verb
Description
RequestSchema
ResponseSchema
ReadOnly
Idempotent
%READERLIST
FeedbackOpens in a new tab