Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%Api] >  [Atelier] >  [v6]
Private  Storage   

class %Api.Atelier.v6 extends %Api.Atelier.v5

%Api.Atelier.v6 provides version 6 APIs for Atelier

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
10


Summary

Methods
%ClassIsLatestVersion %ClassName %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Extends %GetParameter %IsA
%New %OriginalNamespace %PackageName %SetModified
AcceptsContentType AccessCheck Compile ConvertParameter
CvtClientDocToXml CvtXmlToClientDoc Decrypt DeleteDoc
DeleteDocs DispatchRequest DrawCSS3STYLE DrawHEAD
DrawSTHEAD DrawSTTitle DrawSTYLE DrawTitle
DrawTitleSection Encrypt Error EscapeHTML
EscapeURL GetAdpInputOutputClass GetAuthChallenge GetCSPApps
GetCSPDebugId GetDoc GetDocNames GetDocs
GetEnsClassType GetJobs GetMacroDefinition GetMacroExpansion
GetMacroList GetMacroLocation GetMacroSignature GetMetaData
GetModifiedDocNames GetNamespace HeadDoc Http403
Http404 Http405 Http500 HyperEventCall
HyperEventHead Include Index InsertHiddenField
InsertHiddenFields IsPrivate Link Login
OnErrorSetup OnHTTPHeader OnHandleCorsRequest OnHandleOptionsRequest
OnLoginPage OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreDispatch OnPreHTTP OnPreHyperEvent
OnSecurityTokenPage Page PutDoc Query
QuoteJS RenderResponseBody ReportHttpStatusCode RewriteURL
RunDebugger Search ServeDoc ServeXml
SetClientServerHash SetResponseHeaderIfEmpty ShowError StartTimer
StatusToJSON StatusToProxyObject StopTimer SupportedVerbs
ThrowError UnescapeHTML UnescapeURL

Subclasses
%Api.Atelier.v7

Methods

• classmethod Query(pNamespace As %String) as %Status
This method returns the results of running the specified query in the specified namespace.
The request body is simply a JSON object which specifies the query:
{
  "query": "SELECT TOP 1 Name FROM %Dictionary.ClassDefinition",
  "parameters" : []
}

The URL parameter ?max= can be passed to specify the maximum number of rows to return. The value must be a positive integer or the default behavior (return all rows) will be used.

HTTP Codes returned:-

HTTP 200 if OK
HTTP 415 if the we are not passed application/json as the content type
HTTP 500 if an error occurs (details will be in status error array)

If the URL parameter ?positional=1 is passed, the return object key will contain an array of objects, one for each result set, that contains the column metadata and the values for each row in separate arrays:
{
  "status": {
    "errors": [],
    "summary": ""
  },
  "console": [],
  "result": [
     {
       "columns": [
         {
           "name": "Name",
           "type": "VARCHAR(4096)"
         }
       ],
       "content": [
         [
           "%Api.Atelier"
         ]
       ]
     }
  ]
}

If the positional URL parameter is not passed or the value is not 1, the return content will be an array of objects.
The objects contain information relating to each row returned by the query:
{
  "status": {
    "errors": [],
    "summary": ""
  },
  "console": [],
  "result": {
    "content": [
      {
        "Name": "%Api.Atelier"
      }
    ]
  }
}


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.