Cisco WebEx Social API Reference Guide, Release 3.4
User Group Resource Operations
Downloads: This chapterpdf (PDF - 250.0KB) The complete bookPDF (PDF - 15.05MB) | Feedback

User Group Resource Operations

Table Of Contents

User Group Resource Operations

Get Information about a User Group

Get Information about User Groups to which a User Belongs

Get Information about all User Groups

Create a User Group

Update Information for a User Group

Delete a User Group

Get Information about Users in a User Groups


User Group Resource Operations


A Cisco WebEx Social user group is an arbitrary collection of users that a system administrator creates. Typically, users who are in a user group have common interests, goals, or responsibilities.

Table 5-1 provides a summary of the User Group resource operations. Each operation is described in detail in the section that is listed.

These sections provide this information:

Purpose—Brief explanation of the operation

Availability—Cisco WebEx Social releases that support the operation

Request—HTTP method and URI for the operation

Request Payload—Description of the request payload, if the operation requires one

Response—Description of the expected response when the operation executes

Example—Sample request and response for the operation

Table 5-1 User Group Resource Operations Summary 

Operation and Reference
Purpose

Get Information about a User Group

Retrieves information about the designated user group

Get Information about User Groups to which a User Belongs

Retrieves information about the user groups to which the designated user belongs

Get Information about all User Groups

Retrieves information about all user groups in Cisco WebEx Social

Create a User Group

Creates a user group

Update Information for a User Group

Updates information about the designated user group

Delete a User Group

Deletes the designated user group from Cisco WebEx Social

Get Information about Users in a User Groups

Retrieves information about users who are members of the designated user group


Get Information about a User Group

Purpose

Retrieves information about the designated user group.

Availability

Cisco WebEx Social 3.4 and later.

Request

HTTP Method
URI

GET

{http|https}://server[:port]/api/quad/rest/usergroups/usergroup_id


where:

server—Host name or IP address of the Cisco WebEx Social server.

port—Port number on which the Cisco WebEx Social server listens for API requests. The default value is 80.

usergroup_id—Identifier of the user group for which to retrieve information. To obtain the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.

Request Payload

A request payload is not required.

Response

Standard response (see the "API Responses" section) with a response payload that can include one UserGroup resource (the "UserGroup Resource" section describes this resource).

Examples

Request

GET http://webexsocialserver/api/quad/rest/usergroups/40310017
Accept:application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json 
 
   

The response can also include the UserGroup resource. For an example, see the "UserGroup Resource Response, One Resource Returned" section.

Get Information about User Groups to which a User Belongs

Purpose

Retrieves information about the user groups to which the designated user belongs.

Availability

Cisco WebEx Social 3.4 and later.

Request

HTTP Method
URI

GET

{http|https}://server[:port]/api/quad/rest/users/[@me|user_id]/usergroups
[?query_parameters]


where:

server—Host name or IP address of the Cisco WebEx Social server.

port—Port number on which the Cisco WebEx Social server listens for API requests. Required if the port number is not 80.

user_id—Identifier of the user for whom to retrieve information about user groups. Using @me has the same effect as entering your user identifier. To obtain the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.

query_parameters—Query parameters. For this operation:

The fields query parameter is supported for selecting fields from the UserGroup resource to include in a response (Table 3-50 describes these fields).

The filterBy query parameter is supported for filtering resources in a response by the name or description field in the UserGroup resource. (using the description field is supported beginning with Cisco WebEx Social 3.4 SR.1)

The sortOrder query parameter is supported for sorting resources in a response by the name or description field in the UserGroup resource. (Using the description field is not supported beginning with Cisco WebEx Social 3.4 SR1.)

The startIndex query parameter is supported for paginating return results.

The count query parameter is supported for designating the maximum number of items in the return results.

The meta query parameter does not apply.

Request Payload

A request payload is not required.

Response

Standard response (see the "API Responses" section) with a response payload that can include one or more UserGroup resources (the "UserGroup Resource" section describes this resource).

Examples

Request

GET http://webexsocialserver/api/quad/rest/users/12345/usergroups
Accept: application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json 
 
   

The response can also include one or more UserGroup resources. For an example, see the "UserGroup Resource Response, Multiple Resources Returned" section.

Get Information about all User Groups

Purpose

Retrieves information about all user groups in Cisco WebEx Social.

Availability

Cisco WebEx Social 3.4 and later.

Request

HTTP Method
URI

GET

{http|https}://server[:port]/api/quad/rest/usergroups[?query_parameters]


where:

server—Host name or IP address of the Cisco WebEx Social server.

port—Port number on which the Cisco WebEx Social server listens for API requests. The default value is 80.

query_parameters—Query parameters. For this operation:

The fields query parameter is supported for selecting fields from the UserGroup resource to include in a response (Table 3-50 describes these fields).

The filterBy query parameter is supported for filtering resources in a response by the name or description field in the UserGroup resource. (Using the description field is supported beginning with Cisco WebEx Social 3.4 SR1.)

The sortOrder query parameter is supported for sorting resources in a response by the name or description field in the UserGroup resource. (Using the description field is not supported beginning with Cisco WebEx Social 3.4 SR1.)

The startIndex query parameter is supported for paginating return results.

The count query parameter is supported for designating the maximum number of items in the return results.

The meta query parameter does not apply.

Request Payload

A request payload is not required.

Response

Standard response (see the "API Responses" section) with a response payload that can include one or more UserGroup resources (the "UserGroup Resource" section describes this resource).

Examples

Request

GET http://webexsocialserver/api/quad/rest/usergroups
Accept: application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json 
 
   

The response can also include one or more UserGroup resources. For an example, see the "UserGroup Resource Response, Multiple Resources Returned" section.

Create a User Group

Purpose

Creates a user group.

Availability

Cisco WebEx Social 3.4 SR1 and later.

Request

HTTP Method
URI

POST

{http|https}://server[:port]/api/quad/rest/usergroups


where:

server—Host name or IP address of the Cisco WebEx Social server.

port—Port number on which the Cisco WebEx Social server listens for API requests. Required if the port number is not 80.

Request Payload

The request payload includes fields from the UserGroups resource (Table 3-50 describes these fields):

Required Fields
Optional Fields

name

description


Response

Standard response (see the "API Responses" section) with a response payload that can include one UserGroup resource (the "UserGroup Resource" section describes this resource).

Example

Request

POST http://webexsocialserver/api/quad/rest/usergroups
Accept:application/json
Content-Type: application/json
{
"name" : "teasdsdfsfdasd1e",
"description" : "testdesc"
}

Response

HTTP/1.1 201 Created
Content-Type: application/json 
 
   

The response can also include the UserGroup resource. For an example, see the "UserGroup Resource Response, One Resource Returned" section.

Update Information for a User Group

Purpose

Updates information about the designated user group.

Availability

Cisco WebEx Social 3.4 and later.

Request

HTTP Method
URI

PUT

{http|https}://server[:port]/api/quad/rest/usergroups/usergroup_id


where:

server—Host name or IP address of the Cisco WebEx Social server.

port—Port number on which the Cisco WebEx Social server listens for API requests. Required if the port number is not 80.

usergroup_id—Identifier of the user group for which to update information. To obtain the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.

Request Payload

The request payload includes fields from the UserGroups resource (Table 3-50 describes these fields):

Required Fields
Optional Fields

description
name


Response

Standard response (see the "API Responses" section) with an HTTP header only.

Example

Request

PUT http://webexsocialserver/api/quad/rest/usergroups/12345
Accept:application/json
Content-Type: application/json
{
"name" : "teasdsdfsfdasd1e",
"description" : "testdesc"
}

Response

HTTP/1.1 204 No Content

Delete a User Group

Purpose

Deletes the designated user group from Cisco WebEx Social.

Availability

Cisco WebEx Social 3.4 and later.

Request

HTTP Method
URI

DELETE

{http|https}://server[:port]/api/quad/rest/usergroups/usergroup_id


where:

server—Host name or IP address of the Cisco WebEx Social server.

port—Port number on which the Cisco WebEx Social server listens for API requests. Required if the port number is not 80.

usergroup_id—Identifier of the user group to delete. To obtain the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.

Request Payload

A request payload is not required.

Response

Standard response (see the "API Responses" section) with an HTTP header only.

Example

Request

DELETE http://webexsocialserver/api/quad/rest/usergroups/40310017

Response

HTTP/1.1 204 No Content

Get Information about Users in a User Groups

Purpose

Retrieves information about users who are members of the designated user group.

Availability

Cisco WebEx Social 3.4 and later.

Request

HTTP Method
URI

GET

{http|https}://server[:port]/api/quad/rest/usergroups/usergroup_id/users[?filter= {firstName | middleName | lastName | screenName | emailAddress | active}: [value]][{?|&}query_parameters]


where:

server—Host name or IP address of the Cisco WebEx Social server.

port—Port number on which the Cisco WebEx Social server listens for API requests. Required if the port number is not 80.

usergroup_id—Identifier of the user group from which to obtain information about users who are members. To obtain the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.

value:

For filter=firstName, value is the first name of a Cisco WebEx Social user. In this case, the operation retrieves only users with this first name.

For filter=middleName, value is the middle name of a Cisco WebEx Social user. In this case, the operation retrieves only users with this middle name.

For filter=lastName, value is the last name of a Cisco WebEx Social user. In this case, the operation retrieves only users with this last name.

For filter=screenName, value is the screen name of a Cisco WebEx Social user. In this case, the operation retrieves only users with this screen name.

For filter=emailAddress, value is the email address of a Cisco WebEx Social user. In this case, the operation retrieves only users with this email address.

For filter=active, value is value not required. In this case, the operation retrieves only active Cisco WebEx Social users.

query_parameters—Query parameters. For this operation:

The fields query parameter is supported for selecting fields from the User resource to include in a response (Table 3-49 describes this resource)

The filterBy query parameter does not apply

The sortOrder query parameter is supported for sorting resources in a response by the firstName, lastName, screenName, or jobTitle in the User resource

The startIndex query parameter is supported for paginating return results

The count query parameter is supported for designating the maximum number of items in the return results

The meta query parameter is supported with the follow value for requesting relationship metadata

Request Payload

A request payload is not required.

Response

Standard response (see the "API Responses" section) with a response payload that can include one or more User resources (the "User Resource" section describes this resource).

Examples

Request

http://webexsocialserver/api/quad/rest/usergroups/3910017/users
Accept: application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json 
{
 
   

The response can also include one or more User resources. For an example, see the "User Resource Response, Multiple Resources Returned" section.