Skip to main content

%Api.Atelier

Class %Api.Atelier Extends %Atelier.REST

Routing class for the Atelier REST services

Parameters​

CHARSET​

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.

CONVERTINPUTSTREAM​

Parameter CONVERTINPUTSTREAM = 1;

Specifies if input %request.Content or %request.MimeData values are converted from their original character set on input. By default (0) we do not modify these and receive them as a binary stream which may need to be converted manually later. If 1 then if there is a 'charset' value in the request Content-Type or mime section we will convert from this charset when the input data is text based. For either json or xml data with no charset this will convert from utf-8 or honor the BOM if one is present.

CONTENTTYPE​

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.

HandleCorsRequest​

Parameter HandleCorsRequest = 1;

This parameter influences the CORS support. The default is an empty string meaning 'not specified'. If set to true (1) then CORS processing is ON. If set to false (0) then CORS processing is OFF. If left unset "" then the decision to process CORS is delegated to the setting on the URL map route.

UseSession​

Parameter UseSession As Integer = 1;

This parameter controls the CSP session support. By default the CSP session will be ended after each request in accordance with the spirit of REST. However this CAN be overridden by the user. To use a session, it's necessary to manage the CSPSESSION cookie. Browsers do this automatically but command line tools such as CURL require the setting of options.

Note that if you choose to use a session then this will use a CSP license until the session is ended or expires and the grace period has been satisfied. If you use the default of no session then this will be the same behavior as SOAP requests of holding a license for ten seconds.

XDatas​

UrlMap​

XData UrlMap [ XMLNamespace = "http://www.intersystems.com/urlmap" ]

Methods​

OnPreDispatch​

ClassMethod OnPreDispatch(pUrl As %String, pMethod As %String, ByRef pContinue As %Boolean) As %Status [ Internal ]

This method gets called prior to dispatch of the request. Put any common code here that you want to be executed for EVERY request. If pContinue is set to 0, the request will NOT be dispatched according to the UrlMap. In this case it's the responsibility of the user to return a response. HTTP Codes returned:- HTTP 406 will be returned if the Accepts header does not contain */* or application/json HTTP 404 will be returned in the namespace specified does not exist

AccessCheck​

ClassMethod AccessCheck(Output pAuthorized As %Boolean = 0) As %Status [ Internal ]

GetServer​

ClassMethod GetServer() As %Status

This method returns information about the server. GET http://localhost:57772/api/atelier/ HTTP Codes returned:- HTTP 200 if OK HTTP 500 if an error occurs (details will be in status error array) Returned content is a server descriptor. { "status": { "errors": [], "summary": "" }, "console": [], "result": { "content": { "version": "IRIS for UNIX (Apple Mac OS X for x86-64) 2081.1 (Build 513U) Fri Jan 26 2018 18:21:02 EST", "id": "6D1CB774-B314-11E5-888C-38C986213273", "api": 1, "features": [ { "name": "ENSEMBLE", "enabled": true } ], "namespaces": [ "%SYS", "DOCBOOK", "ENSDEMO", "ENSEMBLE", "SAMPLES", "USER" ] } } }

HeadServer​

ClassMethod HeadServer() As %Status

This method returns information about the server. HEAD http://localhost:57772/api/atelier/ HTTP Codes returned:- HTTP 200 if OK HTTP 500 if an error occurs (details will be in status error array) No returned content