Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /gui_app_framework/named_services/{uuid}

SUMMARY 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:

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:

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:

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.
    • 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.
  • 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.

Response Sample