GET /gui_app_framework/named_services/{uuid}

Retrieves a named service.

Using the supplied uuid, retrieves a named service registered with the Application Framework.

Table 1. GET /gui_app_framework/named_services/{uuid} resource details
MIME Type
application/json

Table 2. GET /gui_app_framework/named_services/{uuid} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
uuid	path	Required	String	text/plain	Required - A named service uuid.

Table 3. GET /gui_app_framework/named_services/{uuid} response codes
HTTP Response Code	Unique Code	Description
200		The requested named service was returned.
404	1002	The requested named service could not be found.
409	33700	The application framework is currently disabled.
500	1020	An error occurred while trying to retrieve the requested named service.

Response Description

The details of a named service:

name - String - Service name.
version - String - Service version.
application_id - Integer - ID of the application that implements this service.
uuid - Integer - Unique identifier for this service.
endpoints - Array - List of endpoints provided by this service.
- name - String - Endpoint name.
- path - String - Endpoint URL.
- http_method - String - One of GET/POST/PUT/DELETE.
- request_mime_type - String - MIME type of request body.
- request_body_type - Object - JSON definition of request body.
- parameters - Array - List of request parameters.
  - location - String - Where the parameter goes in the request. One of PATH/QUERY/BODY.
  - name - String - Parameter name.
  - definition - String - Parameter definition, e.g. "String".
- response - Object - Response definition.
  - mime_type - String - MIME type of response body.
  - body_type - Object - JSON definition of response body.
- error_mime_type - String - MIME type of response body when an error occurs.

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"
    }
  ]
}