User Group Resource Operations

Size: px

Start display at page:

Download "User Group Resource Operations"

Julian Barber
6 years ago
Views:

1 CHAPTER 5 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: Brief explanation of the operation Cisco WebEx Social releases that support the operation HTTP method and for the operation Payload Description of the request payload, if the operation requires one Description of the expected response when the operation executes Example Sample request and response for the operation Table 5-1 Summary Operation and Reference Get Information about a User Group, page 5-2 Get Information about User Groups to which a User Belongs, page 5-3 Get Information about all User Groups, page 5-5 Create a User Group, page 5-7 Update Information for a User Group, page 5-8 Delete a User Group, page 5-9 Get Information about Users in a User Groups, page 5-10 Retrieves information about the designated user group Retrieves information about the user groups to which the designated user belongs Retrieves information about all user groups in Cisco WebEx Social Creates a user group Updates information about the designated user group Deletes the designated user group from Cisco WebEx Social Retrieves information about users who are members of the designated user group 5-1

2 Get Information about a User Group Chapter 5 Get Information about a User Group Retrieves information about the designated user group. Cisco WebEx Social 3.4 and later. GET {http https}://server[:port]/api/quad/rest/usergroups/usergroup_id 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 on page Payload A request payload is not required. Standard response (see the API s section on page 1-18) with a response payload that can include one UserGroup resource (the UserGroup Resource section on page 3-49 describes this resource). Examples GET Accept:application/json HTTP/ OK The response can also include the UserGroup resource. For an example, see the UserGroup Resource, One Resource Returned section on page

3 Chapter 5 Get Information about User Groups to which a User Belongs Get Information about User Groups to which a User Belongs Retrieves information about the user groups to which the designated user belongs. Cisco WebEx Social 3.4 and later. GET {http https}://server[:port]/api/quad/rest/users/[@me user_id]/usergroups [?query_parameters] 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. 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 on page 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 on page 3-49 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. Payload A request payload is not required. Standard response (see the API s section on page 1-18) with a response payload that can include one or more UserGroup resources (the UserGroup Resource section on page 3-49 describes this resource). 5-3

4 Get Information about User Groups to which a User Belongs Chapter 5 Examples GET Accept: application/json HTTP/ OK The response can also include one or more UserGroup resources. For an example, see the UserGroup Resource, Multiple Resources Returned section on page

5 Chapter 5 Get Information about all User Groups Get Information about all User Groups Retrieves information about all user groups in Cisco WebEx Social. Cisco WebEx Social 3.4 and later. GET {http https}://server[:port]/api/quad/rest/usergroups[?query_parameters] 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 on page 3-49 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. Payload A request payload is not required. Standard response (see the API s section on page 1-18) with a response payload that can include one or more UserGroup resources (the UserGroup Resource section on page 3-49 describes this resource). Examples GET Accept: application/json 5-5

6 Get Information about all User Groups Chapter 5 HTTP/ OK The response can also include one or more UserGroup resources. For an example, see the UserGroup Resource, Multiple Resources Returned section on page

7 Chapter 5 Create a User Group Create a User Group Creates a user group. Cisco WebEx Social 3.4 SR1 and later. POST {http https}://server[:port]/api/quad/rest/usergroups port Port number on which the Cisco WebEx Social server listens for API requests. Required if the port number is not 80. Payload The request payload includes fields from the UserGroups resource (Table 3-50 on page 3-49 describes these fields): Required Fields name Optional Fields description Standard response (see the API s section on page 1-18) with a response payload that can include one UserGroup resource (the UserGroup Resource section on page 3-49 describes this resource). Example POST Accept:application/json { "name" : "teasdsdfsfdasd1e", "description" : "testdesc" } HTTP/ Created The response can also include the UserGroup resource. For an example, see the UserGroup Resource, One Resource Returned section on page

8 Update Information for a User Group Chapter 5 Update Information for a User Group Updates information about the designated user group. Cisco WebEx Social 3.4 and later. PUT {http https}://server[:port]/api/quad/rest/usergroups/usergroup_id 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 on page Payload The request payload includes fields from the UserGroups resource (Table 3-50 on page 3-49 describes these fields): Required Fields Optional Fields description name Standard response (see the API s section on page 1-18) with an HTTP header only. Example PUT Accept:application/json { "name" : "teasdsdfsfdasd1e", "description" : "testdesc" } HTTP/ No Content 5-8

9 Chapter 5 Delete a User Group Delete a User Group Deletes the designated user group from Cisco WebEx Social. Cisco WebEx Social 3.4 and later. DELETE {http https}://server[:port]/api/quad/rest/usergroups/usergroup_id 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 on page Payload A request payload is not required. Standard response (see the API s section on page 1-18) with an HTTP header only. Example DELETE HTTP/ No Content 5-9

10 Get Information about Users in a User Groups Chapter 5 Get Information about Users in a User Groups Retrieves information about users who are members of the designated user group. Cisco WebEx Social 3.4 and later. GET {http https}://server[:port]/api/quad/rest/usergroups/usergroup_id/users[?filter= {firstname middlename lastname screenname address active}: [value]][{? &}query_parameters] 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 on page 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= address, value is the address of a Cisco WebEx Social user. In this case, the operation retrieves only users with this 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 on page 3-46 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 5-10

11 Chapter 5 Get Information about Users in a User Groups 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 Payload A request payload is not required. Standard response (see the API s section on page 1-18) with a response payload that can include one or more User resources (the User Resource section on page 3-46 describes this resource). Examples Accept: application/json HTTP/ OK { The response can also include one or more User resources. For an example, see the User Resource, Multiple Resources Returned section on page

12 Get Information about Users in a User Groups Chapter

Tags Resource and TagTrends Resource Operations

CHAPTER 9 Tags Resource and TagTrends Resource Operations A Cisco WebEx Social tag is keyword or phrase that can be associated with an element such as a post, message, community, and so on. People can