The Get Console Properties operation retrieves the properties of the
Console object. This operation is supported using the BCPii
interface.
HTTP method and URI
GET /api/console
Query Parameters
Name
Type
Rqd/Opt
Description
properties
List of String Enum
Optional
Filter string to limit returned properties to those that are identified here.
This is a list of comma-separated strings where each string is a property name defined in the
Console object's Data Model.
Response
body contents
On successful completion, the response body
contains an object that provides the current values of the properties
for the Console object as defined in Data model. Field
names and data types in the object are the same as the property names
and data types defined in the data model.
Description
This operation returns the current
properties for the Console object.
On successful execution, HTTP status code 200 (OK) is returned and all of the current properties
as defined by the data model for the Console object are provided in the response body.
Authorization requirements
This operation has the following authorization requirements:
For the web services interface, all authenticated users have permission.
For the BCPii interface the source partition must have receive BCPii security controls
permissions for the CPC object.
HTTP status and reason codes
On success,
HTTP status code 200 (OK) is returned and the response body is provided
as described Response body contents.
The
following HTTP status codes are returned for the indicated errors,
and the response body is a standard error response body providing
the reason code indicated and associated error message.