GET /api/mgmnt/
URL Parameters
None.
Permissions
To use this endpoint, you must have read access to the given namespace. If no namespace is specified, or if the specified namespace is %SYS, you must have read access to the default namespace (USER). Note that you can set the default namespace to a different namespace; to do so, set the global node ^%SYS("REST","UserNamespace") equal to the desired namespace.
Example Request
-
Request Method:
GET
-
Request URL:
http://localhost:52773/api/mgmnt/
Response
The response is a JSON array; each object in the array represents a REST service on this server. Specifically, this call retrieves information about all REST-enabled web applications configured on this server. It finds both newer and manually-coded REST services. If there are REST service classes (newer or manually-coded) that have no associated REST-enabled web application, those are not included in this response.
A given object has the following properties:
-
name — Name of the REST-enabled web application.
-
dispatchClass — Name of the dispatch class of the REST service. Specifically this is the class indicated by the Dispatch Class configuration option of the web application.
-
namespace — Namespace in which the dispatch class is defined.
-
resource — Name of the InterSystems IRIS® data platform resource needed to use this REST service.
-
swaggerSpec — Endpoint where you can obtain the OpenAPI 2.0 specification for this REST service.
-
enabled — Specifies whether the REST service is enabled or not.
The following shows a sample response:
[
{
"name": "/api/atelier",
"dispatchClass": "%Api.Atelier",
"namespace": "%SYS",
"resource": "%Development",
"swaggerSpec": "/api/mgmnt/v1/%25SYS/spec/api/atelier",
"enabled": true
},
{
"name": "/api/deepsee",
"dispatchClass": "%Api.DeepSee",
"namespace": "%SYS",
"resource": "",
"swaggerSpec": "/api/mgmnt/v1/%25SYS/spec/api/deepsee",
"enabled": true
},
{
"name": "/api/docdb",
"dispatchClass": "%Api.DocDB",
"namespace": "%SYS",
"resource": "",
"swaggerSpec": "/api/mgmnt/v1/%25SYS/spec/api/docdb",
"enabled": true
},
{
"name": "/api/iknow",
"dispatchClass": "%Api.iKnow",
"namespace": "%SYS",
"resource": "",
"swaggerSpec": "/api/mgmnt/v1/%25SYS/spec/api/iknow",
"enabled": true
},
{
"name": "/api/mgmnt",
"dispatchClass": "%Api.Mgmnt.v2.disp",
"namespace": "%SYS",
"resource": "",
"swaggerSpec": "/api/mgmnt/v1/%25SYS/spec/api/mgmnt",
"enabled": true
},
{
"name": "/api/uima",
"dispatchClass": "%Api.UIMA",
"namespace": "%SYS",
"resource": "",
"swaggerSpec": "/api/mgmnt/v1/%25SYS/spec/api/uima",
"enabled": true
},
{
"name": "/webapp/simple2",
"dispatchClass": "simple2.disp",
"namespace": "USER",
"resource": "",
"swaggerSpec": "/api/mgmnt/v1/USER/spec/webapp/simple2",
"enabled": true
}
]
