REST interface for BPEL-related process resources - Systems Metadata Resource - GET Method

Use this method to retrieve metadata about one or more WebSphere Process Server installations (single server or cluster).

Sample method invocation

GET /rest/bpm/bfm/v1/systems

Parameters

None

Request Content

None

Response Content

System details.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Systems", 
   "type": "object",
   "properties":
   {  "systems":
      [
         {  "systemID": {"type": "string", 
               "description": "ID of the system that is described by this object."
            },
            "systemType": {"type": "string",
               "description": "Type of the system that is described by this object.",
               "enum":
               [
                  "SYSTEM_TYPE_WPS"
               ]
            },
            "version": {"type": "string",
               "description": "Version of the system that is described by this object."
            },
            "buildLevel": {"type": "string",
               "description": "Build level of the system that is described by this object."
            },
            "supports": {"type": "[string]",
               "description": "List of features the API supports."
            },
            "resources": {"type": "[string]",
               "description": "List of resources the API supports."
            }
         }
      ]
   }    
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description":"Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description":"Message text of the exception."
      },
      "errorMessageParameters": {"type": ["string"], "optional": true,
         "description":"Message text parameters of the exception."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description":"Additional, exception details, for example, a stack trace."
      }
   }
}

Status codes

The method returns one of the following status codes:

Code	Description
200 OK	Success completion.
400 Bad Request	The parameters are not valid or they are missing.
401 Unauthorized	The caller is not authorized for this request.
406 Not Acceptable	The requested content type or content encoding is not supported.
500 Internal Server Error	A severe problem has occurred. Programmer's details are provided.

Change history

The following changes have been applied to this method:

Release	Description
7.5.1	The returned query table attribute entry contains new properties: `"supports"` `"resources"`

Available since

7.5

Parent topic: Systems Metadata Resource