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

If the properties parameter is specified, those properties and their values are returned as key/value pairs. If the properties parameter is not specified, the names of all properties supported by the specified provider are returned.

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 that you want to retrieve from the specified resource environment provider.

Request content

None

Response content

If the properties parameter is specified, the values of the selected properties are returned as a set of key/value pairs. Otherwise, if the properties parameter is not specified, a list of all available properties supported by the specified resource environment provider is returned. If the value of a property cannot be retrieved, it is returned with the null value.

The default content type is application/json.

Error Response content

Detailed error information.

The default content type is application/json.

MIME type: application/json

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 Properties Resource Resource