IBM Business Process Manager, Version 8.5.5

REST interface for BPD-related resources - Resource Environment Provider (REP) Properties Resource Resource - GET Method

If no properties query parameter is specified, then the service will return a list of properties available on the specified provider, if it exists. If a properties query parameter is specified then the service will resolve the value of the requested properties from the provider and return those in key value pairs

Sample method invocation

GET /rest/bpm/wle/v1/system/rep/{providerName}[?properties={string}]

Parameters

Optional parameters

Name	Value Type	Description
properties	string	A JSON Array List of properties you wish to retrieve from the specified Resource Environment Provider

Request content

None

Response content

Depending on the request, and what variables are provided the response will either contain a list of available properties associated with a given provider, or the service will return key value pairs with the properties requested corresoponding to keys, and the values of the properties. If a property failed to resolve, it will have the value "NULL"

The default content type is application/json.

Error Response content

Detailed error information.

The default content type is application/json.

MIME type: application/json

+ View schema

{  "description": "WLE Error Response", 
   "type": "object",
   "properties":
   {  "status": {"type": "string",
         "description": "The status of the previous API call."
      },
      "exceptionType": {"type": "string",
         "description": "The classname associated with the exception."
      },
      "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.
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.

Available since

8.0.1

Parent Topic: Resource Environment Provider (REP) Properties Resource Resource