ON THIS PAGE
GET /gui_app_framework/named_services
SUMMARY Retrieves all named services.
Retrieves a list of all named services registered with the Application Framework.
By using the returned information, the caller can determine what services are available and what facilities each service provides via its REST endpoints.
| MIME Type |
|---|
application/json |
There are no parameters for this endpoint.
| HTTP Response Code | Unique Code | Description |
|---|---|---|
200 |
The list of named services was returned. |
|
409 |
33700 |
The application framework is currently disabled. |
500 |
1020 |
An error occurred while trying to retrieve the list of named services. |
Response Description
A list of named services. The documentation for /named_services/{uuid} has a description of the details returned for a named service instance.
Response Sample
[{
"name": "resourceservice",
"version": "1",
"application_id": 1001,
"uuid": "e4081cd1-c3c8-4089-afc7-c32039bd796c",
"endpoints": [
{
"name": "getResource",
"path": "/console/plugins/1001/app_proxy:resourceservice/resource/{resource_id}",
"http_method": "GET",
"parameters": [
{ "location": "PATH", "name": "resource_id" }
],
"response": {
"mime_type": "application/json+ld",
"body_type": {
"@type": "http://id.ibm.com/Resource",
"resource_id": "http://id.ibm.com/resourceID",
"resource_name": "http://id.ibm.com/resourceName",
"resource_owner": "http://id.ibm.com/personId"
}
},
"error_mime_type": "text/plain"
},
{
"name": "createResource",
"path": "/console/plugins/1001/app_proxy:resourceservice/resource",
"http_method": "POST",
"request_mime_type": "application/json+ld",
"request_body_type": {
"@type": "http://id.ibm.com/Resource",
"resource_name": "http://id.ibm.com/resourceName",
"resource_owner": "http://id.ibm.com/personId"
},
"response": {
"mime_type": "application/json+ld",
"body_type": {
"@type": "http://id.ibm.com/Resource",
"resource_id": "http://id.ibm.com/resourceID",
"resource_name": "http://id.ibm.com/resourceName",
"resource_owner": "http://id.ibm.com/personId"
}
},
"error_mime_type": "text/plain"
},
{
"name": "updateResource",
"path": "/console/plugins/1001/app_proxy:resourceservice/resource/{resource_id}",
"http_method": "PUT",
"request_mime_type": "application/json+ld",
"request_body_type": {
"@type": "http://id.ibm.com/Resource",
"resource_name": "http://id.ibm.com/resourceName",
"resource_owner": "http://id.ibm.com/personId"
},
"parameters": [
{ "location": "PATH", "name": "resource_id" }
],
"response": {
"mime_type": "application/json+ld",
"body_type": {
"@type": "http://id.ibm.com/Resource",
"resource_id": "http://id.ibm.com/resourceID",
"resource_name": "http://id.ibm.com/resourceName",
"resource_owner": "http://id.ibm.com/personId"
}
},
"error_mime_type": "text/plain"
}
]
}]