Adding and Updating a Group

This RESTful web service request can be used to add or update a group to WebFOCUS.

HTTP Method: POST

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/SSYS/GROUPS/Group

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

Group

Is the name of the group to be added.

Body Format:

IBIRS_action=put&IBIRS_object=Object&IBIRS_replace=ReplaceGroupProperties

where:

Object

Is the XML object defining the attributes for the group, using the following format:

<object _jt="IBFSGroupObject" container="true" description="GroupTitle" type="Group"></object>

where:

GroupTitle

Is the title for the group.

ReplaceGroupProperties

Is an optional property that allows you to decide whether or not the properties for a group can be updated.

You can choose true (default) or false.

Example:

In the following example, a group called RestUsers is added. The title for the group is RESTful Web Services Users.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/SSYS/GROUPS/RestUsers

Body:

IBIRS_action=put&IBIRS_object=
  <object _jt="IBFSGroupObject" container="true" description="RESTful Web Services Users" type="Group"></object>

Response:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<ibfsrpc _jt="IBFSResponseObject" language="EN" name="IBIRS_action" returncode="10000" returndesc="SUCCESS" subreturncode="0"
       subsystem="SSYS" type="simple">
 <ibfsparams size="0"/>
 <rootObject _jt="IBFSGroupObject" container="true" description="RESTful Web Services Users" dummy="false"
       fullPath="/SSYS/GROUPS/RestUsers" name="RestUsers" policy="///+f///////9/////////////+AAAAA" type="Group">
   <users _jt="ArrayList" size="0"/>
 </rootObject>
</ibfsrpc>

If the value for the returncode attribute in the XML response is 10000, then the group was added successfully.


WebFOCUS