Get Custom Group Properties

The Get Custom Group Properties operation retrieves the properties of a single Group object that is designated by the {group-id}. This operation is supported using the BCPii interface.

HTTP method and URI

GET /api/groups/{group-id}

In this request, the URI variable {group-id} is the object ID of the group.

Response body contents

On success, HTTP status code 200 (OK) is returned and the response body contains an object that provides the current values of the properties for the Group 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 Group object designated by {group-id}.

The URI path {group-id} must designate an existing Group object.

Authorization requirements

This operation has the following authorization requirement:
  • For the web services interface object-access permission to the Group object designated by {group-id}.
  • 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 in Response body contents.

On error, appropriate 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.

HTTP error status code Reason code Description
400 (Bad Request) Various Errors were detected during common request validation. See Common request validation reason codes for a list of the possible reason codes.
404 (Not Found) 1 The object-id in the URI ({group-id}) does not designate an existing group, or the API user does not have sufficient access (as described above).

Additional standard status and reason codes can be returned, as described in Invoking API operations.

Example HTTP interaction

Figure 1. Get Custom Group Properties: Request
GET /api/groups/ee2782af-dd98-3ec0-bc2d-cfe2e9154341 HTTP/1.1
x-api-session: 42r6t4chltipvd6l4l61wi3111tf7fv2hes80hjqjs3invt7cp
Figure 2. Get Custom Group Properties: Response
200 OK
server: zSeries management console API web server / 1.0
cache-control: no-cache
date: Fri, 25 Nov 2011 16:45:45 GMT
content-type: application/json;charset=UTF-8
content-length: 250
{
   "class": "group", 
   "description": "Spacely Sprockets Web Servers", 
   "replication-overwrite-possible": false,
   "is-locked": false, 
   "match-info": {}, 
   "name": "SS-Web-Servers", 
   "object-id": "ee2782af-dd98-3ec0-bc2d-cfe2e9154341", 
   "object-uri": "/api/groups/ee2782af-dd98-3ec0-bc2d-cfe2e9154341", 
   "parent": null
}